Search
[Protocol Common Services]

Detailed Description

Common Search APIs.


Data Structures

struct  _AlpPostalSearchCriteriaAnd
 Holds a list of search nodes on which a AND operator applies. More...
struct  _AlpPostalSearchCriteriaExist
 A filter criteria on a property existence (NULL or not). More...
struct  _AlpPostalSearchCriteriaLink
 A search criteria that applies on a linked object. This filter applies only on envelope onject. More...
struct  _AlpPostalSearchCriteriaNot
 Holds a search node on which a NOT operator applies. More...
struct  _AlpPostalSearchCriteriaOr
 Holds a list of search nodes on which a OR operator applies. More...
struct  _AlpPostalSearchCriteriaProp
 A filter criteria on a simple property. The filter is made of 4 pieces of information:. More...
struct  _AlpPostalSearchNode
 Holds a filter criteria. More...
struct  _AlpPostalSortCriteria
 Defines a sort criteria. More...

POSTAL FILTER FLAGS

Defines search options to be used in the property filter criteria. Applies to string properties only.

#define ALP_POSTAL_FILTER_FLAG_IGNORE_CASE   ((alp_postal_filter_flag_t)1<<0)
 Ignore case.
#define ALP_POSTAL_FILTER_FLAG_NONE   ((alp_postal_filter_flag_t)0)
 No flag.
#define ALP_POSTAL_FILTER_FLAG_REG_EXP   ((alp_postal_filter_flag_t)1<<1)
 Regular expression = pattern matching. If REG_EXP_MASK is set, the comparison operator must be ALP_POSTAL_FILTER_OP_EQ and ALP_POSTAL_FILTER_FLAG_IGNORE_CASE flag must not be set.
#define ALP_POSTAL_FILTER_FLAG_SUB_STRING   ((alp_postal_filter_flag_t)1<<2)
 Match a sub-string. If ALP_POSTAL_FILTER_FLAG_SUB_STRING is set, the comparison operator must be ALP_POSTAL_FILTER_OP_EQ.

POSTAL SEARCH LINKED OBJECT TYPES

Linked object type.

#define ALP_POSTAL_FILTER_LINK_ADDRESS   ((alp_postal_search_link_obj_t)1)
 Recipients.
#define ALP_POSTAL_FILTER_LINK_BODY_PARTS   ((alp_postal_search_link_obj_t)2)
 Body parts.
#define ALP_POSTAL_FILTER_LINK_PARENT_FOLDER   ((alp_postal_search_link_obj_t)3)
 Parent folder.

POSTAL SEARCH NODE TYPES

Comparison operator for a property filter criteria.

#define ALP_POSTAL_FILTER_OP_EQ   ((alp_postal_search_prop_op_t)1)
 Equal.
#define ALP_POSTAL_FILTER_OP_GE   ((alp_postal_search_prop_op_t)4)
 Greater or Equal.
#define ALP_POSTAL_FILTER_OP_GT   ((alp_postal_search_prop_op_t)2)
 Greater Than.
#define ALP_POSTAL_FILTER_OP_LE   ((alp_postal_search_prop_op_t)5)
 Lesser or Equal.
#define ALP_POSTAL_FILTER_OP_LT   ((alp_postal_search_prop_op_t)3)
 Lesser Than.

POSTAL SEARCH NODE TYPES

Defines postal search node types. Gives a clue on the filter criteria type contained int the _AlpPostalSearchNode structure.

#define ALP_POSTAL_SEARCH_NODE_AND   ((alp_postal_search_node_t)2)
 AND filter criteria.
#define ALP_POSTAL_SEARCH_NODE_EXIST   ((alp_postal_search_node_t)5)
 EXIST filter criteria.
#define ALP_POSTAL_SEARCH_NODE_LINK   ((alp_postal_search_node_t)6)
 LINK filter criteria.
#define ALP_POSTAL_SEARCH_NODE_NOT   ((alp_postal_search_node_t)3)
 NOT filter criteria.
#define ALP_POSTAL_SEARCH_NODE_OR   ((alp_postal_search_node_t)1)
 OR filter criteria.
#define ALP_POSTAL_SEARCH_NODE_PROPERTY   ((alp_postal_search_node_t)4)
 PROPERTY filter criteria.

POSTAL SORT WAY TYPES

Defines postal sort way.

#define ALP_POSTAL_SORT_WAY_ASCENDING   ((alp_postal_sort_way_t)1)
 Ascending, from the lowest value to the highest value.
