#include <alp/postal_types.h>
#include <alp/postal_property.h>
#include <alp/postal_address.h>
#include <alp/postal_folder.h>
#include <alp/postal_bodypart.h>
#include <alp/postal_enumerator.h>
#include <alp/postal_search.h>
Go to the source code of this file.
Data Structures | |
| struct | _AlpPostalEnvelope |
| Postal Envelope. More... | |
| struct | _AlpPostalEnvelopeList |
| a linked list of PostalProperties. More... | |
POSTAL ENVELOPE CLASSES | |
| Defines envelopes class (message or report). | |
| #define | ALP_POSTAL_ENVELOPE_CLASS_DELIVERY_REPORT ((alp_postal_envelope_class_t)2) |
| Envelope is a delivery report. | |
| #define | ALP_POSTAL_ENVELOPE_CLASS_MESSAGE ((alp_postal_envelope_class_t)1) |
| Normal envelope. | |
| #define | ALP_POSTAL_ENVELOPE_CLASS_NON_DELIVERY_REPORT ((alp_postal_envelope_class_t)3) |
| Envelope is a non delivery report. | |
| #define | ALP_POSTAL_ENVELOPE_CLASS_NON_READ_REPORT ((alp_postal_envelope_class_t)6) |
| Envelope is a non read report. | |
| #define | ALP_POSTAL_ENVELOPE_CLASS_READ_REPORT ((alp_postal_envelope_class_t)5) |
| Envelope is a read report. | |
| #define | ALP_POSTAL_ENVELOPE_CLASS_TMP_NON_DELIVERY_REPORT ((alp_postal_envelope_class_t)4) |
| Envelope is a temporary non delivery report. | |
POSTAL ENVELOPE STATUS | |
| Defines envelopes Status, that can be combined. | |
| #define | ALP_POSTAL_ENVELOPE_FLAG_FORWARDED ((alp_postal_envelope_flags_t)1<<2) |
| Envelope was forwarded. | |
| #define | ALP_POSTAL_ENVELOPE_FLAG_REPLIED ((alp_postal_envelope_flags_t)1<<1) |
| A reply was sent. | |
POSTAL ENVELOPE IMPORTANCES | |
| Defines envelopes importances. | |
| #define | ALP_POSTAL_ENVELOPE_IMPORTANCE_HIGH ((alp_postal_envelope_importance_t)3) |
| High importance. | |
| #define | ALP_POSTAL_ENVELOPE_IMPORTANCE_LOW ((alp_postal_envelope_importance_t)1) |
| Low importance. | |
| #define | ALP_POSTAL_ENVELOPE_IMPORTANCE_NORMAL ((alp_postal_envelope_importance_t)2) |
| Normal importance. | |
POSTAL ENVELOPE STATUS LAST STATUS | |
| Defines the Last Postal Envelope status. | |
| #define | ALP_POSTAL_ENVELOPE_LAST_STATUS ALP_POSTAL_ENVELOPE_STATUS_COPIED |
| The last class ID. | |
POSTAL ENVELOPE SENSITIVITIES | |
| Defines envelopes sensitivities. | |
| #define | ALP_POSTAL_ENVELOPE_SENSITIVITY_NONE ((alp_postal_envelope_sensitivity_t)1) |
| Envelope content is not confidential. | |
| #define | ALP_POSTAL_ENVELOPE_SENSITIVITY_PRIVATE ((alp_postal_envelope_sensitivity_t)2) |
| Envelope content is confidential. | |
POSTAL ENVELOPE STATUS | |
| Defines the envelope status provided by the ALP_POSTAL_NOTIFICATION_ENVELOPE_STATUS_CHANGE notification callback. | |
| #define | ALP_POSTAL_ENVELOPE_STATUS_COPIED ((alp_postal_envelope_status_t)7) |
| The envelope has been copied. | |
| #define | ALP_POSTAL_ENVELOPE_STATUS_DELETED ((alp_postal_envelope_status_t)6) |
| The envelope has been deleted. | |
| #define | ALP_POSTAL_ENVELOPE_STATUS_MOVED ((alp_postal_envelope_status_t)4) |
| The envelope has been moved. | |
| #define | ALP_POSTAL_ENVELOPE_STATUS_SAVED ((alp_postal_envelope_status_t)5) |
| The envelope has been saved. | |
| #define | ALP_POSTAL_ENVELOPE_STATUS_UPDATED ((alp_postal_envelope_status_t)1) |
| The envelope has been updated (e.g: a property value of the envelope has been changed). | |
| #define | ALP_POSTAL_ENVELOPE_STATUS_UPDATED_ENVELOPE_TYPE_RECEIVED ((alp_postal_envelope_status_t)3) |
| The envelope has been updated during a receiving process. | |
| #define | ALP_POSTAL_ENVELOPE_STATUS_UPDATED_ENVELOPE_TYPE_SENT ((alp_postal_envelope_status_t)2) |
| The envelope has been updated during a sending process. | |
POSTAL ENVELOPE TYPES | |
| Defines envelope types. | |
| #define | ALP_POSTAL_ENVELOPE_TYPE_DRAFT ((alp_postal_envelope_type_t)3) |
| Draft envelope. | |
| #define | ALP_POSTAL_ENVELOPE_TYPE_RECEIVED ((alp_postal_envelope_type_t)1) |
| Received envelope. | |
| #define | ALP_POSTAL_ENVELOPE_TYPE_SENT ((alp_postal_envelope_type_t)2) |
| Sent envelope. | |
POSTAL ENVELOPE NOTIFICATIONS | |
| Defines envelope notifications. | |
| #define | ALP_POSTAL_NOTIFICATION_ENVELOPE_NEW ALP_POSTAL_NOTIFICATION(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ENVELOPE, 1) |
| New incoming envelope. | |
| #define | ALP_POSTAL_NOTIFICATION_ENVELOPE_STATUS_CHANGE ALP_POSTAL_NOTIFICATION(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ENVELOPE, 2) |
| Envelope status change. | |
POSTAL ENVELOPE PROPERTIES | |
| Defines envelope properties. | |
| #define | ALP_POSTAL_PROPERTY_ENVELOPE_BODYPARTS_TOTAL_SIZE ALP_POSTAL_PROPERTY_READ_ONLY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ENVELOPE, ALP_POSTAL_PROPERTY_TYPE_INT, 34) |
| cumulated size in bytes of all the envelope bodyparts data, automatically computed when the envelope is saved or updated. | |
| #define | ALP_POSTAL_PROPERTY_ENVELOPE_CLASS ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ENVELOPE, ALP_POSTAL_PROPERTY_TYPE_INT, 8) |
| Class. | |
| #define | ALP_POSTAL_PROPERTY_ENVELOPE_FLAGS ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ENVELOPE, ALP_POSTAL_PROPERTY_TYPE_INT, 9) |
| Status. | |
| #define | ALP_POSTAL_PROPERTY_ENVELOPE_FORWARD_TO ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ENVELOPE, ALP_POSTAL_PROPERTY_TYPE_INT, 15) |
| Envelope ID this one is a forward to. | |
| #define | ALP_POSTAL_PROPERTY_ENVELOPE_HAS_ATTACHMENT ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ENVELOPE, ALP_POSTAL_PROPERTY_TYPE_BOOLEAN, 31) |
| Indicate that this envelope has attachment. | |
| #define | ALP_POSTAL_PROPERTY_ENVELOPE_ID ALP_POSTAL_PROPERTY_READ_ONLY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ENVELOPE, ALP_POSTAL_PROPERTY_TYPE_INT, 13) |
| The envelope storage identifer. | |
| #define | ALP_POSTAL_PROPERTY_ENVELOPE_IMPORTANCE ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ENVELOPE, ALP_POSTAL_PROPERTY_TYPE_INT, 10) |
| Importance. | |
| #define | ALP_POSTAL_PROPERTY_ENVELOPE_LAST_ERROR ALP_POSTAL_PROPERTY_READ_ONLY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ENVELOPE, ALP_POSTAL_PROPERTY_TYPE_INT, 27) |
| Last error the occured on this envelope. | |
| #define | ALP_POSTAL_PROPERTY_ENVELOPE_MAIN_ADDRESS ALP_POSTAL_PROPERTY_READ_ONLY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ENVELOPE, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 25) |
| Main address (contains the main from address for type received and main to address for type sent). To be used for sort facilities. | |
| #define | ALP_POSTAL_PROPERTY_ENVELOPE_MAIN_FROM_ADDRESS ALP_POSTAL_PROPERTY_READ_ONLY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ENVELOPE, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 23) |
| Main from address. To be used for sort facilities. | |
| #define | ALP_POSTAL_PROPERTY_ENVELOPE_MAIN_HTML_PART_NO ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ENVELOPE, ALP_POSTAL_PROPERTY_TYPE_INT, 30) |
| The part number value which is indicate main html part. This value references the ALP_POSTAL_PROPERTY_BODYPART_PART_NO of postal_bodypart.h. | |
| #define | ALP_POSTAL_PROPERTY_ENVELOPE_MAIN_TEXT_PART_NO ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ENVELOPE, ALP_POSTAL_PROPERTY_TYPE_INT, 29) |
| The part number value which is indicate main text part. This value references the ALP_POSTAL_PROPERTY_BODYPART_PART_NO of postal_bodypart.h. | |
| #define | ALP_POSTAL_PROPERTY_ENVELOPE_MAIN_TO_ADDRESS ALP_POSTAL_PROPERTY_READ_ONLY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ENVELOPE, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 24) |
| Main to address. To be used for sort facilities. | |
| #define | ALP_POSTAL_PROPERTY_ENVELOPE_MESSAGE_COMPLETE ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ENVELOPE, ALP_POSTAL_PROPERTY_TYPE_BOOLEAN, 28) |
| Was the whole message got or not? | |
| #define | ALP_POSTAL_PROPERTY_ENVELOPE_MESSAGE_ID ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ENVELOPE, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 26) |
| Protocol specific message ID - Internal use only. | |
| #define | ALP_POSTAL_PROPERTY_ENVELOPE_MODIFIED_DATE ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ENVELOPE, ALP_POSTAL_PROPERTY_TYPE_INT, 5) |
| Modified Date. | |
| #define | ALP_POSTAL_PROPERTY_ENVELOPE_MODIFIED_DATE_TZ ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ENVELOPE, ALP_POSTAL_PROPERTY_TYPE_INT, 22) |
| Modified Date Time Zone. | |
| #define | ALP_POSTAL_PROPERTY_ENVELOPE_MOVED_FROM_FOLDER_ID ALP_POSTAL_PROPERTY_READ_ONLY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ENVELOPE, ALP_POSTAL_PROPERTY_TYPE_INT, 32) |
| Indicate the folder Identifier where the envelope has eventually been moved from. | |
| #define | ALP_POSTAL_PROPERTY_ENVELOPE_ORDINAL_INDEX ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ENVELOPE, ALP_POSTAL_PROPERTY_TYPE_INT, 35) |
| ordinal index of envelope for email. | |
| #define | ALP_POSTAL_PROPERTY_ENVELOPE_PROTECTED ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ENVELOPE, ALP_POSTAL_PROPERTY_TYPE_INT, 12) |
| Protected (Prevent envelope from being deleted, if there is no more storage space available). | |
| #define | ALP_POSTAL_PROPERTY_ENVELOPE_READ_FLAG ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ENVELOPE, ALP_POSTAL_PROPERTY_TYPE_BOOLEAN, 16) |
| Read flag. | |
| #define | ALP_POSTAL_PROPERTY_ENVELOPE_RECEIVED_DATE ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ENVELOPE, ALP_POSTAL_PROPERTY_TYPE_INT, 4) |
| Received Date. | |
| #define | ALP_POSTAL_PROPERTY_ENVELOPE_RECEIVED_DATE_TZ ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ENVELOPE, ALP_POSTAL_PROPERTY_TYPE_INT, 21) |
| Received Date Time Zone. | |
| #define | ALP_POSTAL_PROPERTY_ENVELOPE_RECEIVED_HDR_DATE ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ENVELOPE, ALP_POSTAL_PROPERTY_TYPE_INT, 36) |
| Receievd header date for email. | |
| #define | ALP_POSTAL_PROPERTY_ENVELOPE_REPLY_TO ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ENVELOPE, ALP_POSTAL_PROPERTY_TYPE_INT, 14) |
| Envelope ID this one is a reply to. | |
| #define | ALP_POSTAL_PROPERTY_ENVELOPE_SENSITIVITY ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ENVELOPE, ALP_POSTAL_PROPERTY_TYPE_INT, 11) |
| Sensitivity. | |
| #define | ALP_POSTAL_PROPERTY_ENVELOPE_SENT_DATE ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ENVELOPE, ALP_POSTAL_PROPERTY_TYPE_INT, 3) |
| Sent Date. | |
| #define | ALP_POSTAL_PROPERTY_ENVELOPE_SENT_DATE_TZ ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ENVELOPE, ALP_POSTAL_PROPERTY_TYPE_INT, 20) |
| Sent Date Time Zone. | |
| #define | ALP_POSTAL_PROPERTY_ENVELOPE_SIZE ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ENVELOPE, ALP_POSTAL_PROPERTY_TYPE_INT, 6) |
| Size. | |
| #define | ALP_POSTAL_PROPERTY_ENVELOPE_SORT_SUBJECT ALP_POSTAL_PROPERTY_READ_ONLY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ENVELOPE, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 33) |
| Subject with localized Reply or Forward prefixes stripped, to be used when sorting envelope by subject. | |
| #define | ALP_POSTAL_PROPERTY_ENVELOPE_SUBJECT ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ENVELOPE, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 1) |
| Subject. | |
| #define | ALP_POSTAL_PROPERTY_ENVELOPE_SUBJECT_NATIVE_CHARSET ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ENVELOPE, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 2) |
| Native charset encoding. | |
| #define | ALP_POSTAL_PROPERTY_ENVELOPE_TYPE ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ENVELOPE, ALP_POSTAL_PROPERTY_TYPE_INT, 7) |
| Type. | |
Defines | |
| #define | ALP_POSTAL_ENVELOPE_INVALID_ID ((alp_postal_envelope_id_t)ALP_POSTAL_INVALID_OBJECT_ID) |
| Invalid Envelope ID definition. | |
Typedefs | |
| typedef uint8_t | alp_postal_envelope_class_t |
| Envelope class type. | |
| typedef uint8_t | alp_postal_envelope_flags_t |
| Envelope flags type. | |
| typedef uint8_t | alp_postal_envelope_importance_t |
| Envelope importance type. | |
| typedef uint8_t | alp_postal_envelope_sensitivity_t |
| Envelope sensitivity type. | |
| typedef uint8_t | alp_postal_envelope_status_t |
| Envelope status type. | |
| typedef uint8_t | alp_postal_envelope_type_t |
| Envelope Types type. | |
| typedef _AlpPostalEnvelopeList | AlpPostalEnvelopeList |
| Postal Envelope List. | |
| typedef void(* | AlpPostalNotificationEnvelopeNewCallback )(alp_postal_service_id_t iServiceId, alp_postal_account_id_t iAccountId, alp_postal_envelope_id_t iEnvelopeId) |
| Postal new Envelope Notification Callback. *. | |
| typedef void(* | AlpPostalNotificationEnvelopeStatusChangeCallback )(alp_postal_service_id_t iServiceId, alp_postal_account_id_t iAccountId, alp_postal_envelope_id_t iEnvelopeId, alp_postal_folder_id_t iFolderId, alp_postal_envelope_status_t iEnvelopeStatus) |
| Postal Envelope status change Notification Callback. | |
Functions | |
| alp_status_t | alp_postal_envelope_add_address (AlpPostalEnvelope *ioEnvelopeP, AlpPostalAddress *iAddressP, alp_postal_address_class_t iAddressClass) |
| Add an address to an existing envelope. | |
| alp_status_t | alp_postal_envelope_address_init_enumerator (AlpPostalEnumerator *iEnumeratorP) |
| Initialize an address enumerator. MUST be called before alp_postal_envelope_get_address_enumerator. | |
| alp_status_t | alp_postal_envelope_address_release_enumerator (AlpPostalEnumerator *iEnumeratorP) |
| Free datas into the enumerator and release it, must be called when data access is over. | |
| alp_status_t | alp_postal_envelope_append_bodypart (AlpPostalEnvelope *iEnvelopeP, AlpPostalBodypart *iBodypartP, alp_postal_bodypart_part_no_t iParentPartNo, alp_postal_bodypart_part_no_t *oPartNo) |
| Append a bodypart to the bodypart structure held by the envelope. Append it as the last child of iParentPartNo. | |
| alp_status_t | alp_postal_envelope_bodypart_init_enumerator (AlpPostalEnumerator *iEnumeratorP) |
| Initialize a bodypart enumerator. MUST be called before alp_postal_envelope_get_bodypart_enumerator. | |
| alp_status_t | alp_postal_envelope_bodypart_release_enumerator (AlpPostalEnumerator *iEnumeratorP) |
| Free datas into the enumerator and release it, must be called when data access is over. | |
| alp_status_t | alp_postal_envelope_delete (alp_postal_service_id_t iServiceId, alp_postal_envelope_id_t iEnvelopeId) |
| Delete a stored envelope. | |
| alp_status_t | alp_postal_envelope_forward (alp_postal_service_id_t iServiceId, alp_postal_envelope_id_t iEnvelopeId, AlpPostalEnvelope *ioForwardEnvelopeP) |
| Create a Forward envelope from a stored envelope id. | |
| alp_status_t | alp_postal_envelope_free (AlpPostalEnvelope *iEnvelopeP) |
| Free the given Envelope. | |
| alp_status_t | alp_postal_envelope_free_address_list (AlpPostalEnvelope *iEnvelopeP, alp_postal_address_class_t iAddressClassMask) |
| free and remove addresses that match iAddressClassMask from an existing envelope. | |
| alp_status_t | alp_postal_envelope_get (alp_postal_service_id_t iServiceId, alp_postal_envelope_id_t iEnvelopeId, alp_postal_address_class_t iAddressMask, bool iGetBodyparts, AlpPostalEnvelope *ioEnvelopeP) |
| Get a stored envelope. | |
| alp_status_t | alp_postal_envelope_get_account_id (alp_postal_service_id_t iServiceId, alp_postal_envelope_id_t iEnvelopeId, alp_postal_account_id_t *oEnvelopeAccountP) |
| Get the id of an envelope structure provided by the server, otherwise id won't exist. | |
| alp_status_t | alp_postal_envelope_get_address_enumerator (alp_postal_service_id_t iServiceId, alp_postal_envelope_id_t iEnvelopeId, alp_postal_address_class_t iAddressClassMask, AlpPostalEnumerator *oEnumeratorP) |
| Get an enumerator of the addresses of a stored envelope. This call ask for datas into storage. | |
| alp_status_t | alp_postal_envelope_get_address_list (AlpPostalEnvelope *iEnvelopeP, alp_postal_address_class_t iAddressClass, AlpPostalAddressContainerList **oAddressList, size_t *oAddressListCount) |
| Get a iAddressClass(TO, CC, BCC, FROM) address list from a envelope object. There is no call to the storage. To use this function, iEnvelopeP MUST has been retrieved with iAddressClass value. | |
| alp_status_t | alp_postal_envelope_get_address_list_item_at_index (AlpPostalAddressContainerList *iAddressList, size_t iIndex, AlpPostalAddress **oAddress) |
| Get an address at the specified index from an address list that has been retrieved using alp_postal_envelope_get_address_list. | |
| alp_status_t | alp_postal_envelope_get_bodypart_enumerator (alp_postal_service_id_t iServiceId, alp_postal_envelope_id_t iEnvelopeId, AlpPostalEnumerator *oEnumeratorP) |
| Get an enumerator of bodypart of a stored envelope. | |
| alp_status_t | alp_postal_envelope_get_bodypart_from_part_no (AlpPostalEnvelope *iEnvelopeP, alp_postal_bodypart_part_no_t iPartNo, AlpPostalBodypart **oBodypart) |
| Get back a pointer on a bodypart according to its PART_NO property. MUST not be freed. | |
| alp_status_t | alp_postal_envelope_get_bodypart_from_uri (AlpPostalEnvelope *iEnvelopeP, char *iURI, AlpPostalBodypart **oBodypart) |
| Get back a pointer on a bodypart according to its URI property. MUST not be freed. | |
| alp_status_t | alp_postal_envelope_get_id (AlpPostalEnvelope *iEnvelopeP, alp_postal_envelope_id_t *oEnvelopeIdP) |
| Get the id of an envelope structure provided by the server, otherwise id won't exist. | |
| alp_status_t | alp_postal_envelope_get_next_address (AlpPostalEnumerator *iEnumeratorP, AlpPostalAddress *oAddressP) |
| Return the address for the current position and increment it. | |
| alp_status_t | alp_postal_envelope_get_next_bodypart (AlpPostalEnumerator *iEnumeratorP, AlpPostalBodypart *oBodypartP) |
| Return the bodypart structure for the current position and increment it. | |
| alp_status_t | alp_postal_envelope_get_parent_folder_id (alp_postal_service_id_t iServiceId, alp_postal_envelope_id_t iEnvelopeId, alp_postal_folder_id_t *oEnvelopeParentFolderP) |
| Get the id of an envelope structure provided by the server, otherwise id won't exist. | |
| alp_status_t | alp_postal_envelope_get_property (AlpPostalEnvelope *iEnvelopeP, alp_postal_property_id_t iPropertyId, AlpPostalProperty **oEnvelopePropertyP) |
| Get a property from an envelope. | |
| alp_status_t | alp_postal_envelope_get_root_bodypart (AlpPostalEnvelope *iEnvelopeP, AlpPostalBodypart **oHeadBodypart) |
| Get a ptr to the very first bodypart of the envelope. MUST NOT be freed. | |
| alp_status_t | alp_postal_envelope_get_service_id (alp_postal_envelope_id_t iEnvelopeId, alp_postal_service_id_t *oServiceIdP) |
| Get the service Id of a stored envelope. | |
| alp_status_t | alp_postal_envelope_init (AlpPostalEnvelope *iEnvelopeP) |
| initialize an envelope. MUST be called before use. | |
| alp_status_t | alp_postal_envelope_init_as_template (AlpPostalEnvelope *iEnvelopeP) |
| initialize an envelope as a template. MUST be called before use. | |
| alp_status_t | alp_postal_envelope_remove_address (AlpPostalEnvelope *ioEnvelopeP, char *iAddressStrP, alp_postal_address_class_t iAddressClass) |
| Remove an address from an envelope. | |
| alp_status_t | alp_postal_envelope_remove_bodypart (AlpPostalEnvelope *ioEnvelopeP, char *iBodypartNameStrP) |
| Remove a bodypart from an envelope by giving its address. | |
| alp_status_t | alp_postal_envelope_remove_bodypart_by_part_no (AlpPostalEnvelope *ioEnvelopeP, alp_postal_bodypart_part_no_t iPartNo) |
| Remove a bodypart from an envelope by giving its partNo. partNo ordering may change after the part is removed. | |
| alp_status_t | alp_postal_envelope_reply (alp_postal_service_id_t iServiceId, alp_postal_envelope_id_t iEnvelopeId, AlpPostalEnvelope *ioReplyEnvelopeP, bool iReplyToAll) |
| Create a Reply envelope from a stored envelope id. | |
| alp_status_t | alp_postal_envelope_set_bodypart (AlpPostalEnvelope *ioEnvelopeP, AlpPostalBodyPartContainerList *iBodyPartContainerListP) |
| Add a bodypart to an envelope. | |
| alp_status_t | alp_postal_envelope_set_property (AlpPostalEnvelope *ioEnvelopeP, alp_postal_property_id_t iEnvelopePropertyId, alp_postal_property_const_value_t iEnvelopePropertyDataP, uint16_t iEnvelopePropertyDataSize) |
| Set a property to a Postal Envelope. | |
| alp_status_t | alp_postal_envelope_update (alp_postal_service_id_t iServiceId, alp_postal_envelope_id_t iEnvelopeId, alp_postal_address_class_t iUpdateAddressMask, bool iUpdateBodyparts, AlpPostalEnvelope *iEnvelopeP) |
| Update a stored envelope. | |
| alp_status_t | alp_postal_envelope_update_address (alp_postal_service_id_t iServiceId, alp_postal_envelope_id_t iEnvelopeId, AlpPostalAddress *iAddress) |
| Update an existing envelope address, according to its class and address string. | |
Generated on Wed Jul 30 07:06:40 2008 by Doxygen 1.4.6 for ALP SDK + Hiker Documentation
Copyright © 1999-2008 ACCESS CO., LTD. All rights reserved.