Errors
[Email]


POSTAL EMAIL NOTIFICATIONS

Defines notifications sent by the EMAIL plugins,

#define ALP_POSTAL_EMAIL_NOTIFICATION_INTERVAL   1
 It notifies at every time interval. A unit is a second. The following notices support the notice by time progress.
  • ALP_POSTAL_EMAIL_NOTIFICATION_TYPE_RECEIVE_CONTINUE_BYTE(POP/IMAP)
  • ALP_POSTAL_IMAP_NOTIFICATION_TYPE_UPLOAD_CONTINUE
  • ALP_POSTAL_EMAIL_NOTIFICATION_TYPE_SEND_CONTINUE
  • ALP_POSTAL_EMAIL_NOTIFICATION_TYPE_SEARCHING_NEW_MAIL
  • ALP_POSTAL_EMAIL_NOTIFICATION_TYPE_CHECKING_ADJUSTMENT
  • ALP_POSTAL_EMAIL_NOTIFICATION_TYPE_EXECUTING_OFFLINE_DELETE_CMD
  • ALP_POSTAL_EMAIL_NOTIFICATION_TYPE_DELETE_EMAIL_ON_SERVER.

#define ALP_POSTAL_EMAIL_NOTIFICATION_TYPE_AUTH_START   203
 Sent when server attempts to authenticate to server.
#define ALP_POSTAL_EMAIL_NOTIFICATION_TYPE_CHECKING_ADJUSTMENT   209
 It notifies to the midst which is checking the adjustment of mail of a device and a server. Param1: The number which finished performing an adjustment check. Param2: In POP, The number of mails in a device. In IMAP, number of the EXISTS of SELECT response.
#define ALP_POSTAL_EMAIL_NOTIFICATION_TYPE_CONNECT_START   200
 Sent when the plugin starts to connect to the mail server.
#define ALP_POSTAL_EMAIL_NOTIFICATION_TYPE_DELETE_EMAIL_ON_SERVER   211
 It notifies to the midst which is deleting an email of the server side. Param1: The number that deletes an email of server side. Param2: Total of mail on deleted server side. (Note:The E-mail of the terminal is not deleted.).
#define ALP_POSTAL_EMAIL_NOTIFICATION_TYPE_DISCONNECT_END   202
 Sent when server ends disconnecting from the mail server.
#define ALP_POSTAL_EMAIL_NOTIFICATION_TYPE_DISCONNECT_START   201
 Sent when server starts disconnecting from the mail server.
#define ALP_POSTAL_EMAIL_NOTIFICATION_TYPE_ERROR   204
 Sent when the plugin encounters an error. Error parameter may have TCP, POSTAL, ALP or plugins-specific error.
#define ALP_POSTAL_EMAIL_NOTIFICATION_TYPE_EXECUTING_OFFLINE_DELETE_CMD   210
 It notifies to the midst which is executing offline DELETE command. Param1: The number which is processing offline DELETE command. Param2: The number of whole offline DELETE command.
#define ALP_POSTAL_EMAIL_NOTIFICATION_TYPE_RECEIVE_CONTINUE_BYTE   206
 Sent when the plugin receives another block of data when downloading a message from the server. Param1: current message we are receiving Param2: total messages we need to receive Param3: current byte we just finished downloading Param4: total bytes we need to download.
#define ALP_POSTAL_EMAIL_NOTIFICATION_TYPE_RECEIVE_END   207
 Sent when the plugin finishes receiving a message Param1: current message we just finished receiving Param2: total messages we need to download Param3: envelope id.
#define ALP_POSTAL_EMAIL_NOTIFICATION_TYPE_RECEIVE_START   205
 Sent when the plugin begins to receive a message. Param1: current message we just started receiving Param2: total messages we need to download Param3: envelope id.
#define ALP_POSTAL_EMAIL_NOTIFICATION_TYPE_SEARCHING_NEW_MAIL   208
 It notifies to the midst which is looking for newly-arrived mail. Param1: newly-arrivied mail count Param2: In POP, mail count of STAT command response. In IMAP, exists count of SELECT command response.

Email session finished result codes

Result codes sent as param1 for ALP_POSTAL_EMAIL_NOTIFICATION_TYPE_SESSION_FINISHED notifications.

#define ALP_POSTAL_EMAIL_SESSION_RESULT_DUPLICATE_SESSION   4
 Event ignored because a session already exists.
#define ALP_POSTAL_EMAIL_SESSION_RESULT_FAILURE   1
 Event failed.
