Session
[POP]


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.

Define Documentation

#define ALP_POSTAL_POP_NOTIFICATION_SESSION_FINISHED
 

Value:

ALP_POSTAL_NOTIFICATION(ALP_POSTAL_SERVICE_ID_POP, \
        ALP_POSTAL_POP_SERVICE_CLASS_ID_SESSION, 3)
Sent once when a POP session completes for any reason. The UI should register an AlpPostalEmailNotificationSessionFinishedCallback handler to observe these notifications.

Remarks:
This notification is needed separately from the SYNC_PROGRESS notification because the UI will be interested in knowning about new sessions anytime it is running, not just when the sync progress dialog is displayed..

#define ALP_POSTAL_POP_NOTIFICATION_SESSION_STARTING
 

Value:

ALP_POSTAL_NOTIFICATION(ALP_POSTAL_SERVICE_ID_POP, \
        ALP_POSTAL_POP_SERVICE_CLASS_ID_SESSION, 2)
Sent once when a POP session first starts up. The UI should register an AlpPostalEmailNotificationSessionStartingCallback handler to observe these notifications.

Remarks:
This notification is needed separately from the SYNC_PROGRESS notification because the UI will be interested in knowning about new sessions anytime it is running, not just when the sync progress dialog is displayed..

#define ALP_POSTAL_POP_NOTIFICATION_SYNC_PROGRESS
 

Value:

ALP_POSTAL_NOTIFICATION(ALP_POSTAL_SERVICE_ID_POP, \
        ALP_POSTAL_POP_SERVICE_CLASS_ID_SESSION, 1)
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.

The UI should register an AlpPostalEmailNotificationSyncProgressCallback which is common to both this and other email plugin sync progress notifications, where the notificationType parameter given to the callback will be one of ALP_POSTAL_EMAIL_NOTIFICATION_TYPE_*, and the errors corresponding to each notification type are described above.

Remarks:
Note this notification can only be generated if the UI has called alp_postal_pop_service_enable_sync_progress_notifications(true)
With each notification, the POP plugin will package up the following data
  • alp_postal_session_id_t sessionId
  • alp_postal_account_id_t accountId
  • uint32_t notificationType (see ALP_POSTAL_POP_NOTIFICATION_TYPE_*)
  • uint32_t param1 (Example: curr message num)
  • uint32_t param2 (Example: total msgs to download)
  • uint32_t param3 (Example: curr byte num
  • uint32_t param4 (Example: total bytes to download)
  • alp_status_t err;

Typedef Documentation

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().

Parameters:
[in] oSessionId The Postal Session id on which the request has been invoked.
[in] oAccountId The Postal Account id that was synced
[in] oRequestResult The result of the request.

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().

Parameters:
[out] oSessionId The Postal Session id on which the request has been invoked.
[out] oAccountId The Postal Account id that was synced
[out] oRequestResult The result of the request.

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().

Parameters:
[in] iSessionId The Postal Session id on which the request has been invoked.
[in] iAccountId The Postal Account id that was synced
[in] iRequestResult The result of the request.

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.

Parameters:
[in] oSessionId The Postal Session id on which the request has been invoked.
[in] oAccountId The Postal Account id that was validated
[in] oRequestResult The result of the request.

Function Documentation

alp_status_t alp_postal_pop_session_cancel (  alp_postal_session_id_t  iSessionId  ) 
 

Cancel a Sync operation.

Parameters:
[in] iSessionId The session Id on which the request must be cancelled.
Returns:
Returns an error code.

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.

Parameters:
[in] iSessionId The session Id to work on.
[in] iCallbackFuncP The call back function to be called. May be NULL if the caller doesn't care about the result value.
[in] iManual The flag to set conncetion flags to foreground(if true)/background mode
Returns:
Returns an error code.

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.

Parameters:
[in] iSessionId The session Id to work on.
[in] iCallbackFuncP The call back function to be called. May be NULL if the caller doesn't care about the result value.
[in] iManual The flag to set conncetion flags to foreground(if true)/background mode
Returns:
Returns an error code.

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.

Parameters:
[in] iSessionId The session Id to work on.
[in] iCallbackFuncP The call back function to be called. May be NULL if the caller doesn't care about the result value.
[in] iManual The flag to set conncetion flags to foreground(if true)/background mode
Returns:
Returns an error code.

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.

Parameters:
[in] iSessionId The session Id to work on.
[in] iCallbackFuncP The call back function to be called. May be NULL if the caller doesn't care about the result value.
Returns:
Returns an error code.

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.