yetangitu/deltachat-core
1
0
Fork 0
mirror of https://github.com/deltachat/deltachat-core.git synced 2025-10-04 18:29:19 +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

2
docs/html/functions.html
View file

@ -241,7 +241,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
: <a class="el" href="structmrmailbox__t.html#a75011d103515e088e950a64d0706ec86">mrmailbox_t</a>
</li>
<li>mrmailbox_configure_and_connect()
: <a class="el" href="structmrmailbox__t.html#af204aadf66e8adf5403987c5dcf85387">mrmailbox_t</a>
: <a class="el" href="structmrmailbox__t.html#a42ca741cc08785585f1dc74d515be5ef">mrmailbox_t</a>
</li>
<li>mrmailbox_configure_cancel()
: <a class="el" href="structmrmailbox__t.html#a8127c0e3f4cfda14fdfd7be9f43715ef">mrmailbox_t</a>

2
docs/html/functions_func.html
View file

@ -158,7 +158,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
: <a class="el" href="structmrmailbox__t.html#a75011d103515e088e950a64d0706ec86">mrmailbox_t</a>
</li>
<li>mrmailbox_configure_and_connect()
: <a class="el" href="structmrmailbox__t.html#af204aadf66e8adf5403987c5dcf85387">mrmailbox_t</a>
: <a class="el" href="structmrmailbox__t.html#a42ca741cc08785585f1dc74d515be5ef">mrmailbox_t</a>
</li>
<li>mrmailbox_configure_cancel()
: <a class="el" href="structmrmailbox__t.html#a8127c0e3f4cfda14fdfd7be9f43715ef">mrmailbox_t</a>

3
docs/html/globals.html
View file

@ -91,9 +91,6 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<li>MR_EVENT_CHAT_MODIFIED
: <a class="el" href="mrevent_8h.html#a5ac741b81ec97628f44795600c0e4d4c">mrevent.h</a>
</li>
<li>MR_EVENT_CONFIGURE_ENDED
: <a class="el" href="mrevent_8h.html#a3be5f7ee95e6d0a8066e7a839f38c30f">mrevent.h</a>
</li>
<li>MR_EVENT_CONFIGURE_PROGRESS
: <a class="el" href="mrevent_8h.html#abb0881d4c7c887b8f371cedc471846b5">mrevent.h</a>
</li>

3
docs/html/globals_defs.html
View file

@ -91,9 +91,6 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<li>MR_EVENT_CHAT_MODIFIED
: <a class="el" href="mrevent_8h.html#a5ac741b81ec97628f44795600c0e4d4c">mrevent.h</a>
</li>
<li>MR_EVENT_CONFIGURE_ENDED
: <a class="el" href="mrevent_8h.html#a3be5f7ee95e6d0a8066e7a839f38c30f">mrevent.h</a>
</li>
<li>MR_EVENT_CONFIGURE_PROGRESS
: <a class="el" href="mrevent_8h.html#abb0881d4c7c887b8f371cedc471846b5">mrevent.h</a>
</li>

2
docs/html/index.html
View file