#define ALP_POSTAL_SORT_WAY_DESCENDING   ((alp_postal_sort_way_t)2)
 Descending, rom the highest value to the lowest value.

Postal Search & Sort Helpers

Helper functions to build filter and sort criteria.

alp_status_t alp_postal_search_cancel_find_envelopes (void)
 Cancel a global search envelopes asynchronous request.
alp_status_t alp_postal_search_cancel_find_session_envelopes (alp_postal_service_id_t iServiceId, alp_postal_session_id_t iSessionId)
 Cancel a search envelopes asynchrosnous request.
alp_status_t alp_postal_search_cancel_global_find_envelopes (void)
 Cancel the global find envelopes asynchronous request.
alp_status_t alp_postal_search_contact_release_enumerator (AlpPostalEnumerator *iContactEnumeratorP)
 free data into the enumerator and release it, must be called when data access is over.
alp_status_t alp_postal_search_envelope_release_enumerator (AlpPostalEnumerator *iEnvelopeEnumeratorP)
 free data into the enumerator and release it, must be called when data access is over in a search request call back.
alp_status_t alp_postal_search_find_envelopes (AlpPostalServiceIdList *iServiceIdListP, AlpPostalEnvelope *iEnvelopeP, alp_postal_address_class_t iAddressMask, bool iGetBodyparts, AlpPostalSearchNode *iFilterP, AlpPostalSortCriteria *iSortP, AlpPostalSearchFindEnvelopesAsyncReplyCallback iCallbackFuncP)
 Perform a global search on the messaging system - async request.
alp_status_t alp_postal_search_find_envelopes_sync (AlpPostalServiceIdList *iServiceIdListP, AlpPostalEnvelope *iEnvelopeP, alp_postal_address_class_t iAddressMask, bool iGetBodyparts, AlpPostalSearchNode *iFilterP, AlpPostalSortCriteria *iSortP, AlpPostalEnumerator *oEnvelopeEnumeratorP)
 Perform a global search on the messaging system - sync request.
alp_status_t alp_postal_search_find_session_envelopes (alp_postal_service_id_t iServiceId, alp_postal_session_id_t iSessionId, AlpPostalEnvelope *iEnvelopeP, alp_postal_address_class_t iAddressMask, bool iGetBodyparts, AlpPostalSearchNode *iFilterP, AlpPostalSortCriteria *iSortP, AlpPostalSearchFindSessionEnvelopesAsyncReplyCallback iCallbackFuncP)
 Perform a local search on a particuar session - async request.
alp_status_t alp_postal_search_find_session_envelopes_sync (alp_postal_service_id_t iServiceId, alp_postal_session_id_t iSessionId, AlpPostalEnvelope *iEnvelopeP, alp_postal_address_class_t iAddressMask, bool iGetBodyparts, AlpPostalSearchNode *iFilterP, AlpPostalSortCriteria *iSortP, AlpPostalEnumerator *oEnvelopeEnumeratorP)
 Perform a local search on a particuar session - sync request.
alp_status_t alp_postal_search_get_next_contact (AlpPostalEnumerator *iContactEnumeratorP, AlpPostalAddress *oContactP)
 Return the address structure for the current position and increment it.
alp_status_t alp_postal_search_get_next_envelope (AlpPostalEnumerator *iEnvelopeEnumeratorP, AlpPostalEnvelope *oEnvelopeP)
 Return the envelope structure for the current position and increment it.
alp_status_t alp_postal_search_global_find_envelopes (AlpPostalServiceIdList *iServiceIdListP, char *iSearchItem, AlpPostalSearchGlobalFindEnvelopesAsyncReplyCallback iCallbackFuncP)
 Perform a case insensitive global find on the messaging system - async request.
alp_status_t alp_postal_search_node_and_add_child (AlpPostalSearchNode *iAndNode, AlpPostalSearchNode *iChildNode)
 Add a child to an and filter criteria.
AlpPostalSearchNode * alp_postal_search_node_and_new (void)
 Create a new and filter criteria.
AlpPostalSearchNode * alp_postal_search_node_exist_new (alp_postal_property_id_t iProperty, bool iExist)
 Create a new exist filter criteria.
void alp_postal_search_node_free (AlpPostalSearchNode **iNode)
 Free a whole filter node tree.
