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

doxygen

Browse source
This commit is contained in:
B. Petersen 2017-11-19 18:38:59 +01:00
parent d2bdd7cb5f
commit 914d41143a
11 changed files with 217 additions and 96 deletions
Download patch file Download diff file Expand all files Collapse all files

6
docs/html/functions.html
View file

@ -424,9 +424,15 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<li>mrmsg_save_param_to_disk()
: <a class="el" href="structmrmsg__t.html#a0bc3ce5f2ef0065547e4aee0143d22ef">mrmsg_t</a>
</li>
<li>mrmsg_set_file()
: <a class="el" href="structmrmsg__t.html#a98455bee60d64b3d59d89fbbb520ddd5">mrmsg_t</a>
</li>
<li>mrmsg_set_text()
: <a class="el" href="structmrmsg__t.html#ae940aa79a261e1a427b12baefbee2d23">mrmsg_t</a>
</li>
<li>mrmsg_set_type()
: <a class="el" href="structmrmsg__t.html#a3581e331fe9f3f38d4c5bb1b1c8c7867">mrmsg_t</a>
</li>
<li>mrmsg_show_padlock()
: <a class="el" href="structmrmsg__t.html#a9980da92916e42081f2f39ccc72c1696">mrmsg_t</a>
</li>

6
docs/html/functions_func.html
View file

@ -337,9 +337,15 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<li>mrmsg_save_param_to_disk()
: <a class="el" href="structmrmsg__t.html#a0bc3ce5f2ef0065547e4aee0143d22ef">mrmsg_t</a>
</li>
<li>mrmsg_set_file()
: <a class="el" href="structmrmsg__t.html#a98455bee60d64b3d59d89fbbb520ddd5">mrmsg_t</a>
</li>
<li>mrmsg_set_text()
: <a class="el" href="structmrmsg__t.html#ae940aa79a261e1a427b12baefbee2d23">mrmsg_t</a>
</li>
<li>mrmsg_set_type()
: <a class="el" href="structmrmsg__t.html#a3581e331fe9f3f38d4c5bb1b1c8c7867">mrmsg_t</a>
</li>
<li>mrmsg_show_padlock()
: <a class="el" href="structmrmsg__t.html#a9980da92916e42081f2f39ccc72c1696">mrmsg_t</a>
</li>

4
docs/html/mrarray_8h_source.html
View file

File diff suppressed because one or more lines are too long

110
docs/html/mrmailbox_8h_source.html
View file

File diff suppressed because one or more lines are too long

20
docs/html/mrmsg_8h_source.html
View file

File diff suppressed because one or more lines are too long

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

@ -130,7 +130,9 @@ var searchData=
['mrmsg_5fget_5fsummarytext',['mrmsg_get_summarytext',['../structmrmsg__t.html#a8c8c1f342f01439ae40c5cf37532387e',1,'mrmsg_t']]],
['mrmsg_5fnew',['mrmsg_new',['../structmrmsg__t.html#a80f470eb34af414ff28e7d3b3c715b48',1,'mrmsg_t']]],
['mrmsg_5fsave_5fparam_5fto_5fdisk',['mrmsg_save_param_to_disk',['../structmrmsg__t.html#a0bc3ce5f2ef0065547e4aee0143d22ef',1,'mrmsg_t']]],
['mrmsg_5fset_5ffile',['mrmsg_set_file',['../structmrmsg__t.html#a98455bee60d64b3d59d89fbbb520ddd5',1,'mrmsg_t']]],
['mrmsg_5fset_5ftext',['mrmsg_set_text',['../structmrmsg__t.html#ae940aa79a261e1a427b12baefbee2d23',1,'mrmsg_t']]],
['mrmsg_5fset_5ftype',['mrmsg_set_type',['../structmrmsg__t.html#a3581e331fe9f3f38d4c5bb1b1c8c7867',1,'mrmsg_t']]],
['mrmsg_5fshow_5fpadlock',['mrmsg_show_padlock',['../structmrmsg__t.html#a9980da92916e42081f2f39ccc72c1696',1,'mrmsg_t']]],
['mrmsg_5ft',['mrmsg_t',['../structmrmsg__t.html',1,'']]],
['mrmsg_5funref',['mrmsg_unref',['../structmrmsg__t.html#aa33212e41efff643aa7290753f3d9b02',1,'mrmsg_t']]],

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