@ -83,7 +83,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<p>Let's start.</p>
<p>First of all, you have to define a function that is called by the library on specific events (eg. when the configuration is done or when fresh messages arrive). Your function should look like the following:</p>
<div class="fragment"><div class="line"><span class="preprocessor">#include &lt;mrmailbox.h&gt;</span></div><div class="line"></div><div class="line">uintptr_t my_delta_handler(<a class="code" href="structmrmailbox__t.html">mrmailbox_t</a>* nb, <span class="keywordtype">int</span> event, uintptr_t data1, uintptr_t data2)</div><div class="line">{</div><div class="line"> <span class="keywordflow">return</span> 0; <span class="comment">// for unhandled events, it is always safe to return 0</span></div><div class="line">}</div></div><!-- fragment --><p>After that, you can create and configure a <a class="el" href="structmrmailbox__t.html" title="An object representing a single mailbox. ">mrmailbox_t</a> object easily as follows:</p>
<div class="fragment"><div class="line"><a class="code" href="structmrmailbox__t.html">mrmailbox_t</a>* mb = <a class="code" href="structmrmailbox__t.html#a32825e3e0a1b16679580704a4b43db1a">mrmailbox_new</a>(my_delta_handler, NULL, NULL);</div><div class="line"></div><div class="line"><a class="code" href="structmrmailbox__t.html#a19b3e9f5209bc326fc77f3944522e8ad">mrmailbox_set_config</a>(mb, <span class="stringliteral">&quot;addr&quot;</span>, <span class="stringliteral">&quot;alice@delta.chat&quot;</span>); <span class="comment">// use some real test credentials here</span></div><div class="line"><a class="code" href="structmrmailbox__t.html#a19b3e9f5209bc326fc77f3944522e8ad">mrmailbox_set_config</a>(mb, <span class="stringliteral">&quot;mail_pw&quot;</span>, <span class="stringliteral">&quot;***&quot;</span>);</div><div class="line"></div><div class="line"><a class="code" href="structmrmailbox__t.html#af204aadf66e8adf5403987c5dcf85387">mrmailbox_configure_and_connect</a>(mb);</div></div><!-- fragment --><p>If this works, you'll receive the event <a class="el" href="mrevent_8h.html#a3be5f7ee95e6d0a8066e7a839f38c30f" title="Configurartion enden. ">MR_EVENT_CONFIGURE_ENDED</a> with <code>data1</code> set to <code>1</code> - and you can start sending your first message:</p>
<div class="fragment"><div class="line"><a class="code" href="structmrmailbox__t.html">mrmailbox_t</a>* mb = <a class="code" href="structmrmailbox__t.html#a32825e3e0a1b16679580704a4b43db1a">mrmailbox_new</a>(my_delta_handler, NULL, NULL);</div><div class="line"></div><div class="line"><a class="code" href="structmrmailbox__t.html#a19b3e9f5209bc326fc77f3944522e8ad">mrmailbox_set_config</a>(mb, <span class="stringliteral">&quot;addr&quot;</span>, <span class="stringliteral">&quot;alice@delta.chat&quot;</span>); <span class="comment">// use some real test credentials here</span></div><div class="line"><a class="code" href="structmrmailbox__t.html#a19b3e9f5209bc326fc77f3944522e8ad">mrmailbox_set_config</a>(mb, <span class="stringliteral">&quot;mail_pw&quot;</span>, <span class="stringliteral">&quot;***&quot;</span>);</div><div class="line"></div><div class="line"><a class="code" href="structmrmailbox__t.html#a42ca741cc08785585f1dc74d515be5ef">mrmailbox_configure_and_connect</a>(mb);</div></div><!-- fragment --><p>After that, you can send your first message:</p>
<div class="fragment"><div class="line">uint32_t contact_id = <a class="code" href="structmrmailbox__t.html#aa089e97e7ca1add16c10d5cc0e902824">mrmailbox_create_contact</a>(mb, <span class="stringliteral">&quot;bob@delta.chat&quot;</span>); <span class="comment">// use a real testing address here</span></div><div class="line">uint32_t chat_id = <a class="code" href="structmrmailbox__t.html#a1386ec2c091b936b65b25b50a302173d">mrmailbox_create_chat_by_contact_id</a>(mb, contact_id);</div><div class="line"></div><div class="line"><a class="code" href="structmrmailbox__t.html#a3f9ac5fb9ff2dcbaafdddb5d955ac39b">mrmailbox_send_text_msg</a>(mb, chat_id, <span class="stringliteral">&quot;Hi, here is my first message!&quot;</span>);</div></div><!-- fragment --><p>Now, go to the testing address (bob) and you should have received a normal email. Answer this email in any email program with "Got it!" and you will get the message from delta as follows:</p>
<div class="fragment"><div class="line">carray* msglist = <a class="code" href="structmrmailbox__t.html#a5d3be6ed21d43cc93f250a1e7faf979b">mrmailbox_get_chat_msgs</a>(mb, chat_id, 0, 0);</div><div class="line"><span class="keywordflow">for</span>( <span class="keywordtype">size_t</span> i = 0; i &lt; carray_count(msglist); i++ )</div><div class="line">{</div><div class="line"> uint32_t msg_id = carray_get_uint32(msglist, i);</div><div class="line"> <a class="code" href="structmrmsg__t.html">mrmsg_t</a>* msg = <a class="code" href="structmrmailbox__t.html#a9ef144244e7d86ba82ce3257abf14f13">mrmailbox_get_msg</a>(mb, msg_id);</div><div class="line"></div><div class="line"> printf(<span class="stringliteral">&quot;message %i: %s\n&quot;</span>, i+1, msg-&gt;<a class="code" href="structmrmsg__t.html#ae54dcd4036371597d7f8bbd75303527a">m_text</a>);</div><div class="line">}</div></div><!-- fragment --><p>This will output the following two lines:</p>
<div class="fragment"><div class="line">Message 1: Hi, here is my first message!</div><div class="line">Message 2: Got it!</div></div><!-- fragment --><p>I think, you got the idea. For further reading, please dive into the <a class="el" href="structmrmailbox__t.html" title="An object representing a single mailbox. ">mrmailbox_t</a> class.</p>

