Conversation
[Protocol Common Services]

Detailed Description

Common Conversation APIs.


Typedefs

typedef void(* AlpPostalConversationFindContactsAsyncReplyCallback )(AlpPostalEnumerator *iAddressEnumeratorP, alp_status_t iRequestResult)
 Conversation find contacts request async response Callback.
typedef AlpPostalSearchFindEnvelopesAsyncReplyCallback AlpPostalConversationFindEnvelopesAsyncReplyCallback
typedef void(* AlpPostalConversationFindSessionContactsAsyncReplyCallback )(alp_postal_service_id_t iServiceId, alp_postal_session_id_t iSessiontId, AlpPostalEnumerator *iAddressEnumeratorP, alp_status_t iRequestResult)
 Conversation find session contacts request async response Callback.
typedef AlpPostalSearchFindSessionEnvelopesAsyncReplyCallback AlpPostalConversationFindSessionEnvelopesAsyncReplyCallback

Functions

alp_status_t alp_postal_conversation_count_session_unread_envelopes (alp_postal_service_id_t iServiceId, alp_postal_session_id_t iSessionId, AlpPostalAddress *iContactP, uint32_t *oCount)
 Count unread envelopes in a conversation.
alp_status_t alp_postal_conversation_delete_session_envelopes (alp_postal_service_id_t iServiceId, alp_postal_session_id_t iSessionId, AlpPostalAddress *iContactP)
 Delete all envelopes from a conversation.
alp_status_t alp_postal_conversation_find_contacts (AlpPostalServiceIdList *iServiceIdListP, AlpPostalSortCriteria *iSortP, AlpPostalConversationFindContactsAsyncReplyCallback iCallbackFuncP)
 Perform a search on available contacts in a service list - async request.
alp_status_t alp_postal_conversation_find_envelopes (AlpPostalServiceIdList *iServiceIdListP, AlpPostalAddress *iContactP, AlpPostalEnvelope *iEnvelopeP, alp_postal_address_class_t iAddressMask, bool iGetBodyparts, AlpPostalConversationFindEnvelopesAsyncReplyCallback iCallbackFuncP)
 Get all envelopes exchanged with one contact.
alp_status_t alp_postal_conversation_find_last_envelope (AlpPostalServiceIdList *iServiceIdListP, AlpPostalAddress *iContactP, AlpPostalEnvelope *ioEnvelopeP, alp_postal_address_class_t iAddressMask, bool iGetBodyparts)
 Get the last envelope exchanged with one contact.
alp_status_t alp_postal_conversation_find_session_contacts (alp_postal_service_id_t iServiceId, alp_postal_session_id_t iSessionId, AlpPostalSortCriteria *iSortP, AlpPostalConversationFindSessionContactsAsyncReplyCallback iCallbackFuncP)
 Perform a search on available contacts in a session - async request.
alp_status_t alp_postal_conversation_find_session_envelopes (alp_postal_service_id_t iServiceId, alp_postal_session_id_t iSessionId, AlpPostalAddress *iContactP, AlpPostalEnvelope *iEnvelopeP, alp_postal_address_class_t iAddressMask, bool iGetBodyparts, AlpPostalConversationFindSessionEnvelopesAsyncReplyCallback iCallbackFuncP)
 Get all envelopes exchanged with one contact.
alp_status_t alp_postal_conversation_find_session_last_envelope (alp_postal_service_id_t iServiceId, alp_postal_session_id_t iSessionId, AlpPostalAddress *iContactP, AlpPostalEnvelope *ioEnvelopeP, alp_postal_address_class_t iAddressMask, bool iGetBodyparts)
 Get the last envelope exchanged with one contact.
alp_status_t alp_postal_conversation_move_envelopes (AlpPostalServiceIdList *iServiceIdListP, alp_postal_folder_id_t iFolderId, AlpPostalAddress *iContactP)
 Move all the envelopes exchanged with one contact.
alp_status_t alp_postal_conversation_set_session_envelopes_read_flag (alp_postal_service_id_t iServiceId, alp_postal_session_id_t iSessionId, AlpPostalAddress *iContactP, bool iReadFlag)
 Mark all envelopes in a conversation as read or unread.

