From 1e93318e61b53a21005c243d18a0981144b821ea Mon Sep 17 00:00:00 2001 From: Vinay Pamnani <37223378+vinaypamnani-msft@users.noreply.github.com> Date: Tue, 21 Feb 2023 14:47:11 -0500 Subject: [PATCH] EMAIL2 CSP --- windows/client-management/mdm/email2-csp.md | 1577 ++++++++++++-- .../client-management/mdm/email2-ddf-file.md | 1846 +++++++++-------- 2 files changed, 2382 insertions(+), 1041 deletions(-) diff --git a/windows/client-management/mdm/email2-csp.md b/windows/client-management/mdm/email2-csp.md index 31d99fa377..c8ba72d0e2 100644 --- a/windows/client-management/mdm/email2-csp.md +++ b/windows/client-management/mdm/email2-csp.md @@ -1,336 +1,1480 @@ --- title: EMAIL2 CSP -description: Learn how the EMAIL2 configuration service provider (CSP) is used to configure Simple Mail Transfer Protocol (SMTP) email accounts. -ms.reviewer: +description: Learn more about the EMAIL2 CSP. +author: vinaypamnani-msft manager: aaroncz ms.author: vinpa -ms.topic: article +ms.date: 02/21/2023 +ms.localizationpriority: medium ms.prod: windows-client ms.technology: itpro-manage -author: vinaypamnani-msft -ms.date: 06/26/2017 +ms.topic: reference --- + + + # EMAIL2 CSP -The table below shows the applicability of Windows: - -|Edition|Windows 10|Windows 11| -|--- |--- |--- | -|Home|Yes|Yes| -|Pro|Yes|Yes| -|Windows SE|No|Yes| -|Business|Yes|Yes| -|Enterprise|Yes|Yes| -|Education|Yes|Yes| - + + The EMAIL2 configuration service provider (CSP) is used to configure Simple Mail Transfer Protocol (SMTP) email accounts. -> [!Note] +> [!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. -On Windows client, only per user configuration is supported.  - -The following information shows the EMAIL2 configuration service provider management object in tree format as used by both OMA DM and OMA Client Provisioning. - -```console -./Vendor/MSFT -EMAIL2 -----Account GUID ---------ACCOUNTICON ---------ACCOUNTTYPE ---------AUTHNAME ---------AUTHREQUIRED ---------AUTHSECRET ---------DOMAIN ---------DWNDAY ---------INSERVER ---------LINGER ---------KEEPMAX ---------NAME ---------OUTSERVER ---------REPLYADDR ---------SERVICENAME ---------SERVICETYPE ---------RETRIEVE ---------SERVERDELETEACTION ---------CELLULARONLY ---------SYNCINGCONTENTTYPES ---------CONTACTSSERVER ---------CALENDARSERVER ---------CONTACTSSERVERREQUIRESSL ---------CALENDARSERVERREQUIRESSL ---------CONTACTSSYNCSCHEDULE ---------CALENDARSYNCSCHEDULE ---------SMTPALTAUTHNAME ---------SMTPALTDOMAIN ---------SMTPALTENABLED ---------SMTPALTPASSWORD ---------TAGPROPS -------------8128000B -------------812C000B -``` - -After provisioning, the **Start** screen has a tile for the proprietary mail provider and there's also a link to it in the applications list under **Settings, email & accounts**. After an account has been updated over-the-air by the EMAIL2 CSP, the device must be powered off and then powered back on to see the sync status. - -Configuration data isn't encrypted when sent over the air (OTA). This is a potential security risk when sending sensitive configuration data, such as passwords. - > [!IMPORTANT] > All Add and Replace commands need to be wrapped in an Atomic section. + -**EMAIL2** -The configuration service provider root node. + +The following example shows the EMAIL2 configuration service provider in tree format. -Supported operation is Get. +```text +./User/Vendor/MSFT/EMAIL2 +--- {Account GUID} +------ ACCOUNTICON +------ ACCOUNTTYPE +------ AUTHNAME +------ AUTHREQUIRED +------ AUTHSECRET +------ CALENDARSERVER +------ CALENDARSERVERREQUIRESSL +------ CALENDARSYNCSCHEDULE +------ CELLULARONLY +------ CONTACTSSERVER +------ CONTACTSSERVERREQUIRESSL +------ CONTACTSSYNCSCHEDULE +------ DOMAIN +------ DWNDAY +------ INSERVER +------ KEEPMAX +------ LINGER +------ NAME +------ OUTSERVER +------ REPLYADDR +------ RETRIEVE +------ SERVERDELETEACTION +------ SERVICENAME +------ SERVICETYPE +------ SMTPALTAUTHNAME +------ SMTPALTDOMAIN +------ SMTPALTENABLED +------ SMTPALTPASSWORD +------ SYNCINGCONTENTTYPES +------ TAGPROPS +--------- 8128000B +--------- 812C000B +``` + -***GUID*** -Defines a specific email account. 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. + +## {Account GUID} -Supported operations are Get, Add, and Delete. + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| :x: Device
:heavy_check_mark: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1507 [10.0.10240] and later | + + + +```User +./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, `` - For OMA DM, the braces must be sent using ASCII values of 0x7B and 0x7D respectively. For example, `./Vendor/MSFT/EMAIL2/0x7BC556E16F-56C4-4edb-9C64-D9469EE1FBE0x7D` + -**ACCOUNTICON** -Optional. Returns the location of the icon associated with the account. + +**Description framework properties**: -Supported operations are Get, Add, Replace, and Delete. +| 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}\}` | + -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. + + + -**ACCOUNTTYPE** -Required. Specifies the type of account. + -Supported operations are Get, Add, Replace, and Delete. + +### {Account GUID}/ACCOUNTICON -Valid values are: + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| :x: Device
:heavy_check_mark: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1507 [10.0.10240] and later | + -- Email: Normal email -- VVM: Visual voice mail + +```User +./User/Vendor/MSFT/EMAIL2/{Account GUID}/ACCOUNTICON +``` + -**AUTHNAME** -Required. Character string that specifies the name used to authorize the user to a specific email account (also known as the user's logon name). + + +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. + -Supported operations are Get, Add, Replace, and Delete. + + + -**AUTHREQUIRED** -Optional. Character string that specifies whether the outgoing server requires authentication. + +**Description framework properties**: -Supported operations are Get, Add, Replace, and Delete. +| Property name | Property value | +|:--|:--| +| Format | chr (string) | +| Access Type | Add, Delete, Get, Replace | + -Value options are: + + + -- 0 - Server authentication isn't required. -- 1 - Server authentication is required. + + +### {Account GUID}/ACCOUNTTYPE + + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| :x: Device
:heavy_check_mark: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1507 [10.0.10240] and later | + + + +```User +./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 | +|:--|:--|:--| +| :x: Device
:heavy_check_mark: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1507 [10.0.10240] and later | + + + +```User +./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 | +|:--|:--|:--| +| :x: Device
:heavy_check_mark: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1507 [10.0.10240] and later | + + + +```User +./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 value isn't specified, then no SMTP authentication is done. Also, this is different from SMTPALTENABLED. +> If this is not specified then SMTP authentication will not be done. Also, this is different from the SMTPALTENABLED. That is to specify different set of credentials for SMTP. + -**AUTHSECRET** -Optional. Character string that specifies the user's password. The same password is used for SMTP authentication. + + + -Supported operations are Get, Add, Replace, and Delete. + +**Description framework properties**: -**DOMAIN** -Optional. Character string that specifies the incoming server credentials domain. Limited to 255 characters. +| Property name | Property value | +|:--|:--| +| Format | chr (string) | +| Access Type | Add, Delete, Get, Replace | + -Supported operations are Get, Add, Replace, and Delete. + +**Allowed values**: -**DWNDAY** -Optional. Character string that specifies how many days' worth of email should be downloaded from the server. +| Value | Description | +|:--|:--| +| 0 | Server authentication is not required. | +| 1 | Server authentication is required. | + -Supported operations are Get, Add, Replace, and Delete. + + + -Value options: + -- -1: Specifies that all email currently on the server should be downloaded. -- 7: Specifies that seven 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. + +### {Account GUID}/AUTHSECRET -**INSERVER** -Required. Character string that specifies the name of the incoming server name and port number. This string is limited to 62 characters. If the standard port number is used, then you don't have to specify the port number. The value format is: + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| :x: Device
:heavy_check_mark: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1507 [10.0.10240] and later | + -- server name:port number + +```User +./User/Vendor/MSFT/EMAIL2/{Account GUID}/AUTHSECRET +``` + -Supported operations are Get, Add, and Replace. + + +Character string that specifies the user's password. The same password is used for SMTP authentication. + -**LINGER** -Optional. Character string that specifies the length of time between email send/receive updates in minutes. + + + -Supported operations are Get, Add, Replace, and Delete. + +**Description framework properties**: -Value options: +| Property name | Property value | +|:--|:--| +| Format | chr (string) | +| Access Type | Add, Delete, Get, Replace | + -- 0 - Email updates must be performed manually -- 15 (default) - Wait for 15 minutes between updates -- 30 - Wait for 30 minutes between updates -- 60 - Wait for 60 minutes between updates -- 120 - Wait for 120 minutes between updates. + + + -**KEEPMAX** -Optional. Specifies the maximum size for a message attachment. Attachments beyond this size will not 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 is specified in KB. + +### {Account GUID}/CALENDARSERVER -Value options are 0, 25, 50, 125, and 250. + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| :x: Device
:heavy_check_mark: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1507 [10.0.10240] and later | + -A value of 0 meaning that no limit will be enforced. + +```User +./User/Vendor/MSFT/EMAIL2/{Account GUID}/CALENDARSERVER +``` + -Supported operations are Get, Add, Replace, and Delete. + + +Server for calendar sync if it is different from the email server. + -**NAME** -Optional. 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. + + + -Supported operations are Get, Add, Replace, and Delete. + +**Description framework properties**: -**OUTSERVER** -Required. Character string that specifies the name of the messaging service's outgoing email server. Limited to 62 characters. The value format is: +| Property name | Property value | +|:--|:--| +| Format | chr (string) | +| Access Type | Add, Delete, Get, Replace | + -- server name:port number + + + -Supported operations are Get, Add, Delete, and Replace. + -**REPLYADDR** -Required. 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. + +### {Account GUID}/CALENDARSERVERREQUIRESSL -Supported operations are Get, Add, Delete, and Replace. + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| :x: Device
:heavy_check_mark: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1507 [10.0.10240] and later | + -**SERVICENAME** -Required. Character string that specifies the name of the email service to create or edit (32 characters maximum). + +```User +./User/Vendor/MSFT/EMAIL2/{Account GUID}/CALENDARSERVERREQUIRESSL +``` + -Supported operations are Get, Add, Replace, and Delete. + + +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 | +|:--|:--|:--| +| :x: Device
:heavy_check_mark: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1507 [10.0.10240] and later | + + + +```User +./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 | +|:--|:--|:--| +| :x: Device
:heavy_check_mark: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1507 [10.0.10240] and later | + + + +```User +./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 | +|:--|:--|:--| +| :x: Device
:heavy_check_mark: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1507 [10.0.10240] and later | + + + +```User +./User/Vendor/MSFT/EMAIL2/{Account GUID}/CONTACTSSERVER +``` + + + + +Server for contact sync if it is 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 | +|:--|:--|:--| +| :x: Device
:heavy_check_mark: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1507 [10.0.10240] and later | + + + +```User +./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 | +|:--|:--|:--| +| :x: Device
:heavy_check_mark: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1507 [10.0.10240] and later | + + + +```User +./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 | +|:--|:--|:--| +| :x: Device
:heavy_check_mark: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1507 [10.0.10240] and later | + + + +```User +./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 | +|:--|:--|:--| +| :x: Device
:heavy_check_mark: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1507 [10.0.10240] and later | + + + +```User +./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 | +|:--|:--|:--| +| :x: Device
:heavy_check_mark: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1507 [10.0.10240] and later | + + + +```User +./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 | +|:--|:--|:--| +| :x: Device
:heavy_check_mark: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1507 [10.0.10240] and later | + + + +```User +./User/Vendor/MSFT/EMAIL2/{Account GUID}/KEEPMAX +``` + + + + +Specifies the maximum size for a message attachment. Attachments beyond this size will not 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 is 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 is 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 | +|:--|:--|:--| +| :x: Device
:heavy_check_mark: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1507 [10.0.10240] and later | + + + +```User +./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 | +|:--|:--|:--| +| :x: Device
:heavy_check_mark: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1507 [10.0.10240] and later | + + + +```User +./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 | +|:--|:--|:--| +| :x: Device
:heavy_check_mark: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1507 [10.0.10240] and later | + + + +```User +./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 | +|:--|:--|:--| +| :x: Device
:heavy_check_mark: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1507 [10.0.10240] and later | + + + +```User +./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 | +|:--|:--|:--| +| :x: Device
:heavy_check_mark: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1507 [10.0.10240] and later | + + + +```User +./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 | +|:--|:--|:--| +| :x: Device
:heavy_check_mark: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1507 [10.0.10240] and later | + + + +```User +./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 | +|:--|:--|:--| +| :x: Device
:heavy_check_mark: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1507 [10.0.10240] and later | + + + +```User +./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. + -**SERVICETYPE** -Required. Character string that specifies the type of email service to create or edit (for example, "IMAP4" or "POP3"). + -Supported operations are Get, Add, Replace, and Delete. + +### {Account GUID}/SERVICETYPE -> **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. + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| :x: Device
:heavy_check_mark: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1507 [10.0.10240] and later | + -**RETRIEVE** -Optional. Specifies the maximum size in bytes for messages retrieved from the incoming email server. Messages beyond this size are retrieved, but truncated. + +```User +./User/Vendor/MSFT/EMAIL2/{Account GUID}/SERVICETYPE +``` + -Value options are 512, 1024, 2048, 5120, 20480, and 51200. + + +Character string that specifies the type of email service to create or edit (for example, "IMAP4" or "POP3"). + -Supported operations are Get, Add, Replace, and Delete. + + +> [!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. + -**SERVERDELETEACTION** -Optional. Character string that specifies how message is deleted on server. Value options are: + +**Description framework properties**: -- 1 - Delete message on the server. -- 2 - Keep the message on the server (delete to the Trash folder). +| Property name | Property value | +|:--|:--| +| Format | chr (string) | +| Access Type | Add, Delete, Get, Replace | + -Any other value results in default action, which depends on the transport. + + + -Supported operations are Get, Add, Replace, and Delete. + -**CELLULARONLY** -Optional. If this flag is set, the account only uses the cellular network and not Wi-Fi. + +### {Account GUID}/SMTPALTAUTHNAME -Value type is string. Supported operations are Get, Add, Replace, and Delete. + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| :x: Device
:heavy_check_mark: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1507 [10.0.10240] and later | + -**SYNCINGCONTENTTYPES** -Required. Specifies a bitmask for which content types are supported for syncing, like Mail, Contacts, and Calendar. + +```User +./User/Vendor/MSFT/EMAIL2/{Account GUID}/SMTPALTAUTHNAME +``` + -- No data (0x0) -- Contacts (0x1) -- Mail (0x2) -- Appointments (0x4) -- Tasks (0x8) -- Notes (0x10) -- Feeds (0x60) -- Network Photo (0x180) -- Group and room (0x200) -- Chat (0x400) -- Email Recipient Email (0x800) -- Server Link (0x1000) -- All items (0xffffffff) + + +Character string that specifies the display name associated with the user's alternative SMTP email account. + -Supported operations are Get, Add, Replace, and Delete. + + + -**CONTACTSSERVER** -Optional. Server for contact sync if it's different from the email server. + +**Description framework properties**: -Supported operations are Get, Add, Replace, and Delete. +| Property name | Property value | +|:--|:--| +| Format | chr (string) | +| Access Type | Add, Delete, Get, Replace | + -**CALENDARSERVER** -Optional. Server for calendar sync if it's different from the email server. + + + -Supported operations are Get, Add, Replace, and Delete. + -**CONTACTSSERVERREQUIRESSL** -Optional. Indicates if the connection to the contact server requires SSL. + +### {Account GUID}/SMTPALTDOMAIN -Supported operations are Get, Add, Replace, and Delete. + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| :x: Device
:heavy_check_mark: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1507 [10.0.10240] and later | + -**CALENDARSERVERREQUIRESSL** -Optional. Indicates if the connection to the calendar server requires SSL. + +```User +./User/Vendor/MSFT/EMAIL2/{Account GUID}/SMTPALTDOMAIN +``` + -Supported operations are Get, Add, Replace, and Delete. + + +Character string that specifies the domain name for the user's alternative SMTP account. + -**CONTACTSSYNCSCHEDULE** -Optional. Sets the schedule for syncing contact items. + + + -Supported operations are Get, Add, Replace, and Delete. + +**Description framework properties**: -**CALENDARSYNCSCHEDULE** -Optional. Sets the schedule for syncing calendar items. +| Property name | Property value | +|:--|:--| +| Format | chr (string) | +| Access Type | Add, Delete, Get, Replace | + -Supported operations are Get, Add, Replace, and Delete. + + + -**SMTPALTAUTHNAME** -Optional. Character string that specifies the display name associated with the user's alternative SMTP email account. + -Supported operations are Get, Add, Replace, and Delete. + +### {Account GUID}/SMTPALTENABLED -**SMTPALTDOMAIN** -Optional. Character string that specifies the domain name for the user's alternative SMTP account. + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| :x: Device
:heavy_check_mark: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1507 [10.0.10240] and later | + -Supported operations are Get, Add, Replace, and Delete. + +```User +./User/Vendor/MSFT/EMAIL2/{Account GUID}/SMTPALTENABLED +``` + -**SMTPALTENABLED** -Optional. Character string that specifies if the user's alternate SMTP account is enabled. + + +Character string that specifies if the user's alternate SMTP account is enabled. + -Supported operations are Get, Add, Replace, and Delete. + + + -A value of "FALSE" means the user's alternate SMTP email account is disabled. A value of "TRUE" means that the user's alternate SMTP email account is enabled. + +**Description framework properties**: -**SMTPALTPASSWORD** -Optional. Character string that specifies the password for the user's alternate SMTP account. +| Property name | Property value | +|:--|:--| +| Format | chr (string) | +| Access Type | Add, Delete, Get, Replace | + -Supported operations are Get, Add, Replace, and Delete. + +**Allowed values**: -**TAGPROPS** -Optional. Defines a group of properties with non-standard element names. +| Value | Description | +|:--|:--| +| 0 | The user's alternate SMTP email account is disabled. | +| 1 | The user's alternate SMTP email account is enabled. | + -Supported operations are Get, Add, Replace, and Delete. + + + -**TAGPROPS/8128000B** -Optional. Character string that specifies if the incoming email server requires SSL. + -Supported operations are Get, Add, Replace, and Delete. + +### {Account GUID}/SMTPALTPASSWORD -Value options are: + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| :x: Device
:heavy_check_mark: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1507 [10.0.10240] and later | + -- 0 - SSL isn't required. -- 1 - SSL is required. + +```User +./User/Vendor/MSFT/EMAIL2/{Account GUID}/SMTPALTPASSWORD +``` + -**TAGPROPS/812C000B** -Optional. Character string that specifies if the outgoing email server requires SSL. + + +Character string that specifies the password for the user's alternate SMTP account. + -Supported operations are Get and Replace. + + + -Value options: + +**Description framework properties**: -- 0 - SSL isn't required. -- 1 - SSL is required. +| Property name | Property value | +|:--|:--| +| Format | chr (string) | +| Access Type | Add, Delete, Get, Replace | + + + + + + + + +### {Account GUID}/SYNCINGCONTENTTYPES + + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| :x: Device
:heavy_check_mark: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1507 [10.0.10240] and later | + + + +```User +./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 | +|:--|:--|:--| +| :x: Device
:heavy_check_mark: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1507 [10.0.10240] and later | + + + +```User +./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 | +|:--|:--|:--| +| :x: Device
:heavy_check_mark: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1507 [10.0.10240] and later | + + + +```User +./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 is not required. | +| 1 | SSL is required. | + + + + + + + + + +#### {Account GUID}/TAGPROPS/812C000B + + +| Scope | Editions | Applicable OS | +|:--|:--|:--| +| :x: Device
:heavy_check_mark: User | :x: Home
:heavy_check_mark: Pro
:heavy_check_mark: Enterprise
:heavy_check_mark: Education
:heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1507 [10.0.10240] and later | + + + +```User +./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 is not 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). @@ -349,7 +1493,10 @@ If the connection to the mail server is initiated with deferred SSL, the mail se 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. + + + ## Related articles -[Configuration service provider reference](index.yml) +[Configuration service provider reference](configuration-service-provider-reference.md) diff --git a/windows/client-management/mdm/email2-ddf-file.md b/windows/client-management/mdm/email2-ddf-file.md index cda01b7a53..20e168d936 100644 --- a/windows/client-management/mdm/email2-ddf-file.md +++ b/windows/client-management/mdm/email2-ddf-file.md @@ -1,39 +1,986 @@ --- title: EMAIL2 DDF file -description: Learn how the OMA DM device description framework (DDF) for the EMAIL2 configuration service provider (CSP). -ms.reviewer: +description: View the XML file containing the device description framework (DDF) for the EMAIL2 configuration service provider. +author: vinaypamnani-msft manager: aaroncz ms.author: vinpa -ms.topic: article +ms.date: 02/21/2023 +ms.localizationpriority: medium ms.prod: windows-client ms.technology: itpro-manage -author: vinaypamnani-msft -ms.date: 12/05/2017 +ms.topic: reference --- + + # EMAIL2 DDF file -This topic shows the OMA DM device description framework (DDF) for the **EMAIL2** configuration service provider. DDF files are used only with OMA DM provisioning XML. - -Looking for the DDF XML files? See [CSP DDF files download](configuration-service-provider-ddf.md). - -The XML below is the current version for this CSP. +The following XML file contains the device description framework (DDF) for the EMAIL2 configuration service provider. ```xml -]> +]> 1.2 + + + + EMAIL2 + ./User/Vendor/MSFT + + + + + Root node + + + + + + + + + + + + + + 10.0.10240 + 1.0 + 0x4;0x1B;0x30;0x31;0x48;0x54;0x62;0x63;0x64;0x65;0x77;0x79;0x7A;0x7D;0x7E;0x81;0x82;0x8A;0x8B;0xA1;0xA2;0xA4;0xA5;0xAB;0xAC;0xAF;0xB4;0xBC;0xBF;0xCA;0xCB;0xCD; + + + + + + + + + + + + + + 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. + + + + + + + + + + Account GUID + + + + + + + + \{[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}\} + + - EMAIL2 - ./Vendor/MSFT + ACCOUNTICON + + + - Root characteristic + + + + + + + + + + + + + + + + + + + ACCOUNTTYPE + + + + + + + + Specifies the type of account. Valid values are: Email - normal email, VVM - visual voice mail + + + + + + + + + + + + + + + Email + normal email + + + VVM + visual voice mail + + + + + + 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). + + + + + + + + + + + + + + + + + + AUTHREQUIRED + + + + + + + + Character string that specifies whether the outgoing server requires authentication. + 1 for TRUE + 0 for FALSE(default). + Note: If this is not specified then SMTP authentication will not be done. Also, this is different from the SMTPALTENABLED. That is to specify different set of credentials for SMTP. + + + + + + + + + + + + + + + + 0 + Server authentication is not required. + + + 1 + Server authentication is required. + + + + + + AUTHSECRET + + + + + + + + Character string that specifies the user's password. The same password is used for SMTP authentication. + + + + + + + + + + + + + + + + + + DOMAIN + + + + + + + + Character string that specifies the incoming server credentials domain. Limited to 255 characters. + + + + + + + + + + + + + + + + + + DWNDAY + + + + + + + + Character string that specifies how many days' worth of email should be downloaded from the server. + + + + + + + + + + + + + + + -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. + + + + + + INSERVER + + + + + + + + Character string that specifies how many days' worth of email should be downloaded from the server. server name:port number + + + + + + + + + + + + + + + + + + LINGER + + + + + + + + 15 + Character string that specifies the length of time between email send/receive updates in minutes. 0 indicates that updates must be performed manually. + + + + + + + + + + + + + + [(-1)-2147483647] + + + + + KEEPMAX + + + + + + + + Specifies the maximum size for a message attachment. Attachments beyond this size will not 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 is specified in KB. + + + + + + + + + + + + + + + -1 + No limit is enforced + + + 0 + No attachment is downloaded + + + 25 + 25 KB + + + 50 + 50 KB + + + 100 + 100 KB + + + 250 + 250 KB + + + + + + 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. + + + + + + + + + + + + + + + + + + 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 + + + + + + + + + + + + + + + + + + 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. + + + + + + + + + + + + + + + + + + SERVICENAME + + + + + + + + Character string that specifies the name of the email service to create or edit (32 characters maximum). + + + + + + + + + + + + + + + + + + SERVICETYPE + + + + + + + + Character string that specifies the type of email service to create or edit (for example, "IMAP4" or "POP3"). + + + + + + + + + + + + + + + + + + RETRIEVE + + + + + + + + Specifies the maximum size in bytes for messages retrieved from the incoming email server. Messages beyond this size are retrieved, but truncated. + + + + + + + + + + + + + + [(-1)-2147483647] + + + + + SERVERDELETEACTION + + + + + + + + Character string that specifies how message is deleted on server. The default action depends on the transport. + + + + + + + + + + + + + + + 1 + delete message on the server + + + 2 + keep the message on the server (delete to the Trash folder). + + + + + + CELLULARONLY + + + + + + + + If this flag is set, the account only uses the cellular network and not Wi-Fi. + + + + + + + + + + + + + + + + + + SYNCINGCONTENTTYPES + + + + + + + + Specifies a bitmask for which content types are supported for syncing (eg: Mail, Contacts, Calendar). + + + + + + + + + + + + + + + 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 + + + + + + CONTACTSSERVER + + + + + + + + Server for contact sync if it is different from the email server. + + + + + + + + + + + + + + + + + + CALENDARSERVER + + + + + + + + Server for calendar sync if it is different from the email server. + + + + + + + + + + + + + + + + + + CONTACTSSERVERREQUIRESSL + + + + + + + + Indicates if the connection to the contact server requires SSL. + + + + + + + + + + + + + + + + + + CALENDARSERVERREQUIRESSL + + + + + + + + Indicates if the connection to the calendar server requires SSL. + + + + + + + + + + + + + + + + + + CONTACTSSYNCSCHEDULE + + + + + + + + Sets the schedule for syncing contact items. + + + + + + + + + + + + + + + + + + CALENDARSYNCSCHEDULE + + + + + + + + Sets the schedule for syncing calendar items. + + + + + + + + + + + + + + + + + + SMTPALTAUTHNAME + + + + + + + + Character string that specifies the display name associated with the user's alternative SMTP email account. + + + + + + + + + + + + + + + + + + SMTPALTDOMAIN + + + + + + + + Character string that specifies the domain name for the user's alternative SMTP account. + + + + + + + + + + + + + + + + + + SMTPALTENABLED + + + + + + + + Character string that specifies if the user's alternate SMTP account is enabled. + + + + + + + + + + + + + + + 0 + The user's alternate SMTP email account is disabled. + + + 1 + The user's alternate SMTP email account is enabled. + + + + + + SMTPALTPASSWORD + + + + + + + + Character string that specifies the password for the user's alternate SMTP account. + + + + + + + + + + + + + + + + + + TAGPROPS + + + + + + + + Specifies that stated parameter element name attributes is nonstandard tag properties. @@ -41,839 +988,86 @@ The XML below is the current version for this CSP. - + - com.microsoft/1.0/MDM/EMAIL2 + - + 8128000B - - + + - 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. + Character string that specifies if the incoming email server requires SSL. - + - 1 + - Account GUID - + + + + 0 + SSL is not required. + + + 1 + SSL is required. + + + + + + 812C000B + + + + + + + + Character string that specifies if the outgoing email server requires SSL. + + + + + + + + + + + + + + + 0 + SSL is not required. + + + 1 + SSL is required. + + - - ACCOUNTICON - - - - - - - - The location of the icon associated with the account. - - - - - - - - - - - text/plain - - - - - ACCOUNTTYPE - - - - - - - - Specifies the type of account. Valid values are: Email - normal email, VVM - visual voice mail - - - - - - - - - - - text/plain - - - - - AUTHNAME - - - - - - - - User Name for Incoming server. Limited to 255 chars. - - - - - - - - - - - text/plain - - - - - AUTHREQUIRED - - - - - - - - This will specify whether the outgoing server requires authentication. - 1 for TRUE - 0 for FALSE(default). - Note: If this is not specified then SMTP authentication will not be done. Also, this is different from the SMTPALTENABLED. That is to specify different set of credentials for SMTP. - - - - - - - - - - - - text/plain - - - - - AUTHSECRET - - - - - - - - Password. Limited to 255 chars. - - - - - - - - - - - text/plain - - - - - DOMAIN - - - - - - - - Incoming server credentials domain. Limited to 255 chars. - - - - - - - - - - - text/plain - - - - - DWNDAY - - - - - - - - Specifies how many days of email to download. (number of days worth going back into the past) - - - - - - - - - - - text/plain - - - - - INSERVER - - - - - - - - The incoming server name and port number. Limited to 62 chars. If the standard port number is used, the port number isn't necessary to be specified in this node. The value format is: - Server name:port number - - - - - - - - - - - - text/plain - - - - - LINGER - - - - - - - - Specifies how frequently Messaging performs scheduled send/receives. (Specified as the length of time in minutes, between updates.) - - - - - - - - - - - text/plain - - - - - KEEPMAX - - - - - - - - Specifies the maximum size for a message's attachment. (Attachments beyond this size will not be downloaded but will remain on the server. The message itself will be downloaded). This value can be set only for IMAP4 accounts. The limit is specified in KB, with a value of 0 meaning that no limit will be enforced. - - - - - - - - - - - text/plain - - - - - NAME - - - - - - - - User Display Name. Limited to 255 chars - - - - - - - - - - - text/plain - - - - - OUTSERVER - - - - - - - - The outcoming server name and port number. Limited to 62 chars. The value format is: - Server name:port number - If the standard port number is used, the port number isn't necessary to be specified in this node. - - - - - - - - - - - - text/plain - - - - - REPLYADDR - - - - - - - - SMTP reply address of the user. Limited to 255 chars. - - - - - - - - - - - text/plain - - - - - SERVICENAME - - - - - - - - This is the account name. It's limited to 32 characters. - - - - - - - - - - - text/plain - - - - - SERVICETYPE - - - - - - - - This is the type of account. Valid values are POP3/IMAP4. - - - - - - - - - - - text/plain - - - - - RETRIEVE - - - - - - - - Specifies the maximum size(in bytes) for messages retrieved from the incoming email server. Messages beyond this size will still be retrieved, but will be truncated. - - - - - - - - - - - text/plain - - - - - SERVERDELETEACTION - - - - - - - - Specifies how message is deleted on server. - 1 for delete message on server, - 2 for keep the message on server (delete to Trash folder), - any other value default action is used, which depends on the transport. - - - - - - - - - - - - text/plain - - - - - CELLULARONLY - - - - - - - - If this flag is set, the account uses cellular network only and not Wi-Fi. - - - - - - - - - - - text/plain - - - - - SYNCINGCONTENTTYPES - - - - - - - - Specifies a bitmask for which content types are supported for syncing (eg: Mail, Contacts, Calendar). No data (0x0), Contacts (0x1), Mail (0x2), Appointments (0x4), Tasks (0x8), Notes (0x10), Feeds (0x60), Network Photo (0x180), Group and room (0x200), Chat (0x400), Email Recipient Email (0x800), Server Link (0x1000), All items (0xffffffff). - - - - - - - - - - - text/plain - - - - - CONTACTSSERVER - - - - - - - - Server for contact sync if it is different from the email server. - - - - - - - - - - - text/plain - - - - - CALENDARSERVER - - - - - - - - Server for calendar sync if it is different from the email server. - - - - - - - - - - - text/plain - - - - - CONTACTSSERVERREQUIRESSL - - - - - - - - Defines if the connection to the contact server requires SSL. - - - - - - - - - - - text/plain - - - - - CALENDARSERVERREQUIRESSL - - - - - - - - Defines if the connection to the calendar server requires SSL. - - - - - - - - - - - text/plain - - - - - CONTACTSSYNCSCHEDULE - - - - - - - - Sets the schedule for syncing contact items. - - - - - - - - - - - text/plain - - - - - CALENDARSYNCSCHEDULE - - - - - - - - Sets the schedule for syncing calendar items. - - - - - - - - - - - text/plain - - - - - SMTPALTAUTHNAME - - - - - - - - If SMTPALTENABLED is true, then this will have the alternate User Name for SMTP. 255 chars. - - - - - - - - - - - text/plain - - - - - SMTPALTDOMAIN - - - - - - - - If SMTPALTENABLED is true, then this will have the alternate domain for SMTP. 255 chars. - - - - - - - - - - - text/plain - - - - - SMTPALTENABLED - - - - - - - - This is a bool value that specifies if we have separate SMTP credentials. -1 for true -0 for false (default) - - - - - - - - - - - text/plain - - - - - SMTPALTPASSWORD - - - - - - - - If SMTPALTENABLED is true, then this will have the alternate password for SMTP. 255 chars. - - - - - - - - - - - text/plain - - - - - TAGPROPS - - - - - - - - Specifies that stated parameter element name attributes is nonstandard tag properties. - - - - - - - - - - - - - - - 8128000B - - - - - - - - Specify whether incoming server requires SSL connection. -1- Require SSL connection -0- Doesn't require SSL connection (default) - - - - - - - - - - - text/plain - - - - - 812C000B - - - - - - - - Specify whether outgoing server requires SSL connection. -1- Require SSL connection -0- Doesn't require SSL connection (default) - - - - - - - - - - - text/plain - - - - + + ``` -## Related topics - - -[EMAIL2 configuration service provider](email2-csp.md) - -  - -  - - - - - +## Related articles +[EMAIL2 configuration service provider reference](email2-csp.md)