2
docs/html/mrchat_8h_source.html
View file

File diff suppressed because one or more lines are too long

2
docs/html/mrchatlist_8h_source.html
View file

File diff suppressed because one or more lines are too long

30
docs/html/mrevent_8h.html
View file

@ -126,11 +126,8 @@ Macros</h2></td></tr>
<tr class="memitem:ad50b3a76349834631dc26b6c9557be8f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mrevent_8h.html#ad50b3a76349834631dc26b6c9557be8f">MR_EVENT_CONTACTS_CHANGED</a>&#160;&#160;&#160;2030</td></tr>
<tr class="memdesc:ad50b3a76349834631dc26b6c9557be8f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Contact(s) created, renamed, blocked or deleted. <a href="#ad50b3a76349834631dc26b6c9557be8f">More...</a><br /></td></tr>
<tr class="separator:ad50b3a76349834631dc26b6c9557be8f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3be5f7ee95e6d0a8066e7a839f38c30f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mrevent_8h.html#a3be5f7ee95e6d0a8066e7a839f38c30f">MR_EVENT_CONFIGURE_ENDED</a>&#160;&#160;&#160;2040</td></tr>
<tr class="memdesc:a3be5f7ee95e6d0a8066e7a839f38c30f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configurartion enden. <a href="#a3be5f7ee95e6d0a8066e7a839f38c30f">More...</a><br /></td></tr>
<tr class="separator:a3be5f7ee95e6d0a8066e7a839f38c30f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abb0881d4c7c887b8f371cedc471846b5"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mrevent_8h.html#abb0881d4c7c887b8f371cedc471846b5">MR_EVENT_CONFIGURE_PROGRESS</a>&#160;&#160;&#160;2041</td></tr>
<tr class="memdesc:abb0881d4c7c887b8f371cedc471846b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Inform about the configuration progress started by <a class="el" href="structmrmailbox__t.html#af204aadf66e8adf5403987c5dcf85387" title="Configure and connect a mailbox. ">mrmailbox_configure_and_connect()</a>. <a href="#abb0881d4c7c887b8f371cedc471846b5">More...</a><br /></td></tr>
<tr class="memdesc:abb0881d4c7c887b8f371cedc471846b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Inform about the configuration progress started by <a class="el" href="structmrmailbox__t.html#a42ca741cc08785585f1dc74d515be5ef" title="Configure and connect a mailbox. ">mrmailbox_configure_and_connect()</a>. <a href="#abb0881d4c7c887b8f371cedc471846b5">More...</a><br /></td></tr>
<tr class="separator:abb0881d4c7c887b8f371cedc471846b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a10211bf20ad64f8f6d635120ca64f374"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mrevent_8h.html#a10211bf20ad64f8f6d635120ca64f374">MR_EVENT_IMEX_ENDED</a>&#160;&#160;&#160;2050</td></tr>
<tr class="memdesc:a10211bf20ad64f8f6d635120ca64f374"><td class="mdescLeft">&#160;</td><td class="mdescRight">Import/export done. <a href="#a10211bf20ad64f8f6d635120ca64f374">More...</a><br /></td></tr>
@ -181,29 +178,6 @@ Macros</h2></td></tr>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 </dd></dl>
</div>
</div>
<a class="anchor" id="a3be5f7ee95e6d0a8066e7a839f38c30f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MR_EVENT_CONFIGURE_ENDED&#160;&#160;&#160;2040</td>
</tr>
</table>
</div><div class="memdoc">
<p>Configurartion enden. </p>
<p>You'll get this event from a call to <a class="el" href="structmrmailbox__t.html#af204aadf66e8adf5403987c5dcf85387" title="Configure and connect a mailbox. ">mrmailbox_configure_and_connect()</a></p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data1</td><td>0=failed-not-connected, 1=configured-and-connected</td></tr>
<tr><td class="paramname">data2</td><td>0</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 </dd></dl>
</div>
</div>
<a class="anchor" id="abb0881d4c7c887b8f371cedc471846b5"></a>
@ -216,7 +190,7 @@ Macros</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Inform about the configuration progress started by <a class="el" href="structmrmailbox__t.html#af204aadf66e8adf5403987c5dcf85387" title="Configure and connect a mailbox. ">mrmailbox_configure_and_connect()</a>. </p>
<p>Inform about the configuration progress started by <a class="el" href="structmrmailbox__t.html#a42ca741cc08785585f1dc74d515be5ef" title="Configure and connect a mailbox. ">mrmailbox_configure_and_connect()</a>. </p>
<p>As we want to get rid of the threads in the core, this event may be deleted.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">

