/usr/share/cone/mail-getsendfolder.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 | <html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii"/>
<title>mail::account::getSendFolder</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="native.html" title="mail::account Native API reference"/>
<link rel="prev" href="mail-getfolderkeywordinfo.html" title="mail::account::getFolderKeywordInfo"/>
<link rel="next" href="mail-hascapability.html" title="mail::account::hasCapability"/>
<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::getSendFolder</th>
</tr>
<tr>
<td width="20%" align="left" rowspan="1" colspan="1">
<a accesskey="p" href="mail-getfolderkeywordinfo.html" shape="rect">Prev</a> </td>
<th width="60%" align="center" rowspan="1" colspan="1">
<span class="structname">mail::account</span> Native API
reference</th>
<td width="20%" align="right" rowspan="1" colspan="1">
 <a accesskey="n" href="mail-hascapability.html" shape="rect">Next</a></td>
</tr>
</table>
<hr/>
</div>
<div class="refentry" title="mail::account::getSendFolder">
<a id="mail-getsendfolder" shape="rect" name="mail-getsendfolder"> </a>
<div class="titlepage"/>
<div class="refnamediv">
<h2>Name</h2>
<p>mail::account::getSendFolder — Create a folder
object for sending mail</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/mail.H><br clear="none"/>
<br clear="none"/>
<br clear="none"/>
class myCallback : public mail::callback {<br clear="none"/>
public:<br clear="none"/>
    void success(std::string msg);<br clear="none"/>
    void fail(std::string msg);<br clear="none"/>
};<br clear="none"/></p>
</div>
<div class="literallayout">
<p><br clear="none"/>
<br clear="none"/>
#include <libmail/smtpinfo.H><br clear="none"/>
#include <libmail/addmessage.H><br clear="none"/>
<br clear="none"/>
mail::account *account;<br clear="none"/>
<br clear="none"/>
mail::smtpInfo info;<br clear="none"/>
<br clear="none"/>
info.sender="nobody@example.com";<br clear="none"/>
<br clear="none"/>
info.recipients.push_back("recipient@example.com");<br clear="none"/>
<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">mail::folder *folder=account-><b class="fsfunc">getSendFolder</b>(</code></td>
<td rowspan="1" colspan="1">const mail::smtpInfo
&<var class="pdparam">info</var>,</td>
</tr>
<tr>
<td rowspan="1" colspan="1"> </td>
<td rowspan="1" colspan="1">const mail::folder
*<var class="pdparam">saveFolder</var>,</td>
</tr>
<tr>
<td rowspan="1" colspan="1"> </td>
<td rowspan="1" colspan="1">std::string <var class="pdparam">errmsg</var><code>)</code>;</td>
</tr>
</table>
<div class="funcprototype-spacer">
 
