ActiveSync CSP

The ActiveSync configuration service provider is used to set up and change settings for Exchange ActiveSync. After an Exchange account has been updated over-the-air by the ActiveSync configuration service provider, the device must be powered off and then powered back on to see sync status.

Configuring Windows Live ActiveSync accounts through this configuration service provider isn't supported.

Note

The target user must be logged in for the CSP to succeed. The correct way to configure an account is to use the ./User/Vendor/MSFT/ActiveSync path. The ./Vendor/MSFT/ActiveSync path is deprecated.

The following list shows the ActiveSync configuration service provider nodes:

• ./User/Vendor/MSFT/ActiveSync
  • Accounts
    • {Account GUID}
      • AccountIcon
      • AccountName
      • AccountType
      • Domain
      • EmailAddress
      • Options
        • CalendarAgeFilter
        • ContentTypes
          • {Content Type GUID}
            • Enabled
            • Name
        • Logging
        • MailAgeFilter
        • MailBodyType
        • MailHTMLTruncation
        • MailPlainTextTruncation
        • Schedule
        • UseSSL
      • Password
      • Policies
        • MailBodyType
        • MaxMailAgeFilter
      • ServerName
      • UserName

Accounts

Scope	Editions	Applicable OS
❌ Device ✅ User	✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC	✅ Windows 10, version 1507 [10.0.10240] and later

./User/Vendor/MSFT/ActiveSync/Accounts

The parent node group all active sync accounts.

Description framework properties:

Property name	Property value
Format	node
Access Type	Get

Accounts/{Account GUID}

Scope	Editions	Applicable OS
❌ Device ✅ User	✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC	✅ Windows 10, version 1507 [10.0.10240] and later

./User/Vendor/MSFT/ActiveSync/Accounts/{Account GUID}

Defines a specific ActiveSync account. A globally unique identifier (GUID) must be generated for each ActiveSync account on the device.

When managing over OMA DM, make sure to always use a unique GUID. Provisioning with an account that has the same GUID as an existing one deletes the existing account and doesn't create the new account.

Description framework properties:

Property name	Property value
Format	node
Access Type	Add, Delete, Get, Replace
Atomic Required	True
Dynamic Node Naming	ServerGeneratedUniqueIdentifier
Allowed Values	Regular Expression: \{[0-9A-Fa-f]{8}\-[0-9A-Fa-f]{4}\-[0-9A-Fa-f]{4}\-[0-9A-Fa-f]{4}\-[0-9A-Fa-f]{12}\}

Example:

Braces {} are required around the GUID. In OMA Client Provisioning, you can type the braces. For example:

<characteristic type="{C556E16F-56C4-4EDB-9C64-D9469EE1FBE0}"/>

For OMA DM, you must use the ASCII values of %7B and %7D for the opening and closing braces, respectively. For example, if the GUID is "C556E16F-56C4-4EDB-9C64-D9469EE1FBE0", type:

<Target>
   <LocURI>
      ./Vendor/MSFT/ActiveSync/Accounts/%7BC556E16F-56C4-4EDB-9C64-D9469EE1FBE0%7D
   </LocURI>
</Target>

Accounts/{Account GUID}/AccountIcon

Scope	Editions	Applicable OS
❌ Device ✅ User	✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC	✅ Windows 10, version 1507 [10.0.10240] and later

./User/Vendor/MSFT/ActiveSync/Accounts/{Account GUID}/AccountIcon

Specify the location of the icon associated with the account.

The account icon can be used as a tile in the Start list or an icon in the applications list under Settings > Email & accounts. Some icons are already provided on the device. The suggested icon for POP/IMAP or generic ActiveSync accounts is at res://AccountSettingsSharedRes{ScreenResolution}!%s.genericmail.png. The suggested icon for Exchange Accounts is at res://AccountSettingsSharedRes{ScreenResolution}!%s.office.outlook.png. Custom icons can be added if desired.

Description framework properties:

Property name	Property value
Format	chr (string)
Access Type	Add, Delete, Get, Replace

Accounts/{Account GUID}/AccountName

Scope	Editions	Applicable OS
❌ Device ✅ User	✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC	✅ Windows 10, version 1507 [10.0.10240] and later

./User/Vendor/MSFT/ActiveSync/Accounts/{Account GUID}/AccountName

The name that refers to the account on the device.

Description framework properties:

Property name	Property value
Format	chr (string)
Access Type	Add, Delete, Get, Replace