AlpPostalSearchNode * alp_postal_search_node_link_new (alp_postal_search_link_obj_t iLinkedObject, AlpPostalSearchNode *iNode)
 Create a new link filter criteria.
AlpPostalSearchNode * alp_postal_search_node_not_new (AlpPostalSearchNode *iNode)
 Create a new not filter criteria.
alp_status_t alp_postal_search_node_or_add_child (AlpPostalSearchNode *iOrNode, AlpPostalSearchNode *iChildNode)
 Add a child to an or filter criteria.
AlpPostalSearchNode * alp_postal_search_node_or_new (void)
 Create a new or filter criteria.
AlpPostalSearchNode * alp_postal_search_node_prop_new (alp_postal_property_id_t iProperty, alp_postal_search_prop_op_t iOp, void *iValue, alp_postal_filter_flag_t iFlagMask)
 Create a new property filter criteria.
alp_status_t alp_postal_search_sync_envelope_init_enumerator (AlpPostalEnumerator *iEnvelopeEnumeratorP)
 Initialize an search envelope enumerator to be used with a sync search API. MUST be called before alp_postal_search_find_envelopes_sync and alp_postal_search_find_session_envelopes_sync API.
alp_status_t alp_postal_search_sync_envelope_release_enumerator (AlpPostalEnumerator *iEnvelopeEnumeratorP)
 free data into the enumerator and release it, must be called when data access is over when the enumerator is filled by a synchronous search API call.
void alp_postal_sort_criteria_free (AlpPostalSortCriteria **iCriteria)
 Free a sort criteria.
AlpPostalSortCriteria * alp_postal_sort_criteria_new (alp_postal_property_id_t iProperty, alp_postal_sort_way_t iWay)
 Create a new sort criteria.
alp_status_t alp_postal_sort_criteria_set_secondary_sort (AlpPostalSortCriteria *iSort, alp_postal_property_id_t iProperty, alp_postal_sort_way_t iWay)
 Add a secondary sort criteria.

Typedefs

typedef uint8_t alp_postal_filter_flag_t
 postal Filter Flags type.
typedef void * alp_postal_filter_prop_value_t
 postal Sort Way Types type.
typedef uint8_t alp_postal_search_link_obj_t
 postal Search linked object type.
typedef uint8_t alp_postal_search_node_t
 postal Search Node Types type.
typedef uint8_t alp_postal_search_prop_op_t
 postal Search property operator Types type.
typedef uint8_t alp_postal_sort_way_t
 postal Sort Way Types type.
typedef _AlpPostalSearchCriteriaAnd AlpPostalSearchCriteriaAnd
 Holds a list of search nodes on which a AND operator applies.
typedef _AlpPostalSearchCriteriaExist AlpPostalSearchCriteriaExist
 A filter criteria on a property existence (NULL or not).
typedef _AlpPostalSearchCriteriaLink AlpPostalSearchCriteriaLink
 A search criteria that applies on a linked object. This filter applies only on envelope onject.
typedef _AlpPostalSearchCriteriaNot AlpPostalSearchCriteriaNot
 Holds a filter criteria on which a NOT operator applies.
typedef _AlpPostalSearchCriteriaOr AlpPostalSearchCriteriaOr
 Holds a list of search nodes on which a OR operator applies.
typedef _AlpPostalSearchCriteriaProp AlpPostalSearchCriteriaProp
 A filter criteria on a simple property.
typedef void(* AlpPostalSearchFindEnvelopesAsyncReplyCallback )(AlpPostalEnumerator *iEnvelopeEnumeratorP, alp_status_t iRequestResult)
 Postal global envelopes search request async response Callback.
typedef void(* AlpPostalSearchFindSessionEnvelopesAsyncReplyCallback )(alp_postal_service_id_t iServiceId, alp_postal_session_id_t iSessiontId, AlpPostalEnumerator *iEnvelopeEnumeratorP, alp_status_t iRequestResult)
 Postal global envelopes search request async response Callback.
typedef void(* AlpPostalSearchGlobalFindEnvelopesAsyncReplyCallback )(alp_postal_service_id_t iServiceId, alp_postal_envelope_id_t iEnvelopeId, alp_status_t iRequestResult)
 Postal global find search request async response Callback.
typedef _AlpPostalSearchNode AlpPostalSearchNode
 A common search filter node.
typedef _AlpPostalSortCriteria AlpPostalSortCriteria
 Defines a sort criteria.