</div>
</div>
<div class="literallayout">
<p><br clear="none"/>
myCallback sendCallback;<br clear="none"/>
<br clear="none"/>
mail::addMessage *addMessage= folder->addMessage(sendCallback);<br clear="none"/>
<br clear="none"/>
addMessage->saveMessageContents(std::string messageText);<br clear="none"/>
addMessage->go();<br clear="none"/></p>
</div>
</div>
<div class="refsect1" title="USAGE">
<a id="id596110" shape="rect" name="id596110"> </a>
<h2>USAGE</h2>
<p>This function creates a special folder object: copying a
message to this folder will E-mail it to the designated
recipient list. The <span class="structname">mail::account</span> object must be an account
that's capable of creating this kind of a folder (such as
<code class="literal">smtp</code> accounts created by
<a class="link" href="mail-open.html" title="mail::account::open" shape="rect"><span class="citerefentry"><span class="refentrytitle">mail::account::open</span>(3x)</span></a>).
The message may be manually added to the folder with
<a class="link" href="folder-addmessage.html" title="mail::folder::addMessage" shape="rect"><span class="citerefentry"><span class="refentrytitle">mail::folder::addmessage</span>(3x)</span></a>,
or by copying a message from another folder using <a class="link" href="mail-copymessagesto.html" title="mail::account::copyMessagesTo" shape="rect"><span class="citerefentry"><span class="refentrytitle">mail::folder::copyMessagesTo</span>(3x)</span></a>.</p>
<div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>Multiple messages may be copied to this <span class="structname">mail::folder</span>. Each messages is E-mail
separately, to all recipients. Excersize caution to prevent
an accidental request to copy an entire folder, with
thousand messages, to a thousand recipients.</p>
</div>
<div class="refsect2" title="saveFolder">
<a id="id584097" shape="rect" name="id584097"> </a>
<h3><em class="parameter"><code>saveFolder</code></em></h3>
<p><em class="parameter"><code>saveFolder</code></em>, if
not <code class="literal">NULL</code>, specifies that a
copy of the message should also be saved in this folder. If
this mail account uses the experimental <a class="link" href="smap1.html" title="Appendix A. Simple Mail Access Protocol, Version 1" shape="rect">SMAP</a> protocol, a single copy of the
message will be transmitted to the <code class="literal">SMAP</code> server, which will file the message
in the folder, and send it to the designated recipients.
Otherwise the message is manually saved to this folder
using <a class="link" href="folder-addmessage.html" title="mail::folder::addMessage" shape="rect"><span class="citerefentry"><span class="refentrytitle">mail::folder::addMessage</span>(3x)</span></a>,
or <a class="link" href="account-libmail-addmessage.html" title="mail::ACCOUNT::addMessage" shape="rect"><span class="citerefentry"><span class="refentrytitle">mail::ACCOUNT::addMessage</span>(3x)</span></a>.</p>
</div>
<div class="refsect2" title="The mail::smtpInfo object">
<a id="id584160" shape="rect" name="id584160"> </a>
<h3>The <span class="structname">mail::smtpInfo</span>
object</h3>
<p><em class="parameter"><code>info</code></em> specifies
the following parameters which are used to deliver the
message:</p>
<pre class="programlisting" xml:space="preserve">
class mail::smtpInfo {
public:
std::string sender;
std::vector<std::string> recipients;
std::map<std::string, std::string> options;
} ;
</pre>
<p><em class="structfield"><code>sender</code></em>
specifies the sender's E-mail address, in the form of
"<em class="replaceable"><code>user</code></em>@<em class="replaceable"><code>domain</code></em>". <em class="structfield"><code>recipients</code></em> is a list of
recipients' E-mail addresses. At least one recipient must
be specified.</p>
<p><em class="structfield"><code>options</code></em>
specifies additional parameters for sending E-mail,
initialized as follows:</p>
<div class="variablelist">
<dl>
<dt><span class="term">options.insert(make_pair("novalidate-cert",
"1"))</span></dt>
<dd>
<p>See <a class="link" href="mail-open.html" title="mail::account::open" shape="rect"><span class="citerefentry"><span class="refentrytitle">mail::account::open</span>(3x)</span></a>)
for a description of this option.</p>
</dd>
<dt><span class="term">options.insert(make_pair("cram",
"1"))</span></dt>
<dd>
<p>See <a class="link" href="mail-open.html" title="mail::account::open" shape="rect"><span class="citerefentry"><span class="refentrytitle">mail::account::open</span>(3x)</span></a>)
for a description of this option.</p>
</dd>
<dt><span class="term">options.insert(make_pair("DSN",
"<em class="replaceable"><code>list</code></em>"))</span></dt>
<dd>
<p>Request a delivery status notification. <em class="replaceable"><code>list</code></em> is a
comma-separated list of the following keywords:
"<code class="literal">never</code>" - do not request
any receipts, not even non-delivery notices;
"<code class="literal">success</code>" - request a
delivery confirmation receipt; "<code class="literal">fail</code>" - request a non-delivery
notice; "<code class="literal">delay</code>" -
request a delayed delivery notice.</p>
<div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>An error will be reported if the mail server
does not implement delivery status
notifications.</p>
</div>
</dd>
<dt><span class="term">options.insert(make_pair("RET",
"hdrs"))</span></dt>
<dd>
<p>Request that the delivery status notification
should not include the entire original message, only
its headers.</p>
</dd>
<dt><span class="term">options.insert(make_pair("RET",
"full"))</span></dt>
<dd>
<p>Request that the delivery status notifications
should include the entire original message.</p>
</dd>
<dt><span class="term">options.insert(make_pair("NOPIPELINING",
"1"))</span></dt>
<dd>
<p>Do not use the <code class="literal">PIPELINING</code> <code class="literal">SMTP</code> extension even if the mail
server claims to support it (workaround for buggy
firewalls).</p>
</dd>
<dt><span class="term">options.insert(make_pair("VERP",
"1"))</span></dt>
<dd>
<p>Use the <code class="literal">VERP</code> mailing
list extension. If the <em class="structfield"><code>sender</code></em> address is
"<em class="replaceable"><code>sender</code></em>@<em class="replaceable"><code>senddomain</code></em>", then a
delivery status notification for "<em class="replaceable"><code>recipient</code></em>@<em class="replaceable"><code>recipientdomain</code></em>" will
be sent to "<em class="replaceable"><code>sender</code></em>-<em class="replaceable"><code>recipient</code></em>=<em class="replaceable"><code>recipientdomain</code></em>@<em class="replaceable"><code>senddomain</code></em>"
(with certain additional details). This option is
currently implemented only by the <a class="ulink" href="http://www.courier-mta.org" target="_top" shape="rect">Courier mail server</a>.</p>
</dd>
<dt><span class="term">options.insert(make_pair("SECURITY",
"STARTTLS"))</span></dt>
<dd>
<p>The message must be sent via TLS, and the
recipient's server must present a certificate signed
by a trusted, private, certificate authority. This
option is currently implemented only by the <a class="ulink" href="http://www.courier-mta.org" target="_top" shape="rect">Courier mail server</a>.</p>
<div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>This is not the standard <code class="literal">STARTTLS</code> <code class="literal">ESMTP</code> extension. <code class="literal">STARTTLS</code> is always used
automatically, if it's supported by the mail
server.</p>
</div>
</dd>
</dl>
</div>
</div>
</div>
<div class="refsect1" title="RETURN CODES AND CALLBACKS">
<a id="id596602" shape="rect" name="id596602"> </a>
<h2>RETURN CODES AND CALLBACKS</h2>
<p><code class="function">mail::account::getSendFolder</code>
returns NULL if this <span class="structname">mail::account</span> object is not capable of
sending mail. <em class="parameter"><code>errmsg</code></em>
is initialized with an appropriate error message.</p>
</div>
<div class="refsect1" title="SEE ALSO">
<a id="id596628" shape="rect" name="id596628"> </a>
<h2>SEE ALSO</h2>
<p><a class="link" href="mail-open.html" title="mail::account::open" shape="rect"><span class="citerefentry"><span class="refentrytitle">mail::account::open</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="mail-getfolderkeywordinfo.html" shape="rect">Prev</a> </td>
<td width="20%" align="center" rowspan="1" colspan="1">
<a accesskey="u" href="native.html" shape="rect">Up</a></td>
<td width="40%" align="right" rowspan="1" colspan="1">
 <a accesskey="n" href="mail-hascapability.html" shape="rect">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top" rowspan="1" colspan="1">mail::account::getFolderKeywordInfo </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"> mail::account::hasCapability</td>
</tr>
</table>
</div>
</body>
</html>
|