#define ALP_POSTAL_EMAIL_SESSION_RESULT_FOLDER_NOT_MAPPED   7
 A sync folder does not maped. Can only be returned for sessions of type: ALP_POSTAL_EMAIL_SESSION_TYPE_IMAP_SYNC_FOLDER ALP_POSTAL_EMAIL_SESSION_TYPE_IMAP_IDLE_AND_SYNC_FOLDER.
#define ALP_POSTAL_EMAIL_SESSION_RESULT_NONE   2
 Event still in progress.
#define ALP_POSTAL_EMAIL_SESSION_RESULT_ONE_OR_MORE_MESSAGES_SENT   5
 Not currently used by the Email UI, but can be used to detect if the session caused any emails to be successfully sent from the outbox.
#define ALP_POSTAL_EMAIL_SESSION_RESULT_SUCCESS   0
 Event finished successfully.
#define ALP_POSTAL_EMAIL_SESSION_RESULT_SUCCESS_NO_NEW_ENVELOPE   6
 Event finished successfully, but no new envelope was created. Can only be returned for sessions of type: ALP_POSTAL_EMAIL_SESSION_TYPE_POP_RECEIVE_ALL ALP_POSTAL_EMAIL_SESSION_TYPE_POP_SEND_AND_RECEIVE_ALL ALP_POSTAL_EMAIL_SESSION_TYPE_IMAP_SYNC_FOLDER ALP_POSTAL_EMAIL_SESSION_TYPE_IMAP_SYNC_ALL_FOLDERS ALP_POSTAL_EMAIL_SESSION_TYPE_IMAP_SEND_AND_SYNC_FOLDER ALP_POSTAL_EMAIL_SESSION_TYPE_IMAP_SEND_AND_SYNC_ALL_FOLDERS.
#define ALP_POSTAL_EMAIL_SESSION_RESULT_USER_CANCEL   3
 Event was cancelled by user.

alp_postal_email_session_type_t session types

sent to AlpPostalEmailNotificationSessionStartingCallback sessionType parameter and to alp_postal_pop_service_get_session_info_list(), alp_postal_imap_service_get_session_info_list(),

#define ALP_POSTAL_EMAIL_SESSION_TYPE_IMAP_IDLE_AND_SYNC_FOLDER   9
 Session type used for alp_postal_imap_session_idle_folder().
#define ALP_POSTAL_EMAIL_SESSION_TYPE_IMAP_SEND   6
 Session type used for alp_postal_imap_session_send().
#define ALP_POSTAL_EMAIL_SESSION_TYPE_IMAP_SEND_AND_SYNC_ALL_FOLDERS   11
 Session type used for alp_postal_imap_session_send_and_sync_all_folders().
#define ALP_POSTAL_EMAIL_SESSION_TYPE_IMAP_SEND_AND_SYNC_FOLDER   10
 Session type used for alp_postal_imap_session_send_and_sync_folder.
#define ALP_POSTAL_EMAIL_SESSION_TYPE_IMAP_SYNC_ALL_FOLDERS   8
 Session type used for alp_postal_imap_session_sync_all_folders().
#define ALP_POSTAL_EMAIL_SESSION_TYPE_IMAP_SYNC_FOLDER   7
 Session type used for alp_postal_imap_session_sync_folder().
#define ALP_POSTAL_EMAIL_SESSION_TYPE_IMAP_VALIDATE_ACCOUNT   5
 Session type used for alp_postal_imap_session_validate_account().
#define ALP_POSTAL_EMAIL_SESSION_TYPE_POP_RECEIVE_ALL   3
 Session type used for alp_postal_pop_session_receive().
#define ALP_POSTAL_EMAIL_SESSION_TYPE_POP_SEND   2
 Session type used for alp_postal_pop_session_send().
#define ALP_POSTAL_EMAIL_SESSION_TYPE_POP_SEND_AND_RECEIVE_ALL   4
 Session type used for alp_postal_pop_session_send_and_receive_all.
#define ALP_POSTAL_EMAIL_SESSION_TYPE_POP_VALIDATE_ACCOUNT   1
 Session type used for alp_postal_pop_session_validate_account().
#define ALP_POSTAL_EMAIL_SESSION_TYPE_UNKNOWN   0
 Invalid session type - used for error cases when event id cannot be matched to session type.

Typedefs

typedef uint32_t alp_postal_email_session_result_t
 One of ALP_POSTAL_EMAIL_SESSION_RESULT_*.
typedef uint32_t alp_postal_email_session_type_t
 One of ALP_POSTAL_EMAIL_SESSION_TYPE_*.