Accounts/{Account GUID}/AccountType

Scope	Editions	Applicable OS
❌ Device ✅ User	✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC	✅ Windows 10, version 1507 [10.0.10240] and later

./User/Vendor/MSFT/ActiveSync/Accounts/{Account GUID}/AccountType

Specify the account type. This value is entered during setup and can't be modified once entered. An Exchange account is indicated by the string value "Exchange".

Description framework properties:

Property name	Property value
Format	chr (string)
Access Type	Add, Delete, Get, Replace

Accounts/{Account GUID}/Domain

Scope	Editions	Applicable OS
❌ Device ✅ User	✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC	✅ Windows 10, version 1507 [10.0.10240] and later

./User/Vendor/MSFT/ActiveSync/Accounts/{Account GUID}/Domain

Domain name of the Exchange server.

Description framework properties:

Property name	Property value
Format	chr (string)
Access Type	Add, Delete, Get, Replace

Accounts/{Account GUID}/EmailAddress

Scope	Editions	Applicable OS
❌ Device ✅ User	✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC	✅ Windows 10, version 1507 [10.0.10240] and later

./User/Vendor/MSFT/ActiveSync/Accounts/{Account GUID}/EmailAddress

The email address the user entered during setup. This is the email address that's associated with the Exchange ActiveSync account and it's required.

This email address is entered by the user during setup and must be in the fully qualified email address format, for example, someone@example.com.

Description framework properties:

Property name	Property value
Format	chr (string)
Access Type	Add, Delete, Get, Replace

Accounts/{Account GUID}/Options

Scope	Editions	Applicable OS
❌ Device ✅ User	✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC	✅ Windows 10, version 1507 [10.0.10240] and later

./User/Vendor/MSFT/ActiveSync/Accounts/{Account GUID}/Options

Specifies whether email, contacts, and calendar need to synchronize by default, and sets preference such as sync schedule, truncation sizes, and logging.

Description framework properties:

Property name	Property value
Format	node
Access Type	Add, Delete, Get, Replace

Accounts/{Account GUID}/Options/CalendarAgeFilter

Scope	Editions	Applicable OS
❌ Device ✅ User	✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC	✅ Windows 10, version 1507 [10.0.10240] and later

./User/Vendor/MSFT/ActiveSync/Accounts/{Account GUID}/Options/CalendarAgeFilter

Specifies the time window used for syncing calendar items to the phone.

Description framework properties:

Property name	Property value
Format	chr (string)
Access Type	Add, Delete, Get, Replace

Accounts/{Account GUID}/Options/ContentTypes

Scope	Editions	Applicable OS
❌ Device ✅ User	✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC	✅ Windows 10, version 1507 [10.0.10240] and later

./User/Vendor/MSFT/ActiveSync/Accounts/{Account GUID}/Options/ContentTypes

Interior node for Content Types.

Description framework properties:

Property name	Property value
Format	node
Access Type	Add, Delete, Get, Replace

Accounts/{Account GUID}/Options/ContentTypes/{Content Type GUID}

Scope	Editions	Applicable OS
❌ Device ✅ User	✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC	✅ Windows 10, version 1507 [10.0.10240] and later

./User/Vendor/MSFT/ActiveSync/Accounts/{Account GUID}/Options/ContentTypes/{Content Type GUID}

Enables or disables syncing email, contacts, task, and calendar. Each is represented by a GUID. Email: {c6d47067-6e92-480e-b0fc-4ba82182fac7}. Contacts: {0dd8685c-e272-4fcb-9ecf-2ead7ea2497b}. Calendar: {4a5d9fe0-f139-4a63-a5a4-4f31ceea02ad}. Tasks:{783ae4f6-4c12-4423-8270-66361260d4f1}

Description framework properties:

Property name	Property value
Format	node
Access Type	Add, Delete, Get, Replace
Dynamic Node Naming	UniqueName: The GUID values allowed are one of the following: Email: "{c6d47067-6e92-480e-b0fc-4ba82182fac7}". Contacts: "{0dd8685c-e272-4fcb-9ecf-2ead7ea2497b}". Calendar: "{4a5d9fe0-f139-4a63-a5a4-4f31ceea02ad}". Tasks: "{783ae4f6-4c12-4423-8270-66361260d4f1}".

Accounts/{Account GUID}/Options/ContentTypes/{Content Type GUID}/Enabled

