-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathaddr_config_type.html
149 lines (147 loc) · 13.2 KB
/
addr_config_type.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
<!-- HTML header for doxygen 1.9.6-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.6"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>NeoMutt: Config type: Email address</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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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>
<link href="doxygen.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 id="projectrow">
<td id="projectlogo"><a href="https://neomutt.org"><img alt="Logo" src="neomutt-64.png"/></a></td>
<td id="projectalign" style="padding-left: 0.5em;">
<a style="color: black; text-decoration: none;" href="https://neomutt.org">
<div id="projectname">NeoMutt
 <span id="projectnumber">2025-04-04</span>
</div>
<div id="projectbrief">Teaching an old dog new tricks</div>
</a>
<a href="https://github.com/neomutt/neomutt" class="github-corner" aria-label="View source on Github"><svg width="80" height="80" viewBox="0 0 250 250" style="fill:#000000; color:#fff; position: fixed; top: 0; border: 0; right: 0; z-index: 9999;" aria-hidden="true"><path d="M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z"></path><path d="M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6 C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3 125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2" fill="currentColor" style="transform-origin: 130px 106px;" class="octo-arm"></path><path d="M115.0,115.0 C114.9,115.1 118.7,116.5 119.8,115.4 L133.7,101.6 C136.9,99.2 139.9,98.4 142.2,98.6 C133.8,88.0 127.5,74.4 143.8,58.0 C148.5,53.4 154.0,51.2 159.7,51.0 C160.3,49.4 163.2,43.6 171.4,40.1 C171.4,40.1 176.1,42.5 178.8,56.2 C183.1,58.6 187.2,61.8 190.9,65.4 C194.5,69.0 197.7,73.2 200.1,77.6 C213.8,80.2 216.3,84.9 216.3,84.9 C212.7,93.1 206.9,96.0 205.4,96.6 C205.1,102.4 203.0,107.8 198.3,112.5 C181.9,128.9 168.3,122.5 157.7,114.1 C157.9,116.9 156.7,120.9 152.7,124.9 L141.0,136.5 C139.8,137.7 141.6,141.9 141.8,141.8 Z" fill="currentColor" class="octo-body"></path></svg></a><style>.github-corner:hover .octo-arm{animation:octocat-wave 560ms ease-in-out}@keyframes octocat-wave{0%,100%{transform:rotate(0)}20%,60%{transform:rotate(-25deg)}40%,80%{transform:rotate(10deg)}}@media (max-width:500px){.github-corner:hover .octo-arm{animation:none}.github-corner .octo-arm{animation:octocat-wave 560ms ease-in-out}}</style>
</td>
<td><a style="text-decoration: none; position: absolute; right: 0; top: 25px; margin-right: 100px; color: #66d866; font-size: 400%;" href="http://www.doxygen.org/index.html">DOXYGEN</a></td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.6 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(document).ready(function(){initNavTree('addr_config_type.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div><div class="header">
<div class="headertitle"><div class="title">Config type: <a class="el" href="structEmail.html" title="The envelope/body of an email.">Email</a> address </div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>Config type representing an email address.</p>
<ul>
<li>Backed by <code>struct <a class="el" href="structAddress.html" title="An email address.">Address</a></code></li>
<li>Empty address is stored as <code>NULL</code></li>
<li>Validator is passed <code>struct <a class="el" href="structAddress.html" title="An email address.">Address</a> *</code>, which may be <code>NULL</code></li>
<li>Data is freed when <code><a class="el" href="structConfigSet.html" title="Container for lots of config items.">ConfigSet</a></code> is freed</li>
<li>Implementation: <a class="el" href="address_2config__type_8c.html#a4550af5202cdff5d0930d60f0aa84733" title="Config type representing an Email Address.">CstAddress</a></li>
</ul>
<h2><a class="anchor" id="autotoc_md130"></a>
Data</h2>
<table class="markdownTable">
<tr class="markdownTableHead">
<th class="markdownTableHeadLeft">Data </th><th class="markdownTableHeadLeft">Description </th><th class="markdownTableHeadLeft">Links </th></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyLeft"><a class="el" href="address_2config__type_8c.html#a4550af5202cdff5d0930d60f0aa84733" title="Config type representing an Email Address.">CstAddress</a> </td><td class="markdownTableBodyLeft">Config type representing an <a class="el" href="structEmail.html" title="The envelope/body of an email.">Email</a> <a class="el" href="structAddress.html" title="An email address.">Address</a> </td><td class="markdownTableBodyLeft"></td></tr>
</table>
<h2><a class="anchor" id="autotoc_md131"></a>
Functions</h2>
<table class="markdownTable">
<tr class="markdownTableHead">
<th class="markdownTableHeadLeft">Function </th><th class="markdownTableHeadLeft">Description </th><th class="markdownTableHeadLeft">Links </th></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyLeft"><a class="el" href="group__cfg__type__destroy.html#gac13fde215d412763b167aa4621b764f1" title="Destroy an Address object - Implements ConfigSetType::destroy() -.">address_destroy()</a> </td><td class="markdownTableBodyLeft">Destroy an <a class="el" href="structAddress.html" title="An email address.">Address</a> object </td><td class="markdownTableBodyLeft"><a class="el" href="structConfigSetType.html#aa547c6d34a2912c20e0d3bd33ef773f3">ConfigSetType::destroy()</a>, <a href="group__cfg__type__destroy.html"><b>cfg_type_destroy</b></a> </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyLeft"><a class="el" href="address_2config__type_8c.html#a97ecee35f07a69196a9bbe88d9ae4db4" title="Create a copy of an Address object.">address_dup()</a> </td><td class="markdownTableBodyLeft">Create a copy of an <a class="el" href="structAddress.html" title="An email address.">Address</a> object </td><td class="markdownTableBodyLeft"></td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyLeft"><a class="el" href="group__cfg__type__has__been__set.html#ga706d8de1fd392f10a651434f581e29f6" title="Is the config value different to its initial value? - Implements ConfigSetType::has_been_set() -.">address_has_been_set()</a> </td><td class="markdownTableBodyLeft">Is the config value different to its initial value? </td><td class="markdownTableBodyLeft"><a class="el" href="structConfigSetType.html#a52e56669cc1d1a8d4c75a0f9b2a6a1aa">ConfigSetType::has_been_set()</a>, <a href="group__cfg__type__has__been__set.html"><b>cfg_type_has_been_set</b></a> </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyLeft"><a class="el" href="group__cfg__type__native__get.html#ga8aac61b4c6ff08418db3e99da6a0681e" title="Get an Address object from an Address config item - Implements ConfigSetType::native_get() -.">address_native_get()</a> </td><td class="markdownTableBodyLeft">Get an <a class="el" href="structAddress.html" title="An email address.">Address</a> object from an <a class="el" href="structAddress.html" title="An email address.">Address</a> config item </td><td class="markdownTableBodyLeft"><a class="el" href="structConfigSetType.html#a2c73ef0fc0257e1578b0e31f6e35697b">ConfigSetType::native_get()</a>, <a href="group__cfg__type__native__get.html"><b>cfg_type_native_get</b></a> </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyLeft"><a class="el" href="group__cfg__type__native__set.html#gaafd62e544fd5faf7700631b74a224bad" title="Set an Address config item by Address object - Implements ConfigSetType::native_set() -.">address_native_set()</a> </td><td class="markdownTableBodyLeft">Set an <a class="el" href="structAddress.html" title="An email address.">Address</a> config item by <a class="el" href="structAddress.html" title="An email address.">Address</a> object </td><td class="markdownTableBodyLeft"><a class="el" href="structConfigSetType.html#a28b7957f552e12b8a0fcd7fb3789f902">ConfigSetType::native_set()</a>, <a href="group__cfg__type__native__set.html"><b>cfg_type_native_set</b></a> </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyLeft"><a class="el" href="address_2config__type_8c.html#a387010d3016202b78e14f3574953ccfb" title="Create an Address from a string.">address_new()</a> </td><td class="markdownTableBodyLeft">Create an <a class="el" href="structAddress.html" title="An email address.">Address</a> from a string </td><td class="markdownTableBodyLeft"></td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyLeft"><a class="el" href="group__cfg__type__reset.html#gaa6a4d31cd291ffd52ff7431b17bc368a" title="Reset an Address to its initial value - Implements ConfigSetType::reset() -.">address_reset()</a> </td><td class="markdownTableBodyLeft">Reset an <a class="el" href="structAddress.html" title="An email address.">Address</a> to its initial value </td><td class="markdownTableBodyLeft"><a class="el" href="structConfigSetType.html#a818267ba2bcd246332facd32fbd6aa9e">ConfigSetType::reset()</a>, <a href="group__cfg__type__reset.html"><b>cfg_type_reset</b></a> </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyLeft"><a class="el" href="group__cfg__type__string__get.html#ga3b15a03a48d2918d27ea1579186efe1b" title="Get an Address as a string - Implements ConfigSetType::string_get() -.">address_string_get()</a> </td><td class="markdownTableBodyLeft">Get an <a class="el" href="structAddress.html" title="An email address.">Address</a> as a string </td><td class="markdownTableBodyLeft"><a class="el" href="structConfigSetType.html#a94f05f7427b26380b25647e50642e3cf">ConfigSetType::string_get()</a>, <a href="group__cfg__type__string__get.html"><b>cfg_type_string_get</b></a> </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyLeft"><a class="el" href="group__cfg__type__string__set.html#ga29f6d03bc5b30751eb83fbb1ba05e53e" title="Set an Address by string - Implements ConfigSetType::string_set() -.">address_string_set()</a> </td><td class="markdownTableBodyLeft">Set an <a class="el" href="structAddress.html" title="An email address.">Address</a> by string </td><td class="markdownTableBodyLeft"><a class="el" href="structConfigSetType.html#a12496fc0bf059e077a0bb6fff786acb8">ConfigSetType::string_set()</a>, <a href="group__cfg__type__string__set.html"><b>cfg_type_string_set</b></a> </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyLeft"><a class="el" href="address_2config__type_8c.html#ae303ac83498043a651ec046b572bc707" title="Get an Address config item by name.">cs_subset_address()</a> </td><td class="markdownTableBodyLeft">Get an <a class="el" href="structAddress.html" title="An email address.">Address</a> config item by name </td><td class="markdownTableBodyLeft"></td></tr>
</table>
</div></div><!-- contents -->
</div><!-- PageDoc -->
</div><!-- doc-content -->
</body>
</html>