Define Documentation

#define ALP_POSTAL_FILTER_FLAG_IGNORE_CASE   ((alp_postal_filter_flag_t)1<<0)
 

Ignore case.

#define ALP_POSTAL_FILTER_FLAG_NONE   ((alp_postal_filter_flag_t)0)
 

No flag.

#define ALP_POSTAL_FILTER_FLAG_REG_EXP   ((alp_postal_filter_flag_t)1<<1)
 

Regular expression = pattern matching. If REG_EXP_MASK is set, the comparison operator must be ALP_POSTAL_FILTER_OP_EQ and ALP_POSTAL_FILTER_FLAG_IGNORE_CASE flag must not be set.

#define ALP_POSTAL_FILTER_FLAG_SUB_STRING   ((alp_postal_filter_flag_t)1<<2)
 

Match a sub-string. If ALP_POSTAL_FILTER_FLAG_SUB_STRING is set, the comparison operator must be ALP_POSTAL_FILTER_OP_EQ.

#define ALP_POSTAL_FILTER_LINK_ADDRESS   ((alp_postal_search_link_obj_t)1)
 

Recipients.

#define ALP_POSTAL_FILTER_LINK_BODY_PARTS   ((alp_postal_search_link_obj_t)2)
 

Body parts.

#define ALP_POSTAL_FILTER_LINK_PARENT_FOLDER   ((alp_postal_search_link_obj_t)3)
 

Parent folder.

#define ALP_POSTAL_FILTER_OP_EQ   ((alp_postal_search_prop_op_t)1)
 

Equal.

#define ALP_POSTAL_FILTER_OP_GE   ((alp_postal_search_prop_op_t)4)
 

Greater or Equal.

#define ALP_POSTAL_FILTER_OP_GT   ((alp_postal_search_prop_op_t)2)
 

Greater Than.

#define ALP_POSTAL_FILTER_OP_LE   ((alp_postal_search_prop_op_t)5)
 

Lesser or Equal.

#define ALP_POSTAL_FILTER_OP_LT   ((alp_postal_search_prop_op_t)3)
 

Lesser Than.

#define ALP_POSTAL_SEARCH_NODE_AND   ((alp_postal_search_node_t)2)
 

AND filter criteria.

#define ALP_POSTAL_SEARCH_NODE_EXIST   ((alp_postal_search_node_t)5)
 

EXIST filter criteria.

#define ALP_POSTAL_SEARCH_NODE_LINK   ((alp_postal_search_node_t)6)
 

LINK filter criteria.

#define ALP_POSTAL_SEARCH_NODE_NOT   ((alp_postal_search_node_t)3)
 

NOT filter criteria.

#define ALP_POSTAL_SEARCH_NODE_OR   ((alp_postal_search_node_t)1)
 

OR filter criteria.

#define ALP_POSTAL_SEARCH_NODE_PROPERTY   ((alp_postal_search_node_t)4)
 

PROPERTY filter criteria.

#define ALP_POSTAL_SORT_WAY_ASCENDING   ((alp_postal_sort_way_t)1)
 

Ascending, from the lowest value to the highest value.

#define ALP_POSTAL_SORT_WAY_DESCENDING   ((alp_postal_sort_way_t)2)
 

Descending, rom the highest value to the lowest value.

Typedef Documentation

typedef uint8_t alp_postal_filter_flag_t
 

postal Filter Flags type.

typedef void* alp_postal_filter_prop_value_t
 

postal Sort Way Types type.

typedef uint8_t alp_postal_search_link_obj_t
 

postal Search linked object type.

typedef uint8_t alp_postal_search_node_t
 

postal Search Node Types type.

typedef uint8_t alp_postal_search_prop_op_t
 

postal Search property operator Types type.

typedef uint8_t alp_postal_sort_way_t
 

postal Sort Way Types type.

typedef struct _AlpPostalSearchCriteriaAnd AlpPostalSearchCriteriaAnd
 

Holds a list of search nodes on which a AND operator applies.

typedef struct _AlpPostalSearchCriteriaExist AlpPostalSearchCriteriaExist
 

A filter criteria on a property existence (NULL or not).

typedef struct _AlpPostalSearchCriteriaLink AlpPostalSearchCriteriaLink
 

A search criteria that applies on a linked object. This filter applies only on envelope onject.

typedef struct _AlpPostalSearchCriteriaNot AlpPostalSearchCriteriaNot
 

