yetangitu/deltachat-core
1
0
Fork 0
mirror of https://github.com/deltachat/deltachat-core.git synced 2025-10-05 02:29:28 +02:00
Code Issues Releases Wiki Activity

Doxygen

Browse source
This commit is contained in:
B. Petersen 2017-11-15 17:12:43 +01:00
parent 76d950ae74
commit ed1da4f70f
27 changed files with 45 additions and 78 deletions
Download patch file Download diff file Expand all files Collapse all files

25
docs/html/structmrmailbox__t.html
View file

@ -266,11 +266,11 @@ Public Member Functions</h2></td></tr>
<tr class="memitem:a67281e50b568dc18df710275e0e13f5b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrmailbox__t.html#a67281e50b568dc18df710275e0e13f5b">mrmailbox_markseen_msgs</a> (<a class="el" href="structmrmailbox__t.html">mrmailbox_t</a> *mailbox, const uint32_t *msg_ids, int msg_cnt)</td></tr>
<tr class="memdesc:a67281e50b568dc18df710275e0e13f5b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Mark a message as <em>seen</em>, updates the IMAP state and sends MDNs. <a href="#a67281e50b568dc18df710275e0e13f5b">More...</a><br /></td></tr>
<tr class="separator:a67281e50b568dc18df710275e0e13f5b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af204aadf66e8adf5403987c5dcf85387"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrmailbox__t.html#af204aadf66e8adf5403987c5dcf85387">mrmailbox_configure_and_connect</a> (<a class="el" href="structmrmailbox__t.html">mrmailbox_t</a> *mailbox)</td></tr>
<tr class="memdesc:af204aadf66e8adf5403987c5dcf85387"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configure and connect a mailbox. <a href="#af204aadf66e8adf5403987c5dcf85387">More...</a><br /></td></tr>
<tr class="separator:af204aadf66e8adf5403987c5dcf85387"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a42ca741cc08785585f1dc74d515be5ef"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrmailbox__t.html#a42ca741cc08785585f1dc74d515be5ef">mrmailbox_configure_and_connect</a> (<a class="el" href="structmrmailbox__t.html">mrmailbox_t</a> *mailbox)</td></tr>
<tr class="memdesc:a42ca741cc08785585f1dc74d515be5ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configure and connect a mailbox. <a href="#a42ca741cc08785585f1dc74d515be5ef">More...</a><br /></td></tr>
<tr class="separator:a42ca741cc08785585f1dc74d515be5ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8127c0e3f4cfda14fdfd7be9f43715ef"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrmailbox__t.html#a8127c0e3f4cfda14fdfd7be9f43715ef">mrmailbox_configure_cancel</a> (<a class="el" href="structmrmailbox__t.html">mrmailbox_t</a> *mailbox)</td></tr>
<tr class="memdesc:a8127c0e3f4cfda14fdfd7be9f43715ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cancel an configuration started by <a class="el" href="structmrmailbox__t.html#af204aadf66e8adf5403987c5dcf85387" title="Configure and connect a mailbox. ">mrmailbox_configure_and_connect()</a>. <a href="#a8127c0e3f4cfda14fdfd7be9f43715ef">More...</a><br /></td></tr>
<tr class="memdesc:a8127c0e3f4cfda14fdfd7be9f43715ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Signal the configure-process to stop. <a href="#a8127c0e3f4cfda14fdfd7be9f43715ef">More...</a><br /></td></tr>
<tr class="separator:a8127c0e3f4cfda14fdfd7be9f43715ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa6e325e49ecccfc96276db6c327dba94"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrmailbox__t.html#aa6e325e49ecccfc96276db6c327dba94">mrmailbox_is_configured</a> (<a class="el" href="structmrmailbox__t.html">mrmailbox_t</a> *mailbox)</td></tr>
<tr class="memdesc:aa6e325e49ecccfc96276db6c327dba94"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if the mailbox is already configured. <a href="#aa6e325e49ecccfc96276db6c327dba94">More...</a><br /></td></tr>
@ -562,12 +562,12 @@ void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="st
</div>
</div>
<a class="anchor" id="af204aadf66e8adf5403987c5dcf85387"></a>
<a class="anchor" id="a42ca741cc08785585f1dc74d515be5ef"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrmailbox_configure_and_connect </td>
<td class="memname">int mrmailbox_configure_and_connect </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmrmailbox__t.html">mrmailbox_t</a> *&#160;</td>
<td class="paramname"><em>mailbox</em></td><td>)</td>
@ -579,17 +579,16 @@ void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="st
<p>Configure and connect a mailbox. </p>
<ul>
<li>Before your call this function, you should set at least <code>addr</code> and <code>mail_pw</code> using <a class="el" href="structmrmailbox__t.html#a19b3e9f5209bc326fc77f3944522e8ad" title="Configure the mailbox. ">mrmailbox_set_config()</a>.</li>
<li><a class="el" href="structmrmailbox__t.html#af204aadf66e8adf5403987c5dcf85387" title="Configure and connect a mailbox. ">mrmailbox_configure_and_connect()</a> returns immediately, configuration is done in another thread; when done, the event MR_EVENT_CONFIGURE_ENDED ist posted</li>
<li><a class="el" href="structmrmailbox__t.html#a42ca741cc08785585f1dc74d515be5ef" title="Configure and connect a mailbox. ">mrmailbox_configure_and_connect()</a> may take a while, so it might be a good idea to let it run in a non-GUI-thread; to cancel the configuration progress, you can then use <a class="el" href="structmrmailbox__t.html#a8127c0e3f4cfda14fdfd7be9f43715ef" title="Signal the configure-process to stop. ">mrmailbox_configure_cancel()</a></li>
<li>There is no need to call this every program start, the result is saved in the database.</li>
<li><a class="el" href="structmrmailbox__t.html#af204aadf66e8adf5403987c5dcf85387" title="Configure and connect a mailbox. ">mrmailbox_configure_and_connect()</a> should be called after any settings change.</li>
</ul>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mailbox</td><td>the mailbox object as created by <a class="el" href="structmrmailbox__t.html#a32825e3e0a1b16679580704a4b43db1a" title="Create a new mailbox object. ">mrmailbox_new()</a></td></tr>
<tr><td class="paramname">mailbox</td><td>the mailbox object as created by <a class="el" href="structmrmailbox__t.html#a32825e3e0a1b16679580704a4b43db1a" title="Create a new mailbox object. ">mrmailbox_new()</a>.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>none </dd></dl>
<dl class="section return"><dt>Returns</dt><dd>1=configured and connected, 0=not configured, not explicitly connected, however, an existing connection may still be present </dd></dl>
</div>
</div>
@ -607,7 +606,9 @@ void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="st
</table>
</div><div class="memdoc">
<p>Cancel an configuration started by <a class="el" href="structmrmailbox__t.html#af204aadf66e8adf5403987c5dcf85387" title="Configure and connect a mailbox. ">mrmailbox_configure_and_connect()</a>. </p>
<p>Signal the configure-process to stop. </p>
<p>After that, <a class="el" href="structmrmailbox__t.html#a8127c0e3f4cfda14fdfd7be9f43715ef" title="Signal the configure-process to stop. ">mrmailbox_configure_cancel()</a> returns <em>without</em> waiting for <a class="el" href="structmrmailbox__t.html#a42ca741cc08785585f1dc74d515be5ef" title="Configure and connect a mailbox. ">mrmailbox_configure_and_connect()</a> to return.</p>
<p><a class="el" href="structmrmailbox__t.html#a42ca741cc08785585f1dc74d515be5ef" title="Configure and connect a mailbox. ">mrmailbox_configure_and_connect()</a> will return ASAP then, however, it may still take a second. If in doubt, the caller may also decide the kill the thread after a few seconds; eg. the configuration process may hang in a function not under the control of the core (eg. <a class="el" href="mrevent_8h.html#aba8b1a46a18cd05070b301c757a74ddc" title="Request a HTTP-file from the frontend. ">MR_EVENT_HTTP_GET</a>)</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mailbox</td><td>The mailbox object as created by <a class="el" href="structmrmailbox__t.html#a32825e3e0a1b16679580704a4b43db1a" title="Create a new mailbox object. ">mrmailbox_new()</a></td></tr>
@ -1876,7 +1877,7 @@ void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="st
</div><div class="memdoc">
<p>Check if the mailbox is already configured. </p>
<p>Typically, for unconfigured mailboxes, the user is prompeted for to enter some settings and <a class="el" href="structmrmailbox__t.html#af204aadf66e8adf5403987c5dcf85387" title="Configure and connect a mailbox. ">mrmailbox_configure_and_connect()</a> is called with them.</p>
<p>Typically, for unconfigured mailboxes, the user is prompeted for to enter some settings and <a class="el" href="structmrmailbox__t.html#a42ca741cc08785585f1dc74d515be5ef" title="Configure and connect a mailbox. ">mrmailbox_configure_and_connect()</a> is called with them.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mailbox</td><td>The mailbox object as created by <a class="el" href="structmrmailbox__t.html#a32825e3e0a1b16679580704a4b43db1a" title="Create a new mailbox object. ">mrmailbox_new()</a></td></tr>