include/alp/postal_pop_account.h File Reference

Detailed Description

POP Account properties.

Notes:

See postal_account.h for additional common account properties

#include <alp/postal_types.h>
#include <alp/postal_property.h>
#include <alp/postal_service.h>
#include <alp/postal_envelope.h>

Go to the source code of this file.

POP ACCOUNT PROPERTIES

Defines the POP account properties.

#define ALP_POSTAL_POP_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_POP_PROPERTY_ACCOUNT_DOWNLOAD_BEHAVIOR_TYPE

Download user type The type in which download conditions. Status: Required Client: read/write Server: read Default: 0 = EMAIL_BEHAVIOR_TYPE_SECONDARY.

#define ALP_POSTAL_POP_PROPERTY_ACCOUNT_DOWNLOAD_ORDER_TYPE

Download order type Order at the time of ALP_POSTAL_POP_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_POP_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_POP_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_POP_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_POP_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_POP_PROPERTY_ACCOUNT_HEADERS_ONLY

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

#define ALP_POSTAL_POP_PROPERTY_ACCOUNT_INCLUDE_IN_SCHEDULED_SYNC

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

#define ALP_POSTAL_POP_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_POP_PROPERTY_ACCOUNT_INCOMING_VALIDATED

Property is set when the incoming account is successfully validated Status: Required Client: read Server: write Default: 0 = Account is not validated.

#define ALP_POSTAL_POP_PROPERTY_ACCOUNT_IS_PROVISIONED

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

#define ALP_POSTAL_POP_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_POP_PROPERTY_ACCOUNT_LAST_UID

Last UID which POP read Status: Required Client: read/write Server: read Default:.

#define ALP_POSTAL_POP_PROPERTY_ACCOUNT_LOGIN_ID

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

#define ALP_POSTAL_POP_PROPERTY_ACCOUNT_LOGIN_PASSWORD

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

#define ALP_POSTAL_POP_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_POP_PROPERTY_ACCOUNT_OUTGOING_VALIDATED

Property is set when the outgoing account is successfully validated Status: Required Client: read Server: write Default: 0 = Account is not validated.

#define ALP_POSTAL_POP_PROPERTY_ACCOUNT_REPLY_TO_ADDRESS

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

#define ALP_POSTAL_POP_PROPERTY_ACCOUNT_SERVER_ADDRESS

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

#define ALP_POSTAL_POP_PROPERTY_ACCOUNT_SERVER_PORT

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

#define ALP_POSTAL_POP_PROPERTY_ACCOUNT_SOCKET_TIMEOUT_SECONDS

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

#define ALP_POSTAL_POP_PROPERTY_ACCOUNT_USE_APOP

Use APOP Status: Optional Client: read/write Server: read Default: true.

#define ALP_POSTAL_POP_PROPERTY_ACCOUNT_USE_SSL

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

#define ALP_POSTAL_POP_PROPERTY_ACCOUNT_VERSION

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

#define ALP_POSTAL_POP_PROPERTY_EMAIL_ADDRESS

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

#define ALP_POSTAL_POP_PROPERTY_LEAVE_MAIL_ON_SERVER

If property is set, then after the entire message is successfully downloaded, the message is deleted from the server. Status: Optional Client: read/write Server: read Default: 0 = delete messages after downloading.

#define ALP_POSTAL_POP_PROPERTY_REMOVE_DELETED_MAIL

While property is set, the act of moving a message to the Trash folder on the device will create an "action item" to delete that message from the server. Moving a message out of the trash should remove any pending action items to delete that message on the server.

#define ALP_POSTAL_POP_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_POP_PROPERTY_SMTP_ACCOUNT_SERVER_ADDRESS

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

#define ALP_POSTAL_POP_PROPERTY_SMTP_ACCOUNT_SERVER_PORT

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

#define ALP_POSTAL_POP_PROPERTY_SMTP_BCC

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

#define ALP_POSTAL_POP_PROPERTY_SMTP_BCC_TO_ADDRESS

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

#define ALP_POSTAL_POP_PROPERTY_SMTP_ENCRYPTION

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

#define ALP_POSTAL_POP_PROPERTY_SMTP_LOGIN_ID

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

#define ALP_POSTAL_POP_PROPERTY_SMTP_LOGIN_PASSWORD

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

#define ALP_POSTAL_POP_PROPERTY_SMTP_POP_BEFORE_SMTP_INTERVAL

SMTP POP_BEFORE_SMTP_INTERVAL property If >0, the plugin uses POP before SMTP authentication method waiting for "interval" value after POP authentication before connecting to SMTP server Status: Optional Client: read/write Server: read Default: 0.

#define ALP_POSTAL_POP_PROPERTY_SMTP_SIGNATURE

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

#define ALP_POSTAL_POP_PROPERTY_SMTP_USE_INCOMING_CREDENTIALS

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

#define ALP_POSTAL_POP_PROPERTY_SMTP_USE_SIGNATURE

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

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


POP ACCOUNT PROPERTIES
Defines the POP account properties.
#define	ALP_POSTAL_POP_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_POP_PROPERTY_ACCOUNT_DOWNLOAD_BEHAVIOR_TYPE
	Download user type The type in which download conditions. Status: Required Client: read/write Server: read Default: 0 = EMAIL_BEHAVIOR_TYPE_SECONDARY.
#define	ALP_POSTAL_POP_PROPERTY_ACCOUNT_DOWNLOAD_ORDER_TYPE
	Download order type Order at the time of ALP_POSTAL_POP_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_POP_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_POP_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_POP_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_POP_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_POP_PROPERTY_ACCOUNT_HEADERS_ONLY
	Download headers only Status: Optional Client: read/write Server: read Default: false.
