EMAIL2 DDF File

4/8/2010

This topic shows the Device Description Framework (DDF) file for the EMAIL2 Configuration Service Provider. Open Mobile Alliance Device Management (OMA DM) DDF files and the example in this topic are used only for OMA DM provisioning. For more information, see OMA Device Management.

Note

The first line of the DDF is the namespace reference for Microsoft custom properties. For more information, see Managing Microsoft Custom Properties (OMA DM).

<MgmtTree xmlns:MSFT="https://schemas.microsoft.com/MobileDevice/DM">
    <VerDTD>1.2</VerDTD>
    <Node>
        <NodeName>EMAIL2</NodeName>
        <Path>./Vendor/MSFT</Path>
        <DFProperties>
            <AccessType>
                <Get />
            </AccessType>
            <DFFormat>
                <node />
            </DFFormat>
            <Occurrence>
                <One />
            </Occurrence>
            <Scope>
                <Permanent />
            </Scope>
            <MSFT:RWAccess>3</MSFT:RWAccess>
            <DFTitle>EMAIL2</DFTitle>
            <MSFT:MinValue></MSFT:MinValue>
            <MSFT:MaxValue></MSFT:MaxValue>
            <MSFT:MaxLength></MSFT:MaxLength>
            <Description>Root characteristic</Description>
        </DFProperties>
        <Node>
            <NodeName></NodeName>
            <DFProperties>
                <AccessType>
                    <Add />
                    <Delete />
                </AccessType>
                <DFFormat>
                    <node />
                </DFFormat>
                <Occurrence>
                    <OneOr6 />
                </Occurrence>
                <Scope>
                    <Dynamic />
                </Scope>
                <MSFT:RWAccess>3</MSFT:RWAccess>
                <DFTitle>The GUID property</DFTitle>
                <DFType>
                    <MIME>GUID</MIME>
                </DFType>
                <MSFT:MinValue></MSFT:MinValue>
                <MSFT:MaxValue></MSFT:MaxValue>
                <MSFT:MaxLength></MSFT:MaxLength>
                <Description>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.</Description>
            </DFProperties>
            <Node>
                <NodeName>SERVICENAME</NodeName>
                <DFProperties>
                    <AccessType>
                        <Get />
                        <Replace />
                    </AccessType>
                    <DFFormat>
                        <chr />
                    </DFFormat>
                    <Occurrence>
                        <One />
                    </Occurrence>
                    <Scope>
                        <Dynamic />
                    </Scope>
                    <MSFT:RWAccess>3</MSFT:RWAccess>
                    <DFType>
                        <MIME>text/plain</MIME>
                    </DFType>
                    <MSFT:MinValue></MSFT:MinValue>
                    <MSFT:MaxValue></MSFT:MaxValue>
                    <MSFT:MaxLength>32</MSFT:MaxLength>
                    <Description>This is the account name. It's limited to 32 characters.</Description>
                </DFProperties>
            </Node>
            <Node>
                <NodeName>SERVICETYPE</NodeName>
                <DFProperties>
                    <AccessType>
                        <Get />
                        <Replace />
                    </AccessType>
                    <DFFormat>
                        <chr />
                    </DFFormat>
                    <Occurrence>
                        <One />
                    </Occurrence>
                    <Scope>
                        <Dynamic />
                    </Scope>
                    <MSFT:RWAccess>3</MSFT:RWAccess>
                    <DFType>
                        <MIME>text/plain</MIME>
                    </DFType>
                    <MSFT:MinValue></MSFT:MinValue>
                    <MSFT:MaxValue></MSFT:MaxValue>
                    <MSFT:MaxLength></MSFT:MaxLength>
                    <Description>This is the type of account. Valid values are POP3/IMAP4.</Description>
                </DFProperties>
            </Node>
            <Node>
                <NodeName>INSERVER</NodeName>
                <DFProperties>
                    <AccessType>
                        <Get />
                        <Replace />
                    </AccessType>
                    <DFFormat>
                        <chr />
                    </DFFormat>
                    <Occurrence>
                        <One />
                    </Occurrence>
                    <Scope>
                        <Dynamic />
                    </Scope>
                    <MSFT:RWAccess>3</MSFT:RWAccess>
                    <DFType>
                        <MIME>text/plain</MIME>
                    </DFType>
                    <MSFT:MinValue></MSFT:MinValue>
                    <MSFT:MaxValue></MSFT:MaxValue>
                    <MSFT:MaxLength>62</MSFT:MaxLength>
                    <Description>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</Description>
                </DFProperties>
            </Node>
            <Node>
                <NodeName>OUTSERVER</NodeName>
                <DFProperties>
                    <AccessType>
                        <Get />
                        <Replace />
                    </AccessType>
                    <DFFormat>
                        <chr />
                    </DFFormat>
                    <Occurrence>
                        <One />
                    </Occurrence>
                    <Scope>
                        <Dynamic />
                    </Scope>
                    <MSFT:RWAccess>3</MSFT:RWAccess>
                    <DFType>
                        <MIME>text/plain</MIME>
                    </DFType>
                    <MSFT:MinValue></MSFT:MinValue>
                    <MSFT:MaxValue></MSFT:MaxValue>
                    <MSFT:MaxLength>62</MSFT:MaxLength>
                    <Description>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.</Description>
                </DFProperties>
            </Node>
            <Node>
                <NodeName>AUTHNAME</NodeName>
                <DFProperties>
                    <AccessType>
                        <Get />
                        <Replace />
                    </AccessType>
                    <DFFormat>
                        <chr />
                    </DFFormat>
                    <Occurrence>
                        <One />
                    </Occurrence>
                    <Scope>
                        <Dynamic />
                    </Scope>
                    <MSFT:RWAccess>3</MSFT:RWAccess>
                    <DFType>
                        <MIME>text/plain</MIME>
                    </DFType>
                    <MSFT:MinValue></MSFT:MinValue>
                    <MSFT:MaxValue></MSFT:MaxValue>
                    <MSFT:MaxLength>255</MSFT:MaxLength>
                    <Description>User Name for Incoming server. Limited to 255 chars.</Description>
                </DFProperties>
            </Node>
            <Node>
                <NodeName>AUTHSECRET</NodeName>
                <DFProperties>
                    <AccessType>
                        <Get />
                        <Delete />
                        <Replace />
                    </AccessType>
                    <DFFormat>
                        <chr />
                    </DFFormat>
                    <Occurrence>
                        <ZeroOrOne />
                    </Occurrence>
                    <Scope>
                        <Dynamic />
                    </Scope>
                    <MSFT:RWAccess>2</MSFT:RWAccess>
                    <DFType>
                        <MIME>text/password</MIME>
                    </DFType>
                    <MSFT:MinValue></MSFT:MinValue>
                    <MSFT:MaxValue></MSFT:MaxValue>
                    <MSFT:MaxLength>255</MSFT:MaxLength>
                    <Description>Password. Limited to 255 chars.</Description>
                </DFProperties>
            </Node>
            <Node>
                <NodeName>DOMAIN</NodeName>
                <DFProperties>
                    <AccessType>
                        <Get />
                        <Delete />
                        <Replace />
                    </AccessType>
                    <DFFormat>
                        <chr />
                    </DFFormat>
                    <Occurrence>
                        <ZeroOrOne />
                    </Occurrence>
                    <Scope>
                        <Dynamic />
                    </Scope>
                    <MSFT:RWAccess>3</MSFT:RWAccess>
                    <DFType>
                        <MIME>text/plain</MIME>
                    </DFType>
                    <MSFT:MinValue></MSFT:MinValue>
                    <MSFT:MaxValue></MSFT:MaxValue>
                    <MSFT:MaxLength>255</MSFT:MaxLength>
                    <Description>Incoming server credentials domain. Limited to 255 chars.</Description>
                </DFProperties>
            </Node>
            <Node>
                <NodeName>NAME</NodeName>
                <DFProperties>
                    <AccessType>
                        <Get />
                        <Delete />
                        <Replace />
                    </AccessType>
                    <DFFormat>
                        <chr />
                    </DFFormat>
                    <Occurrence>
                        <ZeroOrOne />
                    </Occurrence>
                    <Scope>
                        <Dynamic />
                    </Scope>
                    <MSFT:RWAccess>3</MSFT:RWAccess>
                    <DFType>
                        <MIME>text/plain</MIME>
                    </DFType>
                    <MSFT:MinValue></MSFT:MinValue>
                    <MSFT:MaxValue></MSFT:MaxValue>
                    <MSFT:MaxLength>255</MSFT:MaxLength>
                    <Description>User Display Name. Limited to 255 chars</Description>
                </DFProperties>
            </Node>
            <Node>
                <NodeName>REPLYADDR</NodeName>
                <DFProperties>
                    <AccessType>
                        <Get />
                        <Replace />
                    </AccessType>
                    <DFFormat>
                        <chr />
                    </DFFormat>
                    <Occurrence>
                        <One />
                    </Occurrence>
                    <Scope>
                        <Dynamic />
                    </Scope>
                    <MSFT:RWAccess>3</MSFT:RWAccess>
                    <DFType>
                        <MIME>text/emailaddress</MIME>
                    </DFType>
                    <MSFT:MinValue></MSFT:MinValue>
                    <MSFT:MaxValue></MSFT:MaxValue>
                    <MSFT:MaxLength>255</MSFT:MaxLength>
                    <Description>SMTP reply address of the user. Limited to 255 chars.</Description>
                </DFProperties>
            </Node>
            <Node>
                <NodeName>SMTPALTENABLED</NodeName>
                <DFProperties>
                    <AccessType>
                        <Get />
                        <Replace />
                    </AccessType>
                    <DFFormat>
                        <bool />
                    </DFFormat>
                    <Occurrence>
                        <ZeroOrOne />
                    </Occurrence>
                    <Scope>
                        <Dynamic />
                    </Scope>
                    <MSFT:RWAccess>3</MSFT:RWAccess>
                    <DFType>
                        <MIME>text/plain</MIME>
                    </DFType>
                    <MSFT:MinValue></MSFT:MinValue>
                    <MSFT:MaxValue></MSFT:MaxValue>
                    <MSFT:MaxLength></MSFT:MaxLength>
                    <Description>This is a bool value that specifies if we have separate SMTP credentials.
