IXPLogon.c File Reference

Transport provider status information. More...

#include "libmapi/libmapi.h"
#include "libmapi/libmapi_private.h"

Functions

_PUBLIC_ enum MAPISTATUS AddressTypes (mapi_object_t *obj_store, uint16_t *lpcAdrType, struct mapi_LPSTR **lpAdrTypeArray)
 
_PUBLIC_ enum MAPISTATUS OptionsData (mapi_object_t *obj_store, const char *addrtype, uint8_t **OptionsData, uint16_t *OptionsLength, uint8_t **HelpFile, uint16_t *HelpFileLength, const char **HelpFileName)
 
_PUBLIC_ enum MAPISTATUS SetSpooler (mapi_object_t *obj_store)
 
_PUBLIC_ enum MAPISTATUS SpoolerLockMessage (mapi_object_t *obj_store, mapi_object_t *obj_message, enum LockState lockstate)
 

Detailed Description

Transport provider status information.

Function Documentation

_PUBLIC_ enum MAPISTATUS AddressTypes ( mapi_object_t obj_store,
uint16_t *  lpcAdrType,
struct mapi_LPSTR **  lpAdrTypeArray 
)

Returns the types of recipients that the transport provider handles.

Parameters
obj_storethe object to get recipients types from
lpcAdrTypethe count of recipients types returned
lpAdrTypeArraypointer on pointer of returned transport provider types
Returns
MAPI_E_SUCCESS on success, otherwise MAPI error.
Note
Developers may also call GetLastError() to retrieve the last MAPI error code. Possible MAPI error codes are:
  • MAPI_E_NOT_INITIALIZED: MAPI subsystem has not been initialized
  • MAPI_E_INVALID_PARAMETER: obj_store is not initialized
  • MAPI_E_CALL_FAILED: A network problem was encountered during the transaction

References emsmdb_transaction_wrapper(), mapi_object_get_handle(), mapi_object_get_logon_id(), mapi_object_get_session(), OPENCHANGE_CHECK_NOTIFICATION, and OPENCHANGE_RETVAL_IF.

_PUBLIC_ enum MAPISTATUS OptionsData ( mapi_object_t obj_store,
const char *  addrtype,
uint8_t **  OptionsData,
uint16_t *  OptionsLength,
uint8_t **  HelpFile,
uint16_t *  HelpFileLength,
const char **  HelpFileName 
)

Returns options information for the types of recipients that the transport provider handles.

Parameters
[in]obj_storethe object to get recipients types from
[in]addrtypestring name of the address type to get options for
[out]OptionsDatathe options data for this addrtype
[out]OptionsLengthlength of the OptionsData array
[out]HelpFilethe help file data for this addrtype (often empty)
[out]HelpFileLengthlength of the HelpFile array
[out]HelpFileNamethe name of the help file (often null)

The caller is responsible for talloc_free()ing the OptionsData array.

Returns
MAPI_E_SUCCESS on success, otherwise MAPI error.
Note
Developers may also call GetLastError() to retrieve the last MAPI error code. Possible MAPI error codes are:
  • MAPI_E_NOT_INITIALIZED: MAPI subsystem has not been initialized
  • MAPI_E_INVALID_PARAMETER: obj_store is not initialized
  • MAPI_E_CALL_FAILED: A network problem was encountered during the transaction

References emsmdb_transaction_wrapper(), mapi_object_get_handle(), mapi_object_get_logon_id(), mapi_object_get_session(), and OPENCHANGE_RETVAL_IF.

_PUBLIC_ enum MAPISTATUS SetSpooler ( mapi_object_t obj_store)

Informs the server that the client intends to act as a mail spooler.

Parameters
obj_store,:the object server store object
Returns
MAPI_E_SUCCESS on success, otherwise MAPI error.
Note
Developers may also call GetLastError() to retrieve the last MAPI error code. Possible MAPI error codes are:
  • MAPI_E_NOT_INITIALIZED: MAPI subsystem has not been initialized
  • MAPI_E_INVALID_PARAMETER: obj_store is not initialized
  • MAPI_E_CALL_FAILED: A network problem was encountered during the transaction
See Also
SpoolerLockMessage

References emsmdb_transaction_wrapper(), mapi_object_get_handle(), mapi_object_get_logon_id(), mapi_object_get_session(), OPENCHANGE_CHECK_NOTIFICATION, and OPENCHANGE_RETVAL_IF.

_PUBLIC_ enum MAPISTATUS SpoolerLockMessage ( mapi_object_t obj_store,
mapi_object_t obj_message,
enum LockState  lockstate 
)

Locks the specified message for spooling.

Parameters
obj_storethe store object
obj_messagethe message object we want to lock
lockstatethe lock state

Possible values for the lock state:

  1. LockState_1stLock (0x0): Mark the message as locked
  2. LockState_1stUnlock (0x1): Mark the message as unlocked
  3. LockState_1stFinished (0x2): Mark the message as ready for processing by the server
Returns
MAPI_E_SUCCESS on success, otherwise MAPI error.
Note
Developers may also call GetLastError() to retrieve the last MAPI error code. Possible MAPI error codes are:
  • MAPI_E_NOT_INITIALIZED: MAPI subsystem has not been initialized
  • MAPI_E_INVALID_PARAMETER: obj_store is not initialized
  • MAPI_E_CALL_FAILED: A network problem was encountered during the transaction
See Also
SetSPooler

References emsmdb_transaction_wrapper(), mapi_object_get_handle(), mapi_object_get_id(), mapi_object_get_logon_id(), mapi_object_get_session(), OPENCHANGE_CHECK_NOTIFICATION, and OPENCHANGE_RETVAL_IF.


Creative Commons License
Creative Commons Attribution icon Creative Commons Share Alike icon
This content is licensed under the Creative Commons
Attribution ShareAlike License v. 3.0:
http://creativecommons.org/licenses/by-sa/3.0/