Scope	Editions	Applicable OS
❌ Device ✅ User	✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC	✅ Windows 10, version 1507 [10.0.10240] and later

./User/Vendor/MSFT/ActiveSync/Accounts/{Account GUID}/Options/ContentTypes/{Content Type GUID}/Enabled

Enables or disables Sync for Email, contacts, calendar, and Tasks.

Description framework properties:

Property name	Property value
Format	chr (string)
Access Type	Add, Delete, Get, Replace
Default Value	1

Allowed values:

Value	Description
0	Sync for email, contacts, calendar, or tasks is disabled.
1 (Default)	Sync is enabled.

Accounts/{Account GUID}/Options/ContentTypes/{Content Type GUID}/Name

Scope	Editions	Applicable OS
❌ Device ✅ User	✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC	✅ Windows 10, version 1507 [10.0.10240] and later

./User/Vendor/MSFT/ActiveSync/Accounts/{Account GUID}/Options/ContentTypes/{Content Type GUID}/Name

The name of the content type.

Description framework properties:

Property name	Property value
Format	chr (string)
Access Type	Add, Delete, Get, Replace

Accounts/{Account GUID}/Options/Logging

Scope	Editions	Applicable OS
❌ Device ✅ User	✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC	✅ Windows 10, version 1507 [10.0.10240] and later

./User/Vendor/MSFT/ActiveSync/Accounts/{Account GUID}/Options/Logging

Specifies whether diagnostic logging is enabled and at what level.

Description framework properties:

Property name	Property value
Format	chr (string)
Access Type	Add, Delete, Get, Replace
Default Value	0

Allowed values:

Value	Description
0 (Default)	Logging is off.
1	Basic logging is enabled.
2	Advanced logging is enabled.

Accounts/{Account GUID}/Options/MailAgeFilter

Scope	Editions	Applicable OS
❌ Device ✅ User	✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC	✅ Windows 10, version 1507 [10.0.10240] and later

./User/Vendor/MSFT/ActiveSync/Accounts/{Account GUID}/Options/MailAgeFilter

Specifies the time window used for syncing email items to the phone.

Description framework properties:

Property name	Property value
Format	chr (string)
Access Type	Add, Delete, Get, Replace
Default Value	3

Allowed values:

Value	Description
0	No age filter is used, and all email items are synced to the device.
1	Only email up to one day old is synced to the device.
2	Only email up to three days old is synced to the device.
3 (Default)	Email up to a week old is synced to the device.
4	Email up to two weeks old is synced to the device.
5	Email up to a month old is synced to the device.
6	Email up to three months old is synced to the device.

Accounts/{Account GUID}/Options/MailBodyType

Scope	Editions	Applicable OS
❌ Device ✅ User	✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC	✅ Windows 10, version 1507 [10.0.10240] and later

./User/Vendor/MSFT/ActiveSync/Accounts/{Account GUID}/Options/MailBodyType

Indicates format type of the Email. Supported values are 0 (none), 1 (text), 2 (HTML), 3 (RTF), and 4 (MIME).

Description framework properties:

Property name	Property value
Format	chr (string)
Access Type	Add, Delete, Get, Replace

Allowed values:

Value	Description
0	None.
1	Text.
2	HTML.
3	RTF.
4	MIME.

Accounts/{Account GUID}/Options/MailHTMLTruncation

Scope	Editions	Applicable OS
❌ Device ✅ User	✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC	✅ Windows 10, version 1507 [10.0.10240] and later

./User/Vendor/MSFT/ActiveSync/Accounts/{Account GUID}/Options/MailHTMLTruncation

This setting specifies the size beyond which HTML-formatted e-mail messages are truncated when they're synchronized to the mobile phone. The value is specified in KB. A value of -1 disables truncation.

Description framework properties:

Property name	Property value
Format	chr (string)
Access Type	Add, Delete, Get, Replace

Accounts/{Account GUID}/Options/MailPlainTextTruncation

Scope	Editions	Applicable OS
❌ Device ✅ User	✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC	✅ Windows 10, version 1507 [10.0.10240] and later

./User/Vendor/MSFT/ActiveSync/Accounts/{Account GUID}/Options/MailPlainTextTruncation

This setting specifies the size beyond which text-formatted e-mail messages are truncated when they're synchronized to the mobile phone. The value is specified in KB. A value of -1 disables truncation.

Description framework properties:

Property name	Property value
Format	chr (string)
Access Type	Add, Delete, Get, Replace

