include/alp/postal_pop_session.h File Reference

Detailed Description

Postal POP Session related APIs.

#include <alp/postal_types.h>
#include <alp/postal_envelope.h>
#include <alp/postal_session.h>
#include <alp/postal_email_notifications.h>
#include <alp/postal_notification.h>

Go to the source code of this file.

Data Structures

struct _AlpPostalPopSessionInfoType

Pop session Info datatype includes some interesting information about active async POP sessions found with alp_postal_pop_service_get_session_info_list(). More...

POP session notifications

Defines notifications generated by POP session API's

#define ALP_POSTAL_POP_NOTIFICATION_SESSION_FINISHED

Sent once when a POP session completes for any reason. The UI should register an AlpPostalEmailNotificationSessionFinishedCallback handler to observe these notifications.

#define ALP_POSTAL_POP_NOTIFICATION_SESSION_STARTING

Sent once when a POP session first starts up. The UI should register an AlpPostalEmailNotificationSessionStartingCallback handler to observe these notifications.

#define ALP_POSTAL_POP_NOTIFICATION_SYNC_PROGRESS

The following postal service notification is broadcast throughout the course of a POP sync session. It is used to give an observing application some insight into what is currently going on in the sync session so that it can update a progress dialog.

Typedefs

typedef void(* AlpPostalPOPSessionReceiveAccountAsyncReplyCallback )(alp_postal_session_id_t oSessiontId, alp_postal_account_id_t oAccountId, alp_status_t oRequestResult)

Postal session receive account async response callback sent to alp_postal_pop_session_receive().

typedef void(* AlpPostalPOPSessionSendAccountAsyncReplyCallback )(alp_postal_session_id_t oSessiontId, alp_postal_account_id_t oAccountId, alp_status_t oRequestResult)

Postal session send account async response callback sent to alp_postal_pop_session_send().

typedef void(* AlpPostalPOPSessionSendAndReceiveAllAsyncReplyCallback )(alp_postal_session_id_t iSessiontId, alp_postal_account_id_t iAccountId, alp_status_t iRequestResult)

Postal session send and receive account async response callback sent to alp_postal_pop_session_send_and_receive_all().

typedef void(* AlpPostalPOPSessionValidateAccountAsyncReplyCallback )(alp_postal_session_id_t oSessiontId, alp_postal_account_id_t oAccountId, alp_status_t oRequestResult)

Postal session validate POP account async response callback.

Functions

alp_status_t alp_postal_pop_session_cancel (alp_postal_session_id_t iSessionId)

Cancel a Sync operation.

alp_status_t alp_postal_pop_session_receive (alp_postal_session_id_t iSessionId, bool iManual, AlpPostalPOPSessionReceiveAccountAsyncReplyCallback iCallbackFuncP)

Syncs with a POP server, downloading new messages and deleting messages from the server or moving them to the Deleted Items folder according to the other POP account properties.

alp_status_t alp_postal_pop_session_send (alp_postal_session_id_t iSessionId, bool iManual, AlpPostalPOPSessionSendAccountAsyncReplyCallback iCallbackFuncP)

Syncs with a SMTP server, sending messages from the Outbox and moving them to the Sent Items folder respecting any SMTP-related account properties defined in the current account.

alp_status_t alp_postal_pop_session_send_and_receive_all (alp_postal_session_id_t iSessionId, bool iManual, AlpPostalPOPSessionSendAndReceiveAllAsyncReplyCallback iCallbackFuncP)

SMTP send and Syncs with a POP server, downloading new messages and deleting messages from the server or moving them to the Deleted Items folder according to the other POP account properties.

alp_status_t alp_postal_pop_session_validate_account (alp_postal_session_id_t iSessionId, AlpPostalPOPSessionValidateAccountAsyncReplyCallback iCallbackFuncP)

Validates POP account settings. Should only be called during account setup. Checks the POP account for required capabilities and returns results to the async callback.

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


Data Structures
struct	_AlpPostalPopSessionInfoType
	Pop session Info datatype includes some interesting information about active async POP sessions found with alp_postal_pop_service_get_session_info_list(). More...
POP session notifications
Defines notifications generated by POP session API's
#define	ALP_POSTAL_POP_NOTIFICATION_SESSION_FINISHED
	Sent once when a POP session completes for any reason. The UI should register an AlpPostalEmailNotificationSessionFinishedCallback handler to observe these notifications.
#define	ALP_POSTAL_POP_NOTIFICATION_SESSION_STARTING
	Sent once when a POP session first starts up. The UI should register an AlpPostalEmailNotificationSessionStartingCallback handler to observe these notifications.
#define	ALP_POSTAL_POP_NOTIFICATION_SYNC_PROGRESS
	The following postal service notification is broadcast throughout the course of a POP sync session. It is used to give an observing application some insight into what is currently going on in the sync session so that it can update a progress dialog.
Typedefs
typedef void(*	AlpPostalPOPSessionReceiveAccountAsyncReplyCallback )(alp_postal_session_id_t oSessiontId, alp_postal_account_id_t oAccountId, alp_status_t oRequestResult)
	Postal session receive account async response callback sent to alp_postal_pop_session_receive().
typedef void(*	AlpPostalPOPSessionSendAccountAsyncReplyCallback )(alp_postal_session_id_t oSessiontId, alp_postal_account_id_t oAccountId, alp_status_t oRequestResult)
	Postal session send account async response callback sent to alp_postal_pop_session_send().
typedef void(*	AlpPostalPOPSessionSendAndReceiveAllAsyncReplyCallback )(alp_postal_session_id_t iSessiontId, alp_postal_account_id_t iAccountId, alp_status_t iRequestResult)
	Postal session send and receive account async response callback sent to alp_postal_pop_session_send_and_receive_all().
typedef void(*	AlpPostalPOPSessionValidateAccountAsyncReplyCallback )(alp_postal_session_id_t oSessiontId, alp_postal_account_id_t oAccountId, alp_status_t oRequestResult)
	Postal session validate POP account async response callback.
Functions
alp_status_t	alp_postal_pop_session_cancel (alp_postal_session_id_t iSessionId)
	Cancel a Sync operation.
alp_status_t	alp_postal_pop_session_receive (alp_postal_session_id_t iSessionId, bool iManual, AlpPostalPOPSessionReceiveAccountAsyncReplyCallback iCallbackFuncP)
	Syncs with a POP server, downloading new messages and deleting messages from the server or moving them to the Deleted Items folder according to the other POP account properties.
alp_status_t	alp_postal_pop_session_send (alp_postal_session_id_t iSessionId, bool iManual, AlpPostalPOPSessionSendAccountAsyncReplyCallback iCallbackFuncP)
	Syncs with a SMTP server, sending messages from the Outbox and moving them to the Sent Items folder respecting any SMTP-related account properties defined in the current account.
alp_status_t	alp_postal_pop_session_send_and_receive_all (alp_postal_session_id_t iSessionId, bool iManual, AlpPostalPOPSessionSendAndReceiveAllAsyncReplyCallback iCallbackFuncP)
	SMTP send and Syncs with a POP server, downloading new messages and deleting messages from the server or moving them to the Deleted Items folder according to the other POP account properties.
alp_status_t	alp_postal_pop_session_validate_account (alp_postal_session_id_t iSessionId, AlpPostalPOPSessionValidateAccountAsyncReplyCallback iCallbackFuncP)
	Validates POP account settings. Should only be called during account setup. Checks the POP account for required capabilities and returns results to the async callback.