mirror of
https://github.com/deltachat/deltachat-core.git
synced 2025-10-04 18:29:19 +02:00
243 lines
14 KiB
HTML
243 lines
14 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.11"/>
|
|
<title>Delta Chat Core C-Library: mrcontact_t Struct Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { init_search(); });
|
|
</script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
<link href="user.css" rel="stylesheet" type="text/css"/>
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">Delta Chat Core C-Library
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.11 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-attribs">Public Attributes</a> |
|
|
<a href="structmrcontact__t-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">mrcontact_t Struct Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>An object representing a single contact in memory.
|
|
<a href="structmrcontact__t.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="mrcontact_8h_source.html">mrcontact.h</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a11d19a7e25ce069131b9b6c629af440a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a11d19a7e25ce069131b9b6c629af440a"></a>
|
|
<a class="el" href="structmrcontact__t.html">mrcontact_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcontact__t.html#a11d19a7e25ce069131b9b6c629af440a">mrcontact_new</a> ()</td></tr>
|
|
<tr class="memdesc:a11d19a7e25ce069131b9b6c629af440a"><td class="mdescLeft"> </td><td class="mdescRight">Create a new contact object in memory. <br /></td></tr>
|
|
<tr class="separator:a11d19a7e25ce069131b9b6c629af440a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acdff2696f48b1d5cdbc67a8466322b25"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acdff2696f48b1d5cdbc67a8466322b25"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcontact__t.html#acdff2696f48b1d5cdbc67a8466322b25">mrcontact_unref</a> (<a class="el" href="structmrcontact__t.html">mrcontact_t</a> *ths)</td></tr>
|
|
<tr class="memdesc:acdff2696f48b1d5cdbc67a8466322b25"><td class="mdescLeft"> </td><td class="mdescRight">Free a contact object. <br /></td></tr>
|
|
<tr class="separator:acdff2696f48b1d5cdbc67a8466322b25"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac40bd5673e132c31a21ee742dee30696"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac40bd5673e132c31a21ee742dee30696"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcontact__t.html#ac40bd5673e132c31a21ee742dee30696">mrcontact_empty</a> (<a class="el" href="structmrcontact__t.html">mrcontact_t</a> *ths)</td></tr>
|
|
<tr class="memdesc:ac40bd5673e132c31a21ee742dee30696"><td class="mdescLeft"> </td><td class="mdescRight">Empty a contact object. <br /></td></tr>
|
|
<tr class="separator:ac40bd5673e132c31a21ee742dee30696"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a804337f9c9e735a5429559b0fcb06121"><td class="memItemLeft" align="right" valign="top">char * </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"> </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"> </td></tr>
|
|
<tr class="memitem:ad906207191f0cfd62e408dbc82a156cf"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcontact__t.html#ad906207191f0cfd62e408dbc82a156cf">mrcontact_normalize_name</a> (char *full_name)</td></tr>
|
|
<tr class="memdesc:ad906207191f0cfd62e408dbc82a156cf"><td class="mdescLeft"> </td><td class="mdescRight">Normalize a name in-place. <a href="#ad906207191f0cfd62e408dbc82a156cf">More...</a><br /></td></tr>
|
|
<tr class="separator:ad906207191f0cfd62e408dbc82a156cf"><td class="memSeparator" colspan="2"> </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:ab2ee31297c327e04ed14673adbd49716"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab2ee31297c327e04ed14673adbd49716"></a>
|
|
uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structmrcontact__t.html#ab2ee31297c327e04ed14673adbd49716">m_id</a></td></tr>
|
|
<tr class="memdesc:ab2ee31297c327e04ed14673adbd49716"><td class="mdescLeft"> </td><td class="mdescRight">The contact ID. <br /></td></tr>
|
|
<tr class="separator:ab2ee31297c327e04ed14673adbd49716"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a48fba862b41f7da3b8c6193c0554654b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a48fba862b41f7da3b8c6193c0554654b"></a>
|
|
char * </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"> </td><td class="mdescRight">may be NULL or empty, this name should not be spreaded as it may be "Daddy" and so on; initially set to m_authname <br /></td></tr>
|
|
<tr class="separator:a48fba862b41f7da3b8c6193c0554654b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a559c848feee29d334098f9a581448e56"><td class="memItemLeft" align="right" valign="top">char * </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"> </td><td class="mdescRight">may be NULL or empty, this is the name authorized by the sender, only this name may be speaded to others, eg. <a href="#a559c848feee29d334098f9a581448e56">More...</a><br /></td></tr>
|
|
<tr class="separator:a559c848feee29d334098f9a581448e56"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaedd60ba4cad97bb87ba5a55958341e5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaedd60ba4cad97bb87ba5a55958341e5"></a>
|
|
char * </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"> </td><td class="mdescRight">may be NULL or empty <br /></td></tr>
|
|
<tr class="separator:aaedd60ba4cad97bb87ba5a55958341e5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac22d500e5c439b07c943ed2c7afb2a23"><td class="memItemLeft" align="right" valign="top">int </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"> </td><td class="mdescRight">Blocked state. <a href="#ac22d500e5c439b07c943ed2c7afb2a23">More...</a><br /></td></tr>
|
|
<tr class="separator:ac22d500e5c439b07c943ed2c7afb2a23"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<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="a804337f9c9e735a5429559b0fcb06121"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">char * mrcontact_get_first_name </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>full_name</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the first name. </p>
|
|
<p>In a string, get the part before the first space. If there is no space in the string, the whole string is returned.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">full_name</td><td>Full name of the contct.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>String with the first name, must be free()'d after usage. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad906207191f0cfd62e408dbc82a156cf"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void mrcontact_normalize_name </td>
|
|
<td>(</td>
|
|
<td class="paramtype">char * </td>
|
|
<td class="paramname"><em>full_name</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Normalize a name in-place. </p>
|
|
<ul>
|
|
<li>Remove quotes (come from some bad MUA implementations)</li>
|
|
<li>Convert names as "Petersen, Björn" to "Björn Petersen"</li>
|
|
<li>Trims the resulting string</li>
|
|
</ul>
|
|
<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>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>None. But the given buffer may be modified. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<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>may be NULL or empty, this is the name authorized by the sender, only this name may be speaded to others, eg. </p>
|
|
<p>in To:-lists; for displaying in the app, use m_name </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. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this struct was generated from the following files:<ul>
|
|
<li>/home/bpetersen/projects/deltachat-core/src/<a class="el" href="mrcontact_8h_source.html">mrcontact.h</a></li>
|
|
<li>/home/bpetersen/projects/deltachat-core/src/mrcontact.c</li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Tue Nov 14 2017 11:55:36 for Delta Chat Core C-Library by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.11
|
|
</small></address>
|
|
</body>
|
|
</html>
|