Account
[IMAP]


IMAP ACCOUNT PROPERTIES

Defines the IMAP account properties.

#define ALP_POSTAL_IMAP_PROPERTY_ACCOUNT_CONNECTION_PROFILE_STRING
 The Connection Manager connection profile string, used for provisioned accounts. Status: Optional Client: read/write Server: read Default: Empty.
#define ALP_POSTAL_IMAP_PROPERTY_ACCOUNT_CONTINUOUS_SYNC
 Continuous sync preference (IDLE) Status: Optional Client: read/write Server: Ignore Default: false.
#define ALP_POSTAL_IMAP_PROPERTY_ACCOUNT_DOWNLOAD_ORDER_TYPE
 Download order type Order at the time of ALP_POSTAL_IMAP_PROPERTY_ACCOUNT_DOWNLOAD_TYPE == EMAIL_DOWNLOAD_TYPE_RECV_ALL. for ALP: EMAIL_DOWNLOAD_RECV_ORDER_TYPE_DESC / NEW -> OLD for NMCS: EMAIL_DOWNLOAD_RECV_ORDER_TYPE_ASC / OLD -> NEW Status: Required Client: read/write Server: read Default: 0 = EMAIL_DOWNLOAD_RECV_ORDER_TYPE_ASC 1 = EMAIL_DOWNLOAD_RECV_ORDER_TYPE_DESC.
#define ALP_POSTAL_IMAP_PROPERTY_ACCOUNT_DOWNLOAD_TYPE
 Download type The type in which download conditions. Status: Required Client: read/write Server: read Default: 0 = EMAIL_DOWNLOAD_TYPE_RECV_ALL 1 = EMAIL_DOWNLOAD_TYPE_X_DAYS 2 = EMAIL_DOWNLOAD_TYPE_X_MESSAGES.
#define ALP_POSTAL_IMAP_PROPERTY_ACCOUNT_DOWNLOAD_X_DAYS
 Download all messages less than X days, and purge all messages in the user's Inbox that are older than X days. Note this feature is not exclusive to any other property. Status: Optional Client: read/write Server: read Default: 0=disable this feature.
#define ALP_POSTAL_IMAP_PROPERTY_ACCOUNT_DOWNLOAD_X_KB
 Download up to X KB for each message Status: Optional Client: read/write Server: read Default: 0=Ignore.
#define ALP_POSTAL_IMAP_PROPERTY_ACCOUNT_DOWNLOAD_X_MESSAGES
 Download up to X messages. Note this feature is not mutually exclusive with any other property. Status: Optional Client: read/write Server: read Default: 0=disable this feature.
#define ALP_POSTAL_IMAP_PROPERTY_ACCOUNT_HEADERS_ONLY
 Download headers only Status: Optional Client: read/write Server: read Default: false.
#define ALP_POSTAL_IMAP_PROPERTY_ACCOUNT_INCLUDE_IN_SCHEDULED_SYNC
 Include this account in scheduled syncs Status: Optional Client: read/write Server: Ignore Default: false.
#define ALP_POSTAL_IMAP_PROPERTY_ACCOUNT_INCOMING_PREVIOUSLY_VALIDATED
 Set when the incoming account has been successfully validated at least once in the past. Set by plugin at the same time INCOMING_VALIDATED is set, but the difference is that this one is never cleared. Used for disallowing users to change the server address and username once an account has been validated. Status: Optional Client: read Server: write Default: 0 = Account has never been validated.
#define ALP_POSTAL_IMAP_PROPERTY_ACCOUNT_INCOMING_VALIDATED
 Property is set when the incoming account is successfully validated (i.e. the IMAP server and user auth properties) Status: Required Client: read Server: write Default: 0 = Account is not validated.
#define ALP_POSTAL_IMAP_PROPERTY_ACCOUNT_IS_PROVISIONED
 Whether or not the account is provisioned. Status: Optional Client: read/write Server: Ignore Default: false.
#define ALP_POSTAL_IMAP_PROPERTY_ACCOUNT_ISP_INDEX
 Index into array of ISP list kept by the email application. Status: Optional Client: read/write Server: Ignore Default: -1=No ISP selected.
#define ALP_POSTAL_IMAP_PROPERTY_ACCOUNT_LOGIN_ID
 IMAP Server Login ID Status: Required Client: read/write Server: read Default:.
#define ALP_POSTAL_IMAP_PROPERTY_ACCOUNT_LOGIN_PASSWORD
 IMAP Server Login Password Status: Required Client: read/write Server: read Default:.
