Session
[Protocol Common Services]

---

Detailed Description

Common Session APIs.

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.

---

Define Documentation

#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.

#define ALP_POSTAL_SESSION_INVALID_ID   ((alp_postal_session_id_t)0)

Invalid Session ID definition.

#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.

---

Typedef Documentation

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. Parameters: [in]  iServiceId  The serviceId that is unique among all services. [in]  iSessionId  The Postal Session id, which the status changed. [in]  iEnvelopeId  The Postal Envelope id, if the envelope reception succeeded. [in]  iProgressInfoP  The progress information.

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. Parameters: [in]  iServiceId  The serviceId that is unique among all services. [in]  iSessionId  The Postal Session id, which the status changed. [in]  iSessionStatus  The last status of the session. [in]  iProgressInfoP  The progress information.

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. Parameters: [in]  iServiceId  The serviceId that is unique among all services. [in]  iSessionId  The Postal Session id, which the status changed. [in]  iSessionStatus  The last status of the session.

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. Parameters: [in]  iServiceId  The serviceId that is unique among all services. [in]  iSessionId  The Postal Session id on which the request has been invoked. [in]  iRequestResult  The result of the request.

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. Parameters: [in]  iServiceId  The serviceId that is unique among all services. [in]  iSessionId  The Postal Session id on which the request has been invoked. [in]  iRequestResult  The result of the request.

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. Parameters: [in]  iServiceId  The serviceId that is unique among all services. [in]  iSessionId  The Postal Session id on which the request has been invoked. [in]  iLastReceivedEnvelopeId  The Postal Envelope id of the last received envelope, if its reception succeeded. [in]  iTotalProgressP  The overall progression status. [in]  iEnvProgressP  The progression status per envelope. [in]  iRequestResult  The result of the request.

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. Parameters: [in]  iServiceId  The serviceId that is unique among all services. [in]  iSessionId  The Postal Session id on which the request has been invoked. [in]  iLastSentEnvelopeId  The Postal Envelope id of the last sent envelope, if its submission succeeded. [in]  iTotalProgressInfoP  The overall progression status. [in]  iProgressInfoP  The progression status per envelope. [in]  iRequestResult  The result of the request.

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. Parameters: [in]  iServiceId  The serviceId that is unique among all services. [in]  iSessionId  The Postal Session id on which the request has been invoked. [in]  iEnvelopeId  The Postal Envelope id, if the envelope submission succeeded. [in]  iProgressInfoP  The progress information. [in]  iRequestResult  The result of the request.

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. Parameters: [in]  iServiceId  The serviceId that is unique among all services. [in]  iSessionId  The Postal Session id on which the request has been invoked. [in]  iEnvelopeId  The Postal Envelope id, if the envelope submission succeeded. [in]  iProgressInfoP  The progress information. [in]  iRequestResult  The result of the request.

---

Function Documentation

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. Parameters: [in]  iServiceId  The serviceId that is unique among all services. [in]  iSessionId  The session Id on which the request must be cancelled. Returns: Returns an error code.

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. Parameters: [in]  iServiceId  The serviceId that is unique among all services. [in]  iSessionId  The session Id on which the request must be cancelled. Returns: Returns an error code.

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. Parameters: [in]  iServiceId  The serviceId that is unique among all services. [in]  iSessionId  The session Id on which the request must be cancelled. Returns: Returns an error code.

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. Parameters: [in]  iServiceId  The serviceId that is unique among all services. [in]  iSessionId  The session Id on which the request must be cancelled. Returns: Returns an error code.

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. Parameters: [in]  iServiceId  The serviceId that is unique among all services. [in]  iSessionId  The session Id on which the request must be cancelled. Returns: Returns an error code.

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. Parameters: [in]  iServiceId  The serviceId that is unique among all services. [in]  iSessionId  The session Id on which the request must be cancelled. Returns: Returns an error code.

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. Parameters: [in]  iServiceId  The serviceId that is unique among all services. [in]  iSessionId  The session Id on which the request must be cancelled. [in]  iEnvelopeId  The Id of the envelope to be cancelled. Returns: Returns an error code.

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. Parameters: [in]  iServiceId  The serviceId that is unique among all services. [in]  iSessionId  The session Id to connect. [in]  iReceivePasswd  If set, overrides the default account password for envelope receiving. [in]  iSendPasswd  If set, overrides the default account password for envelope sending. [in]  iCallbackFuncP  The call back function to be called when connection process will terminate. Returns: Returns an error code.

alp_status_t alp_postal_session_delete (  alp_postal_service_id_t  iServiceId, alp_postal_session_id_t  iSessionId )

Delete the given session. Parameters: [in]  iServiceId  The serviceId that is unique among all services. [in]  iSessionId  The session Id to delete. Returns: Returns an error code.

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. Parameters: [in]  iServiceId  The serviceId that is unique among all services. [in]  iSessionId  The session Id. [in]  iFilterP  The filter criteria. Returns: Returns an error code.

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. Parameters: [in]  iServiceId  The serviceId that is unique among all services. [in]  iSessionId  The session Id to disconnect. [in]  iCallbackFuncP  The call back function to be called when disconnection process will terminate. Returns: Returns an error code.

alp_status_t alp_postal_session_free_session_id_list (  AlpPostalSessionIdList *  iSessionIdListP  )

Free the list of Postal session Identifier. Parameters: [in]  iSessionIdListP,:  a pointer on the session identifiers list to be freed. Returns: Returns an error code.

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. Parameters: [in]  iServiceId  The serviceId that is unique among all services. [in]  iSessionId  The session Id to work on. [out]  oAccountIdP  The account id associated. Returns: Returns an error code.

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. Parameters: [in]  iServiceId  The serviceId that is unique among all services. [in]  iSessionId  The session Id to work on. [out]  oSessionStatusP  The status of the session (see above). Returns: Returns an error code.

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. Parameters: [in]  iServiceId  The serviceId that is unique among all services. [in]  iSessionId  The session Id to work on. [out]  oFolderIdP  The id of the root folder. Returns: Returns an error code.

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. Parameters: [in]  iServiceId  The serviceId that is unique among all services. [in]  iSessionId  The session Id to work on. [in]  iFolderType  (INBOX, OUTBOX, etc.. see special id value in folder.h) [out]  oFolderIdP  the id of the resuested folder. Returns: Returns an error code.

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. Parameters: [in]  iServiceId  The serviceId that is unique among all services. [in]  iSessionId  The session Id to work on. [in]  iCallbackFuncP  The call back function to be called when. Returns: Returns an error code.

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. Parameters: [in]  iServiceId  The serviceId that is unique among all services. [in]  iSessionId  The session Id where to find the outbox folder. [in]  iCallbackFuncP  The call back function to be called when. Returns: Returns an error code.

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. Parameters: [in]  iServiceId  The serviceId that is unique among all services. [in]  iSessionId  The session Id to work on. [in]  iEnvelopeP  . [in]  iCallbackFuncP  The call back function to be called when. Returns: Returns an error code.

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. Parameters: [in]  iServiceId  The serviceId that is unique among all services. [in]  iSessionId  The session Id to work on. [in]  iEnvelopeId  The Id of the envelope to be sent. [in]  iCallbackFuncP  The call back function to be called when. Returns: Returns an error code.

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. Parameters: [in]  iServiceId  The serviceId to which belongs the session ID. [in]  iSessionId  The session Id to which assign the given application ID. use ALP_POSTAL_SESSION_INVALID_ID to associate iAppIdP with all the session created by iServiceId. [in]  iAppIdP  The application ID Ptr to attach to the given session ID, service ID, if NULL remove previous application ID. 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.