MAPI subsystem related operations. More...
#include "libmapi/libmapi.h"
#include "libmapi/libmapi_private.h"
Functions | |
_PUBLIC_ enum MAPISTATUS | GetLoadparmContext (struct mapi_context *mapi_ctx, struct loadparm_context **lp_ctx) |
_PUBLIC_ enum MAPISTATUS | MAPIInitialize (struct mapi_context **_mapi_ctx, const char *profiledb) |
_PUBLIC_ enum MAPISTATUS | MapiLogonEx (struct mapi_context *mapi_ctx, struct mapi_session **session, const char *profname, const char *password) |
_PUBLIC_ enum MAPISTATUS | MapiLogonProvider (struct mapi_context *mapi_ctx, struct mapi_session **session, const char *profname, const char *password, enum PROVIDER_ID provider) |
_PUBLIC_ void | MAPIUninitialize (struct mapi_context *mapi_ctx) |
_PUBLIC_ enum MAPISTATUS | SetMAPIDebugLevel (struct mapi_context *mapi_ctx, uint32_t level) |
_PUBLIC_ enum MAPISTATUS | SetMAPIDumpData (struct mapi_context *mapi_ctx, bool status) |
MAPI subsystem related operations.
_PUBLIC_ enum MAPISTATUS GetLoadparmContext | ( | struct mapi_context * | mapi_ctx, | |
struct loadparm_context ** | lp_ctx | |||
) |
Retrieve the MAPI loadparm context for specified MAPI context
mapi_ctx | pointer to the MAPI context | |
lp_ctx | pointer to a pointer to the loadparm context that the function returns |
References mapi_context::lp_ctx, and OPENCHANGE_RETVAL_IF.
_PUBLIC_ enum MAPISTATUS MAPIInitialize | ( | struct mapi_context ** | _mapi_ctx, | |
const char * | profiledb | |||
) |
Initialize mapi context structure
This function inititalizes the MAPI subsystem and open the profile database pointed by profiledb .
_mapi_ctx | pointer to the MAPI context | |
profiledb | profile database path |
References mapi_context::dumpdata, mapi_context::ldb_ctx, mapi_context::lp_ctx, mapi_context::mem_ctx, OPENCHANGE_RETVAL_IF, OpenProfileStore(), and mapi_context::session.
_PUBLIC_ enum MAPISTATUS MapiLogonEx | ( | struct mapi_context * | mapi_ctx, | |
struct mapi_session ** | session, | |||
const char * | profname, | |||
const char * | password | |||
) |
Create a full MAPI session
Open providers stored in the profile and return a pointer on a IMAPISession object.
mapi_ctx | pointer to the MAPI context | |
session | pointer to a pointer to a MAPI session object | |
profname | profile name to use | |
password | password to use for the profile |
password should be set to NULL if the password has been stored in the profile.
References MapiLogonProvider(), PROVIDER_ID_EMSMDB, and PROVIDER_ID_NSPI.
_PUBLIC_ enum MAPISTATUS MapiLogonProvider | ( | struct mapi_context * | mapi_ctx, | |
struct mapi_session ** | session, | |||
const char * | profname, | |||
const char * | password, | |||
enum PROVIDER_ID | provider | |||
) |
Initialize a session on the specified provider
mapi_ctx | pointer to the MAPI context | |
session | pointer to a pointer to a MAPI session object | |
profname | profile name | |
password | profile password | |
provider | provider we want to establish a connection on |
password should be set to NULL if the password has been stored in the profile.
Supported providers are:
References mapi_session::emsmdb, emsmdb_disconnect_dtor(), LoadProfile(), Logon(), mapi_session::logon_ids, mapi_session::mapi_ctx, mapi_context::mem_ctx, mapi_session::next, mapi_session::nspi, nspi_disconnect_dtor(), OPENCHANGE_RETVAL_IF, OpenProfile(), mapi_session::profile, PROVIDER_ID_EMSMDB, PROVIDER_ID_NSPI, and mapi_context::session.
Referenced by DuplicateProfile(), and MapiLogonEx().
_PUBLIC_ void MAPIUninitialize | ( | struct mapi_context * | mapi_ctx | ) |
Uninitialize MAPI subsystem
mapi_ctx | pointer to the MAPI context |
This function uninitializes the MAPI context and destroy recursively the whole mapi session and associated objects hierarchy
References mapi_notify_ctx::fd, mapi_context::mem_ctx, mapi_session::notify_ctx, and mapi_context::session.
_PUBLIC_ enum MAPISTATUS SetMAPIDebugLevel | ( | struct mapi_context * | mapi_ctx, | |
uint32_t | level | |||
) |
Set MAPI debug level
mapi_ctx | pointer to the MAPI context | |
level | the debug level to set |
References mapi_context::lp_ctx, mapi_context::mem_ctx, and OPENCHANGE_RETVAL_IF.
_PUBLIC_ enum MAPISTATUS SetMAPIDumpData | ( | struct mapi_context * | mapi_ctx, | |
bool | status | |||
) |
Enable MAPI network trace output
mapi_ctx | pointer to the MAPI context | |
status | the status |
possible status values/behavior:
References mapi_context::dumpdata, and OPENCHANGE_RETVAL_IF.
![]() ![]() ![]() |
This content is licensed under the Creative Commons Attribution ShareAlike License v. 3.0: http://creativecommons.org/licenses/by-sa/3.0/ |