2
docs/html/mrevent_8h_source.html
View file

File diff suppressed because one or more lines are too long

2
docs/html/mrimap_8h_source.html
View file

File diff suppressed because one or more lines are too long

2
docs/html/mrjob_8h_source.html
View file

File diff suppressed because one or more lines are too long

2
docs/html/mrkey_8h_source.html
View file

File diff suppressed because one or more lines are too long

18
docs/html/mrmailbox_8h_source.html
View file

File diff suppressed because one or more lines are too long

2
docs/html/mrmimefactory_8h_source.html
View file

File diff suppressed because one or more lines are too long

2
docs/html/mrmimeparser_8h_source.html
View file

File diff suppressed because one or more lines are too long

2
docs/html/mrmsg_8h_source.html
View file

File diff suppressed because one or more lines are too long

2
docs/html/mrosnative_8h_source.html
View file

File diff suppressed because one or more lines are too long

2
docs/html/mrpgp_8h_source.html
View file

File diff suppressed because one or more lines are too long

2
docs/html/mrsmtp_8h_source.html
View file

File diff suppressed because one or more lines are too long

2
docs/html/mrsqlite3_8h_source.html
View file

File diff suppressed because one or more lines are too long

2
docs/html/mrstock_8h_source.html
View file

File diff suppressed because one or more lines are too long

2
docs/html/mrtools_8h_source.html
View file

File diff suppressed because one or more lines are too long

3
docs/html/search/all_1.js
View file