Accounts/{Account GUID}/Options/Schedule

Scope	Editions	Applicable OS
❌ Device ✅ User	✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC	✅ Windows 10, version 1507 [10.0.10240] and later

./User/Vendor/MSFT/ActiveSync/Accounts/{Account GUID}/Options/Schedule

Specifies the time until the next sync is performed in minutes. If -1 is chosen, a sync will occur as items are received. If a 0 is chosen, all syncs must be performed manually.

Description framework properties:

Property name	Property value
Format	chr (string)
Access Type	Add, Delete, Get, Replace
Allowed Values	Range: [(-1)-4294967295]
Default Value	-1

Accounts/{Account GUID}/Options/UseSSL

Scope	Editions	Applicable OS
❌ Device ✅ User	✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC	✅ Windows 10, version 1507 [10.0.10240] and later

./User/Vendor/MSFT/ActiveSync/Accounts/{Account GUID}/Options/UseSSL

Specifies whether SSL is used.

Description framework properties:

Property name	Property value
Format	chr (string)
Access Type	Add, Delete, Get, Replace
Default Value	1

Allowed values:

Value	Description
0	SSL isn't used.
1 (Default)	SSL is used.

Accounts/{Account GUID}/Password

Scope	Editions	Applicable OS
❌ Device ✅ User	✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC	✅ Windows 10, version 1507 [10.0.10240] and later

./User/Vendor/MSFT/ActiveSync/Accounts/{Account GUID}/Password

A character string that specifies the password for the account. For the Get command, only asterisks are returned.

Description framework properties:

Property name	Property value
Format	chr (string)
Access Type	Add, Delete, Get, Replace

Accounts/{Account GUID}/Policies

Scope	Editions	Applicable OS
❌ Device ✅ User	✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC	✅ Windows 10, version 1507 [10.0.10240] and later

./User/Vendor/MSFT/ActiveSync/Accounts/{Account GUID}/Policies

Specifies the mail body type and email age filter.

Description framework properties:

Property name	Property value
Format	node
Access Type	Add, Delete, Get, Replace

Accounts/{Account GUID}/Policies/MailBodyType

Scope	Editions	Applicable OS
❌ Device ✅ User	✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC	✅ Windows 10, version 1507 [10.0.10240] and later

./User/Vendor/MSFT/ActiveSync/Accounts/{Account GUID}/Policies/MailBodyType

Specifies the email body type. HTML or plain.

Description framework properties:

Property name	Property value
Format	chr (string)
Access Type	Add, Delete, Get, Replace

Allowed values:

Value	Description
HTML	HTML.
plain	Plain.

Accounts/{Account GUID}/Policies/MaxMailAgeFilter

Scope	Editions	Applicable OS
❌ Device ✅ User	✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC	✅ Windows 10, version 1507 [10.0.10240] and later

./User/Vendor/MSFT/ActiveSync/Accounts/{Account GUID}/Policies/MaxMailAgeFilter

Specifies the time window used for syncing mail items to the device.

Description framework properties:

Property name	Property value
Format	chr (string)
Access Type	Add, Delete, Get, Replace

Accounts/{Account GUID}/ServerName

Scope	Editions	Applicable OS
❌ Device ✅ User	✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC	✅ Windows 10, version 1507 [10.0.10240] and later

./User/Vendor/MSFT/ActiveSync/Accounts/{Account GUID}/ServerName

Specifies the server name used by the account.

Description framework properties:

Property name	Property value
Format	chr (string)
Access Type	Add, Delete, Get, Replace

Accounts/{Account GUID}/UserName

Scope	Editions	Applicable OS
❌ Device ✅ User	✅ Pro ✅ Enterprise ✅ Education ✅ Windows SE ✅ IoT Enterprise / IoT Enterprise LTSC	✅ Windows 10, version 1507 [10.0.10240] and later

./User/Vendor/MSFT/ActiveSync/Accounts/{Account GUID}/UserName

Specifies the user name for the account. The user name can't be changed after a sync has been successfully performed. The user name can be in the fully qualified format "someone@example.com", or just "username", depending on the type of account created. For most Exchange accounts, the user name format is just "username", whereas for Microsoft, Google, Yahoo, and most POP/IMAP accounts, the user name format is "someone@example.com".

Description framework properties:

Property name	Property value
Format	chr (string)
Access Type	Add, Delete, Get, Replace

Related articles

Configuration service provider reference