EMAIL2 CSP

The EMAIL2 configuration service provider (CSP) is used to configure Simple Mail Transfer Protocol (SMTP) email accounts.

Note

This configuration service provider requires the ID_CAP_CSP_FOUNDATION and ID_CAP_CSP_MAIL capabilities to be accessed from a network configuration application.

Important

All Add and Replace commands need to be wrapped in an Atomic section.

The following list shows the EMAIL2 configuration service provider nodes:

{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/EMAIL2/{Account GUID}

This is unique and identifies a particular account. Also, we can only have 6 additional email accounts. So, depending on how many are already there on the device, we can have from 1 to 6.

A globally unique identifier (GUID) must be generated for each email account on the device. Provisioning with an account that has the same GUID as an existing one doesn't create the new account and Add command will fail in this case.

The braces {} around the GUID are required in the EMAIL2 configuration service provider.

  • For OMA Client Provisioning, the braces can be sent literally. For example, <characteristic type="{C556E16F-56C4-4edb-9C64-D9469EE1FBE0}"/>
  • For OMA DM, the braces must be sent using ASCII values of 0x7B and 0x7D respectively. For example, <Target><LocURI>./Vendor/MSFT/EMAIL2/0x7BC556E16F-56C4-4edb-9C64-D9469EE1FBE0x7D</LocURI></Target>

Description framework properties:

Property name Property value
Format node
Access Type Add, Delete, Get, Replace
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}\}