@ -80,7 +80,9 @@ var searchData=
['mrmsg_5fget_5fsummarytext',['mrmsg_get_summarytext',['../structmrmsg__t.html#a8c8c1f342f01439ae40c5cf37532387e',1,'mrmsg_t']]],
['mrmsg_5fnew',['mrmsg_new',['../structmrmsg__t.html#a80f470eb34af414ff28e7d3b3c715b48',1,'mrmsg_t']]],
['mrmsg_5fsave_5fparam_5fto_5fdisk',['mrmsg_save_param_to_disk',['../structmrmsg__t.html#a0bc3ce5f2ef0065547e4aee0143d22ef',1,'mrmsg_t']]],
['mrmsg_5fset_5ffile',['mrmsg_set_file',['../structmrmsg__t.html#a98455bee60d64b3d59d89fbbb520ddd5',1,'mrmsg_t']]],
['mrmsg_5fset_5ftext',['mrmsg_set_text',['../structmrmsg__t.html#ae940aa79a261e1a427b12baefbee2d23',1,'mrmsg_t']]],
['mrmsg_5fset_5ftype',['mrmsg_set_type',['../structmrmsg__t.html#a3581e331fe9f3f38d4c5bb1b1c8c7867',1,'mrmsg_t']]],
['mrmsg_5fshow_5fpadlock',['mrmsg_show_padlock',['../structmrmsg__t.html#a9980da92916e42081f2f39ccc72c1696',1,'mrmsg_t']]],
['mrmsg_5funref',['mrmsg_unref',['../structmrmsg__t.html#aa33212e41efff643aa7290753f3d9b02',1,'mrmsg_t']]],
['mrparam_5fempty',['mrparam_empty',['../structmrparam__t.html#a88397aa66e74bcdc61c8376c8e9a761b',1,'mrparam_t']]],

6
docs/html/structmrarray__t.html
View file

@ -110,7 +110,7 @@ Public Member Functions</h2></td></tr>
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:abd4dde487b63dc1bd2ff00c76854af4f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structmrmailbox__t.html">mrmailbox_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrarray__t.html#abd4dde487b63dc1bd2ff00c76854af4f">m_mailbox</a></td></tr>
<tr class="memdesc:abd4dde487b63dc1bd2ff00c76854af4f"><td class="mdescLeft">&#160;</td><td class="mdescRight">The mailbox the array belongs. <a href="#abd4dde487b63dc1bd2ff00c76854af4f">More...</a><br /></td></tr>
<tr class="memdesc:abd4dde487b63dc1bd2ff00c76854af4f"><td class="mdescLeft">&#160;</td><td class="mdescRight">The mailbox the array belongs to. <a href="#abd4dde487b63dc1bd2ff00c76854af4f">More...</a><br /></td></tr>
<tr class="separator:abd4dde487b63dc1bd2ff00c76854af4f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
@ -214,8 +214,8 @@ Public Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<p>The mailbox the array belongs. </p>
<p>to </p>
<p>The mailbox the array belongs to. </p>
<p>May be NULL when NULL is given to mrarray_new(). </p>
</div>
</div>

67
docs/html/structmrmailbox__t.html
View file

