Service
[POP]

Detailed Description

Postal POP service APIs.

Data Structures

struct _AlpPostalPopSessionInfoList

Defines

#define ALP_POSTAL_POP_SERVICE_CLASS_ID_SESSION ALP_POSTAL_SERVICE_CLASS_ID(ALP_POSTAL_SERVICE_LAST_CLASS_ID + 1)

#define ALP_POSTAL_SERVICE_ID_POP ALP_POSTAL_SERVICE_ID(10)

Typedefs

typedef _AlpPostalPopSessionInfoList AlpPostalPopSessionInfoList

returned by alp_postal_pop_service_get_session_info_list() See postal_pop_session.h and postal_imap_session.h for a list of properties supported inside this list

typedef _AlpPostalPopSessionInfoType AlpPostalPopSessionInfoType

Defines The Pop session Info datatype.

Functions

alp_status_t alp_postal_pop_service_clear_inactive_session_info_list ()

clear the inactive sessions in the postal context

alp_status_t alp_postal_pop_service_enable_sync_progress_notifications (bool enable)

Called from an email application when opening and closing the email progress dialog UI. This API will enable or disable expensive sync progress notifications to make sure they are only generated when needed by the UI.

alp_status_t alp_postal_pop_service_finalize (void)

service finalize.

alp_status_t alp_postal_pop_service_free_session_info_list (AlpPostalPopSessionInfoList *iSessionInfoListP)

Free a session info list.

alp_status_t alp_postal_pop_service_get_log_level (alp_postal_log_level_t *oMaxLogLevel)

Gets the log level for the given plugin which is used to filter what log entries are created.

alp_status_t alp_postal_pop_service_get_max_log_entries (uint32_t *oMaxLogEntries)

Gets the max log entries limit for the given plugin.

alp_status_t alp_postal_pop_service_get_session_info_list (AlpPostalPopSessionInfoList *oSessionInfo)

Returns a list of all active asynchronous POP sessions.

alp_status_t alp_postal_pop_service_init_session_info_list (AlpPostalPopSessionInfoList *iSessionInfoListP)

Initialize a session info list. MUST be called before use.

alp_status_t alp_postal_pop_service_initialize (void)

service initialize.

alp_status_t alp_postal_pop_service_post_attention_alerts (bool iEnabled)

Called from an email application to enable or disable the generation of Attention Manager alerts (ie "You have new mail") by the plugin.

alp_status_t alp_postal_pop_service_set_log_level (alp_postal_log_level_t iMaxLogLevel)

Sets the log level for the given plugin which is used to filter what log entries are created. Lowering the log level value will produce fewer log entries by sessions run by the plugin.

alp_status_t alp_postal_pop_service_set_max_log_entries (uint32_t iMaxLogEntries)

Sets the max log entries limit for the given plugin. Lowering the log entries value will result in a smaller number log entries for the plugin and if needed, excess log entries being deleted from oldest to newest.

int alp_postal_pop_unpack_session_info (AlpPostalProperty *propertyP, AlpPostalPopSessionInfoType *sessionInfoP)

This is a utility function to unpack data in an AlpPostalProperty that was retrieved using alp_postal_pop_service_get_session_info_list(). Each property in that list can be passed to this utility to extract the blob data contained in it.

Define Documentation

#define ALP_POSTAL_POP_SERVICE_CLASS_ID_SESSION ALP_POSTAL_SERVICE_CLASS_ID(ALP_POSTAL_SERVICE_LAST_CLASS_ID + 1)

#define ALP_POSTAL_SERVICE_ID_POP ALP_POSTAL_SERVICE_ID(10)

Typedef Documentation

typedef struct _AlpPostalPopSessionInfoList AlpPostalPopSessionInfoList

returned by alp_postal_pop_service_get_session_info_list() See postal_pop_session.h and postal_imap_session.h for a list of properties supported inside this list

typedef struct _AlpPostalPopSessionInfoType AlpPostalPopSessionInfoType

Defines The Pop session Info datatype.

Function Documentation

alp_status_t alp_postal_pop_service_clear_inactive_session_info_list ( )

clear the inactive sessions in the postal context

Returns:
POSTAL_STATUS_OK on success

