Sorry, you need to enable JavaScript to visit this website.

Feedback

Your feedback is important to keep improving our website and offer you a more reliable experience.

CPClient

The CPClient is a middleware component that provides support for wireless provisioning of application and connection settings and exposes d-Bus APIs. It implements the OMA Client Provisioning (CP) protocol controlling application and connection settings. It works with Provman, which directly modifies application and connection settings.

The CPClient allows multiple email accounts to be provisioned. Two incoming protocols, POP and IMAP4 and one outgoing email protocol, SMTP, are supported. Typically, OMA CP documents always contain an even number of APPLICATION characteristics that provision email applications. These characteristics are grouped into sets of two by the PROVIDER-ID parameter. One characteristic in each set contains the details for the server used to send email (the SMTP server, for example). The other contains the details of the server from which email can be retrieved (such as a POP3 or an IMAP4 server). So a combination of two APPLICATION characteristics with the same PROVIDER-ID correspond to a single Provman email account.

The only restriction on the provisioning of email accounts is that it is not possible to specify that a given connection or proxy should be used to access the various email servers. All connectoid references within an email application characteristic are ignored.

The supported email settings are specified in the table below.

OMA CP Parameter Occurrence Description Permissible Values
Supported SMTP Parameters
APPLICATION/APPID 1 Identifies the application characteristic as one containing settings for an SMTP server 25
APPLICATION/NAME 0 or 1 Contains the user readable name of the email account A string
APPLICATION/PROVIDER-ID 0 or 1 Binds this characteristic to an IMAP4 or a POP3 characteristic A string
APPLICATION/APPADDR 1 Characteristic for specifying the server address, service and port number  
APPLICATION/APPADDR/ADDR 1 Contains the address of the SMTP server A string
APPLICATION/APPADDR/PORT 0 or 1 The port number of the SMTP server An integer
APPLICATION/APPADDR/SERVICE 0 or 1 Indicates whether or not secure SMTP over SSL is to be used 465 indicates that secure SMTP is being used, 25 indicates that it is not
APPLICATION/APPAUTH 0 or 1 Characteristic for specifying the server's login credentials  
APPLICATION/APPAUTH/AAUTHTYPE 0 or 1 Indicates the type of authentication to be used PLAIN, NTLM, GSSAPI, CRAM-MD5, DIGEST-MD5, POPB4SMTP, LOGIN
APPLICATION/APPAUTH/AAUTHNAME 0 or 1 The user name A string
APPLICATION/APPAUTH/AAUTHSECRET 0 or 1 The password A string
APPLICATION/FROM 1 Specifies the from email address A string
Supported POP3 Parameters
APPLICATION/APPID 1 Identifies the application characteristic as one containing settings for a POP3 server 110
APPLICATION/NAME 0 or 1 Contains the user readable name of the email account A string
APPLICATION/PROVIDER-ID 0 or 1 Binds this characteristic to an SMTP characteristic A string
APPLICATION/APPADDR 1 Characteristic for specifying the server address, service and port number  
APPLICATION/APPADDR/ADDR 1 Contains the address of the POP3 server A string
APPLICATION/APPADDR/PORT 0 or 1 The port number of the POP3 server An integer
APPLICATION/APPADDR/SERVICE 0 or 1 Indicates whether traffic between the client and the server should be encrypted 995 indicates that secure POP over SSL should be used as described in RFC2595. 110 indicates that an unsecured connection should be made to the port number specified in the PORTNBR parameter. If this parameter is omitted, SSL is not used
APPLICATION/APPAUTH 0 or 1 Characteristic for specifying the server's login credentials  
APPLICATION/APPAUTH/AAUTHTYPE 0 or 1 Indicates the type of authentication to be used PLAIN, NTLM, GSSAPI, CRAM-MD5, DIGEST-MD5, POPB4SMTP, APOP
APPLICATION/APPAUTH/AAUTHNAME 0 or 1 The user name A string
APPLICATION/APPAUTH/AAUTHSECRET 0 or 1 The password A string
Supported IMAP4 Parameters
APPLICATION/APPID 1 Identifies the application characteristic as one containing settings for a IMAP4 server 143
APPLICATION/NAME 0 or 1 Contains the user readable name of the email account A string
APPLICATION/PROVIDER-ID 0 or 1 Binds this characteristic to an SMTP characteristic A string
APPLICATION/APPADDR 1 Characteristic for specifying the server address, service and port number  
APPLICATION/APPADDR/ADDR 1 Contains the address of the IMAP4 server A string
APPLICATION/APPADDR/PORT 0 or 1 The port number of the IMAP4 server An integer
APPLICATION/APPADDR/SERVICE 0 or 1 Indicates whether traffic between the client and the server should be encrypted 993 indicates that secure IMAP4 over SSL should be used as described in RFC2595. 143 indicates that an unsecured connection should be made to the port number specified in the PORTNBR parameter. If this parameter is omitted, SSL is not used
APPLICATION/APPAUTH 0 or 1 Characteristic for specifying the server's login credentials  
APPLICATION/APPAUTH/AAUTHTYPE 0 or 1 Indicates the type of authentication to be used PLAIN, NTLM, GSSAPI, CRAM-MD5, DIGEST-MD5, POPB4SMTP, APOP
APPLICATION/APPAUTH/AAUTHNAME 0 or 1 The user name A string
APPLICATION/APPAUTH/AAUTHSECRET 0 or 1 The password A string