@ -117,7 +117,7 @@ Public Member Functions</h2></td></tr>
<tr class="memdesc:a75011d103515e088e950a64d0706ec86"><td class="mdescLeft">&#160;</td><td class="mdescRight">Close mailbox database. <a href="#a75011d103515e088e950a64d0706ec86">More...</a><br /></td></tr>
<tr class="separator:a75011d103515e088e950a64d0706ec86"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aace7cd8b68f45b869956d5c7476a1da0"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrmailbox__t.html#aace7cd8b68f45b869956d5c7476a1da0">mrmailbox_is_open</a> (const <a class="el" href="structmrmailbox__t.html">mrmailbox_t</a> *mailbox)</td></tr>
<tr class="memdesc:aace7cd8b68f45b869956d5c7476a1da0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if a given mailbox database is open. <a href="#aace7cd8b68f45b869956d5c7476a1da0">More...</a><br /></td></tr>
<tr class="memdesc:aace7cd8b68f45b869956d5c7476a1da0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if the mailbox database is open. <a href="#aace7cd8b68f45b869956d5c7476a1da0">More...</a><br /></td></tr>
<tr class="separator:aace7cd8b68f45b869956d5c7476a1da0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a19b3e9f5209bc326fc77f3944522e8ad"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrmailbox__t.html#a19b3e9f5209bc326fc77f3944522e8ad">mrmailbox_set_config</a> (<a class="el" href="structmrmailbox__t.html">mrmailbox_t</a> *ths, const char *key, const char *value)</td></tr>
<tr class="memdesc:a19b3e9f5209bc326fc77f3944522e8ad"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configure the mailbox. <a href="#a19b3e9f5209bc326fc77f3944522e8ad">More...</a><br /></td></tr>
@ -198,7 +198,7 @@ Public Member Functions</h2></td></tr>
<tr class="memdesc:a3f9ac5fb9ff2dcbaafdddb5d955ac39b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send a simple text message to the given chat. <a href="#a3f9ac5fb9ff2dcbaafdddb5d955ac39b">More...</a><br /></td></tr>
<tr class="separator:a3f9ac5fb9ff2dcbaafdddb5d955ac39b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a88ef3066cec30fe26f61f273b233d90c"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrmailbox__t.html#a88ef3066cec30fe26f61f273b233d90c">mrmailbox_send_msg</a> (<a class="el" href="structmrmailbox__t.html">mrmailbox_t</a> *mailbox, uint32_t chat_id, <a class="el" href="structmrmsg__t.html">mrmsg_t</a> *msg)</td></tr>
<tr class="memdesc:a88ef3066cec30fe26f61f273b233d90c"><td class="mdescLeft">&#160;</td><td class="mdescRight">save message in database and send it, the given message object is not unref'd by the function but some fields are set up! <a href="#a88ef3066cec30fe26f61f273b233d90c">More...</a><br /></td></tr>
<tr class="memdesc:a88ef3066cec30fe26f61f273b233d90c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send a message of any type to a chat. <a href="#a88ef3066cec30fe26f61f273b233d90c">More...</a><br /></td></tr>
<tr class="separator:a88ef3066cec30fe26f61f273b233d90c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a47156db87107ec208d6637f460d897a8"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrmailbox__t.html#a47156db87107ec208d6637f460d897a8">mrmailbox_create_group_chat</a> (<a class="el" href="structmrmailbox__t.html">mrmailbox_t</a> *mailbox, const char *chat_name)</td></tr>
<tr class="memdesc:a47156db87107ec208d6637f460d897a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new group chat. <a href="#a47156db87107ec208d6637f460d897a8">More...</a><br /></td></tr>
@ -243,7 +243,7 @@ Public Member Functions</h2></td></tr>
<tr class="memdesc:abb069358386b767a60444651195e0895"><td class="mdescLeft">&#160;</td><td class="mdescRight">Block or unblock a contact. <a href="#abb069358386b767a60444651195e0895">More...</a><br /></td></tr>
<tr class="separator:abb069358386b767a60444651195e0895"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa4d582bc9d6d80e43038d213b081031f"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrmailbox__t.html#aa4d582bc9d6d80e43038d213b081031f">mrmailbox_get_contact_encrinfo</a> (<a class="el" href="structmrmailbox__t.html">mrmailbox_t</a> *mailbox, uint32_t contact_id)</td></tr>
<tr class="memdesc:aa4d582bc9d6d80e43038d213b081031f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get encryption info. <a href="#aa4d582bc9d6d80e43038d213b081031f">More...</a><br /></td></tr>
<tr class="memdesc:aa4d582bc9d6d80e43038d213b081031f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get encryption info for a contact. <a href="#aa4d582bc9d6d80e43038d213b081031f">More...</a><br /></td></tr>
<tr class="separator:aa4d582bc9d6d80e43038d213b081031f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a209732d105e40cd0c61d33d76d288c59"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrmailbox__t.html#a209732d105e40cd0c61d33d76d288c59">mrmailbox_delete_contact</a> (<a class="el" href="structmrmailbox__t.html">mrmailbox_t</a> *mailbox, uint32_t contact_id)</td></tr>
<tr class="memdesc:a209732d105e40cd0c61d33d76d288c59"><td class="mdescLeft">&#160;</td><td class="mdescRight">Delete a contact. <a href="#a209732d105e40cd0c61d33d76d288c59">More...</a><br /></td></tr>
@ -255,13 +255,13 @@ Public Member Functions</h2></td></tr>
<tr class="memdesc:a13e05fe3f43102c3323ba4c7e2761593"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get an informational text for a single message. <a href="#a13e05fe3f43102c3323ba4c7e2761593">More...</a><br /></td></tr>
<tr class="separator:a13e05fe3f43102c3323ba4c7e2761593"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab316ed8a30c968085fa503e6c215e2f1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrmailbox__t.html#ab316ed8a30c968085fa503e6c215e2f1">mrmailbox_forward_msgs</a> (<a class="el" href="structmrmailbox__t.html">mrmailbox_t</a> *mailbox, const uint32_t *msg_ids, int msg_cnt, uint32_t chat_id)</td></tr>
<tr class="memdesc:ab316ed8a30c968085fa503e6c215e2f1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Forward a list of messages to another chat. <a href="#ab316ed8a30c968085fa503e6c215e2f1">More...</a><br /></td></tr>
<tr class="memdesc:ab316ed8a30c968085fa503e6c215e2f1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Forward messages to another chat. <a href="#ab316ed8a30c968085fa503e6c215e2f1">More...</a><br /></td></tr>
<tr class="separator:ab316ed8a30c968085fa503e6c215e2f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8ed1c3bd08cd6515abf6046ebad9cafc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrmailbox__t.html#a8ed1c3bd08cd6515abf6046ebad9cafc">mrmailbox_star_msgs</a> (<a class="el" href="structmrmailbox__t.html">mrmailbox_t</a> *mailbox, const uint32_t *msg_ids, int msg_cnt, int star)</td></tr>
<tr class="memdesc:a8ed1c3bd08cd6515abf6046ebad9cafc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Star/unstar messages by setting the last parameter to 0 (unstar) or 1(star). <a href="#a8ed1c3bd08cd6515abf6046ebad9cafc">More...</a><br /></td></tr>
<tr class="separator:a8ed1c3bd08cd6515abf6046ebad9cafc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adf02bfc046577b46e1f0f5a31869890f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrmailbox__t.html#adf02bfc046577b46e1f0f5a31869890f">mrmailbox_delete_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:adf02bfc046577b46e1f0f5a31869890f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Delete a list of messages. <a href="#adf02bfc046577b46e1f0f5a31869890f">More...</a><br /></td></tr>
<tr class="memdesc:adf02bfc046577b46e1f0f5a31869890f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Delete messages. <a href="#adf02bfc046577b46e1f0f5a31869890f">More...</a><br /></td></tr>
<tr class="separator:adf02bfc046577b46e1f0f5a31869890f"><td class="memSeparator" colspan="2">&#160;</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>
@ -290,15 +290,14 @@ Public Member Functions</h2></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a6c557153209e128b69301246dbf9e230"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6c557153209e128b69301246dbf9e230"></a>
void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrmailbox__t.html#a6c557153209e128b69301246dbf9e230">m_userdata</a></td></tr>
<tr class="memdesc:a6c557153209e128b69301246dbf9e230"><td class="mdescLeft">&#160;</td><td class="mdescRight">the same pointer as given to <a class="el" href="structmrmailbox__t.html#a32825e3e0a1b16679580704a4b43db1a" title="Create a new mailbox object. ">mrmailbox_new()</a>, may be used by the caller for any purpose <br /></td></tr>
<tr class="memitem:a6c557153209e128b69301246dbf9e230"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrmailbox__t.html#a6c557153209e128b69301246dbf9e230">m_userdata</a></td></tr>
<tr class="memdesc:a6c557153209e128b69301246dbf9e230"><td class="mdescLeft">&#160;</td><td class="mdescRight">Use data, may be used for any purpose. <a href="#a6c557153209e128b69301246dbf9e230">More...</a><br /></td></tr>
<tr class="separator:a6c557153209e128b69301246dbf9e230"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aab18660500768b611373190720439956"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrmailbox__t.html#aab18660500768b611373190720439956">m_dbfile</a></td></tr>
<tr class="memdesc:aab18660500768b611373190720439956"><td class="mdescLeft">&#160;</td><td class="mdescRight">the database file in file. <a href="#aab18660500768b611373190720439956">More...</a><br /></td></tr>
<tr class="memdesc:aab18660500768b611373190720439956"><td class="mdescLeft">&#160;</td><td class="mdescRight">The database file. <a href="#aab18660500768b611373190720439956">More...</a><br /></td></tr>
<tr class="separator:aab18660500768b611373190720439956"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0ea304d47a08116f6eda8f1c80e5a930"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrmailbox__t.html#a0ea304d47a08116f6eda8f1c80e5a930">m_blobdir</a></td></tr>
<tr class="memdesc:a0ea304d47a08116f6eda8f1c80e5a930"><td class="mdescLeft">&#160;</td><td class="mdescRight">full path of the blob directory in use. <a href="#a0ea304d47a08116f6eda8f1c80e5a930">More...</a><br /></td></tr>
<tr class="memdesc:a0ea304d47a08116f6eda8f1c80e5a930"><td class="mdescLeft">&#160;</td><td class="mdescRight">Full path of the blob directory. <a href="#a0ea304d47a08116f6eda8f1c80e5a930">More...</a><br /></td></tr>
<tr class="separator:a0ea304d47a08116f6eda8f1c80e5a930"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
@ -489,7 +488,7 @@ void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="st
</div><div class="memdoc">
<p>Block or unblock a contact. </p>
<p>May result in a MR_EVENT_BLOCKING_CHANGED event.</p>
<p>May result in a <a class="el" href="mrevent_8h.html#ad50b3a76349834631dc26b6c9557be8f" title="Contact(s) created, renamed, blocked or deleted. ">MR_EVENT_CONTACTS_CHANGED</a> event.</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>
@ -905,7 +904,7 @@ void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="st
</table>
</div><div class="memdoc">
<p>Delete a list of messages. </p>
<p>Delete messages. </p>
<p>The messages are deleted on the current device and on the IMAP server.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
@ -980,7 +979,7 @@ void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="st
</table>
</div><div class="memdoc">
<p>Forward a list of messages to another chat. </p>
<p>Forward messages to another chat. </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>
@ -1445,8 +1444,8 @@ void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="st
</table>
</div><div class="memdoc">
<p>Get encryption info. </p>
<p>Get a multi-line encryption info, containing your fingerprint and the fingerprint of the contact, used eg. to compare the fingerprints.</p>
<p>Get encryption info for a contact. </p>
<p>Get a multi-line encryption info, containing your fingerprint and the fingerprint of the contact, used eg. to compare the fingerprints for a simple out-of-band verification.</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>
@ -1946,7 +1945,7 @@ void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="st
</table>
</div><div class="memdoc">
<p>Check if a given mailbox database is open. </p>
<p>Check if the mailbox database is open. </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>
@ -2116,7 +2115,7 @@ void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="st
<li>If not mentioned otherweise, the callback should return 0.</li>
</ul>
</td></tr>
<tr><td class="paramname">userdata</td><td>can be used by the client for any purpuse. He finds it later in mrmailbox_get_userdata().</td></tr>
<tr><td class="paramname">userdata</td><td>can be used by the client for any purpuse. He finds it later in mrmailbox__t::m_userdata().</td></tr>
<tr><td class="paramname">os_name</td><td>is only for decorative use and is shown eg. in the X-Mailer header in the form "Delta Chat &lt;version&gt; for &lt;osName&gt;"</td></tr>
</table>
</dd>
@ -2160,8 +2159,8 @@ void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="st
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mailbox</td><td>the mailbox object as created by mrmailbox_new</td></tr>
<tr><td class="paramname">dbfile</td><td>the file to use to store the database, sth. like "~/file" won't work on all systems, if in doubt, use absolute paths</td></tr>
<tr><td class="paramname">blobdir</td><td>a directory to store the blobs in, the trailing slash is added by us, so if you want to avoid double slashes, do not add one. If you give NULL as blobdir, <code>dbfile-blobs</code> is used in the same directory as <em>dbfile</em> will be created in.</td></tr>
<tr><td class="paramname">dbfile</td><td>the file to use to store the database, sth. like "~/file" won't work on all systems, if in doubt, use absolute paths. You can find the file path later in <a class="el" href="structmrmailbox__t.html#aab18660500768b611373190720439956" title="The database file. ">mrmailbox_t::m_dbfile</a></td></tr>
<tr><td class="paramname">blobdir</td><td>a directory to store the blobs in, the trailing slash is added by us, so if you want to avoid double slashes, do not add one. If you give NULL as blobdir, <code>dbfile-blobs</code> is used in the same directory as <em>dbfile</em> will be created in. You can find the path to the blob direcrory later in <a class="el" href="structmrmailbox__t.html#a0ea304d47a08116f6eda8f1c80e5a930" title="Full path of the blob directory. ">mrmailbox_t::m_blobdir</a></td></tr>
</table>
</dd>
</dl>
@ -2288,8 +2287,10 @@ void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="st
</table>
</div><div class="memdoc">
<p>save message in database and send it, the given message object is not unref'd by the function but some fields are set up! </p>
<p>Send a message of any type to a chat. </p>
<p>The given message object is not unref'd by the function but some fields are set up.</p>
<p>Sends the event <a class="el" href="mrevent_8h.html#a17eaeb107cbab46c0d9271d0b5560fc8" title="One or more messages changed for some reasons in the database. ">MR_EVENT_MSGS_CHANGED</a> on succcess. However, this does not imply, the message really reached the recipient - sending may be delayed eg. due to network problems. However, from your view, you're done with the message. Sooner or later it will find its way.</p>
<p>To send a simple text message, you can also use <a class="el" href="structmrmailbox__t.html#a3f9ac5fb9ff2dcbaafdddb5d955ac39b" title="Send a simple text message to the given chat. ">mrmailbox_send_text_msg()</a> which is easier to use.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mailbox</td><td>The mailbox object as returned from <a class="el" href="structmrmailbox__t.html#a32825e3e0a1b16679580704a4b43db1a" title="Create a new mailbox object. ">mrmailbox_new()</a>.</td></tr>
@ -2298,8 +2299,9 @@ void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="st
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The ID of the message that is about being sent. </dd></dl>
<dl class="section return"><dt>Returns</dt><dd>The ID of the message that is about being sent.</dd></dl>
<p>Examples:</p>
<div class="fragment"><div class="line"><a class="code" href="structmrmsg__t.html">mrmsg_t</a>* msg1 = mrmsg_new();</div><div class="line"> mrmsg_set_type(msg1, MR_MSG_TEXT);</div><div class="line"> mrmsg_set_text(msg1, <span class="stringliteral">&quot;Hi there!&quot;</span>);</div><div class="line"> <a class="code" href="structmrmailbox__t.html#a88ef3066cec30fe26f61f273b233d90c">mrmailbox_send_msg</a>(mailbox, chat_id, msg1); <span class="comment">// send a simple text message</span></div><div class="line">mrmsg_unref(msg1);</div><div class="line"></div><div class="line"><a class="code" href="structmrmsg__t.html">mrmsg_t</a>* msg2 = mrmsg_new();</div><div class="line"> mrmsg_set_type(msg2, MR_MSG_IMAGE);</div><div class="line"> mrmsg_set_file(msg2, <span class="stringliteral">&quot;/path/to/image.jpg&quot;</span>);</div><div class="line"> <a class="code" href="structmrmailbox__t.html#a88ef3066cec30fe26f61f273b233d90c">mrmailbox_send_msg</a>(mailbox, chat_id, msg2); <span class="comment">// send a simple text message</span></div><div class="line">mrmsg_unref(msg1);</div></div><!-- fragment -->
</div>
</div>
<a class="anchor" id="a3f9ac5fb9ff2dcbaafdddb5d955ac39b"></a>
@ -2660,7 +2662,8 @@ void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="st
</table>
</div><div class="memdoc">
<p>full path of the blob directory in use. </p>
<p>Full path of the blob directory. </p>
<p>This is the directory given to <a class="el" href="structmrmailbox__t.html#a32825e3e0a1b16679580704a4b43db1a" title="Create a new mailbox object. ">mrmailbox_new()</a> or a directory in the same directory as <a class="el" href="structmrmailbox__t.html#aab18660500768b611373190720439956" title="The database file. ">mrmailbox_t::m_dbfile</a>. </p>
</div>
</div>
@ -2674,7 +2677,23 @@ void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="st
</table>
</div><div class="memdoc">
<p>the database file in file. </p>
<p>The database file. </p>
<p>This is the file given to <a class="el" href="structmrmailbox__t.html#a32825e3e0a1b16679580704a4b43db1a" title="Create a new mailbox object. ">mrmailbox_new()</a>. </p>
</div>
</div>
<a class="anchor" id="a6c557153209e128b69301246dbf9e230"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* mrmailbox_t::m_userdata</td>
</tr>
</table>
</div><div class="memdoc">
<p>Use data, may be used for any purpose. </p>
<p>The same pointer as given to <a class="el" href="structmrmailbox__t.html#a32825e3e0a1b16679580704a4b43db1a" title="Create a new mailbox object. ">mrmailbox_new()</a>, may be used by the caller for any purpose. </p>
</div>
</div>