{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/EMAIL2/{Account GUID}/ACCOUNTICON

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

{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/EMAIL2/{Account GUID}/ACCOUNTTYPE

Specifies the type of account. Valid values are: Email - normal email, VVM - visual voice mail.

Description framework properties:

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

Allowed values:

Value Description
Email Normal email.
VVM Visual voice mail.

{Account GUID}/AUTHNAME

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/EMAIL2/{Account GUID}/AUTHNAME

Character string that specifies the name used to authorize the user to a specific email account (also known as the user's logon name).

Description framework properties:

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

{Account GUID}/AUTHREQUIRED

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/EMAIL2/{Account GUID}/AUTHREQUIRED

Character string that specifies whether the outgoing server requires authentication.

1 for TRUE 0 for FALSE(default).

Note

If this isn't specified then SMTP authentication won't be done. Also, this is different from the SMTPALTENABLED. That is to specify different set of credentials for SMTP.

Description framework properties:

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

Allowed values:

Value Description
0 Server authentication isn't required.
1 Server authentication is required.

{Account GUID}/AUTHSECRET

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/EMAIL2/{Account GUID}/AUTHSECRET

Character string that specifies the user's password. The same password is used for SMTP authentication.

Description framework properties:

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

{Account GUID}/CALENDARSERVER

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/EMAIL2/{Account GUID}/CALENDARSERVER

Server for calendar sync if it's different from the email server.

Description framework properties:

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

{Account GUID}/CALENDARSERVERREQUIRESSL

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/EMAIL2/{Account GUID}/CALENDARSERVERREQUIRESSL

Indicates if the connection to the calendar server requires SSL.

Description framework properties:

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

{Account GUID}/CALENDARSYNCSCHEDULE

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/EMAIL2/{Account GUID}/CALENDARSYNCSCHEDULE

Sets the schedule for syncing calendar items.

Description framework properties:

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

{Account GUID}/CELLULARONLY

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/EMAIL2/{Account GUID}/CELLULARONLY

If this flag is set, the account only uses the cellular network and not Wi-Fi.

Description framework properties:

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

{Account GUID}/CONTACTSSERVER

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/EMAIL2/{Account GUID}/CONTACTSSERVER

Server for contact sync if it's different from the email server.

Description framework properties:

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

{Account GUID}/CONTACTSSERVERREQUIRESSL

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/EMAIL2/{Account GUID}/CONTACTSSERVERREQUIRESSL

Indicates if the connection to the contact server requires SSL.

Description framework properties:

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

{Account GUID}/CONTACTSSYNCSCHEDULE

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/EMAIL2/{Account GUID}/CONTACTSSYNCSCHEDULE

Sets the schedule for syncing contact items.

Description framework properties:

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

{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/EMAIL2/{Account GUID}/DOMAIN

Character string that specifies the incoming server credentials domain. Limited to 255 characters.

Description framework properties:

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

{Account GUID}/DWNDAY

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/EMAIL2/{Account GUID}/DWNDAY

Character string that specifies how many days' worth of email should be downloaded from the server.

Description framework properties:

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

Allowed values:

Value Description
-1 Specifies that all email currently on the server should be downloaded.
7 Specifies that 7 days’ worth of email should be downloaded.
14 Specifies that 14 days’ worth of email should be downloaded.
30 Specifies that 30 days’ worth of email should be downloaded.
90 Specifies that 90 days’ worth of email should be downloaded.

{Account GUID}/INSERVER

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/EMAIL2/{Account GUID}/INSERVER

Character string that specifies how many days' worth of email should be downloaded from the server. server name:port number.

Description framework properties:

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

{Account GUID}/KEEPMAX

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/EMAIL2/{Account GUID}/KEEPMAX

Specifies the maximum size for a message attachment. Attachments beyond this size won't be downloaded but it will remain on the server. The message itself will be downloaded. This value can be set only for IMAP4 accounts. The limit's specified in KB.

Description framework properties:

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

Allowed values:

Value Description
-1 No limit's enforced.
0 No attachment is downloaded.
25 25 KB.
50 50 KB.
100 100 KB.
250 250 KB.

{Account GUID}/LINGER

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/EMAIL2/{Account GUID}/LINGER

Character string that specifies the length of time between email send/receive updates in minutes. 0 indicates that updates must be performed manually.

Description framework properties:

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

{Account 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/EMAIL2/{Account GUID}/NAME

Character string that specifies the name of the sender displayed on a sent email. It should be set to the user's name. Limited to 255 characters.

Description framework properties:

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

{Account GUID}/OUTSERVER

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/EMAIL2/{Account GUID}/OUTSERVER

Character string that specifies the name of the messaging service's outgoing email server. Limited to 62 characters. The value format is: server name:port number.

Description framework properties:

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

{Account GUID}/REPLYADDR

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/EMAIL2/{Account GUID}/REPLYADDR

Character string that specifies the reply email address of the user (usually the same as the user email address). Sending email will fail without it. Limited to 255 characters.

Description framework properties:

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

{Account GUID}/RETRIEVE

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/EMAIL2/{Account GUID}/RETRIEVE

Specifies the maximum size in bytes for messages retrieved from the incoming email server. Messages beyond this size are retrieved, but truncated.

Description framework properties:

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

{Account GUID}/SERVERDELETEACTION

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/EMAIL2/{Account GUID}/SERVERDELETEACTION

Character string that specifies how message is deleted on server. The default action depends on the transport.

Description framework properties:

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

Allowed values:

Value Description
1 Delete message on the server.
2 Keep the message on the server (delete to the Trash folder).

{Account GUID}/SERVICENAME

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/EMAIL2/{Account GUID}/SERVICENAME

Character string that specifies the name of the email service to create or edit (32 characters maximum).

Description framework properties:

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

Note

The EMAIL2 Configuration Service Provider doesn't support the OMA DM Replace command on the parameters SERVICENAME and SERVICETYPE. To replace either the email account name or the account service type, the existing email account must be deleted and then a new one must be created.

{Account GUID}/SERVICETYPE

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/EMAIL2/{Account GUID}/SERVICETYPE

Character string that specifies the type of email service to create or edit (for example, "IMAP4" or "POP3").

Note

The EMAIL2 Configuration Service Provider doesn't support the OMA DM Replace command on the parameters SERVICENAME and SERVICETYPE. To replace either the email account name or the account service type, the existing email account must be deleted and then a new one must be created.

Description framework properties:

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

{Account GUID}/SMTPALTAUTHNAME

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/EMAIL2/{Account GUID}/SMTPALTAUTHNAME

Character string that specifies the display name associated with the user's alternative SMTP email account.

Description framework properties:

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

{Account GUID}/SMTPALTDOMAIN

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/EMAIL2/{Account GUID}/SMTPALTDOMAIN

Character string that specifies the domain name for the user's alternative SMTP account.

Description framework properties:

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

{Account GUID}/SMTPALTENABLED

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/EMAIL2/{Account GUID}/SMTPALTENABLED

Character string that specifies if the user's alternate SMTP account is enabled.

Description framework properties:

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

Allowed values:

Value Description
0 The user's alternate SMTP email account is disabled.
1 The user's alternate SMTP email account is enabled.

{Account GUID}/SMTPALTPASSWORD

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/EMAIL2/{Account GUID}/SMTPALTPASSWORD

Character string that specifies the password for the user's alternate SMTP account.

Description framework properties:

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

{Account GUID}/SYNCINGCONTENTTYPES

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/EMAIL2/{Account GUID}/SYNCINGCONTENTTYPES

Specifies a bitmask for which content types are supported for syncing (eg: Mail, Contacts, Calendar).

Description framework properties:

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

Allowed values:

Flag Description
0x0 No data.
0x1 Contacts.
0x2 Mail.
0x4 Appointments.
0x8 Tasks.
0x10 Notes.
0x60 Feeds.
0x180 Network Photo.
0x200 Group and room.
0x400 Chat.
0x800 Email Recipient Email.
0x1000 Server Link.
0xffffffff All items.

{Account GUID}/TAGPROPS

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/EMAIL2/{Account GUID}/TAGPROPS

Specifies that stated parameter element name attributes is nonstandard tag properties.

Description framework properties:

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

{Account GUID}/TAGPROPS/8128000B

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/EMAIL2/{Account GUID}/TAGPROPS/8128000B

Character string that specifies if the incoming email server requires SSL.

Description framework properties:

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

Allowed values:

Value Description
0 SSL isn't required.
1 SSL is required.

{Account GUID}/TAGPROPS/812C000B

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/EMAIL2/{Account GUID}/TAGPROPS/812C000B

Character string that specifies if the outgoing email server requires SSL.

Description framework properties:

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

Allowed values:

Value Description
0 SSL isn't required.
1 SSL is required.

Remarks

When an application removal or configuration roll-back is provisioned, the EMAIL2 CSP passes the request to Configuration Manager, which handles the transaction externally. When a MAPI application is removed, the accounts that were created with it are deleted. All messages and other properties that the transport (like Short Message Service [SMS], Post Office Protocol [POP], or Simple Mail Transfer Protocol [SMTP]) might have stored, are lost. If an attempt to create a new email account is unsuccessful, the new account is automatically deleted. If an attempt to edit an existing account is unsuccessful, the original configuration is automatically rolled back (restored).

For OMA DM, the EMAIL2 CSP handles the Replace command differently from most other configuration service providers. For the EMAIL2 CSP, Configuration Manager implicitly adds the missing part of the node to be replaced or any segment in the path of the node if it's left out in the <LocURI></LocURI> block. There are separate parameters defined for the outgoing server logon credentials. The following are the usage rules for these credentials:

  • The incoming server logon credentials are used (AUTHNAME, AUTHSECRET, and DOMAIN) unless the outgoing server credentials are set.
  • If some of the outgoing server credentials parameters are present, then the EMAIL2 Configuration Service Provider will be considered in error.
  • Account details can't be queried unless the account GUID is known. Currently, there's no way to perform a top-level query for account GUIDs.

If the connection to the mail server is initiated with deferred SSL, the mail server can send STARTTLS as a server capability and TLS will be enabled. The following steps show how to enable TLS.

  1. The device attempts to connect to the mail server using SSL
  2. If the SSL connection fails, the device attempts to connect using deferred SSL
  3. If the connection fails over both SSL and deferred SSL, and the user selected Server requires encrypted (SSL) connection, the device doesn't attempt another connection
  4. If the user didn't select Server requires encrypted (SSL) connection, the device attempts to establish a non-SSL connection
  5. If the connection succeeds using any of the encryption protocols, the device requests the server capabilities.
  6. If one of the capabilities sent by the mail server is STARTTLS and the connection is deferred SSL, then the device enables TLS. TLS isn't enabled on connections using SSL or non-SSL.

Configuration service provider reference