@ -26,7 +26,6 @@ var searchData=
['m_5ftype',['m_type',['../structmrchat__t.html#a568c4e6fb9633ffe9a76428db16e0201',1,'mrchat_t::m_type()'],['../structmrmsg__t.html#a3896e269c90cbf0f563ab0848fb44c65',1,'mrmsg_t::m_type()']]],
['m_5fuserdata',['m_userdata',['../structmrmailbox__t.html#a6c557153209e128b69301246dbf9e230',1,'mrmailbox_t']]],
['mr_5fevent_5fchat_5fmodified',['MR_EVENT_CHAT_MODIFIED',['../mrevent_8h.html#a5ac741b81ec97628f44795600c0e4d4c',1,'mrevent.h']]],
['mr_5fevent_5fconfigure_5fended',['MR_EVENT_CONFIGURE_ENDED',['../mrevent_8h.html#a3be5f7ee95e6d0a8066e7a839f38c30f',1,'mrevent.h']]],
['mr_5fevent_5fconfigure_5fprogress',['MR_EVENT_CONFIGURE_PROGRESS',['../mrevent_8h.html#abb0881d4c7c887b8f371cedc471846b5',1,'mrevent.h']]],
['mr_5fevent_5fcontacts_5fchanged',['MR_EVENT_CONTACTS_CHANGED',['../mrevent_8h.html#ad50b3a76349834631dc26b6c9557be8f',1,'mrevent.h']]],
['mr_5fevent_5ferror',['MR_EVENT_ERROR',['../mrevent_8h.html#a7088b24d6d49fee42d6b83360bf1fcca',1,'mrevent.h']]],
@ -68,7 +67,7 @@ var searchData=
['mrmailbox_5fblock_5fcontact',['mrmailbox_block_contact',['../structmrmailbox__t.html#abb069358386b767a60444651195e0895',1,'mrmailbox_t']]],
['mrmailbox_5fcheck_5fpassword',['mrmailbox_check_password',['../structmrmailbox__t.html#a3b55fcb1a91c616f032e160914406ed2',1,'mrmailbox_t']]],
['mrmailbox_5fclose',['mrmailbox_close',['../structmrmailbox__t.html#a75011d103515e088e950a64d0706ec86',1,'mrmailbox_t']]],
['mrmailbox_5fconfigure_5fand_5fconnect',['mrmailbox_configure_and_connect',['../structmrmailbox__t.html#af204aadf66e8adf5403987c5dcf85387',1,'mrmailbox_t']]],
['mrmailbox_5fconfigure_5fand_5fconnect',['mrmailbox_configure_and_connect',['../structmrmailbox__t.html#a42ca741cc08785585f1dc74d515be5ef',1,'mrmailbox_t']]],
['mrmailbox_5fconfigure_5fcancel',['mrmailbox_configure_cancel',['../structmrmailbox__t.html#a8127c0e3f4cfda14fdfd7be9f43715ef',1,'mrmailbox_t']]],
['mrmailbox_5fconnect',['mrmailbox_connect',['../structmrmailbox__t.html#a67eef5ffc3369b8ad09326471b0a266f',1,'mrmailbox_t']]],
['mrmailbox_5fcreate_5fchat_5fby_5fcontact_5fid',['mrmailbox_create_chat_by_contact_id',['../structmrmailbox__t.html#a1386ec2c091b936b65b25b50a302173d',1,'mrmailbox_t']]],

1
docs/html/search/defines_0.js
View file