4
docs/html/structmrmsg__t-members.html
View file

@ -105,7 +105,9 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<tr class="even"><td class="entry"><a class="el" href="structmrmsg__t.html#a8c8c1f342f01439ae40c5cf37532387e">mrmsg_get_summarytext</a>(mrmsg_t *msg, int approx_characters)</td><td class="entry"><a class="el" href="structmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structmrmsg__t.html#a80f470eb34af414ff28e7d3b3c715b48">mrmsg_new</a>()</td><td class="entry"><a class="el" href="structmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structmrmsg__t.html#a0bc3ce5f2ef0065547e4aee0143d22ef">mrmsg_save_param_to_disk</a>(mrmsg_t *msg)</td><td class="entry"><a class="el" href="structmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structmrmsg__t.html#ae940aa79a261e1a427b12baefbee2d23">mrmsg_set_text</a>(mrmsg_t *msg, const char *text)</td><td class="entry"><a class="el" href="structmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structmrmsg__t.html#a98455bee60d64b3d59d89fbbb520ddd5">mrmsg_set_file</a>(mrmsg_t *msg, const char *file)</td><td class="entry"><a class="el" href="structmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structmrmsg__t.html#ae940aa79a261e1a427b12baefbee2d23">mrmsg_set_text</a>(mrmsg_t *msg, const char *text)</td><td class="entry"><a class="el" href="structmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structmrmsg__t.html#a3581e331fe9f3f38d4c5bb1b1c8c7867">mrmsg_set_type</a>(mrmsg_t *msg, int type)</td><td class="entry"><a class="el" href="structmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structmrmsg__t.html#a9980da92916e42081f2f39ccc72c1696">mrmsg_show_padlock</a>(mrmsg_t *msg)</td><td class="entry"><a class="el" href="structmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structmrmsg__t.html#aa33212e41efff643aa7290753f3d9b02">mrmsg_unref</a>(mrmsg_t *msg)</td><td class="entry"><a class="el" href="structmrmsg__t.html">mrmsg_t</a></td><td class="entry"></td></tr>
</table></div><!-- contents -->

