|
POSTAL SESSION NOTIFICATIONS |
Defines session notifications.
|
| #define | ALP_POSTAL_NOTIFICATION_SESSION_RECEIVING_PROGRESS ALP_POSTAL_NOTIFICATION(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_SESSION, 3) |
| | session envelope receiving progress notification.
|
| #define | ALP_POSTAL_NOTIFICATION_SESSION_SENDING_PROGRESS ALP_POSTAL_NOTIFICATION(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_SESSION, 2) |
| | session envelope sending progress notification.
|
| #define | ALP_POSTAL_NOTIFICATION_SESSION_STATUS_CHANGE ALP_POSTAL_NOTIFICATION(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_SESSION, 1) |
| | session state change.
|
POSTAL SESSION STATUS |
Defines the session status provided by the ALP_POSTAL_NOTIFICATION_SESSION_STATUS_CHANGED notification callback.
|
| #define | ALP_POSTAL_SESSION_STATUS_CONNECTED ((alp_postal_session_status_t)3) |
| | The session has been connected.
|
| #define | ALP_POSTAL_SESSION_STATUS_CONNECTING ((alp_postal_session_status_t)2) |
| | The session is connecting.
|
| #define | ALP_POSTAL_SESSION_STATUS_CREATED ((alp_postal_session_status_t)0) |
| | The session has been created.
|
| #define | ALP_POSTAL_SESSION_STATUS_DELETED ((alp_postal_session_status_t)1) |
| | The session has been connected.
|
| #define | ALP_POSTAL_SESSION_STATUS_DISCONNECTED ((alp_postal_session_status_t)5) |
| | The session has been disconnected.
|
| #define | ALP_POSTAL_SESSION_STATUS_DISCONNECTING ((alp_postal_session_status_t)4) |
| | The session is connecting.
|
Defines |
| #define | ALP_POSTAL_SESSION_INVALID_ID ((alp_postal_session_id_t)0) |
| | Invalid Session ID definition.
|
Typedefs |
| typedef uint8_t | alp_postal_session_status_t |
| | Session status change type.
|
| typedef void(* | AlpPostalNotificationSessionReceivingProgressCallback )(alp_postal_service_id_t iServiceId, alp_postal_session_id_t iSessiontId, alp_postal_envelope_id_t iEnvelopeId, AlpPostalProgressInfo *iProgressInfoP) |
| | Postal Session Envelope Receiving In Progress Notification Callback.
|
| typedef void(* | AlpPostalNotificationSessionSendingProgressCallback )(alp_postal_service_id_t iServiceId, alp_postal_session_id_t iSessiontId, alp_postal_envelope_id_t iEnvelopeId, AlpPostalProgressInfo *iProgressInfoP) |
| | Postal Session Envelope Sending In Progress Notification Callback.
|
| typedef void(* | AlpPostalNotificationSessionStatusChangedCallback )(alp_postal_service_id_t iServiceId, alp_postal_session_id_t iSessiontId, alp_postal_session_status_t iSessionStatus) |
| | Postal Session Status change Notification Callback.
|
| typedef void(* | AlpPostalSessionConnectAsyncReplyCallback )(alp_postal_service_id_t oServiceId, alp_postal_session_id_t iSessiontId, alp_status_t iRequestResult) |
| | Postal Session Connection request async response Callback.
|
| typedef void(* | AlpPostalSessionDisconnectAsyncReplyCallback )(alp_postal_service_id_t iServiceId, alp_postal_session_id_t iSessiontId, alp_status_t iRequestResult) |
| | Postal Session Disconnection request async response Callback.
|
| typedef void(* | AlpPostalSessionReceiveAllEnvelopesAsyncReplyCallback )(alp_postal_service_id_t iServiceId, alp_postal_session_id_t iSessiontId, alp_postal_envelope_id_t iLastReceivedEnvelopeId, AlpPostalProgressInfo *iTotalProgressP, AlpPostalProgressInfo *iEnvProgressP, alp_status_t iRequestResult) |
| | Postal Session Receive All Envelopes request async response Callback.
|
| typedef void(* | AlpPostalSessionSendAllEnvelopesAsyncReplyCallback )(alp_postal_service_id_t iServiceId, alp_postal_session_id_t iSessiontId, alp_postal_envelope_id_t iLastSentEnvelopeId, AlpPostalProgressInfo *iTotalProgressInfoP, AlpPostalProgressInfo *iProgressInfoP, alp_status_t iRequestResult) |
| | Postal Session Send all Envelopes request async response Callback.
|
| typedef void(* | AlpPostalSessionSendEnvelopeAsyncReplyCallback )(alp_postal_service_id_t iServiceId, alp_postal_session_id_t iSessiontId, alp_postal_envelope_id_t iSentEnvelopeId, AlpPostalProgressInfo *iProgressInfoP, alp_status_t iRequestResult) |
| | Postal Session Send Envelope request async response Callback.
|
| typedef void(* | AlpPostalSessionSendStoredEnvelopeAsyncReplyCallback )(alp_postal_service_id_t iServiceId, alp_postal_session_id_t iSessiontId, alp_postal_envelope_id_t iSentEnvelopeId, AlpPostalProgressInfo *iProgressInfoP, alp_status_t iRequestResult) |
| | Postal Session Send Stored envelope request async response Callback.
|
Functions |
| alp_status_t | alp_postal_session_cancel_connect (alp_postal_service_id_t iServiceId, alp_postal_session_id_t iSessionId) |
| | Cancel a session connection request.
|
| alp_status_t | alp_postal_session_cancel_disconnect (alp_postal_service_id_t iServiceId, alp_postal_session_id_t iSessionId) |
| | Cancel a session disconnection request.
|
| alp_status_t | alp_postal_session_cancel_receive_all_envelopes (alp_postal_service_id_t iServiceId, alp_postal_session_id_t iSessionId) |
| | Cancel a receive all envelopes request.
|
| alp_status_t | alp_postal_session_cancel_send_all_envelopes (alp_postal_service_id_t iServiceId, alp_postal_session_id_t iSessionId) |
| | Cancel a send all envelopes request.
|
| alp_status_t | alp_postal_session_cancel_send_envelope (alp_postal_service_id_t iServiceId, alp_postal_session_id_t iSessionId) |
| | Cancel a send envelope request.
|
| alp_status_t | alp_postal_session_cancel_send_stored_envelope (alp_postal_service_id_t iServiceId, alp_postal_session_id_t iSessionId) |
| | Cancel a send stored envelope request.
|
| alp_status_t | alp_postal_session_cancel_send_stored_envelope_by_envelope_id (alp_postal_service_id_t iServiceId, alp_postal_session_id_t iSessionId, alp_postal_envelope_id_t iEnvelopeId) |
| | Cancel a send stored envelope request using an envelope identifier.
|
| alp_status_t | alp_postal_session_connect (alp_postal_service_id_t iServiceId, alp_postal_session_id_t iSessionId, char *iReceivePasswd, char *iSendPasswd, AlpPostalSessionConnectAsyncReplyCallback iCallbackFuncP) |
| | Connect the given session - async request.
|
| alp_status_t | alp_postal_session_delete (alp_postal_service_id_t iServiceId, alp_postal_session_id_t iSessionId) |
| | Delete the given session.
|
| alp_status_t | alp_postal_session_delete_envelopes (alp_postal_service_id_t iServiceId, alp_postal_session_id_t iSessionId, AlpPostalSearchNode *iFilterP) |
| | Delete all the envelope that match the provided filter criteria.
|
| alp_status_t | alp_postal_session_disconnect (alp_postal_service_id_t iServiceId, alp_postal_session_id_t iSessionId, AlpPostalSessionDisconnectAsyncReplyCallback iCallbackFuncP) |
| | Disconnect the given session - async request.
|
| alp_status_t | alp_postal_session_free_session_id_list (AlpPostalSessionIdList *iSessionIdListP) |
| | Free the list of Postal session Identifier.
|
| alp_status_t | alp_postal_session_get_account_id (alp_postal_service_id_t iServiceId, alp_postal_session_id_t iSessionId, alp_postal_account_id_t *oAccountIdP) |
| | Return the unique account id associated with the given session id.
|
| alp_status_t | alp_postal_session_get_connection_status (alp_postal_service_id_t iServiceId, alp_postal_session_id_t iSessionId, alp_postal_session_status_t *oSessionStatusP) |
| | Return the status of the session.
|
| alp_status_t | alp_postal_session_get_root_folder (alp_postal_service_id_t iServiceId, alp_postal_session_id_t iSessionId, alp_postal_folder_id_t *oFolderIdP) |
| | Get the root folder Id of the given session Id.
|
| alp_status_t | alp_postal_session_get_special_folder (alp_postal_service_id_t iServiceId, alp_postal_session_id_t iSessionId, alp_postal_folder_type_t iFolderType, alp_postal_folder_id_t *oFolderIdP) |
| | Get a special folder id of a session.
|
| alp_status_t | alp_postal_session_receive_all_envelopes (alp_postal_service_id_t iServiceId, alp_postal_session_id_t iSessionId, AlpPostalSessionReceiveAllEnvelopesAsyncReplyCallback iCallbackFuncP) |
| | Try to retrieve some envelopes - async request.
|
| alp_status_t | alp_postal_session_send_all_envelopes (alp_postal_service_id_t iServiceId, alp_postal_session_id_t iSessionId, AlpPostalSessionSendAllEnvelopesAsyncReplyCallback iCallbackFuncP) |
| | Send all the envelope in the outbox folder - async request.
|
| alp_status_t | alp_postal_session_send_envelope (alp_postal_service_id_t iServiceId, alp_postal_session_id_t iSessionId, AlpPostalEnvelope *iEnvelopeP, AlpPostalSessionSendEnvelopeAsyncReplyCallback iCallbackFuncP) |
| | Send an envelope structure - async request.
|
| alp_status_t | alp_postal_session_send_stored_envelope (alp_postal_service_id_t iServiceId, alp_postal_session_id_t iSessionId, alp_postal_envelope_id_t iEnvelopeId, AlpPostalSessionSendStoredEnvelopeAsyncReplyCallback iCallbackFuncP) |
| | Send a stored envelope - async request.
|
| alp_status_t | alp_postal_session_set_app_id (alp_postal_service_id_t iServiceId, alp_postal_session_id_t iSessionId, char *iAppIdP) |
| | Assign an application ID to a postal service session.
|
Copyright © 1999-2008 ACCESS CO., LTD. All rights reserved.