#define ALP_POSTAL_IMAP_PROPERTY_ACCOUNT_OMADM_KEY
 The OMA-DM account identifier string for this account, or NULL for non-provisioned accounts. Status: Optional Client: read/write Server: Ignore Default: NULL.
#define ALP_POSTAL_IMAP_PROPERTY_ACCOUNT_OUTGOING_VALIDATED
 Property is set when the outgoing account is successfully validated (i.e. the SMTP server and user auth properties) Status: Required Client: read Server: write Default: 0 = Account is not validated.
#define ALP_POSTAL_IMAP_PROPERTY_ACCOUNT_REPLY_TO_ADDRESS
 The reply-to email address. Status: Optional Client: read/write Server: read Default: Empty.
#define ALP_POSTAL_IMAP_PROPERTY_ACCOUNT_SERVER_ADDRESS
 IMAP Server Address Status: Required Client: read/write Server: read Default:.
#define ALP_POSTAL_IMAP_PROPERTY_ACCOUNT_SERVER_PORT
 IMAP Server Port Status: Required Client: read/write Server: read Default: 110.
#define ALP_POSTAL_IMAP_PROPERTY_ACCOUNT_SOCKET_TIMEOUT_SECONDS
 TCP Socket Timeout (seconds) Status: Required Client: read/write Server: read Default: 10.
#define ALP_POSTAL_IMAP_PROPERTY_ACCOUNT_USE_SSL
 Use SSL Status: Optional Client: read/write Server: read Default: false.
#define ALP_POSTAL_IMAP_PROPERTY_ACCOUNT_VERSION
 Version of account datatype Status: Required Client: read/write Server: read Default: 1.
#define ALP_POSTAL_IMAP_PROPERTY_EMAIL_ADDRESS
 User's email address (ie joe@hotmail.com) Status: Optional Client: read/write Server: Ignore Default: Empty.
#define ALP_POSTAL_IMAP_PROPERTY_IMAP_CAPA_AUTH_CRAM_MD5
 AUTH=CRAM-MD5 flag Status: Optional Client: read Server: read/write Default: false.
#define ALP_POSTAL_IMAP_PROPERTY_IMAP_CAPA_AUTH_LOGIN
 AUTH=LOGIN flag Status: Optional Client: read Server: read/write Default: false.
#define ALP_POSTAL_IMAP_PROPERTY_IMAP_CAPA_AUTH_PLAIN
 AUTH=PLAIN flag Status: Optional Client: read Server: read/write Default: false.
#define ALP_POSTAL_IMAP_PROPERTY_IMAP_CAPA_IDLE
 IDLE flag Status: Optional Client: read Server: read/write Default: false.
#define ALP_POSTAL_IMAP_PROPERTY_IMAP_CAPA_IMAP4REV1
 IMAP4rev1 flag Status: Optional Client: read Server: read/write Default: false.
#define ALP_POSTAL_IMAP_PROPERTY_IMAP_CAPA_LOGINDISABLED
 LOGINDISABLED flag Status: Optional Client: read Server: read/write Default: false.
#define ALP_POSTAL_IMAP_PROPERTY_IMAP_CAPA_STARTTLS
 STARTTLS flag Status: Optional Client: read Server: read/write Default: false.
#define ALP_POSTAL_IMAP_PROPERTY_IMAP_CAPA_STATUS
 Status of the IMAP capabilities: should be 0 when the account is newly created (never updated from the server).
#define ALP_POSTAL_IMAP_PROPERTY_IMAP_CAPA_UIDPLUS
 UIDPLUS flag Status: Optional Client: read Server: read/write Default:.
#define ALP_POSTAL_IMAP_PROPERTY_IMAP_SUPPORT_APPEND
 This property is set to TRUE when not supporting the APPEND command. Status: Optional Client: read/write Server: read/write Default: true.
#define ALP_POSTAL_IMAP_PROPERTY_IMAP_SUPPORT_COPY
 This property is set to TRUE when not supporting the COPY command. Status: Optional Client: read/write Server: read/write Default: true.
#define ALP_POSTAL_IMAP_PROPERTY_SENDER_DISPLAY_NAME
 User's real name, displayed in outgoing email (e.g. Joe Smith) Status: Optional Client: read/write Server: Ignore Default: Empty.
#define ALP_POSTAL_IMAP_PROPERTY_SMTP_ACCOUNT_SERVER_ADDRESS
 SMTP Server Address Status: Required Client: read/write Server: read Default:.