Holds a filter criteria on which a NOT operator applies.

typedef struct _AlpPostalSearchCriteriaOr AlpPostalSearchCriteriaOr
 

Holds a list of search nodes on which a OR operator applies.

typedef struct _AlpPostalSearchCriteriaProp AlpPostalSearchCriteriaProp
 

A filter criteria on a simple property.

typedef void(* AlpPostalSearchFindEnvelopesAsyncReplyCallback)(AlpPostalEnumerator *iEnvelopeEnumeratorP, alp_status_t iRequestResult)
 

Postal global envelopes search request async response Callback.

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

typedef void(* AlpPostalSearchFindSessionEnvelopesAsyncReplyCallback)(alp_postal_service_id_t iServiceId, alp_postal_session_id_t iSessiontId, AlpPostalEnumerator *iEnvelopeEnumeratorP, alp_status_t iRequestResult)
 

Postal global envelopes search 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] iEnvelopeEnumeratorP A returned enumerator that allows to retrieve the result set of envelopes.
[in] iRequestResult The result of the request.

typedef void(* AlpPostalSearchGlobalFindEnvelopesAsyncReplyCallback)(alp_postal_service_id_t iServiceId, alp_postal_envelope_id_t iEnvelopeId, alp_status_t iRequestResult)
 

Postal global find search request async response Callback.

Parameters:
[in] iServiceId The serviceId where the envelope has been found.
[in] iEnvelopeId The envelopeId of the envelope that match the searchString.
[in] iRequestResult The result of the request. while iRequestResult==POSTAL_STATUS_IN_PROGRESS, the callback will be called again. On the very last call, iRequestResult==POSTAL_STATUS_OK and iEnvelopeId==ALP_POSTAL_ENVELOPE_INVALID_ID and iServiceId==ALP_POSTAL_SERVICE_INVALID_ID. iRequestResult==POSTAL_STATUS_BUSY if the global_find is already processing.

typedef struct _AlpPostalSearchNode AlpPostalSearchNode
 

A common search filter node.

typedef struct _AlpPostalSortCriteria AlpPostalSortCriteria
 

Defines a sort criteria.

Function Documentation

alp_status_t alp_postal_search_cancel_find_envelopes (  void   ) 
 

Cancel a global search envelopes asynchronous request.

Returns:
Returns an error code.

alp_status_t alp_postal_search_cancel_find_session_envelopes (  alp_postal_service_id_t  iServiceId,
alp_postal_session_id_t  iSessionId
) 
 

Cancel a search envelopes asynchrosnous 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_search_cancel_global_find_envelopes (  void   ) 
 

Cancel the global find envelopes asynchronous request.

Returns:
Returns an error code.

alp_status_t alp_postal_search_contact_release_enumerator (  AlpPostalEnumerator *  iContactEnumeratorP  ) 
 

free data into the enumerator and release it, must be called when data access is over.

Parameters:
[in] iContactEnumeratorP the enumerator to release.
Returns:
Returns an error code.

alp_status_t alp_postal_search_envelope_release_enumerator (  AlpPostalEnumerator *  iEnvelopeEnumeratorP  ) 
 

free data into the enumerator and release it, must be called when data access is over in a search request call back.

Parameters:
[in] iEnvelopeEnumeratorP the enumerator to release

alp_status_t alp_postal_search_find_envelopes (  AlpPostalServiceIdList *  iServiceIdListP,
AlpPostalEnvelope *  iEnvelopeP,
alp_postal_address_class_t  iAddressMask,
bool  iGetBodyparts,
AlpPostalSearchNode *  iFilterP,
AlpPostalSortCriteria *  iSortP,
AlpPostalSearchFindEnvelopesAsyncReplyCallback  iCallbackFuncP
) 
 

Perform a global search on the messaging system - async request.

Parameters:
[in] iServiceIdListP If not NULL, the search is performed on all opened sessions from this Service identifiers array. If not NULL, the search is performed on all available sessions from all the plug-ins.
[in] iEnvelopeP An envelope used as a filter for retrieved envelopes. Only property that have been setted (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] iFilterP An optional search filter. Might be NULL to specify all envelopes.
[in] iSortP An optional sort criteria. Might be NULL.
[in] iCallbackFuncP The call back function to be called when.
Returns:
Returns an error code.