@ -1,7 +1,6 @@
var searchData=
[
['mr_5fevent_5fchat_5fmodified',['MR_EVENT_CHAT_MODIFIED',['../mrevent_8h.html#a5ac741b81ec97628f44795600c0e4d4c',1,'mrevent.h']]],
['mr_5fevent_5fconfigure_5fended',['MR_EVENT_CONFIGURE_ENDED',['../mrevent_8h.html#a3be5f7ee95e6d0a8066e7a839f38c30f',1,'mrevent.h']]],
['mr_5fevent_5fconfigure_5fprogress',['MR_EVENT_CONFIGURE_PROGRESS',['../mrevent_8h.html#abb0881d4c7c887b8f371cedc471846b5',1,'mrevent.h']]],
['mr_5fevent_5fcontacts_5fchanged',['MR_EVENT_CONTACTS_CHANGED',['../mrevent_8h.html#ad50b3a76349834631dc26b6c9557be8f',1,'mrevent.h']]],
['mr_5fevent_5ferror',['MR_EVENT_ERROR',['../mrevent_8h.html#a7088b24d6d49fee42d6b83360bf1fcca',1,'mrevent.h']]],

2
docs/html/search/functions_0.js
View file

@ -20,7 +20,7 @@ var searchData=
['mrmailbox_5fblock_5fcontact',['mrmailbox_block_contact',['../structmrmailbox__t.html#abb069358386b767a60444651195e0895',1,'mrmailbox_t']]],
['mrmailbox_5fcheck_5fpassword',['mrmailbox_check_password',['../structmrmailbox__t.html#a3b55fcb1a91c616f032e160914406ed2',1,'mrmailbox_t']]],
['mrmailbox_5fclose',['mrmailbox_close',['../structmrmailbox__t.html#a75011d103515e088e950a64d0706ec86',1,'mrmailbox_t']]],
['mrmailbox_5fconfigure_5fand_5fconnect',['mrmailbox_configure_and_connect',['../structmrmailbox__t.html#af204aadf66e8adf5403987c5dcf85387',1,'mrmailbox_t']]],
['mrmailbox_5fconfigure_5fand_5fconnect',['mrmailbox_configure_and_connect',['../structmrmailbox__t.html#a42ca741cc08785585f1dc74d515be5ef',1,'mrmailbox_t']]],
['mrmailbox_5fconfigure_5fcancel',['mrmailbox_configure_cancel',['../structmrmailbox__t.html#a8127c0e3f4cfda14fdfd7be9f43715ef',1,'mrmailbox_t']]],
['mrmailbox_5fconnect',['mrmailbox_connect',['../structmrmailbox__t.html#a67eef5ffc3369b8ad09326471b0a266f',1,'mrmailbox_t']]],
['mrmailbox_5fcreate_5fchat_5fby_5fcontact_5fid',['mrmailbox_create_chat_by_contact_id',['../structmrmailbox__t.html#a1386ec2c091b936b65b25b50a302173d',1,'mrmailbox_t']]],

2
docs/html/structmrmailbox__t-members.html
View file

@ -97,7 +97,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<tr class="even"><td class="entry"><a class="el" href="structmrmailbox__t.html#abb069358386b767a60444651195e0895">mrmailbox_block_contact</a>(mrmailbox_t *mailbox, uint32_t contact_id, int new_blocking)</td><td class="entry"><a class="el" href="structmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structmrmailbox__t.html#a3b55fcb1a91c616f032e160914406ed2">mrmailbox_check_password</a>(mrmailbox_t *mailbox, const char *test_pw)</td><td class="entry"><a class="el" href="structmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structmrmailbox__t.html#a75011d103515e088e950a64d0706ec86">mrmailbox_close</a>(mrmailbox_t *mailbox)</td><td class="entry"><a class="el" href="structmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structmrmailbox__t.html#af204aadf66e8adf5403987c5dcf85387">mrmailbox_configure_and_connect</a>(mrmailbox_t *mailbox)</td><td class="entry"><a class="el" href="structmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structmrmailbox__t.html#a42ca741cc08785585f1dc74d515be5ef">mrmailbox_configure_and_connect</a>(mrmailbox_t *mailbox)</td><td class="entry"><a class="el" href="structmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structmrmailbox__t.html#a8127c0e3f4cfda14fdfd7be9f43715ef">mrmailbox_configure_cancel</a>(mrmailbox_t *mailbox)</td><td class="entry"><a class="el" href="structmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structmrmailbox__t.html#a67eef5ffc3369b8ad09326471b0a266f">mrmailbox_connect</a>(mrmailbox_t *mailbox)</td><td class="entry"><a class="el" href="structmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structmrmailbox__t.html#a1386ec2c091b936b65b25b50a302173d">mrmailbox_create_chat_by_contact_id</a>(mrmailbox_t *mailbox, uint32_t contact_id)</td><td class="entry"><a class="el" href="structmrmailbox__t.html">mrmailbox_t</a></td><td class="entry"></td></tr>

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>