FieldMapping.xml

Learn how to define and modify fieldmapping.

An example of FieldMapping.xml (FieldMapping_Sample.xml) is deployed to the installation directory by the setup routine. To modify the out-of-the-box field mapping, you have to copy FieldMapping_Sample.xml to FieldMapping.xml.

Basically there are several ways to define a field mapping – for all samples below, the colors used have the following meaning:

Node-Name

Can have the following values:

FieldFullName

FieldFullId

FieldExtId

FieldExtName

The node name determines, which kind of declaration has to be

used. E.g. if you use the node name FieldFullName, connector SE expects a declaration containing the attribute MSExFieldFullName.

Mandatory Attribute Required attribute
Legacy Attribute Not used by connector SE (solely used by "classic" connector)
Optional Attribute

If not provided the particular default values are used.

MSExFieldType – field type (if not specified PT_TSTRING is used)

MSExFieldGuid – field GUID (if not specified PROP_GUID_USER is used)

If you want to map a field which is part of the particular EWS field schema32, you may use the simple form as sketched below.

<FieldFullName MapFieldID="1" MSExFieldFullName="Location" OLDisplName="Location"/>

If you want to map a field which is not part of the particular EWS field schema, you can use one of the definitions listed below.

<FieldFullId MapFieldID="2"MSExFieldFullID="0x80320040" MapiPropTag="0x80320040" OLDisplName="Reminder Time"/>
<FieldExtId MapFieldID="3" MSExFieldID="0x803F" MSExFieldType="PT_LONG" MSExFieldGuid="PROP_GUID_APPOINTMENT" OLDisplName="Duration"/>
<FieldExtName MapFieldID="4" MSExFieldName="mmTemporary" MSExFieldType="PT_TSTRING" MSExFieldGuid="PROP_GUID_USER" OLDisplName="mmTemporary"/>

Consequently the most simple way to declare a mapping for a user-generated Outlook field of type string would be

<FieldExtName MapFieldID="15" MSExFieldName="MyMappedField"/>
Note: The file FieldMapping_Sample.xml is provided as is, without any warranty of any kind.

In particular, note that the attribute MSExFieldFullID for fields may differ in some cases from Exchange server to server.

Field mapping is supported for the following MAPI data types:

  • single value data types:

    PT_UNICODE (PT_TSTRING), PT_BOOLEAN, PT_LONGLONG, PT_SYSTIME

  • multi-value data types33:

    PT_MV_UNICODE (PT_MV_TSTRING), PT_MV_LONGLONG