<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii"/>
<title>mail::account::copyMessagesTo</title>
<link rel="stylesheet" href="manpage.css" type="text/css"/>
<link rel="start" 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-checknewmail.html" title="mail::account::checkNewMail"/>
<link rel="next" href="mail-findfolder.html" title="mail::account::findFolder"/>
<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::copyMessagesTo</th>
</tr>
<tr>
<td width="20%" align="left" rowspan="1" colspan="1">
<a accesskey="p" href="mail-checknewmail.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-findfolder.html" shape="rect">Next</a></td>
</tr>
</table>
<hr/>
</div>
<div class="refentry" lang="en" xml:lang="en">
<a id="mail-copymessagesto" shape="rect" name="mail-copymessagesto"> </a>
<div class="titlepage"/>
<div class="refnamediv">
<h2>Name</h2>
<p>mail::account::copyMessagesTo — Copy messages to
another folder</p>
</div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<div class="literallayout">
<p><br clear="none"/>
<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="funcsynopsis">
<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0">
<tr>
<td rowspan="1" colspan="1"><code class="funcdef">account-><b class="fsfunc">copyMessagesTo</b>(</code></td>
<td rowspan="1" colspan="1">const
std::vector<size_t> & </td>
<td rowspan="1" colspan="1"><var class="pdparam">msgList</var>,</td>
</tr>
<tr>
<td rowspan="1" colspan="1"> </td>
<td rowspan="1" colspan="1">mail::folder * </td>
<td rowspan="1" colspan="1"><var class="pdparam">copyTo</var>,</td>
</tr>
<tr>
<td rowspan="1" colspan="1"> </td>
<td rowspan="1" colspan="1">myCallback & </td>
<td rowspan="1" colspan="1"><var class="pdparam">callback</var><code>)</code>;</td>
</tr>
</table>
</div>
</div>
<div class="refsect1" lang="en" xml:lang="en">
<a id="id584437" shape="rect" name="id584437"> </a>
<h2>USAGE</h2>
<p><code class="function">mail::account::copyMessagesTo</code> copies
messages in the currently-open folder to another folder.
<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="mail-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.</p>
<p><em class="parameter"><code>copyTo</code></em> is a
pointer to a <span class="structname">mail::folder</span>
object, representing the folder where messages are copied to.
If <code class="varname">account</code> is an IMAP account
and <em class="parameter"><code>copyTo</code></em> is another
folder in the same account, then the messages are quickly
copied by the IMAP server. Otherwise each message is
individually downloaded and copied to the <em class="parameter"><code>copyTo</code></em> folder.</p>
</div>
<div class="refsect1" lang="en" xml:lang="en">
<a id="id585537" shape="rect" name="id585537"> </a>
<h2>Return Codes</h2>
<p>The application must wait until <em class="parameter"><code>callback</code></em>'s <code class="function">success</code> or <code class="function">fail</code> method is invoked. The <code class="function">success</code> method is invoked when this request
is succesfully processed. The <code class="function">fail</code> method is invoked if this request
cannot be processed. The application must not destroy
<em class="parameter"><code>callback</code></em> until either
the <code class="function">success</code> or <code class="function">fail</code> method is invoked.</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p><em class="parameter"><code>callback</code></em>'s
<code class="function">fail</code> method may be invoked
even after other callback methods were invoked. This
indicates that the request was partially completed before
the error was encountered.</p>
</div>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>Multiple applications may have the same account and
folder opened at the same time. It is possible that a
message referenced by this request was already deleted by
another application. Depending on the underlying server
implementation this will result in either a failed request,
invoking <code class="function">callback.fail</code>, or
the request completing (<code class="function">callback.success</code> invoked) but without
invoking any callback function that refer to the
message.</p>
</div>
</div>
<div class="refsect1" lang="en" xml:lang="en">
<a id="id585394" shape="rect" name="id585394"> </a>
<h2>SEE ALSO</h2>
<p><a class="link" href="mail-movemessagesto.html" title="mail::account::moveMessagesTo" shape="rect"><span class="citerefentry"><span class="refentrytitle">mail::account::moveMessagesTo</span>(3x)</span></a>,
<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-checknewmail.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-findfolder.html" shape="rect">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top" rowspan="1" colspan="1">mail::account::checkNewMail </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::findFolder</td>
</tr>
</table>
</div>
</body>
</html>