alp_status_t alp_postal_pop_service_enable_sync_progress_notifications ( bool enable )

Called from an email application when opening and closing the email progress dialog UI. This API will enable or disable expensive sync progress notifications to make sure they are only generated when needed by the UI.

Parameters:

[in] enable If true, then ALP_POSTAL_POP_NOTIFICATION_SYNC_PROGRESS notifications will be generated by any active POP sessions.

Returns:
POSTAL_STATUS_OK: Success POSTAL_STATUS_MEMORY_ERROR: Failed to send request

alp_status_t alp_postal_pop_service_finalize ( void )

service finalize.

Returns:
Returns an error code.

alp_status_t alp_postal_pop_service_free_session_info_list ( AlpPostalPopSessionInfoList * iSessionInfoListP )

Free a session info list.

Parameters:

[in] iSessionInfoListP An AlpPostalPopSessionInfoList structure.

Returns:
POSTAL_STATUS_OK on success

alp_status_t alp_postal_pop_service_get_log_level ( alp_postal_log_level_t * oMaxLogLevel )

Gets the log level for the given plugin which is used to filter what log entries are created.

Remarks:
see alp_postal_pop_service_get_log_level

Parameters:

[in] oMaxLogLevel See ALP_POSTAL_LOG_LEVEL_* The log level value currently being used by the plugin.

Returns:
POSTAL_STATUS_OK: Success POSTAL_STATUS_MEMORY_ERROR: Failed to send request

alp_status_t alp_postal_pop_service_get_max_log_entries ( uint32_t * oMaxLogEntries )

Gets the max log entries limit for the given plugin.

Remarks:
see alp_postal_pop_service_get_log_entries

Parameters:

[out] oMaxLogEntries The max log entries limit currently being used by the plugin.

Returns:
POSTAL_STATUS_OK: Success POSTAL_STATUS_MEMORY_ERROR: Failed to send request

alp_status_t alp_postal_pop_service_get_session_info_list ( AlpPostalPopSessionInfoList * oSessionInfo )

Returns a list of all active asynchronous POP sessions.

Parameters:

[out] oSessionInfo List of active POP sessions along with relavent information.

Returns:
0 or POSTAL_STATUS_NOT_FOUND if no sessions exist

alp_status_t alp_postal_pop_service_init_session_info_list ( AlpPostalPopSessionInfoList * iSessionInfoListP )

Initialize a session info list. MUST be called before use.

Parameters:

[in] iSessionInfoListP The AlpPostalPopSessionInfoList to be initialized.

Returns:
POSTAL_STATUS_OK on success

alp_status_t alp_postal_pop_service_initialize ( void )

service initialize.

Returns:
Returns an error code.

alp_status_t alp_postal_pop_service_post_attention_alerts ( bool iEnabled )

Called from an email application to enable or disable the generation of Attention Manager alerts (ie "You have new mail") by the plugin.
The email application should pass true to enable the generation of alerts when the UI is not running (exited).

Parameters:

[in] iEnabled If true, then attention manager alerts may be generated when new email is downloaded.

Returns:
POSTAL_STATUS_OK: success POSTAL_STATUS_MEMORY_ERROR: failed to send request

alp_status_t alp_postal_pop_service_set_log_level ( alp_postal_log_level_t iMaxLogLevel )

Sets the log level for the given plugin which is used to filter what log entries are created. Lowering the log level value will produce fewer log entries by sessions run by the plugin.

Remarks:
see alp_postal_pop_service_get_log_level

Parameters:

[in] iMaxLogLevel See ALP_POSTAL_LOG_LEVEL_* Note, set to 0 to disable logging for the given plugin

Returns:
POSTAL_STATUS_OK: Success POSTAL_STATUS_MEMORY_ERROR: Failed to send request

alp_status_t alp_postal_pop_service_set_max_log_entries ( uint32_t iMaxLogEntries )

Sets the max log entries limit for the given plugin. Lowering the log entries value will result in a smaller number log entries for the plugin and if needed, excess log entries being deleted from oldest to newest.

Parameters:

[in] iMaxLogEntries Note, set to 0 for no limit

Returns:
POSTAL_STATUS_OK: Success POSTAL_STATUS_MEMORY_ERROR: Failed to send request