1 for true
0 for false (default)</Description>
                </DFProperties>
            </Node>
            <Node>
                <NodeName>SMTPALTAUTHNAME</NodeName>
                <DFProperties>
                    <AccessType>
                        <Get />
                        <Delete />
                        <Replace />
                    </AccessType>
                    <DFFormat>
                        <chr />
                    </DFFormat>
                    <Occurrence>
                        <ZeroOrOne />
                    </Occurrence>
                    <Scope>
                        <Dynamic />
                    </Scope>
                    <MSFT:RWAccess>3</MSFT:RWAccess>
                    <DFType>
                        <MIME>text/plain</MIME>
                    </DFType>
                    <MSFT:MinValue></MSFT:MinValue>
                    <MSFT:MaxValue></MSFT:MaxValue>
                    <MSFT:MaxLength>255</MSFT:MaxLength>
                    <Description>If SMTPALTENABLED is true, then this will have the alternate User Name for SMTP. 255 chars.</Description>
                </DFProperties>
            </Node>
            <Node>
                <NodeName>SMTPALTPASSWORD</NodeName>
                <DFProperties>
                    <AccessType>
                        <Get />
                        <Delete />
                        <Replace />
                    </AccessType>
                    <DFFormat>
                        <chr />
                    </DFFormat>
                    <Occurrence>
                        <ZeroOrOne />
                    </Occurrence>
                    <Scope>
                        <Dynamic />
                    </Scope>
                    <MSFT:RWAccess>2</MSFT:RWAccess>
                    <DFType>
                        <MIME>text/password</MIME>
                    </DFType>
                    <MSFT:MinValue></MSFT:MinValue>
                    <MSFT:MaxValue></MSFT:MaxValue>
                    <MSFT:MaxLength>255</MSFT:MaxLength>
                    <Description>If SMTPALTENABLED is true, then this will have the alternate password for SMTP. 255 chars.</Description>
                </DFProperties>
            </Node>
            <Node>
                <NodeName>SMTPALTDOMAIN</NodeName>
                <DFProperties>
                    <AccessType>
                        <Get />
                        <Delete />
                        <Replace />
                    </AccessType>
                    <DFFormat>
                        <chr />
                    </DFFormat>
                    <Occurrence>
                        <ZeroOrOne />
                    </Occurrence>
                    <Scope>
                        <Dynamic />
                    </Scope>
                    <MSFT:RWAccess>3</MSFT:RWAccess>
                    <DFType>
                        <MIME>text/plain</MIME>
                    </DFType>
                    <MSFT:MinValue></MSFT:MinValue>
                    <MSFT:MaxValue></MSFT:MaxValue>
                    <MSFT:MaxLength>255</MSFT:MaxLength>
                    <Description>If SMTPALTENABLED is true, then this will have the alternate domain for SMTP. 255 chars.</Description>
                </DFProperties>
            </Node>
            <Node>
                <NodeName>CONNECTIONID</NodeName>
                <DFProperties>
                    <AccessType>
                        <Get />
                        <Delete />
                        <Replace />
                    </AccessType>
                    <DFFormat>
                        <chr />
                    </DFFormat>
                    <Occurrence>
                        <ZeroOrOne />
                    </Occurrence>
                    <Scope>
                        <Dynamic />
                    </Scope>
                    <MSFT:RWAccess>3</MSFT:RWAccess>
                    <DFType>
                        <MIME>text/plain</MIME>
                    </DFType>
                    <MSFT:MinValue></MSFT:MinValue>
                    <MSFT:MaxValue></MSFT:MaxValue>
                    <MSFT:MaxLength></MSFT:MaxLength>
                    <Description>This is the GUID that can specify the connection to use while connecting to the servers. If not specified, the device will choose the best possible one.</Description>
                </DFProperties>
            </Node>
            <Node>
                <NodeName>LINGER</NodeName>
                <DFProperties>
                    <AccessType>
                        <Get />
                        <Replace />
                    </AccessType>
                    <DFFormat>
                        <int />
                    </DFFormat>
                    <Occurrence>
                        <ZeroOrOne />
                    </Occurrence>
                    <Scope>
                        <Dynamic />
                    </Scope>
                    <MSFT:RWAccess>3</MSFT:RWAccess>
                    <DFType>
                        <MIME>text/plain</MIME>
                    </DFType>
                    <MSFT:MinValue></MSFT:MinValue>
                    <MSFT:MaxValue>60</MSFT:MaxValue>
                    <MSFT:MaxLength></MSFT:MaxLength>
                    <Description>Specifies how frequently Messaging performs scheduled send/receives. (Specified as the length of time in minutes, between updates.)</Description>
                </DFProperties>
            </Node>
            <Node>
                <NodeName>KEEPMAX</NodeName>
                <DFProperties>
                    <AccessType>
                        <Get />
                        <Replace />
                    </AccessType>
                    <DFFormat>
                        <int />
                    </DFFormat>
                    <Occurrence>
                        <ZeroOrOne />
                    </Occurrence>
                    <Scope>
                        <Dynamic />
                    </Scope>
                    <MSFT:RWAccess>3</MSFT:RWAccess>
                    <DFType>
                        <MIME>text/plain</MIME>
                    </DFType>
                    <MSFT:MinValue></MSFT:MinValue>
                    <MSFT:MaxValue></MSFT:MaxValue>
                    <MSFT:MaxLength></MSFT:MaxLength>
                    <Description>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.</Description>
                </DFProperties>
            </Node>
            <Node>
                <NodeName>DWNDAY</NodeName>
                <DFProperties>
                    <AccessType>
                        <Get />
                        <Replace />
                    </AccessType>
                    <DFFormat>
                        <int />
                    </DFFormat>
                    <Occurrence>
                        <ZeroOrOne />
                    </Occurrence>
                    <Scope>
                        <Dynamic />
                    </Scope>
                    <MSFT:RWAccess>3</MSFT:RWAccess>
                    <DFType>
                        <MIME>text/plain</MIME>
                    </DFType>
                    <MSFT:MinValue></MSFT:MinValue>
                    <MSFT:MaxValue>99</MSFT:MaxValue>
                    <MSFT:MaxLength></MSFT:MaxLength>
                    <Description>Specifies how many days of email to download. (number of days worth going back into the past)</Description>
                </DFProperties>
            </Node>
            <Node>
                <NodeName>RETRIEVE</NodeName>
                <DFProperties>
                    <AccessType>
                        <Get />
                        <Replace />
                    </AccessType>
                    <DFFormat>
                        <int />
                    </DFFormat>
                    <Occurrence>
                        <ZeroOrOne />
                    </Occurrence>
                    <Scope>
                        <Dynamic />
                    </Scope>
                    <MSFT:RWAccess>3</MSFT:RWAccess>
                    <DFType>
                        <MIME>text/plain</MIME>
                    </DFType>
                    <MSFT:MinValue></MSFT:MinValue>
                    <MSFT:MaxValue>1022976</MSFT:MaxValue>
                    <MSFT:MaxLength></MSFT:MaxLength>
                    <Description>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.</Description>
                </DFProperties>
            </Node>
            <Node>
                <NodeName>AUTHREQUIRED</NodeName>
                <DFProperties>
                    <AccessType>
                        <Get />
                        <Replace />
                    </AccessType>
                    <DFFormat>
                        <bool />
                    </DFFormat>
                    <Occurrence>
                        <ZeroOrOne />
                    </Occurrence>
                    <Scope>
                        <Dynamic />
                    </Scope>
                    <MSFT:RWAccess>3</MSFT:RWAccess>
                    <DFType>
                        <MIME>text/plain</MIME>
                    </DFType>
                    <MSFT:MinValue></MSFT:MinValue>
                    <MSFT:MaxValue></MSFT:MaxValue>
                    <MSFT:MaxLength></MSFT:MaxLength>
                    <Description>This will specify whether the outgoing server must use 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.</Description>
                </DFProperties>
            </Node>
            <Node>
                <NodeName>TAGPROPS</NodeName>
                <DFProperties>
                    <AccessType>
                        <Get />
                    </AccessType>
                    <DFFormat>
                        <node />
                    </DFFormat>
                    <Occurrence>
                        <One />
                    </Occurrence>
                    <Scope>
                        <Dynamic />
                    </Scope>
                    <MSFT:RWAccess>1</MSFT:RWAccess>
                    <MSFT:MinValue></MSFT:MinValue>
                    <MSFT:MaxValue></MSFT:MaxValue>
                    <MSFT:MaxLength></MSFT:MaxLength>
                    <Description>Specifies that stated parameter element name attributes is nonstandard tag properties.</Description>
                </DFProperties>
                <Node>
                    <NodeName>8128000B</NodeName>
                    <DFProperties>
                        <AccessType>
                            <Get />
                            <Replace />
                        </AccessType>
                        <DFFormat>
                            <bool />
                        </DFFormat>
                        <Occurrence>
                            <ZeroOrOne />
                        </Occurrence>
                        <Scope>
                            <Dynamic />
                        </Scope>
                        <MSFT:RWAccess>3</MSFT:RWAccess>
                        <DFType>
                            <MIME>text/plain</MIME>
                        </DFType>
                        <MSFT:MinValue></MSFT:MinValue>
                        <MSFT:MaxValue></MSFT:MaxValue>
                        <MSFT:MaxLength></MSFT:MaxLength>
                        <Description>Specify whether incoming server must use an SSL connection.
1- Require SSL connection
0- Doesn't require SSL connection (default)</Description>
                    </DFProperties>
                </Node>
                <Node>
                    <NodeName>812C000B</NodeName>
                    <DFProperties>
                        <AccessType>
                            <Get />
                            <Replace />
                        </AccessType>
                        <DFFormat>
                            <bool />
                        </DFFormat>
                        <Occurrence>
                            <ZeroOrOne />
                        </Occurrence>
                        <Scope>
                            <Dynamic />
                        </Scope>
                        <MSFT:RWAccess>3</MSFT:RWAccess>
                        <DFType>
                            <MIME>text/plain</MIME>
                        </DFType>
                        <MSFT:MinValue></MSFT:MinValue>
                        <MSFT:MaxValue></MSFT:MaxValue>
                        <MSFT:MaxLength></MSFT:MaxLength>
                        <Description>Specify whether outgoing server must use an SSL connection.
1- Require SSL connection
0- Doesn't require SSL connection (default)</Description>
                    </DFProperties>
                </Node>
            </Node>
        </Node>
    </Node>
</MgmtTree>

See Also

Other Resources

EMAIL2 Configuration Service Provider Examples for OMA DM