#define ALP_POSTAL_IMAP_PROPERTY_SMTP_ACCOUNT_SERVER_PORT
 SMTP Server Port Status: Required Client: read/write Server: read Default: 25.
#define ALP_POSTAL_IMAP_PROPERTY_SMTP_BCC
 SMTP BCC TO property Status: Optional Client: read/write Server: read Default: off.
#define ALP_POSTAL_IMAP_PROPERTY_SMTP_BCC_TO_ADDRESS
 SMTP BCC TO ADDRESS property Status: Optional Client: read/write Server: read Default:.
#define ALP_POSTAL_IMAP_PROPERTY_SMTP_ENCRYPTION
 SMTP ENCRYPTION property Status: Required Client: read/write Server: read Default: 0 = EMAIL_ENCRYPTION_TYPE_NONE.
#define ALP_POSTAL_IMAP_PROPERTY_SMTP_LOGIN_ID
 SMTP Login ID Status: Required Client: read/write Server: read Default: 110.
#define ALP_POSTAL_IMAP_PROPERTY_SMTP_LOGIN_PASSWORD
 SMTP Login Password Status: Required Client: read/write Server: read Default: 110.
#define ALP_POSTAL_IMAP_PROPERTY_SMTP_SIGNATURE
 SMTP Signature property Status: Required Client: read/write Server: read Default:.
#define ALP_POSTAL_IMAP_PROPERTY_SMTP_USE_INCOMING_CREDENTIALS
 SMTP Reuse IMAP user/pass credentials to login to SMTP server. If enabled, the plugin ignores the SMTP user/pass and uses the IMAP Status: Required Client: read/write Server: read Default: 110.
#define ALP_POSTAL_IMAP_PROPERTY_SMTP_USE_SIGNATURE
 SMTP Use Signature property Status: Required Client: read/write Server: read Default: false.


Define Documentation

#define ALP_POSTAL_IMAP_PROPERTY_ACCOUNT_CONNECTION_PROFILE_STRING
 

Value:

The Connection Manager connection profile string, used for provisioned accounts. Status: Optional Client: read/write Server: read Default: Empty.

#define ALP_POSTAL_IMAP_PROPERTY_ACCOUNT_CONTINUOUS_SYNC
 

Value:

Continuous sync preference (IDLE) Status: Optional Client: read/write Server: Ignore Default: false.

#define ALP_POSTAL_IMAP_PROPERTY_ACCOUNT_DOWNLOAD_ORDER_TYPE
 

Value:

Download order type Order at the time of ALP_POSTAL_IMAP_PROPERTY_ACCOUNT_DOWNLOAD_TYPE == EMAIL_DOWNLOAD_TYPE_RECV_ALL. for ALP: EMAIL_DOWNLOAD_RECV_ORDER_TYPE_DESC / NEW -> OLD for NMCS: EMAIL_DOWNLOAD_RECV_ORDER_TYPE_ASC / OLD -> NEW Status: Required Client: read/write Server: read Default: 0 = EMAIL_DOWNLOAD_RECV_ORDER_TYPE_ASC 1 = EMAIL_DOWNLOAD_RECV_ORDER_TYPE_DESC.

#define ALP_POSTAL_IMAP_PROPERTY_ACCOUNT_DOWNLOAD_TYPE
 

Value:

Download type The type in which download conditions. Status: Required Client: read/write Server: read Default: 0 = EMAIL_DOWNLOAD_TYPE_RECV_ALL 1 = EMAIL_DOWNLOAD_TYPE_X_DAYS 2 = EMAIL_DOWNLOAD_TYPE_X_MESSAGES.

#define ALP_POSTAL_IMAP_PROPERTY_ACCOUNT_DOWNLOAD_X_DAYS
 

Value:

Download all messages less than X days, and purge all messages in the user's Inbox that are older than X days. Note this feature is not exclusive to any other property. Status: Optional Client: read/write Server: read Default: 0=disable this feature.

#define ALP_POSTAL_IMAP_PROPERTY_ACCOUNT_DOWNLOAD_X_KB
 

Value:

Download up to X KB for each message Status: Optional Client: read/write Server: read Default: 0=Ignore.

#define ALP_POSTAL_IMAP_PROPERTY_ACCOUNT_DOWNLOAD_X_MESSAGES
 

Value:

Download up to X messages. Note this feature is not mutually exclusive with any other property. Status: Optional Client: read/write Server: read Default: 0=disable this feature.