typedef void(* AlpPostalEmailNotificationSessionFinishedCallback )(alp_postal_service_id_t serviceId, alp_postal_session_id_t sessionId, alp_postal_account_id_t accountId, alp_postal_email_session_result_t result, alp_status_t error)
 Callback used to observe ALP_POSTAL_POP_NOTIFICATION_SESSION_FINISHED and ALP_POSTAL_IMAP_NOTIFICATION_SESSION_FINISHED notifications.
typedef void(* AlpPostalEmailNotificationSessionStartingCallback )(alp_postal_service_id_t serviceId, alp_postal_session_id_t sessionId, alp_postal_account_id_t accountId, alp_postal_folder_id_t folderId, alp_postal_folder_type_t folderType, alp_postal_email_session_type_t sessionType, bool manualSync, char *accountNameP)
 Callback used to observe ALP_POSTAL_POP_NOTIFICATION_SESSION_STARTING and ALP_POSTAL_IMAP_NOTIFICATION_SESSION_STARTING notifications.
typedef void(* AlpPostalEmailNotificationSyncProgressCallback )(alp_postal_session_id_t sessionId, alp_postal_account_id_t accountId, uint32_t notificationType, alp_status_t errorCode, uint32_t param1, uint32_t param2, uint32_t param3, uint32_t param4)
 Callback describing activity for email sync sessions, sent for ALP_POSTAL_POP_NOTIFICATION_SYNC_PROGRESS and ALP_POSTAL_IMAP_NOTIFICATION_SYNC_PROGRESS.

Define Documentation

#define ALP_POSTAL_EMAIL_NOTIFICATION_INTERVAL   1
 

It notifies at every time interval. A unit is a second. The following notices support the notice by time progress.

  • ALP_POSTAL_EMAIL_NOTIFICATION_TYPE_RECEIVE_CONTINUE_BYTE(POP/IMAP)
  • ALP_POSTAL_IMAP_NOTIFICATION_TYPE_UPLOAD_CONTINUE
  • ALP_POSTAL_EMAIL_NOTIFICATION_TYPE_SEND_CONTINUE
  • ALP_POSTAL_EMAIL_NOTIFICATION_TYPE_SEARCHING_NEW_MAIL
  • ALP_POSTAL_EMAIL_NOTIFICATION_TYPE_CHECKING_ADJUSTMENT
  • ALP_POSTAL_EMAIL_NOTIFICATION_TYPE_EXECUTING_OFFLINE_DELETE_CMD
  • ALP_POSTAL_EMAIL_NOTIFICATION_TYPE_DELETE_EMAIL_ON_SERVER.

#define ALP_POSTAL_EMAIL_NOTIFICATION_TYPE_AUTH_START   203
 

Sent when server attempts to authenticate to server.

#define ALP_POSTAL_EMAIL_NOTIFICATION_TYPE_CHECKING_ADJUSTMENT   209
 

It notifies to the midst which is checking the adjustment of mail of a device and a server. Param1: The number which finished performing an adjustment check. Param2: In POP, The number of mails in a device. In IMAP, number of the EXISTS of SELECT response.

#define ALP_POSTAL_EMAIL_NOTIFICATION_TYPE_CONNECT_START   200
 

Sent when the plugin starts to connect to the mail server.

#define ALP_POSTAL_EMAIL_NOTIFICATION_TYPE_DELETE_EMAIL_ON_SERVER   211
 

It notifies to the midst which is deleting an email of the server side. Param1: The number that deletes an email of server side. Param2: Total of mail on deleted server side. (Note:The E-mail of the terminal is not deleted.).

#define ALP_POSTAL_EMAIL_NOTIFICATION_TYPE_DISCONNECT_END   202
 

Sent when server ends disconnecting from the mail server.

#define ALP_POSTAL_EMAIL_NOTIFICATION_TYPE_DISCONNECT_START   201
 

Sent when server starts disconnecting from the mail server.

#define ALP_POSTAL_EMAIL_NOTIFICATION_TYPE_ERROR   204
 

Sent when the plugin encounters an error. Error parameter may have TCP, POSTAL, ALP or plugins-specific error.

#define ALP_POSTAL_EMAIL_NOTIFICATION_TYPE_EXECUTING_OFFLINE_DELETE_CMD   210
 

It notifies to the midst which is executing offline DELETE command. Param1: The number which is processing offline DELETE command. Param2: The number of whole offline DELETE command.