#define	ALP_POSTAL_POP_PROPERTY_ACCOUNT_INCLUDE_IN_SCHEDULED_SYNC
	Include this account in scheduled syncs Status: Optional Client: read/write Server: Ignore Default: false.
#define	ALP_POSTAL_POP_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_POP_PROPERTY_ACCOUNT_INCOMING_VALIDATED
	Property is set when the incoming account is successfully validated Status: Required Client: read Server: write Default: 0 = Account is not validated.
#define	ALP_POSTAL_POP_PROPERTY_ACCOUNT_IS_PROVISIONED
	Whether or not the account is provisioned. Status: Optional Client: read/write Server: Ignore Default: false.
#define	ALP_POSTAL_POP_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_POP_PROPERTY_ACCOUNT_LAST_UID
	Last UID which POP read Status: Required Client: read/write Server: read Default:.
#define	ALP_POSTAL_POP_PROPERTY_ACCOUNT_LOGIN_ID
	POP Server Login ID Status: Required Client: read/write Server: read Default:.
#define	ALP_POSTAL_POP_PROPERTY_ACCOUNT_LOGIN_PASSWORD
	POP Server Login Password Status: Required Client: read/write Server: read Default:.
#define	ALP_POSTAL_POP_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_POP_PROPERTY_ACCOUNT_OUTGOING_VALIDATED
	Property is set when the outgoing account is successfully validated Status: Required Client: read Server: write Default: 0 = Account is not validated.
#define	ALP_POSTAL_POP_PROPERTY_ACCOUNT_REPLY_TO_ADDRESS
	The reply-to email address. Status: Optional Client: read/write Server: read Default: Empty.
#define	ALP_POSTAL_POP_PROPERTY_ACCOUNT_SERVER_ADDRESS
	POP Server Address Status: Required Client: read/write Server: read Default:.
#define	ALP_POSTAL_POP_PROPERTY_ACCOUNT_SERVER_PORT
	POP Server Port Status: Required Client: read/write Server: read Default: 110.
#define	ALP_POSTAL_POP_PROPERTY_ACCOUNT_SOCKET_TIMEOUT_SECONDS
	TCP Socket Timeout (seconds) Status: Required Client: read/write Server: read Default: 10.
#define	ALP_POSTAL_POP_PROPERTY_ACCOUNT_USE_APOP
	Use APOP Status: Optional Client: read/write Server: read Default: true.
#define	ALP_POSTAL_POP_PROPERTY_ACCOUNT_USE_SSL
	Use SSL Status: Optional Client: read/write Server: read Default: false.
#define	ALP_POSTAL_POP_PROPERTY_ACCOUNT_VERSION
	Version of account datatype Status: Required Client: read/write Server: read Default: 1.
#define	ALP_POSTAL_POP_PROPERTY_EMAIL_ADDRESS
	User's email address (ie joe@hotmail.com) Status: Optional Client: read/write Server: Ignore Default: Empty.
#define	ALP_POSTAL_POP_PROPERTY_LEAVE_MAIL_ON_SERVER
	If property is set, then after the entire message is successfully downloaded, the message is deleted from the server. Status: Optional Client: read/write Server: read Default: 0 = delete messages after downloading.
#define	ALP_POSTAL_POP_PROPERTY_REMOVE_DELETED_MAIL
	While property is set, the act of moving a message to the Trash folder on the device will create an "action item" to delete that message from the server. Moving a message out of the trash should remove any pending action items to delete that message on the server.
#define	ALP_POSTAL_POP_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_POP_PROPERTY_SMTP_ACCOUNT_SERVER_ADDRESS
	SMTP Server Address Status: Required Client: read/write Server: read Default:.
#define	ALP_POSTAL_POP_PROPERTY_SMTP_ACCOUNT_SERVER_PORT
	SMTP Server Port Status: Required Client: read/write Server: read Default: 25.
#define	ALP_POSTAL_POP_PROPERTY_SMTP_BCC
	SMTP BCC TO property Status: Optional Client: read/write Server: read Default: off.
#define	ALP_POSTAL_POP_PROPERTY_SMTP_BCC_TO_ADDRESS
	SMTP BCC TO ADDRESS property Status: Optional Client: read/write Server: read Default:.
#define	ALP_POSTAL_POP_PROPERTY_SMTP_ENCRYPTION
	SMTP ENCRYPTION property Status: Required Client: read/write Server: read Default: 0 = EMAIL_ENCRYPTION_TYPE_NONE.
#define	ALP_POSTAL_POP_PROPERTY_SMTP_LOGIN_ID
	SMTP Login ID Status: Required Client: read/write Server: read Default:.
#define	ALP_POSTAL_POP_PROPERTY_SMTP_LOGIN_PASSWORD
	SMTP Login Password Status: Required Client: read/write Server: read Default:.
#define	ALP_POSTAL_POP_PROPERTY_SMTP_POP_BEFORE_SMTP_INTERVAL
	SMTP POP_BEFORE_SMTP_INTERVAL property If >0, the plugin uses POP before SMTP authentication method waiting for "interval" value after POP authentication before connecting to SMTP server Status: Optional Client: read/write Server: read Default: 0.
#define	ALP_POSTAL_POP_PROPERTY_SMTP_SIGNATURE
	SMTP Signature property Status: Required Client: read/write Server: read Default:.
#define	ALP_POSTAL_POP_PROPERTY_SMTP_USE_INCOMING_CREDENTIALS
	SMTP Reuse POP user/pass credentials to login to SMTP server. If enabled, the plugin ignores the SMTP user/pass and uses the POP Status: Required Client: read/write Server: read Default: false.
#define	ALP_POSTAL_POP_PROPERTY_SMTP_USE_SIGNATURE
	SMTP Use Signature property Status: Required Client: read/write Server: read Default: false.