#define ALP_POSTAL_IMAP_PROPERTY_ACCOUNT_HEADERS_ONLY
 

Value:

Download headers only Status: Optional Client: read/write Server: read Default: false.

#define ALP_POSTAL_IMAP_PROPERTY_ACCOUNT_INCLUDE_IN_SCHEDULED_SYNC
 

Value:

Include this account in scheduled syncs Status: Optional Client: read/write Server: Ignore Default: false.

#define ALP_POSTAL_IMAP_PROPERTY_ACCOUNT_INCOMING_PREVIOUSLY_VALIDATED
 

Value:

Set when the incoming account has been successfully validated at least once in the past. Set by plugin at the same time INCOMING_VALIDATED is set, but the difference is that this one is never cleared. Used for disallowing users to change the server address and username once an account has been validated. Status: Optional Client: read Server: write Default: 0 = Account has never been validated.

#define ALP_POSTAL_IMAP_PROPERTY_ACCOUNT_INCOMING_VALIDATED
 

Value:

Property is set when the incoming account is successfully validated (i.e. the IMAP server and user auth properties) Status: Required Client: read Server: write Default: 0 = Account is not validated.

#define ALP_POSTAL_IMAP_PROPERTY_ACCOUNT_IS_PROVISIONED
 

Value:

Whether or not the account is provisioned. Status: Optional Client: read/write Server: Ignore Default: false.

#define ALP_POSTAL_IMAP_PROPERTY_ACCOUNT_ISP_INDEX
 

Value:

Index into array of ISP list kept by the email application. Status: Optional Client: read/write Server: Ignore Default: -1=No ISP selected.

#define ALP_POSTAL_IMAP_PROPERTY_ACCOUNT_LOGIN_ID
 

Value:

IMAP Server Login ID Status: Required Client: read/write Server: read Default:.

#define ALP_POSTAL_IMAP_PROPERTY_ACCOUNT_LOGIN_PASSWORD
 

Value:

IMAP Server Login Password Status: Required Client: read/write Server: read Default:.

#define ALP_POSTAL_IMAP_PROPERTY_ACCOUNT_OMADM_KEY
 

Value:

The OMA-DM account identifier string for this account, or NULL for non-provisioned accounts. Status: Optional Client: read/write Server: Ignore Default: NULL.

#define ALP_POSTAL_IMAP_PROPERTY_ACCOUNT_OUTGOING_VALIDATED
 

Value:

Property is set when the outgoing account is successfully validated (i.e. the SMTP server and user auth properties) Status: Required Client: read Server: write Default: 0 = Account is not validated.

#define ALP_POSTAL_IMAP_PROPERTY_ACCOUNT_REPLY_TO_ADDRESS
 

Value:

The reply-to email address. Status: Optional Client: read/write Server: read Default: Empty.

#define ALP_POSTAL_IMAP_PROPERTY_ACCOUNT_SERVER_ADDRESS
 

Value:

IMAP Server Address Status: Required Client: read/write Server: read Default:.

#define ALP_POSTAL_IMAP_PROPERTY_ACCOUNT_SERVER_PORT
 

Value:

IMAP Server Port Status: Required Client: read/write Server: read Default: 110.

#define ALP_POSTAL_IMAP_PROPERTY_ACCOUNT_SOCKET_TIMEOUT_SECONDS
 

Value:

TCP Socket Timeout (seconds) Status: Required Client: read/write Server: read Default: 10.

#define ALP_POSTAL_IMAP_PROPERTY_ACCOUNT_USE_SSL
 

Value:

Use SSL Status: Optional Client: read/write Server: read Default: false.

#define ALP_POSTAL_IMAP_PROPERTY_ACCOUNT_VERSION
 

Value:

Version of account datatype Status: Required Client: read/write Server: read Default: 1.

#define ALP_POSTAL_IMAP_PROPERTY_EMAIL_ADDRESS
 

Value:

User's email address (ie joe@hotmail.com) Status: Optional Client: read/write Server: Ignore Default: Empty.

#define ALP_POSTAL_IMAP_PROPERTY_IMAP_CAPA_AUTH_CRAM_MD5
 

Value:

AUTH=CRAM-MD5 flag Status: Optional Client: read Server: read/write Default: false.

#define ALP_POSTAL_IMAP_PROPERTY_IMAP_CAPA_AUTH_LOGIN
 

Value:

AUTH=LOGIN flag Status: Optional Client: read Server: read/write Default: false.

#define ALP_POSTAL_IMAP_PROPERTY_IMAP_CAPA_AUTH_PLAIN
 