#define ALP_POSTAL_EMAIL_NOTIFICATION_TYPE_RECEIVE_CONTINUE_BYTE   206
 

Sent when the plugin receives another block of data when downloading a message from the server. Param1: current message we are receiving Param2: total messages we need to receive Param3: current byte we just finished downloading Param4: total bytes we need to download.

#define ALP_POSTAL_EMAIL_NOTIFICATION_TYPE_RECEIVE_END   207
 

Sent when the plugin finishes receiving a message Param1: current message we just finished receiving Param2: total messages we need to download Param3: envelope id.

#define ALP_POSTAL_EMAIL_NOTIFICATION_TYPE_RECEIVE_START   205
 

Sent when the plugin begins to receive a message. Param1: current message we just started receiving Param2: total messages we need to download Param3: envelope id.

#define ALP_POSTAL_EMAIL_NOTIFICATION_TYPE_SEARCHING_NEW_MAIL   208
 

It notifies to the midst which is looking for newly-arrived mail. Param1: newly-arrivied mail count Param2: In POP, mail count of STAT command response. In IMAP, exists count of SELECT command response.

#define ALP_POSTAL_EMAIL_SESSION_RESULT_DUPLICATE_SESSION   4
 

Event ignored because a session already exists.

#define ALP_POSTAL_EMAIL_SESSION_RESULT_FAILURE   1
 

Event failed.

#define ALP_POSTAL_EMAIL_SESSION_RESULT_FOLDER_NOT_MAPPED   7
 

A sync folder does not maped. Can only be returned for sessions of type: ALP_POSTAL_EMAIL_SESSION_TYPE_IMAP_SYNC_FOLDER ALP_POSTAL_EMAIL_SESSION_TYPE_IMAP_IDLE_AND_SYNC_FOLDER.

#define ALP_POSTAL_EMAIL_SESSION_RESULT_NONE   2
 

Event still in progress.

#define ALP_POSTAL_EMAIL_SESSION_RESULT_ONE_OR_MORE_MESSAGES_SENT   5
 

Not currently used by the Email UI, but can be used to detect if the session caused any emails to be successfully sent from the outbox.

#define ALP_POSTAL_EMAIL_SESSION_RESULT_SUCCESS   0
 

Event finished successfully.

#define ALP_POSTAL_EMAIL_SESSION_RESULT_SUCCESS_NO_NEW_ENVELOPE   6
 

Event finished successfully, but no new envelope was created. Can only be returned for sessions of type: ALP_POSTAL_EMAIL_SESSION_TYPE_POP_RECEIVE_ALL ALP_POSTAL_EMAIL_SESSION_TYPE_POP_SEND_AND_RECEIVE_ALL ALP_POSTAL_EMAIL_SESSION_TYPE_IMAP_SYNC_FOLDER ALP_POSTAL_EMAIL_SESSION_TYPE_IMAP_SYNC_ALL_FOLDERS ALP_POSTAL_EMAIL_SESSION_TYPE_IMAP_SEND_AND_SYNC_FOLDER ALP_POSTAL_EMAIL_SESSION_TYPE_IMAP_SEND_AND_SYNC_ALL_FOLDERS.

#define ALP_POSTAL_EMAIL_SESSION_RESULT_USER_CANCEL   3
 

Event was cancelled by user.

#define ALP_POSTAL_EMAIL_SESSION_TYPE_IMAP_IDLE_AND_SYNC_FOLDER   9
 

Session type used for alp_postal_imap_session_idle_folder().

#define ALP_POSTAL_EMAIL_SESSION_TYPE_IMAP_SEND   6
 

Session type used for alp_postal_imap_session_send().

#define ALP_POSTAL_EMAIL_SESSION_TYPE_IMAP_SEND_AND_SYNC_ALL_FOLDERS   11
 

Session type used for alp_postal_imap_session_send_and_sync_all_folders().

#define ALP_POSTAL_EMAIL_SESSION_TYPE_IMAP_SEND_AND_SYNC_FOLDER   10
 

Session type used for alp_postal_imap_session_send_and_sync_folder.

#define ALP_POSTAL_EMAIL_SESSION_TYPE_IMAP_SYNC_ALL_FOLDERS   8
 

Session type used for alp_postal_imap_session_sync_all_folders().

#define ALP_POSTAL_EMAIL_SESSION_TYPE_IMAP_SYNC_FOLDER   7
 

Session type used for alp_postal_imap_session_sync_folder().

#define ALP_POSTAL_EMAIL_SESSION_TYPE_IMAP_VALIDATE_ACCOUNT   5
 

