/usr/share/cone/account-updatekeywords.html is in cone 0.89-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 | <html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii"/>
<title>mail::ACCOUNT::updateKeywords</title>
<link rel="stylesheet" href="manpage.css" type="text/css"/>
<link rel="home" href="index.html" title="Cone: COnsole Newsreader And Emailer"/>
<link rel="up" href="synchronous.html" title="mail::ACCOUNT Synchronous API reference"/>
<link rel="prev" href="account-updatefolderindexinfo.html" title="mail::ACCOUNT::updateFolderIndexInfo"/>
<link rel="next" href="native.html" title="mail::account Native API reference"/>
<link xmlns="" rel="icon" href="icon.gif" type="image/gif"/>
<meta xmlns="" name="MSSmartTagsPreventParsing" content="TRUE"/>
<!--
Copyright 2002 - 2007 Double Precision, Inc. See COPYING for distribution
information.
-->
</head>
<body>
<div class="navheader">
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center" rowspan="1">
mail::ACCOUNT::updateKeywords</th>
</tr>
<tr>
<td width="20%" align="left" rowspan="1" colspan="1">
<a accesskey="p" href="account-updatefolderindexinfo.html" shape="rect">Prev</a> </td>
<th width="60%" align="center" rowspan="1" colspan="1">
<span class="structname">mail::ACCOUNT</span> Synchronous
API reference</th>
<td width="20%" align="right" rowspan="1" colspan="1">
 <a accesskey="n" href="native.html" shape="rect">Next</a></td>
</tr>
</table>
<hr/>
</div>
<div class="refentry" title="mail::ACCOUNT::updateKeywords">
<a id="account-updatekeywords" shape="rect" name="account-updatekeywords"> </a>
<div class="titlepage"/>
<div class="refnamediv">
<h2>Name</h2>
<p>mail::ACCOUNT::updateKeywords — Update message
keywords</p>
</div>
<div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
<div class="literallayout">
<p><br clear="none"/>
<br clear="none"/>
<br clear="none"/>
#include <libmail/sync.H><br clear="none"/>
<br clear="none"/>
mail::ACCOUNT *mail;<br clear="none"/></p>
</div>
<div class="funcsynopsis">
<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td rowspan="1" colspan="1"><code class="funcdef">bool
ok=mail-><b class="fsfunc">updateKeywords</b>(</code></td>
<td rowspan="1" colspan="1">const
std::vector<size_t> <var class="pdparam">msgList</var>,</td>
</tr>
<tr>
<td rowspan="1" colspan="1"> </td>
<td rowspan="1" colspan="1">const
std::set<std::string> &<var class="pdparam">keywords</var>,</td>
</tr>
<tr>
<td rowspan="1" colspan="1"> </td>
<td rowspan="1" colspan="1">bool <var class="pdparam">setOrChange</var>,</td>
</tr>
<tr>
<td rowspan="1" colspan="1"> </td>
<td rowspan="1" colspan="1">bool <var class="pdparam">changeTo</var><code>)</code>;</td>
</tr>
</table>
<div class="funcprototype-spacer">
 
</div>
</div>
<div class="funcsynopsis">
<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td rowspan="1" colspan="1"><code class="funcdef">bool
ok=mail-><b class="fsfunc">updateKeywords</b>(</code></td>
<td rowspan="1" colspan="1">const
std::vector<size_t> <var class="pdparam">msgList</var>,</td>
</tr>
<tr>
<td rowspan="1" colspan="1"> </td>
<td rowspan="1" colspan="1">const
std::list<std::string> &<var class="pdparam">keywords</var>,</td>
</tr>
<tr>
<td rowspan="1" colspan="1"> </td>
<td rowspan="1" colspan="1">bool <var class="pdparam">setOrChange</var>,</td>
</tr>
<tr>
<td rowspan="1" colspan="1"> </td>
<td rowspan="1" colspan="1">bool <var class="pdparam">changeTo</var><code>)</code>;</td>
</tr>
</table>
<div class="funcprototype-spacer">
 