86
docs/html/structmrmsg__t.html
View file

@ -106,6 +106,12 @@ Public Member Functions</h2></td></tr>
<tr class="memitem:a57d94b55fc918b27874b9194d6c35388"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrmsg__t.html#a57d94b55fc918b27874b9194d6c35388">mrmsg_empty</a> (<a class="el" href="structmrmsg__t.html">mrmsg_t</a> *msg)</td></tr>
<tr class="memdesc:a57d94b55fc918b27874b9194d6c35388"><td class="mdescLeft">&#160;</td><td class="mdescRight">Empty a message object. <a href="#a57d94b55fc918b27874b9194d6c35388">More...</a><br /></td></tr>
<tr class="separator:a57d94b55fc918b27874b9194d6c35388"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3581e331fe9f3f38d4c5bb1b1c8c7867"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrmsg__t.html#a3581e331fe9f3f38d4c5bb1b1c8c7867">mrmsg_set_type</a> (<a class="el" href="structmrmsg__t.html">mrmsg_t</a> *msg, int type)</td></tr>
<tr class="memdesc:a3581e331fe9f3f38d4c5bb1b1c8c7867"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the type of a message. <a href="#a3581e331fe9f3f38d4c5bb1b1c8c7867">More...</a><br /></td></tr>
<tr class="separator:a3581e331fe9f3f38d4c5bb1b1c8c7867"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a98455bee60d64b3d59d89fbbb520ddd5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrmsg__t.html#a98455bee60d64b3d59d89fbbb520ddd5">mrmsg_set_file</a> (<a class="el" href="structmrmsg__t.html">mrmsg_t</a> *msg, const char *file)</td></tr>
<tr class="memdesc:a98455bee60d64b3d59d89fbbb520ddd5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the file belonging to a message. <a href="#a98455bee60d64b3d59d89fbbb520ddd5">More...</a><br /></td></tr>
<tr class="separator:a98455bee60d64b3d59d89fbbb520ddd5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae940aa79a261e1a427b12baefbee2d23"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrmsg__t.html#ae940aa79a261e1a427b12baefbee2d23">mrmsg_set_text</a> (<a class="el" href="structmrmsg__t.html">mrmsg_t</a> *msg, const char *text)</td></tr>
<tr class="memdesc:ae940aa79a261e1a427b12baefbee2d23"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the text of a message object. <a href="#ae940aa79a261e1a427b12baefbee2d23">More...</a><br /></td></tr>
<tr class="separator:ae940aa79a261e1a427b12baefbee2d23"><td class="memSeparator" colspan="2">&#160;</td></tr>
@ -292,9 +298,46 @@ char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="st
</div><div class="memdoc">
<p>Create new message object. </p>
<p>Message objects are needed eg. for sending messages using <a class="el" href="structmrmailbox__t.html#a88ef3066cec30fe26f61f273b233d90c" title="save message in database and send it, the given message object is not unref&#39;d by the function but som...">mrmailbox_send_msg()</a>. Moreover, they are returned eg. from <a class="el" href="structmrmailbox__t.html#a9ef144244e7d86ba82ce3257abf14f13" title="Get a single message object of the type mrmsg_t. ">mrmailbox_get_msg()</a>, set up with the current state of a message. The message object is not updated; to achieve this, you have to recreate it.</p>
<p>Message objects are needed eg. for sending messages using <a class="el" href="structmrmailbox__t.html#a88ef3066cec30fe26f61f273b233d90c" title="Send a message of any type to a chat. ">mrmailbox_send_msg()</a>. Moreover, they are returned eg. from <a class="el" href="structmrmailbox__t.html#a9ef144244e7d86ba82ce3257abf14f13" title="Get a single message object of the type mrmsg_t. ">mrmailbox_get_msg()</a>, set up with the current state of a message. The message object is not updated; to achieve this, you have to recreate it.</p>
<dl class="section return"><dt>Returns</dt><dd>The created message object. </dd></dl>
</div>
</div>
<a class="anchor" id="a98455bee60d64b3d59d89fbbb520ddd5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrmsg_set_file </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmrmsg__t.html">mrmsg_t</a> *&#160;</td>
<td class="paramname"><em>msg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>file</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the file belonging to a message. </p>
<p>The file may be an image, a video, an audio file, an PDF and so on. This function is a shortcut for mrparam_set(msg-&gt;m_param, MRP_FILE, file)</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">msg</td><td>The message object to modify.</td></tr>
<tr><td class="paramname">file</td><td>Path, filename and extension to set for the given message.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None. </dd></dl>
</div>
</div>
<a class="anchor" id="ae940aa79a261e1a427b12baefbee2d23"></a>
@ -332,6 +375,44 @@ char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="st
</dl>
<dl class="section return"><dt>Returns</dt><dd>None. </dd></dl>
</div>
</div>
<a class="anchor" id="a3581e331fe9f3f38d4c5bb1b1c8c7867"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrmsg_set_type </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmrmsg__t.html">mrmsg_t</a> *&#160;</td>
<td class="paramname"><em>msg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>type</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the type of a message. </p>
<p>Possible types are MR_MSG_TEXT, MR_MSG_IMAGE, MR_MSG_GIF,MR_MSG_AUDIO,, MR_MSG_VOICE, MR_MSG_VIDEO or MR_MSG_FILE.</p>
<p>See <a class="el" href="structmrmailbox__t.html#a88ef3066cec30fe26f61f273b233d90c" title="Send a message of any type to a chat. ">mrmailbox_send_msg()</a> for some examples.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">msg</td><td>The message object to modify.</td></tr>
<tr><td class="paramname">type</td><td>Type to set for the message.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None. </dd></dl>
</div>
</div>
<a class="anchor" id="a9980da92916e42081f2f39ccc72c1696"></a>
@ -377,10 +458,11 @@ char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="st
<p>by <a class="el" href="structmrmsg__t.html#a80f470eb34af414ff28e7d3b3c715b48" title="Create new message object. ">mrmsg_new()</a> or <a class="el" href="structmrmailbox__t.html#a9ef144244e7d86ba82ce3257abf14f13" title="Get a single message object of the type mrmsg_t. ">mrmailbox_get_msg()</a>. This also free()s all strings; so if you set up the object yourself, make sure to use strdup()!</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">msg</td><td>The message object to free. </td></tr>
<tr><td class="paramname">msg</td><td>The message object to free.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None. </dd></dl>
</div>
</div>