Session type used for alp_postal_imap_session_validate_account().

#define ALP_POSTAL_EMAIL_SESSION_TYPE_POP_RECEIVE_ALL   3
 

Session type used for alp_postal_pop_session_receive().

#define ALP_POSTAL_EMAIL_SESSION_TYPE_POP_SEND   2
 

Session type used for alp_postal_pop_session_send().

#define ALP_POSTAL_EMAIL_SESSION_TYPE_POP_SEND_AND_RECEIVE_ALL   4
 

Session type used for alp_postal_pop_session_send_and_receive_all.

#define ALP_POSTAL_EMAIL_SESSION_TYPE_POP_VALIDATE_ACCOUNT   1
 

Session type used for alp_postal_pop_session_validate_account().

#define ALP_POSTAL_EMAIL_SESSION_TYPE_UNKNOWN   0
 

Invalid session type - used for error cases when event id cannot be matched to session type.

Typedef Documentation

typedef uint32_t alp_postal_email_session_result_t
 

One of ALP_POSTAL_EMAIL_SESSION_RESULT_*.

typedef uint32_t alp_postal_email_session_type_t
 

One of ALP_POSTAL_EMAIL_SESSION_TYPE_*.

typedef void(* AlpPostalEmailNotificationSessionFinishedCallback)(alp_postal_service_id_t serviceId, alp_postal_session_id_t sessionId, alp_postal_account_id_t accountId, alp_postal_email_session_result_t result, alp_status_t error)
 

Callback used to observe ALP_POSTAL_POP_NOTIFICATION_SESSION_FINISHED and ALP_POSTAL_IMAP_NOTIFICATION_SESSION_FINISHED notifications.

This notification can be used by the UI to help keep track of email sessions starting up in the postal service

Remarks:
Use * alp_postal_pop_service_get_session_info_list() and alp_postal_imap_service_get_session_info_list() to get a list of email sessions already in progress.
Parameters:
[in] serviceId Service ID of the session that just finished
[in] sessionId The session the notification is being sent for
[in] result One of ALP_POSTAL_EMAIL_SESSION_RESULT_*
[in] error One of ALP_POSTAL_EMAIL_ERROR_* see postal_email_notifications.h

typedef void(* AlpPostalEmailNotificationSessionStartingCallback)(alp_postal_service_id_t serviceId, alp_postal_session_id_t sessionId, alp_postal_account_id_t accountId, alp_postal_folder_id_t folderId, alp_postal_folder_type_t folderType, alp_postal_email_session_type_t sessionType, bool manualSync, char *accountNameP)
 

Callback used to observe ALP_POSTAL_POP_NOTIFICATION_SESSION_STARTING and ALP_POSTAL_IMAP_NOTIFICATION_SESSION_STARTING notifications.

This notification can be used by the UI to help keep track of email sessions starting up in the postal service

Remarks:
Use * alp_postal_pop_service_get_session_info_list() and alp_postal_imap_service_get_session_info_list() to get a list of email sessions already in progress.
Parameters:
[in] serviceId The service the session is being run by
[in] sessionId The session the notification is being sent for
[in] accountId The account the notification is being sent for
[in] folderId The folder the session is operating on
[in] folderTypeId The type of folder the session operates on.
[in] sessionType ALP_POSTAL_EMAIL_SESSION_TYPE_*
[in] manualSync The session was started by manual request from the user
[in] accountName The friendly name of the account the session is starting for.

typedef void(* AlpPostalEmailNotificationSyncProgressCallback)(alp_postal_session_id_t sessionId, alp_postal_account_id_t accountId, uint32_t notificationType, alp_status_t errorCode, uint32_t param1, uint32_t param2, uint32_t param3, uint32_t param4)
 

Callback describing activity for email sync sessions, sent for ALP_POSTAL_POP_NOTIFICATION_SYNC_PROGRESS and ALP_POSTAL_IMAP_NOTIFICATION_SYNC_PROGRESS.

Details about the meaning of each parameter are described with the notification types and error codes above.

Parameters:
[in] sessionId The session the notification is being sent for
[in] accountId The account the notification is being sent for
[in] notificationType ALP_POSTAL_EMAIL_NOTIFICATION_TYPE_*
[in] errorCode 0=success, (see *EMAIL_ERROR*, above)
[in] param1 Specific information relavent to the notificationType
[in] param2 Specific information relavent to the notificationType
[in] param3 Specific information relavent to the notificationType
[in] param4 Specific information relavent to the notificationType

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.