Typedef Documentation

typedef void(* AlpPostalConversationFindContactsAsyncReplyCallback)(AlpPostalEnumerator *iAddressEnumeratorP, alp_status_t iRequestResult)
 

Conversation find contacts request async response Callback.

Parameters:
[in] iAddressEnumeratorP A returned enumerator that allows to retrieve the result set of addresses.
[in] iRequestResult The result of the request.

typedef AlpPostalSearchFindEnvelopesAsyncReplyCallback AlpPostalConversationFindEnvelopesAsyncReplyCallback
 

typedef void(* AlpPostalConversationFindSessionContactsAsyncReplyCallback)(alp_postal_service_id_t iServiceId, alp_postal_session_id_t iSessiontId, AlpPostalEnumerator *iAddressEnumeratorP, alp_status_t iRequestResult)
 

Conversation find session contacts request async response Callback.

Parameters:
[in] iServiceId A service identifier.
[in] iSessiontId A session identifier.
[in] iAddressEnumeratorP A returned enumerator that allows to retrieve the result set of addresses.
[in] iRequestResult The result of the request.

typedef AlpPostalSearchFindSessionEnvelopesAsyncReplyCallback AlpPostalConversationFindSessionEnvelopesAsyncReplyCallback
 

Function Documentation

alp_status_t alp_postal_conversation_count_session_unread_envelopes (  alp_postal_service_id_t  iServiceId,
alp_postal_session_id_t  iSessionId,
AlpPostalAddress *  iContactP,
uint32_t *  oCount
) 
 

Count unread envelopes in a conversation.

Parameters:
[in] iServiceId The service identifier.
[in] iSessionId The session identifier.
[in] iContactP The contact.
[out] oCount The unread envelope count.
Returns:
Returns an error code.

alp_status_t alp_postal_conversation_delete_session_envelopes (  alp_postal_service_id_t  iServiceId,
alp_postal_session_id_t  iSessionId,
AlpPostalAddress *  iContactP
) 
 

Delete all envelopes from a conversation.

Parameters:
[in] iServiceId The service identifier.
[in] iSessionId The session identifier.
[in] iContactP The contact.
Returns:
Returns an error code.

alp_status_t alp_postal_conversation_find_contacts (  AlpPostalServiceIdList *  iServiceIdListP,
AlpPostalSortCriteria *  iSortP,
AlpPostalConversationFindContactsAsyncReplyCallback  iCallbackFuncP
) 
 

Perform a search on available contacts in a service list - async request.

Parameters:
[in] iServiceIdListP The search is performed on all opened sessions from this Service identifiers array.
[in] iSortP The search sort criteria. Note that the search property has to be an envelope property !!!.
[in] iCallbackFuncP The call back function called when data is available.
Returns:
Returns an error code.

alp_status_t alp_postal_conversation_find_envelopes (  AlpPostalServiceIdList *  iServiceIdListP,
AlpPostalAddress *  iContactP,
AlpPostalEnvelope *  iEnvelopeP,
alp_postal_address_class_t  iAddressMask,
bool  iGetBodyparts,
AlpPostalConversationFindEnvelopesAsyncReplyCallback  iCallbackFuncP
) 
 

Get all envelopes exchanged with one contact.

Parameters:
[in] iServiceIdListP The search is performed on all opened sessions from this Service identifiers array.
[in] iContactP The contact.
[in] iEnvelopeP An envelope used as a filter for retrieved envelopes. Only property that have been set (with any value) will be available when calling envelope_get_next. if iEnvelopeP is empty, all properties will be accessible. note that bodyparts will not be accessible in envelope returned by envelope_get_next. To retrieve such data, you can use envelope_get() on each retrieved envelopes and specify the datas you want.
[in] iAddressMask address classes to retrieve, or 0 for none.
[in] iGetBodyparts TRUE to retrieve bodyparts.
[in] iCallbackFuncP The call back function called when data is available.
Returns:
Returns an error code.