Note that all email APPLICATION characteristics must specify a server address. Those that do not will be discarded. In addition SMTP accounts must specify a FROM address.

An example of an OMA CP document that provisions an email account is shown below.

<wap-provisioningdoc version="1.0">
  <characteristic type="APPLICATION">
    <parm name="APPID" value="110"/>
    <parm name="PROVIDER-ID" value="localmail"/>
    <parm name="NAME" value="Local Email"/>
    <characteristic type="APPADDR">
      <parm name="ADDR" value="pop.localhost"/>
      <characteristic type="PORT">
        <parm name="PORTNBR" value="995"/>
        <parm name="SERVICE" value="995"/>
      </characteristic>
    </characteristic>
    <characteristic type="APPAUTH">
      <parm name="AAUTHNAME" value="user"/>
      <parm name="AAUTHSECRET" value="password"/>
    </characteristic>
  </characteristic>
  <characteristic type="APPLICATION">
    <parm name="APPID" value="25"/>
    <parm name="PROVIDER-ID" value="localmail"/>
    <parm name="NAME" value="Local Email"/>
    <parm name="FROM" value="user@localhost"/>
    <characteristic type="APPADDR">
      <parm name="ADDR" value="smtp.localhost"/>
      <characteristic type="PORT">
        <parm name="PORTNBR" value="465"/>
        <parm name="SERVICE" value="465"/>
      </characteristic>
    </characteristic>
    <characteristic type="APPAUTH">
      <parm name="AAUTHNAME" value="username"/>
      <parm name="AAUTHSECRET" value="password"/>
    </characteristic>
  </characteristic>
</wap-provisioningdoc>

It is converted into the following Provman keys by the CPClient.

/applications/email/localmail/name = Local Email
/applications/email/localmail/address = user@localhost
/applications/email/localmail/incoming/type = pop
/applications/email/localmail/incoming/host = pop.localhost
/applications/email/localmail/incoming/port = 995
/applications/email/localmail/incoming/usessl = always
/applications/email/localmail/incoming/password = password
/applications/email/localmail/incoming/username = user
/applications/email/localmail/outgoing/host = smtp.localhost
/applications/email/localmail/outgoing/port = 465
/applications/email/localmail/outgoing/username = username
/applications/email/localmail/outgoing/usessl = always
/applications/email/localmail/outgoing/type = smtp
/applications/email/localmail/outgoing/password = password

 

Project: