yetangitu/deltachat-core
1
0
Fork 0
mirror of https://github.com/deltachat/deltachat-core.git synced 2025-10-06 03:50:08 +02:00
Code Issues Releases Wiki Activity

Doxygen

Browse source
This commit is contained in:
B. Petersen 2017-11-21 23:06:56 +01:00
parent ad483990c7
commit 25f5a0ba1f
23 changed files with 2742 additions and 2446 deletions
Download patch file Download diff file Expand all files Collapse all files

270
docs/html/structmrcontact__t.html
View file

@ -100,6 +100,18 @@ Public Member Functions</h2></td></tr>
<tr class="memitem:a38e17e55cd66f5e86a1dcb8d1f67797a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcontact__t.html#a38e17e55cd66f5e86a1dcb8d1f67797a">mrcontact_unref</a> (<a class="el" href="structmrcontact__t.html">mrcontact_t</a> *contact)</td></tr>
<tr class="memdesc:a38e17e55cd66f5e86a1dcb8d1f67797a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Free a contact object. <a href="#a38e17e55cd66f5e86a1dcb8d1f67797a">More...</a><br /></td></tr>
<tr class="separator:a38e17e55cd66f5e86a1dcb8d1f67797a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abfe19c7f41061c1946d00556f3e4a971"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcontact__t.html#abfe19c7f41061c1946d00556f3e4a971">mrcontact_get_addr</a> (<a class="el" href="structmrcontact__t.html">mrcontact_t</a> *contact)</td></tr>
<tr class="memdesc:abfe19c7f41061c1946d00556f3e4a971"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get email address. <a href="#abfe19c7f41061c1946d00556f3e4a971">More...</a><br /></td></tr>
<tr class="separator:abfe19c7f41061c1946d00556f3e4a971"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5b559ef46c96f38bf2d1f2c39de3ccb2"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcontact__t.html#a5b559ef46c96f38bf2d1f2c39de3ccb2">mrcontact_get_name</a> (<a class="el" href="structmrcontact__t.html">mrcontact_t</a> *contact)</td></tr>
<tr class="memdesc:a5b559ef46c96f38bf2d1f2c39de3ccb2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get name. <a href="#a5b559ef46c96f38bf2d1f2c39de3ccb2">More...</a><br /></td></tr>
<tr class="separator:a5b559ef46c96f38bf2d1f2c39de3ccb2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a29a93300d97183f795fc711c93fac689"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcontact__t.html#a29a93300d97183f795fc711c93fac689">mrcontact_get_display_name</a> (<a class="el" href="structmrcontact__t.html">mrcontact_t</a> *contact)</td></tr>
<tr class="memdesc:a29a93300d97183f795fc711c93fac689"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get display name. <a href="#a29a93300d97183f795fc711c93fac689">More...</a><br /></td></tr>
<tr class="separator:a29a93300d97183f795fc711c93fac689"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2658329d9e3c74f93943dfd8c25554b2"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcontact__t.html#a2658329d9e3c74f93943dfd8c25554b2">mrcontact_get_name_n_addr</a> (<a class="el" href="structmrcontact__t.html">mrcontact_t</a> *contact)</td></tr>
<tr class="memdesc:a2658329d9e3c74f93943dfd8c25554b2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a summary of name and address. <a href="#a2658329d9e3c74f93943dfd8c25554b2">More...</a><br /></td></tr>
<tr class="separator:a2658329d9e3c74f93943dfd8c25554b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a804337f9c9e735a5429559b0fcb06121"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcontact__t.html#a804337f9c9e735a5429559b0fcb06121">mrcontact_get_first_name</a> (const char *full_name)</td></tr>
<tr class="memdesc:a804337f9c9e735a5429559b0fcb06121"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the first name. <a href="#a804337f9c9e735a5429559b0fcb06121">More...</a><br /></td></tr>
<tr class="separator:a804337f9c9e735a5429559b0fcb06121"><td class="memSeparator" colspan="2">&#160;</td></tr>
@ -113,13 +125,13 @@ Public Attributes</h2></td></tr>
<tr class="memdesc:ab2ee31297c327e04ed14673adbd49716"><td class="mdescLeft">&#160;</td><td class="mdescRight">The contact ID. <a href="#ab2ee31297c327e04ed14673adbd49716">More...</a><br /></td></tr>
<tr class="separator:ab2ee31297c327e04ed14673adbd49716"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a48fba862b41f7da3b8c6193c0554654b"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcontact__t.html#a48fba862b41f7da3b8c6193c0554654b">m_name</a></td></tr>
<tr class="memdesc:a48fba862b41f7da3b8c6193c0554654b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Name given by the user to the contact. <a href="#a48fba862b41f7da3b8c6193c0554654b">More...</a><br /></td></tr>
<tr class="memdesc:a48fba862b41f7da3b8c6193c0554654b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Contact name. <a href="#a48fba862b41f7da3b8c6193c0554654b">More...</a><br /></td></tr>
<tr class="separator:a48fba862b41f7da3b8c6193c0554654b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a559c848feee29d334098f9a581448e56"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcontact__t.html#a559c848feee29d334098f9a581448e56">m_authname</a></td></tr>
<tr class="memdesc:a559c848feee29d334098f9a581448e56"><td class="mdescLeft">&#160;</td><td class="mdescRight">Name authorized by the contact himself. <a href="#a559c848feee29d334098f9a581448e56">More...</a><br /></td></tr>
<tr class="separator:a559c848feee29d334098f9a581448e56"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaedd60ba4cad97bb87ba5a55958341e5"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcontact__t.html#aaedd60ba4cad97bb87ba5a55958341e5">m_addr</a></td></tr>
<tr class="memdesc:aaedd60ba4cad97bb87ba5a55958341e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">The E-Mail-Address of the contact. <a href="#aaedd60ba4cad97bb87ba5a55958341e5">More...</a><br /></td></tr>
<tr class="memdesc:aaedd60ba4cad97bb87ba5a55958341e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">E-Mail-Address of the contact. <a href="#aaedd60ba4cad97bb87ba5a55958341e5">More...</a><br /></td></tr>
<tr class="separator:aaedd60ba4cad97bb87ba5a55958341e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac22d500e5c439b07c943ed2c7afb2a23"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcontact__t.html#ac22d500e5c439b07c943ed2c7afb2a23">m_blocked</a></td></tr>
<tr class="memdesc:ac22d500e5c439b07c943ed2c7afb2a23"><td class="mdescLeft">&#160;</td><td class="mdescRight">Blocked state. <a href="#ac22d500e5c439b07c943ed2c7afb2a23">More...</a><br /></td></tr>
@ -129,6 +141,139 @@ Public Attributes</h2></td></tr>
<div class="textblock"><p>An object representing a single contact in memory. </p>
<p>The contact object is not updated. If you want an update, you have to recreate the object. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a38e17e55cd66f5e86a1dcb8d1f67797a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrcontact_unref </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmrcontact__t.html">mrcontact_t</a> *&#160;</td>
<td class="paramname"><em>contact</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free a contact object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">contact</td><td>The contact object as created eg. by <a class="el" href="structmrmailbox__t.html#a057660d94350ff98eca72785c6e88962" title="Get a single contact object. ">mrmailbox_get_contact()</a>.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None. </dd></dl>
</div>
</div>
<a class="anchor" id="abfe19c7f41061c1946d00556f3e4a971"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char * mrcontact_get_addr </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmrcontact__t.html">mrcontact_t</a> *&#160;</td>
<td class="paramname"><em>contact</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get email address. </p>
<p>May be an empty string.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">contact</td><td>The contact object</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>String with the email address, must be free()'d. Never returns NULL. </dd></dl>
</div>
</div>
<a class="anchor" id="a5b559ef46c96f38bf2d1f2c39de3ccb2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char * mrcontact_get_name </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmrcontact__t.html">mrcontact_t</a> *&#160;</td>
<td class="paramname"><em>contact</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get name. </p>
<p>This is the name as defined the the contact himself or modified by the user. May be an empty string.</p>
<p>This name is typically used in a form where the user can edit the name of a contact. This name must not be spreaded via mail (To:, CC: ...) as it as it may be sth. like "Daddy". To get a fine name to display in lists etc., use <a class="el" href="structmrcontact__t.html#a29a93300d97183f795fc711c93fac689" title="Get display name. ">mrcontact_get_display_name()</a> or <a class="el" href="structmrcontact__t.html#a2658329d9e3c74f93943dfd8c25554b2" title="Get a summary of name and address. ">mrcontact_get_name_n_addr()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">contact</td><td>The contact object</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>String with the name to display, must be free()'d. Empty string if unset, never returns NULL. </dd></dl>
</div>
</div>
<a class="anchor" id="a29a93300d97183f795fc711c93fac689"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char * mrcontact_get_display_name </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmrcontact__t.html">mrcontact_t</a> *&#160;</td>
<td class="paramname"><em>contact</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get display name. </p>
<p>This is the name as defined the the contact himself, modified by the user or, if both are unset, the email address.</p>
<p>This name is typically used in lists and must not be speaded via mail (To:, CC: ...). To get the name editable in a formular, use mrcontact_get_edit_name().</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">contact</td><td>The contact object</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>String with the name to display, must be free()'d. Never returns NULL. </dd></dl>
</div>
</div>
<a class="anchor" id="a2658329d9e3c74f93943dfd8c25554b2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char * mrcontact_get_name_n_addr </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmrcontact__t.html">mrcontact_t</a> *&#160;</td>
<td class="paramname"><em>contact</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a summary of name and address. </p>
<p>The returned string is either "Name (email@domain.com)" or just "email@domain.com" if the name is unset.</p>
<p>The summary is typically used when asking the user something about the contact. The attached email address makes the question unique, eg. "Chat with Alan Miller (am@uniquedomain.com)?"</p>
<p>The summary must not be spreaded via mail (To:, CC: ...) as it as it may contain sth. like "Daddy".</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">contact</td><td>The contact object</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Summary string, must be free()'d. Never returns NULL. </dd></dl>
</div>
</div>
<a class="anchor" id="a804337f9c9e735a5429559b0fcb06121"></a>
<div class="memitem">
<div class="memproto">
@ -175,6 +320,7 @@ Public Attributes</h2></td></tr>
<li>Convert names as "Petersen, Björn" to "Björn Petersen"</li>
<li>Trims the resulting string</li>
</ul>
<p>Typically, this function is not needed as it is called implicitly by <a class="el" href="structmrmailbox__t.html#a25720ea41355cc32cc93aa45709937d6" title="Add a number of contacts. ">mrmailbox_add_address_book()</a></p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">full_name</td><td>Buffer with the name, is modified during processing; the resulting string may be shorter but never longer.</td></tr>
@ -183,79 +329,9 @@ Public Attributes</h2></td></tr>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None. But the given buffer may be modified. </dd></dl>
</div>
</div>
<a class="anchor" id="a38e17e55cd66f5e86a1dcb8d1f67797a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrcontact_unref </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmrcontact__t.html">mrcontact_t</a> *&#160;</td>
<td class="paramname"><em>contact</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free a contact object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">contact</td><td>The contact object as created eg. by <a class="el" href="structmrmailbox__t.html#a057660d94350ff98eca72785c6e88962" title="Get a single contact object. ">mrmailbox_get_contact()</a>.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None. </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="aaedd60ba4cad97bb87ba5a55958341e5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* mrcontact_t::m_addr</td>
</tr>
</table>
</div><div class="memdoc">
<p>The E-Mail-Address of the contact. </p>
<p>May be NULL or empty. </p>
</div>
</div>
<a class="anchor" id="a559c848feee29d334098f9a581448e56"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* mrcontact_t::m_authname</td>
</tr>
</table>
</div><div class="memdoc">
<p>Name authorized by the contact himself. </p>
<p>May be NULL or empty, this is the name authorized by the sender, only this name may be speaded to others, eg. in To:-lists; for displaying in the app, use <a class="el" href="structmrcontact__t.html#a48fba862b41f7da3b8c6193c0554654b" title="Name given by the user to the contact. ">m_name</a> </p>
</div>
</div>
<a class="anchor" id="ac22d500e5c439b07c943ed2c7afb2a23"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mrcontact_t::m_blocked</td>
</tr>
</table>
</div><div class="memdoc">
<p>Blocked state. </p>
<p>1=contact is blocked, 0=contact is not blocked. To block or unblock a contact, use <a class="el" href="structmrmailbox__t.html#abb069358386b767a60444651195e0895" title="Block or unblock a contact. ">mrmailbox_block_contact()</a>. </p>
</div>
</div>
<a class="anchor" id="ab2ee31297c327e04ed14673adbd49716"></a>
<div class="memitem">
<div class="memproto">
@ -284,9 +360,53 @@ Public Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Name given by the user to the contact. </p>
<p>Should be used for displaying everywhere and is editable by the user but must not be spreaded via mail (To:, CC: ...) as it as it may be sth. like "Daddy".</p>
<p>May be NULL or empty, initially set to <a class="el" href="structmrcontact__t.html#a559c848feee29d334098f9a581448e56" title="Name authorized by the contact himself. ">m_authname</a> </p>
<p>Contact name. </p>
<p>It is recommended to use <a class="el" href="structmrcontact__t.html#a5b559ef46c96f38bf2d1f2c39de3ccb2" title="Get name. ">mrcontact_get_name()</a>, <a class="el" href="structmrcontact__t.html#a29a93300d97183f795fc711c93fac689" title="Get display name. ">mrcontact_get_display_name()</a> or <a class="el" href="structmrcontact__t.html#a2658329d9e3c74f93943dfd8c25554b2" title="Get a summary of name and address. ">mrcontact_get_name_n_addr()</a> to access this field. May be NULL or empty, initially set to <a class="el" href="structmrcontact__t.html#a559c848feee29d334098f9a581448e56" title="Name authorized by the contact himself. ">m_authname</a>. </p>
</div>
</div>
<a class="anchor" id="a559c848feee29d334098f9a581448e56"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* mrcontact_t::m_authname</td>
</tr>
</table>
</div><div class="memdoc">
<p>Name authorized by the contact himself. </p>
<p>It is recommended to use <a class="el" href="structmrcontact__t.html#a5b559ef46c96f38bf2d1f2c39de3ccb2" title="Get name. ">mrcontact_get_name()</a>, <a class="el" href="structmrcontact__t.html#a29a93300d97183f795fc711c93fac689" title="Get display name. ">mrcontact_get_display_name()</a> or <a class="el" href="structmrcontact__t.html#a2658329d9e3c74f93943dfd8c25554b2" title="Get a summary of name and address. ">mrcontact_get_name_n_addr()</a> to access this field. This is the name authorized by the sender, only this name may be speaded to others, eg. in To:-lists. May be NULL or empty. </p>
</div>
</div>
<a class="anchor" id="aaedd60ba4cad97bb87ba5a55958341e5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* mrcontact_t::m_addr</td>
</tr>
</table>
</div><div class="memdoc">
<p>E-Mail-Address of the contact. </p>
<p>It is recommended to use <a class="el" href="structmrcontact__t.html#abfe19c7f41061c1946d00556f3e4a971" title="Get email address. ">mrcontact_get_addr()</a> to access this field. May be NULL. </p>
</div>
</div>
<a class="anchor" id="ac22d500e5c439b07c943ed2c7afb2a23"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mrcontact_t::m_blocked</td>
</tr>
</table>
</div><div class="memdoc">
<p>Blocked state. </p>
<p>1=contact is blocked, 0=contact is not blocked. To block or unblock a contact, use <a class="el" href="structmrmailbox__t.html#abb069358386b767a60444651195e0895" title="Block or unblock a contact. ">mrmailbox_block_contact()</a>. </p>
</div>
</div>