<html>
<head>
<title>MAPIClientLibraries 0.8 API Documentation</title>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
<link href="apidocs.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="website">
<div class="header"></div>
<div id="middle_side">
<div id="right_side_home">
<!-- Generated by Doxygen 1.5.9 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>libmapi/IMAPISession.c File Reference</h1>Session initialization options.
<a href="#_details">More...</a>
<p>
<code>#include <libmapi/libmapi.h></code><br>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">_PUBLIC_ enum MAPISTATUS </td><td class="memItemRight" valign="bottom"><a class="el" href="IMAPISession_8c.html#4fdd3c5db64deb2173a9bc921aee2dfd">OpenMsgStore</a> (struct mapi_session *session, mapi_object_t *obj_store)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">_PUBLIC_ enum MAPISTATUS </td><td class="memItemRight" valign="bottom"><a class="el" href="IMAPISession_8c.html#d878c431f446bd697010fab197cfe5ef">OpenPublicFolder</a> (struct mapi_session *session, mapi_object_t *obj_store)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">_PUBLIC_ enum MAPISTATUS </td><td class="memItemRight" valign="bottom"><a class="el" href="IMAPISession_8c.html#4dfac72df5e1bafaf43c4218286ae2c9">OpenUserMailbox</a> (struct mapi_session *session, const char *username, mapi_object_t *obj_store)</td></tr>
</table>
<hr><h2>Detailed Description</h2>
Session initialization options.
<p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="4fdd3c5db64deb2173a9bc921aee2dfd"></a><!-- doxytag: member="IMAPISession.c::OpenMsgStore" ref="4fdd3c5db64deb2173a9bc921aee2dfd" args="(struct mapi_session *session, mapi_object_t *obj_store)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">_PUBLIC_ enum MAPISTATUS OpenMsgStore </td>
<td>(</td>
<td class="paramtype">struct mapi_session * </td>
<td class="paramname"> <em>session</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">mapi_object_t * </td>
<td class="paramname"> <em>obj_store</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Open the Message Store<p>
This function opens the main message store. This allows access to the normal user folders.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>session</em> </td><td>pointer to the MAPI session context </td></tr>
<tr><td valign="top"></td><td valign="top"><em>obj_store</em> </td><td>the result of opening the store</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>MAPI_E_SUCCESS on success, otherwise MAPI error.</dd></dl>
<dl class="note" compact><dt><b>Note:</b></dt><dd>Developers may also call <a class="el" href="IUnknown_8c.html#8237c7fc76377cb07f3f55920d6f20de">GetLastError()</a> to retrieve the last MAPI error code. Possible MAPI error codes are:<ul>
<li>MAPI_E_NOT_INITIALIZED: MAPI subsystem has not been initialized</li><li>MAPI_E_CALL_FAILED: A network problem was encountered during the transaction</li></ul>
</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="cdo__mapi_8c.html#cd55ca55043b2a1c025c370725f1292a">MAPIInitialize</a> which is required before opening the store <p>
<a class="el" href="IUnknown_8c.html#8237c7fc76377cb07f3f55920d6f20de">GetLastError</a> to check the result of a failed call, if necessary <p>
<a class="el" href="IMAPISession_8c.html#d878c431f446bd697010fab197cfe5ef">OpenPublicFolder</a> if you need access to the public folders </dd></dl>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="fetchappointment_8c-example.html#a4">fetchappointment.c</a>, and <a class="el" href="fetchmail_8c-example.html#a4">fetchmail.c</a>.</dl>
<p>References <a class="el" href="IUnknown_8c_source.html#l00166">GetLastError()</a>, and <a class="el" href="IMAPISession_8c_source.html#l00306">OpenUserMailbox()</a>.</p>
</div>
</div><p>
<a class="anchor" name="d878c431f446bd697010fab197cfe5ef"></a><!-- doxytag: member="IMAPISession.c::OpenPublicFolder" ref="d878c431f446bd697010fab197cfe5ef" args="(struct mapi_session *session, mapi_object_t *obj_store)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">_PUBLIC_ enum MAPISTATUS OpenPublicFolder </td>
<td>(</td>
<td class="paramtype">struct mapi_session * </td>
<td class="paramname"> <em>session</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">mapi_object_t * </td>
<td class="paramname"> <em>obj_store</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Open the Public Folder store<p>
This function opens the public folder store. This allows access to the public folders.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>obj_store</em> </td><td>the result of opening the store </td></tr>
<tr><td valign="top"></td><td valign="top"><em>session</em> </td><td>pointer to the MAPI session context</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>MAPI_E_SUCCESS on success, otherwise MAPI error.</dd></dl>
<dl class="note" compact><dt><b>Note:</b></dt><dd>Developers may also call <a class="el" href="IUnknown_8c.html#8237c7fc76377cb07f3f55920d6f20de">GetLastError()</a> to retrieve the last MAPI error code. Possible MAPI error codes are:<ul>
<li>MAPI_E_NOT_INITIALIZED: MAPI subsystem has not been initialized</li><li>MAPI_E_CALL_FAILED: A network problem was encountered during the transaction</li></ul>
</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="cdo__mapi_8c.html#cd55ca55043b2a1c025c370725f1292a">MAPIInitialize</a> which is required before opening the store <p>
<a class="el" href="IUnknown_8c.html#8237c7fc76377cb07f3f55920d6f20de">GetLastError</a> to check the result of a failed call, if necessary <p>
<a class="el" href="IMAPISession_8c.html#4fdd3c5db64deb2173a9bc921aee2dfd">OpenMsgStore</a> if you need access to the message store folders </dd></dl>
<p>References <a class="el" href="emsmdb_8c_source.html#l00283">emsmdb_transaction()</a>, <a class="el" href="IMSProvider_8c_source.html#l00266">GetNewLogonId()</a>, <a class="el" href="mapi__object_8c_source.html#l00276">mapi_object_set_handle()</a>, <a class="el" href="mapi__object_8c_source.html#l00222">mapi_object_set_logon_id()</a>, <a class="el" href="mapi__object_8c_source.html#l00249">mapi_object_set_logon_store()</a>, and <a class="el" href="mapi__object_8c_source.html#l00181">mapi_object_set_session()</a>.</p>
</div>
</div><p>
<a class="anchor" name="4dfac72df5e1bafaf43c4218286ae2c9"></a><!-- doxytag: member="IMAPISession.c::OpenUserMailbox" ref="4dfac72df5e1bafaf43c4218286ae2c9" args="(struct mapi_session *session, const char *username, mapi_object_t *obj_store)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">_PUBLIC_ enum MAPISTATUS OpenUserMailbox </td>
<td>(</td>
<td class="paramtype">struct mapi_session * </td>
<td class="paramname"> <em>session</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>username</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">mapi_object_t * </td>
<td class="paramname"> <em>obj_store</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Open another user mailbox<p>
This function opens the main message store. This allows access to the normal user folders.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>session</em> </td><td>pointer to the MAPI session context </td></tr>
<tr><td valign="top"></td><td valign="top"><em>username</em> </td><td>name of the user's mailbox to open </td></tr>
<tr><td valign="top"></td><td valign="top"><em>obj_store</em> </td><td>the result of opening the store</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>MAPI_E_SUCCESS on success, otherwise MAPI error.</dd></dl>
<dl class="note" compact><dt><b>Note:</b></dt><dd>Developers may also call <a class="el" href="IUnknown_8c.html#8237c7fc76377cb07f3f55920d6f20de">GetLastError()</a> to retrieve the last MAPI error code. Possible MAPI error codes are:<ul>
<li>MAPI_E_NOT_INITIALIZED: MAPI subsystem has not been initialized</li><li>MAPI_E_CALL_FAILED: A network problem was encountered during the transaction</li></ul>
</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="cdo__mapi_8c.html#cd55ca55043b2a1c025c370725f1292a">MAPIInitialize</a> which is required before opening the store <p>
<a class="el" href="IUnknown_8c.html#8237c7fc76377cb07f3f55920d6f20de">GetLastError</a> to check the result of a failed call, if necessary <p>
<a class="el" href="IMAPISession_8c.html#d878c431f446bd697010fab197cfe5ef">OpenPublicFolder</a> if you need access to the public folders </dd></dl>
<p>References <a class="el" href="emsmdb_8c_source.html#l00283">emsmdb_transaction()</a>, <a class="el" href="IMSProvider_8c_source.html#l00266">GetNewLogonId()</a>, <a class="el" href="mapi__object_8c_source.html#l00276">mapi_object_set_handle()</a>, <a class="el" href="mapi__object_8c_source.html#l00222">mapi_object_set_logon_id()</a>, <a class="el" href="mapi__object_8c_source.html#l00249">mapi_object_set_logon_store()</a>, and <a class="el" href="mapi__object_8c_source.html#l00181">mapi_object_set_session()</a>.</p>
<p>Referenced by <a class="el" href="IMAPISession_8c_source.html#l00261">OpenMsgStore()</a>.</p>
</div>
</div><p>
</div>
</div>
<br/>
<table style="clear:both; margin: 0.5em auto; width:80%; text-align: center; background-color:#f8f8f8; border:2px solid #e0e0e0; padding:5px;">
<tr>
<td>
<img alt="Creative Commons License" src="CC_SomeRightsReserved.png" width="90" height="30" border="0" /><br />
<img alt="Creative Commons Attribution icon" src="24px-Cc-by_white.svg.png" width="24" height="24" border="0" />
<img alt="Creative Commons Share Alike icon" src="24px-Cc-sa_white.svg.png" width="24" height="24" border="0" />
</td>
<td> <i><strong class="selflink">This content</strong> is licensed under the Creative Commons<br />
Attribution ShareAlike License v. 3.0:<br />
<a href="http://creativecommons.org/licenses/by-sa/3.0/" class="external free" title="http://creativecommons.org/licenses/by-sa/3.0/" rel="nofollow">http://creativecommons.org/licenses/by-sa/3.0/</a></i>
</td></tr></table>
<br/>
</div>
</div>
</body>
</html>