alp_status_t alp_postal_search_find_envelopes_sync (  AlpPostalServiceIdList *  iServiceIdListP,
AlpPostalEnvelope *  iEnvelopeP,
alp_postal_address_class_t  iAddressMask,
bool  iGetBodyparts,
AlpPostalSearchNode *  iFilterP,
AlpPostalSortCriteria *  iSortP,
AlpPostalEnumerator *  oEnvelopeEnumeratorP
) 
 

Perform a global search on the messaging system - sync request.

Parameters:
[in] iServiceIdListP If not NULL, the search is performed on all opened sessions from this Service identifiers array. If not NULL, the search is performed on all available sessions from all the plug-ins.
[in] iEnvelopeP An envelope used as a filter for retrieved envelopes. Only property that have been setted (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] iFilterP An optional search filter. Might be NULL to specify all envelopes.
[in] iSortP An optional sort criteria. Might be NULL.
[out] oEnvelopeEnumeratorP The result envelope enumerator.
Returns:
Returns an error code.

alp_status_t alp_postal_search_find_session_envelopes (  alp_postal_service_id_t  iServiceId,
alp_postal_session_id_t  iSessionId,
AlpPostalEnvelope *  iEnvelopeP,
alp_postal_address_class_t  iAddressMask,
bool  iGetBodyparts,
AlpPostalSearchNode *  iFilterP,
AlpPostalSortCriteria *  iSortP,
AlpPostalSearchFindSessionEnvelopesAsyncReplyCallback  iCallbackFuncP
) 
 

Perform a local search on a particuar session - async request.

Parameters:
[in] iServiceId the serviceId to work on.
[in] iSessionId The session this search relates to.
[in] iEnvelopeP An envelope used as a filter for retrieved envelopes. Only property that have been setted (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] iFilterP An optional search filter.
[in] iSortP An optional sort criteria. Might be NULL.
[in] iCallbackFuncP The call back function to be called when.
Returns:
Returns an error code.

alp_status_t alp_postal_search_find_session_envelopes_sync (  alp_postal_service_id_t  iServiceId,
alp_postal_session_id_t  iSessionId,
AlpPostalEnvelope *  iEnvelopeP,
alp_postal_address_class_t  iAddressMask,
bool  iGetBodyparts,
AlpPostalSearchNode *  iFilterP,
AlpPostalSortCriteria *  iSortP,
AlpPostalEnumerator *  oEnvelopeEnumeratorP
) 
 

Perform a local search on a particuar session - sync request.

Parameters:
[in] iServiceId the serviceId to work on.
[in] iSessionId The session this search relates to.
[in] iEnvelopeP An envelope used as a filter for retrieved envelopes. Only property that have been setted (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] iFilterP An optional search filter.
[in] iSortP An optional sort criteria. Might be NULL.
[out] oEnvelopeEnumeratorP The result envelope enumerator.
Returns:
Returns an error code.

alp_status_t alp_postal_search_get_next_contact (  AlpPostalEnumerator *  iContactEnumeratorP,
AlpPostalAddress *  oContactP
) 
 

Return the address structure for the current position and increment it.

Parameters:
[in] iContactEnumeratorP An enumerator on a list of result.
[out] oContactP the next contact property list. if the structure is empty, all the properties will be returned.
Returns:
Returns an error code.

alp_status_t alp_postal_search_get_next_envelope (  AlpPostalEnumerator *  iEnvelopeEnumeratorP,
AlpPostalEnvelope *  oEnvelopeP
) 
 

Return the envelope structure for the current position and increment it.

Parameters:
[in] iEnvelopeEnumeratorP An enumerator on a list of result.
[out] oEnvelopeP Only the properties previously added as parameter of the API used to get the enumerator will be filled. if the structure was empty, all the properties will be returned. (The recipient list for example are not returned until a specific call to get_envelope_enumerator).
Returns:
Returns an error code.

alp_status_t alp_postal_search_global_find_envelopes (  AlpPostalServiceIdList *  iServiceIdListP,
char *  iSearchItem,
AlpPostalSearchGlobalFindEnvelopesAsyncReplyCallback  iCallbackFuncP
) 
 

Perform a case insensitive global find on the messaging system - async request.

Parameters:
[in] iServiceIdListP If not NULL, the search is performed on this Service identifiers array.
[in] iSearchItem the string item to search for. (case insensitive)
[in] iCallbackFuncP The call back function called when a envelope is find. (can be called more than once).
Returns:
POSTAL_STATUS_BUSY if a search is already processing.