</div>
</div>
<div class="funcsynopsis">
<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td rowspan="1" colspan="1"><code class="funcdef">bool
ok=mail-><b class="fsfunc">updateKeywords</b>(</code></td>
<td rowspan="1" colspan="1">const
std::vector<size_t> <var class="pdparam">msgList</var>,</td>
</tr>
<tr>
<td rowspan="1" colspan="1"> </td>
<td rowspan="1" colspan="1">const
std::vector<std::string> &<var class="pdparam">keywords</var>,</td>
</tr>
<tr>
<td rowspan="1" colspan="1"> </td>
<td rowspan="1" colspan="1">bool <var class="pdparam">setOrChange</var>,</td>
</tr>
<tr>
<td rowspan="1" colspan="1"> </td>
<td rowspan="1" colspan="1">bool <var class="pdparam">changeTo</var><code>)</code>;</td>
</tr>
</table>
<div class="funcprototype-spacer">
 
</div>
</div>
</div>
<div class="refsect1" title="USAGE">
<a id="id590057" shape="rect" name="id590057"> </a>
<h2>USAGE</h2>
<p>This function updates the set of keywords of one or more
messages. <em class="parameter"><code>keywords</code></em>
may also be specified as a list, or a vector (and duplicate
occurences of a keyword are automatically removed).</p>
<p><em class="parameter"><code>msgList</code></em> specifies
a list of messages. Messages are numbered starting with
message #0 and up to one less than <a class="link" href="account-getfolderindexsize.html" title="mail::ACCOUNT::getFolderIndexSize" shape="rect"><span class="citerefentry"><span class="refentrytitle">mail::ACCOUNT::getFolderIndexSize</span>(3x)</span></a>
(when <code class="function">mail::account::getFolderIndexSize</code> returns
6, the messages are numbered 0 through 5). Only the messages
that appear in <em class="parameter"><code>msgList</code></em> are processed by this
request. When a message is removed from the folder, by
<a class="link" href="account-updatefolderindexinfo.html" title="mail::ACCOUNT::updateFolderIndexInfo" shape="rect"><span class="citerefentry"><span class="refentrytitle">mail::ACCOUNT::updateFolderIndexInfo</span>(3x)</span></a>,
the following messages are renumbered accordingly.</p>
<div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>Most mail servers allow multiple applications to open
the same folder. Therefore, changes to the folder's
contents can occur at any time. Before making this request,
the application should use <a class="link" href="account-checknewmail.html" title="mail::ACCOUNT::checkNewMail" shape="rect"><span class="citerefentry"><span class="refentrytitle">mail::ACCOUNT::checkNewMail</span>(3x)</span></a>
to verify that no unexpected changes have been made to the
folder's contents.</p>
</div>
<p>When <em class="parameter"><code>setOrChange</code></em>
is <code class="literal">false</code>, <em class="parameter"><code>changeTo</code></em> is ignored, and any
existing keywords set for each message in <em class="parameter"><code>msgList</code></em> are completely replaced
by <em class="parameter"><code>keywords</code></em>. When
<em class="parameter"><code>setOrChange</code></em> is
<code class="literal">true</code> <em class="parameter"><code>changeTo</code></em> selects whether
<em class="parameter"><code>keywords</code></em> are added to
the existing set of keywords that are already set for each
message (<em class="parameter"><code>changeTo</code></em> is
<code class="literal">true</code>), or removed from the
existing set of keywords (<em class="parameter"><code>changeTo</code></em> is <code class="literal">false</code>).</p>
<div class="refsect2" title="Keywords">
<a id="id590598" shape="rect" name="id590598"> </a>
<h3>Keywords</h3>
<p>Keywords are application-defined flags, or markers, that
are associated which each message in a folder. Keywords
names are arbitrary, and are subject to certain
restrictions. <span class="application">LibMAIL</span> does
not place any special meaning on any particular keyword
name. <span class="application">LibMAIL</span> 's sole
involvement is to store the save the list of keywords set
for a given message, and then retrieve it upon demand.</p>
<p>Which characters may be included in a keyword name
depends on the underlying account type. Applications that
expect to use any supported account type should limit
themselves to the lowest common denominator: case
insensitive <code class="literal">us-ascii</code> character
set; no whitespace or any of the following characters:
commas; apostrophes; quotes; backslashes; forward slashes;
opening/closing braces, brackets, and parenthesis; question
marks; asterisks; percent signs. In all cases, keyword
names may not include any control characters. Unless
keywords are permanently saved, and remain available after
the folder is closed, and subsequently reopened. When the
folder is reopened at some point later, all keywords will
remain set for their corresponding messages (unless they
were modified by another process).</p>
<div class="itemizedlist">
<ul class="itemizedlist" type="disc">
<li class="listitem">
<p>Temporary folders do not implement keywords.</p>
</li>
<li class="listitem">
<p>IMAP accounts have case-insensitive keywords in
the <code class="literal">us-ascii</code> character
set. Keyword names may not contain: apostrophes;
quotes; backslashes; forward slashes; opening/closing
braces, brackets, and parenthesis; question marks;
asterisks; and percent signs.</p>
</li>
<li class="listitem">
<p><a class="link" href="smap1.html" title="Appendix A. Simple Mail Access Protocol, Version 1" shape="rect">SMAP</a> accounts have case-sensitive
keywords that use the <code class="literal">UTF-8</code> character set. Keyword names
may not contain commas.</p>
<div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>IMAP restrictions also apply if the same account
is accessible via IMAP.</p>
</div>
</li>
<li class="listitem">
<p>Maildir accounts have case-sensitive keywords that
use the <code class="literal">UTF-8</code> character
set.</p>
<div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>IMAP and/or SMAP restrictions also apply if the
maildir is also accessible via IMAP or SMAP.</p>
</div>
</li>
<li class="listitem">
<p>Mbox accounts have case-sensitive keywords that
use the <code class="literal">UTF-8</code> character
set.</p>
</li>
<li class="listitem">
<p>NNTP and POP3 accounts have case-sensitive
keywords that use the <code class="literal">UTF-8</code> character set. Keywords are
not saved. When the folder is closed, all set
keywords are lost. Snapshots may be used to obtain
permanent keyword storage for NNTP and POP3 accounts.
See <a class="link" href="folder-open.html" title="mail::folder::open" shape="rect"><span class="citerefentry"><span class="refentrytitle">mail::folder::open</span>(3x)</span></a>
for more information.</p>
</li>
</ul>
</div>
</div>
</div>
<div class="refsect1" title="Return Codes">
<a id="id590443" shape="rect" name="id590443"> </a>
<h2>Return Codes</h2>
<p>This method returns <code class="literal">true</code> if
it succeeds, or <code class="literal">false</code> if it
fails. If the method fails, use <em class="structfield"><code>mail::ACCOUNT::getErrmsg()</code></em> to
read a brief description of the error.</p>
</div>
<div class="refsect1" title="SEE ALSO">
<a id="id590475" shape="rect" name="id590475"> </a>
<h2>SEE ALSO</h2>
<p><a class="link" href="account-savefolderindexinfo.html" title="mail::ACCOUNT::saveFolderIndexInfo" shape="rect"><span class="citerefentry"><span class="refentrytitle">mail::ACCOUNT::saveFolderIndexInfo</span>(3x)</span></a>,
<a class="link" href="account-getfolderindexinfo.html" title="mail::ACCOUNT::getFolderIndexInfo" shape="rect"><span class="citerefentry"><span class="refentrytitle">mail::ACCOUNT::getFolderIndexInfo</span>(3x)</span></a>,
<a class="link" href="account-getfolderkeywordinfo.html" title="mail::ACCOUNT::getFolderKeywordInfo" shape="rect"><span class="citerefentry"><span class="refentrytitle">mail::ACCOUNT::getFolderKeywordInfo</span>(3x)</span></a>.</p>
</div>
</div>
<div class="navfooter">
<hr/>
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left" rowspan="1" colspan="1">
<a accesskey="p" href="account-updatefolderindexinfo.html" shape="rect">Prev</a> </td>
<td width="20%" align="center" rowspan="1" colspan="1">
<a accesskey="u" href="synchronous.html" shape="rect">Up</a></td>
<td width="40%" align="right" rowspan="1" colspan="1">
 <a accesskey="n" href="native.html" shape="rect">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top" rowspan="1" colspan="1">mail::ACCOUNT::updateFolderIndexInfo </td>
<td width="20%" align="center" rowspan="1" colspan="1">
<a accesskey="h" href="index.html" shape="rect">Home</a> | <a accesskey="t" href="bk01-toc.html" shape="rect">ToC</a></td>
<td width="40%" align="right" valign="top" rowspan="1" colspan="1"> <span class="structname">mail::account</span> Native API reference</td>
</tr>
</table>
</div>
</body>
</html>
|