alp_status_t alp_postal_conversation_find_last_envelope (  AlpPostalServiceIdList *  iServiceIdListP,
AlpPostalAddress *  iContactP,
AlpPostalEnvelope *  ioEnvelopeP,
alp_postal_address_class_t  iAddressMask,
bool  iGetBodyparts
) 
 

Get the last envelope exchanged with one contact.

Parameters:
[in] iServiceIdListP The search is performed on all opened sessions from this Service identifiers array.
[in] iContactP The contact.
[in,out] ioEnvelopeP The last envelope.
[in] iAddressMask address classes to retrieve, or 0 for none.
[in] iGetBodyparts TRUE to retrieve bodyparts.
Returns:
Returns an error code.

alp_status_t alp_postal_conversation_find_session_contacts (  alp_postal_service_id_t  iServiceId,
alp_postal_session_id_t  iSessionId,
AlpPostalSortCriteria *  iSortP,
AlpPostalConversationFindSessionContactsAsyncReplyCallback  iCallbackFuncP
) 
 

Perform a search on available contacts in a session - async request.

Parameters:
[in] iServiceId The service identifier.
[in] iSessionId The session identifier.
[in] iSortP The search sort criteria. Note that the search property has to be an envelope property !!!.
[in] iCallbackFuncP The call back function called when data is available.
Returns:
Returns an error code.

alp_status_t alp_postal_conversation_find_session_envelopes (  alp_postal_service_id_t  iServiceId,
alp_postal_session_id_t  iSessionId,
AlpPostalAddress *  iContactP,
AlpPostalEnvelope *  iEnvelopeP,
alp_postal_address_class_t  iAddressMask,
bool  iGetBodyparts,
AlpPostalConversationFindSessionEnvelopesAsyncReplyCallback  iCallbackFuncP
) 
 

Get all envelopes exchanged with one contact.

Parameters:
[in] iServiceId The service identifier.
[in] iSessionId The session identifier.
[in] iContactP The contact.
[in] iEnvelopeP An envelope used as a filter for retrieved envelopes. Only property that have been set (with any value) will be available when calling envelope_get_next. if iEnvelopeP is empty, all properties will be accessible. note that bodyparts will not be accessible in envelope returned by envelope_get_next. To retrieve such data, you can use envelope_get() on each retrieved envelopes and specify the datas you want.
[in] iAddressMask address classes to retrieve, or 0 for none.
[in] iGetBodyparts TRUE to retrieve bodyparts.
[in] iCallbackFuncP The call back function called when data is available.
Returns:
Returns an error code.

alp_status_t alp_postal_conversation_find_session_last_envelope (  alp_postal_service_id_t  iServiceId,
alp_postal_session_id_t  iSessionId,
AlpPostalAddress *  iContactP,
AlpPostalEnvelope *  ioEnvelopeP,
alp_postal_address_class_t  iAddressMask,
bool  iGetBodyparts
) 
 

Get the last envelope exchanged with one contact.

Parameters:
[in] iServiceId The service identifier.
[in] iSessionId The session identifier.
[in] iContactP The contact.
[in,out] ioEnvelopeP The last envelope.
[in] iAddressMask address classes to retrieve, or 0 for none.
[in] iGetBodyparts TRUE to retrieve bodyparts.
Returns:
Returns an error code.

alp_status_t alp_postal_conversation_move_envelopes (  AlpPostalServiceIdList *  iServiceIdListP,
alp_postal_folder_id_t  iFolderId,
AlpPostalAddress *  iContactP
) 
 

Move all the envelopes exchanged with one contact.

Parameters:
[in] iServiceIdListP The search is performed on all opened sessions from this Service identifiers array.
[in] iFolderId The destination folderId.
[in] iContactP The contact.
Returns:
Returns an error code.

alp_status_t alp_postal_conversation_set_session_envelopes_read_flag (  alp_postal_service_id_t  iServiceId,
alp_postal_session_id_t  iSessionId,
AlpPostalAddress *  iContactP,
bool  iReadFlag
) 
 

Mark all envelopes in a conversation as read or unread.

Parameters:
[in] iServiceId The service identifier.
[in] iSessionId The session identifier.
[in] iContactP The contact.
[in] iReadFlag The read flag to set.
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.