What's New in XML Schemas for Outlook 2010
Summary: This article describes the additions to XML schemas supported by Microsoft Outlook 2010. You can find definitions and detailed documentation for schema elements and types in the Microsoft Outlook 2010 XML Schema Reference.
Applies to: Microsoft Outlook 2010 | Microsoft SharePoint Foundation 2010 | Microsoft SharePoint Server 2010
Published: May 2010
Provided by: Angela Chu-Hatoun, Microsoft Corporation
Overview of the Outlook 2010 XML Schema Reference
The Microsoft Outlook 2010 XML Schema Reference provides documentation for the following 10 schemas supported by Outlook 2010:
ElectronicBusinessCard—defines the layout of Electronic Business Cards.
The form region schemas:
FormRegion—defines manifests for form regions. See the section Enhancements to the FormRegion Schema for new features that this schema supports.
FormRegionLocalization—defines localization files for form regions.
The Microsoft Office 2010 Mobile Service (OMS) schemas. Office 2010 Mobile Service is the updated version of Microsoft Outlook Mobile Service from Microsoft Office Outlook 2007. In addition to working for Outlook 2010, Office Mobile Service supports the sending of text message (SMS) alerts from a SharePoint site. The following are the seven schemas for OMS:
AuthenticationData—defines authentication information for users.
DeliveryResponse—defines a response from an OMS web service.
DeliveryResponsesBatch—defines a batch of multiple responses from an OMS web service. This schema is new for Office 2010. For more information, see the section New Office Mobile Service Schemas.
Message—defines a complete message transferred from a client to an OMS web service, including information about the user, header, body, and recipient.
MessagesBatch—defines a batch of messages transferred from a client to an OMS web service. This schema is new for Office 2010. For more information, see the section New Office Mobile Service Schemas.
ServiceInformation—defines information for an OMS web service such as its name and type of authentication, and the services it supports, such as SMS or multimedia message service (MMS).
UserInformation—defines the user’s information that is returned by an OMS web service, such as the user’s mobile phone number and SMTP address.
New Office Mobile Service Schemas
The DeliveryResponsesBatch schema defines a set of one or more response messages from an OMS web service. The xmsResponses element represents the set of responses, and the xmsResponse element represents each response message in the set. A response message is optionally attributed by a string identifier (the Id attribute), and the web service can use the error child element to specify an error.
Whereas the DeliveryResponsesBatch schema defines a set of delivery responses, the DeliveryResponse schema defines a single delivery response. For more information about the type of the error element, see the DeliveryResponse schema in the Outlook 2010 XML Schema Reference.
The MessagesBatch schema defines a set of one or more messages transferred from a client to an OMS web service. The xmsBatch element represents a set of messages, and the xmsData element represents each message in the set. A message is optionally attributed by a numerical identifier (the Id attribute), and contains data about the user, message header, and message body, specified by the user, xmsHead, and xmsBody child elements, respectively.
Whereas the MessagesBatch schema defines a set of messages, the Message schema defines a single message, transferred from a client to the OMS web service. For more information about the types of the user, xmsHead, and xmsBody child elements, see the Message schema in the Outlook 2010 XML Schema Reference.
Enhancements to the FormRegion Schema
Custom Fields in Form Regions
Developers can now define custom fields for a form region in the form region XML manifest by using the new fieldRegistry and userField elements. There are new child elements for the userField element: name, type, format, formula, and default. Developers can use these new child elements to define the name and type for the custom field and, optionally, the default format, a formula (if the field type is formula or combination), and a default value.
Hiding or Showing Form Regions at Run Time
In Outlook 2010, developers can hide or show an adjoining or separate form region at run time. Developers can use the HideFormPage or ShowFormPage methods of the Inspector object. Developers can also set the new defaultVisibility element in the form region XML manifest for Outlook to show or hide the form region by default.
This article describes changes in the FormRegion XML schema that are of interest to users customizing form regions, and introduces two new schemas, DeliveryResponsesBatch and MessagesBatch, for OMS web service providers. For more information, see the documentation listed under Additional Resources.