Value:

AUTH=PLAIN flag Status: Optional Client: read Server: read/write Default: false.

#define ALP_POSTAL_IMAP_PROPERTY_IMAP_CAPA_IDLE
 

Value:

IDLE flag Status: Optional Client: read Server: read/write Default: false.

#define ALP_POSTAL_IMAP_PROPERTY_IMAP_CAPA_IMAP4REV1
 

Value:

IMAP4rev1 flag Status: Optional Client: read Server: read/write Default: false.

#define ALP_POSTAL_IMAP_PROPERTY_IMAP_CAPA_LOGINDISABLED
 

Value:

LOGINDISABLED flag Status: Optional Client: read Server: read/write Default: false.

#define ALP_POSTAL_IMAP_PROPERTY_IMAP_CAPA_STARTTLS
 

Value:

STARTTLS flag Status: Optional Client: read Server: read/write Default: false.

#define ALP_POSTAL_IMAP_PROPERTY_IMAP_CAPA_STATUS
 

Value:

Status of the IMAP capabilities: should be 0 when the account is newly created (never updated from the server).

Status: Required Client: read Server: read/write Default: 0 - INVALID- server update required

#define ALP_POSTAL_IMAP_PROPERTY_IMAP_CAPA_UIDPLUS
 

Value:

UIDPLUS flag Status: Optional Client: read Server: read/write Default:.

#define ALP_POSTAL_IMAP_PROPERTY_IMAP_SUPPORT_APPEND
 

Value:

This property is set to TRUE when not supporting the APPEND command. Status: Optional Client: read/write Server: read/write Default: true.

#define ALP_POSTAL_IMAP_PROPERTY_IMAP_SUPPORT_COPY
 

Value:

This property is set to TRUE when not supporting the COPY command. Status: Optional Client: read/write Server: read/write Default: true.

#define ALP_POSTAL_IMAP_PROPERTY_SENDER_DISPLAY_NAME
 

Value:

User's real name, displayed in outgoing email (e.g. Joe Smith) Status: Optional Client: read/write Server: Ignore Default: Empty.

#define ALP_POSTAL_IMAP_PROPERTY_SMTP_ACCOUNT_SERVER_ADDRESS
 

Value:

SMTP Server Address Status: Required Client: read/write Server: read Default:.

#define ALP_POSTAL_IMAP_PROPERTY_SMTP_ACCOUNT_SERVER_PORT
 

Value:

SMTP Server Port Status: Required Client: read/write Server: read Default: 25.

#define ALP_POSTAL_IMAP_PROPERTY_SMTP_BCC
 

Value:

SMTP BCC TO property Status: Optional Client: read/write Server: read Default: off.

#define ALP_POSTAL_IMAP_PROPERTY_SMTP_BCC_TO_ADDRESS
 

Value:

SMTP BCC TO ADDRESS property Status: Optional Client: read/write Server: read Default:.

#define ALP_POSTAL_IMAP_PROPERTY_SMTP_ENCRYPTION
 

Value:

SMTP ENCRYPTION property Status: Required Client: read/write Server: read Default: 0 = EMAIL_ENCRYPTION_TYPE_NONE.

#define ALP_POSTAL_IMAP_PROPERTY_SMTP_LOGIN_ID
 

Value:

SMTP Login ID Status: Required Client: read/write Server: read Default: 110.

#define ALP_POSTAL_IMAP_PROPERTY_SMTP_LOGIN_PASSWORD
 

Value:

SMTP Login Password Status: Required Client: read/write Server: read Default: 110.

#define ALP_POSTAL_IMAP_PROPERTY_SMTP_SIGNATURE
 

Value:

SMTP Signature property Status: Required Client: read/write Server: read Default:.

#define ALP_POSTAL_IMAP_PROPERTY_SMTP_USE_INCOMING_CREDENTIALS
 

Value:

SMTP Reuse IMAP user/pass credentials to login to SMTP server. If enabled, the plugin ignores the SMTP user/pass and uses the IMAP Status: Required Client: read/write Server: read Default: 110.

#define ALP_POSTAL_IMAP_PROPERTY_SMTP_USE_SIGNATURE
 

Value:

SMTP Use Signature property Status: Required Client: read/write Server: read Default: false.


Generated on Wed Jul 30 07:06:43 2008 by Doxygen 1.4.6 for ALP SDK + Hiker Documentation

Copyright © 1999-2008 ACCESS CO., LTD. All rights reserved.