Root-Level Characteristic Query

4/8/2010

Perform an EMAIL2 root-level characteristic query when you want to retrieve e-mail account GUIDs and account settings for all e-mail accounts on a Windows Mobile device. This includes e-mail accounts that have been provisioned by the Mobile Operator, as well as those that have been manually setup by the user.

Demonstrates

How to retrieve all of the e-mail account settings from a Windows Mobile device.

Example

This example demonstrates the XML code used to perform a root-level EMAIL2 Configuration Service Provider characteristic query. You can use this code as a template for creating your own XML provisioning documents. Just copy and paste the code into a blank text file, edit the characteristic and parm elements to suit your needs, and then save the text file with an XML extension. If you are using Notepad, then be sure to enclose the entire file name (including the extension) in quotes—otherwise Notepad will append ".txt" to the file name.

<characteristic-query type="EMAIL2" recursive="true" />

<characteristic type="EMAIL2" >
   <characteristic type="{XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXX1}">
      <parm name="SERVICENAME" value="MyIMAP"/>
      <parm name="SERVICETYPE" value="IMAP4"/>
      <parm name="INSERVER"    value="Imapserver"/>
      <parm name="OUTSERVER"   value="smtpserver"/>
      <parm name="AUTHNAME"    value="alias"/>
      <parm name="AUTHSECRET"  value="password"/>
      <parm name="DOMAIN"      value="oceana"/>
      <parm name="REPLYADDR"   value="emailAddress"/>
   </characteristic>
   <characteristic type="{XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXX2}">
      <parm name="SERVICENAME" value="MyPOP"/>
      <parm name="SERVICETYPE" value="POP3"/>
      <parm name="INSERVER"    value="popserver"/>
      <parm name="OUTSERVER"   value="smtpserver"/>
      <parm name="AUTHNAME"    value="alias"/>
      <parm name="AUTHSECRET"  value="password"/>
      <parm name="DOMAIN"      value="oceana"/>
      <parm name="REPLYADDR"   value="emailAddress"/>
  </characteristic>
</characteristic>

Performing an EMAIL2 root-level characteristic query will not retrieve e-mail account passwords.

Performing an EMAIL2 root-level characteristic query will not retrieve information for Exchange email accounts.

All POP and IMAP e-mail accounts have an associated GUID.

If you use Notepad as your text editor, then be sure to enclose the entire file name within a pair of quotes so that Notepad does not save it with a "TXT" extension.

One provisioning XML file typically contains configuration information for multiple Configuration Service Providers. To use this example, you must replace the values as appropriate, and add the node as a child of the OMA Client Provisioning file. For information about the syntax of this file, see OMA Client Provisioning Files. For examples, see OMA Client Provisioning XML File Examples.

See Also

Tasks

EMAIL2 Configuration Service Provider Examples for OMA Client Provisioning

Reference

EMAIL2 Configuration Service Provider