libmapi/IMSProvider.c File Reference

Provider operations. More...

#include <libmapi/libmapi.h>

Functions

enum MAPISTATUS GetNewLogonId (struct mapi_session *session, uint8_t *logon_id)
_PUBLIC_ enum MAPISTATUS Logoff (mapi_object_t *obj_store)
_PUBLIC_ enum MAPISTATUS RegisterNotification (uint16_t ulEventMask)
_PUBLIC_ enum MAPISTATUS RfrGetFQDNFromLegacyDN (struct mapi_session *session, const char **serverFQDN)
_PUBLIC_ char * RfrGetNewDSA (struct mapi_session *session, const char *server, const char *userDN)

Detailed Description

Provider operations.


Function Documentation

enum MAPISTATUS GetNewLogonId ( struct mapi_session *  session,
uint8_t *  logon_id 
)

Retrieve a free logon identifier within the session

Parameters:
sessionpointer to the MAPI session context
logon_idpointer to the logon identifier the function returns
Returns:
MAPI_E_SUCCESS on success, otherwise MAPI eorr

Referenced by OpenPublicFolder(), and OpenUserMailbox().

_PUBLIC_ enum MAPISTATUS Logoff ( mapi_object_t *  obj_store)

Logoff an Exchange store

This function uninitializes the MAPI session associated to the object.

Parameters:
obj_storepointer to the store object
Returns:
MAPI_E_SUCCESS on success, otherwise MAPI_E_NOT_FOUND
Examples:
fetchappointment.c, and fetchmail.c.

References mapi_object_get_session(), and mapi_object_release().

_PUBLIC_ enum MAPISTATUS RegisterNotification ( uint16_t  ulEventMask)

Initialize the notification subsystem

This function initializes the notification subsystem, binds a local UDP port to receive Exchange (server side) notifications and configures the server to send notifications on this port.

Parameters:
ulEventMaskthe mask of events to provide notifications for.
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_CALL_FAILED: A network problem was encountered during the transaction
See also:
Subscribe, Unsubscribe, MonitorNotification, GetLastError

References emsmdb_bind_notification(), and emsmdb_register_notification().

_PUBLIC_ enum MAPISTATUS RfrGetFQDNFromLegacyDN ( struct mapi_session *  session,
const char **  serverFQDN 
)

Returns the FQDN of the NSPI server corresponding to a DN

Parameters:
sessionpointer to the MAPI session context
serverFQDNpointer to the server FQDN string (return value)
Returns:
MAPI_E_SUCCESS on success, otherwise a MAPI error and serverFQDN content set to NULL.
_PUBLIC_ char* RfrGetNewDSA ( struct mapi_session *  session,
const char *  server,
const char *  userDN 
)

Returns the name of an NSPI server

Parameters:
sessionpointer to the MAPI session context
serverthe Exchange server address (IP or FQDN)
userDNoptional user mailbox DN
Returns:
a valid allocated string on success, otherwise NULL.
Note:
The string returned can either be RfrGetNewDSA one on success, or a copy of the server's argument one on failure. If no server string is provided, NULL is returned.

It is up to the developer to free the returned string when not needed anymore.


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/