int alp_postal_pop_unpack_session_info ( AlpPostalProperty * propertyP,

AlpPostalPopSessionInfoType * sessionInfoP

)

This is a utility function to unpack data in an AlpPostalProperty that was retrieved using alp_postal_pop_service_get_session_info_list(). Each property in that list can be passed to this utility to extract the blob data contained in it.

Parameters:

[in] propertyP A property in the linked list returned by alp_postal_pop_service_get_session_info_list().

[out] sessionInfoP A struct used to store unpacked data from the blob

Returns:
Number of bytes unpacked or -1 for error

Generated on Wed Jul 30 07:06:43 2008 by Doxygen 1.4.6 for ALP SDK + Hiker Documentation


Data Structures
struct	_AlpPostalPopSessionInfoList
Defines
#define	ALP_POSTAL_POP_SERVICE_CLASS_ID_SESSION ALP_POSTAL_SERVICE_CLASS_ID(ALP_POSTAL_SERVICE_LAST_CLASS_ID + 1)
#define	ALP_POSTAL_SERVICE_ID_POP ALP_POSTAL_SERVICE_ID(10)
Typedefs
typedef _AlpPostalPopSessionInfoList	AlpPostalPopSessionInfoList
	returned by alp_postal_pop_service_get_session_info_list() See postal_pop_session.h and postal_imap_session.h for a list of properties supported inside this list
typedef _AlpPostalPopSessionInfoType	AlpPostalPopSessionInfoType
	Defines The Pop session Info datatype.
Functions
alp_status_t	alp_postal_pop_service_clear_inactive_session_info_list ()
	clear the inactive sessions in the postal context
alp_status_t	alp_postal_pop_service_enable_sync_progress_notifications (bool enable)
	Called from an email application when opening and closing the email progress dialog UI. This API will enable or disable expensive sync progress notifications to make sure they are only generated when needed by the UI.
alp_status_t	alp_postal_pop_service_finalize (void)
	service finalize.
alp_status_t	alp_postal_pop_service_free_session_info_list (AlpPostalPopSessionInfoList *iSessionInfoListP)
	Free a session info list.
alp_status_t	alp_postal_pop_service_get_log_level (alp_postal_log_level_t *oMaxLogLevel)
	Gets the log level for the given plugin which is used to filter what log entries are created.
alp_status_t	alp_postal_pop_service_get_max_log_entries (uint32_t *oMaxLogEntries)
	Gets the max log entries limit for the given plugin.
alp_status_t	alp_postal_pop_service_get_session_info_list (AlpPostalPopSessionInfoList *oSessionInfo)
	Returns a list of all active asynchronous POP sessions.
alp_status_t	alp_postal_pop_service_init_session_info_list (AlpPostalPopSessionInfoList *iSessionInfoListP)
	Initialize a session info list. MUST be called before use.
alp_status_t	alp_postal_pop_service_initialize (void)
	service initialize.
alp_status_t	alp_postal_pop_service_post_attention_alerts (bool iEnabled)
	Called from an email application to enable or disable the generation of Attention Manager alerts (ie "You have new mail") by the plugin.
alp_status_t	alp_postal_pop_service_set_log_level (alp_postal_log_level_t iMaxLogLevel)
	Sets the log level for the given plugin which is used to filter what log entries are created. Lowering the log level value will produce fewer log entries by sessions run by the plugin.
alp_status_t	alp_postal_pop_service_set_max_log_entries (uint32_t iMaxLogEntries)
	Sets the max log entries limit for the given plugin. Lowering the log entries value will result in a smaller number log entries for the plugin and if needed, excess log entries being deleted from oldest to newest.
int	alp_postal_pop_unpack_session_info (AlpPostalProperty propertyP, AlpPostalPopSessionInfoType sessionInfoP)
	This is a utility function to unpack data in an AlpPostalProperty that was retrieved using alp_postal_pop_service_get_session_info_list(). Each property in that list can be passed to this utility to extract the blob data contained in it.

Service [POP]

Detailed Description

Data Structures

Defines

Typedefs

Functions

Define Documentation

Typedef Documentation

Function Documentation

Service
[POP]