alp_status_t alp_postal_search_node_and_add_child (  AlpPostalSearchNode *  iAndNode,
AlpPostalSearchNode *  iChildNode
) 
 

Add a child to an and filter criteria.

Parameters:
[in] iAndNode an and node to modify.
[in] iChildNode the child node to add.
Returns:
Returns an error code.

AlpPostalSearchNode* alp_postal_search_node_and_new (  void   ) 
 

Create a new and filter criteria.

Returns:
the created node.

AlpPostalSearchNode* alp_postal_search_node_exist_new (  alp_postal_property_id_t  iProperty,
bool  iExist
) 
 

Create a new exist filter criteria.

Parameters:
[in] iProperty the property identifier on which the filter applies.
[in] iExist true to check the existence, or false to check the non existence.
Returns:
the created node.

void alp_postal_search_node_free (  AlpPostalSearchNode **  iNode  ) 
 

Free a whole filter node tree.

Parameters:
[in] iNode tree root node.
Returns:
Returns an error code.
Warning:
This function can be invoked only on the root node.

AlpPostalSearchNode* alp_postal_search_node_link_new (  alp_postal_search_link_obj_t  iLinkedObject,
AlpPostalSearchNode *  iNode
) 
 

Create a new link filter criteria.

Parameters:
[in] iLinkedObject the linked object type.
[in] iNode the filter that applies on this linked object.
Returns:
the created node.

AlpPostalSearchNode* alp_postal_search_node_not_new (  AlpPostalSearchNode *  iNode  ) 
 

Create a new not filter criteria.

Parameters:
[in] iNode the node on which the filter applies.
Returns:
the created node.

alp_status_t alp_postal_search_node_or_add_child (  AlpPostalSearchNode *  iOrNode,
AlpPostalSearchNode *  iChildNode
) 
 

Add a child to an or filter criteria.

Parameters:
[in] iOrNode an or node to modify.
[in] iChildNode the child node to add.
Returns:
Returns an error code.

AlpPostalSearchNode* alp_postal_search_node_or_new (  void   ) 
 

Create a new or filter criteria.

Returns:
the created node.

AlpPostalSearchNode* alp_postal_search_node_prop_new (  alp_postal_property_id_t  iProperty,
alp_postal_search_prop_op_t  iOp,
void *  iValue,
alp_postal_filter_flag_t  iFlagMask
) 
 

Create a new property filter criteria.

Parameters:
[in] iProperty the property identifier on which the filter applies.
[in] iOp the operator (= < > <= >=).
[in] iValue the property value.
[in] iFlagMask optional flags for string comparison.
Returns:
the created node.

alp_status_t alp_postal_search_sync_envelope_init_enumerator (  AlpPostalEnumerator *  iEnvelopeEnumeratorP  ) 
 

Initialize an search envelope enumerator to be used with a sync search API. MUST be called before alp_postal_search_find_envelopes_sync and alp_postal_search_find_session_envelopes_sync API.

Parameters:
[in] iEnvelopeEnumeratorP the enumerator to initialize.
Returns:
Returns an error code.

alp_status_t alp_postal_search_sync_envelope_release_enumerator (  AlpPostalEnumerator *  iEnvelopeEnumeratorP  ) 
 

free data into the enumerator and release it, must be called when data access is over when the enumerator is filled by a synchronous search API call.

Parameters:
[in] iEnvelopeEnumeratorP the enumerator to release

void alp_postal_sort_criteria_free (  AlpPostalSortCriteria **  iCriteria  ) 
 

Free a sort criteria.

Parameters:
[in] iCriteria criteria to free.
Returns:
Returns an error code.

AlpPostalSortCriteria* alp_postal_sort_criteria_new (  alp_postal_property_id_t  iProperty,
alp_postal_sort_way_t  iWay
) 
 

Create a new sort criteria.

Parameters:
[in] iProperty the property identifier on which the sort applies.
[in] iWay the sort way (ascending, descending).
Returns:
the created node.

alp_status_t alp_postal_sort_criteria_set_secondary_sort (  AlpPostalSortCriteria *  iSort,
alp_postal_property_id_t  iProperty,
alp_postal_sort_way_t  iWay
) 
 

Add a secondary sort criteria.

Parameters:
[in] iSort the sort criteria.
[in] iProperty the secondary property identifier on which the sort applies.
[in] iWay the sort way (ascending, descending).
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.