1        Cone©
2
3MAIL::ACCOUNT::MOVEM(3x)Cone: COnsole Newsreader And EMAIL::ACCOUNT::MOVEM(3x)
4
5
6

NAME

8       mail::ACCOUNT::moveMessagesTo - Move messages to another folder
9

SYNOPSIS

11       #include <libmail/sync.H>
12
13
14       mail::ACCOUNT *mail;
15       mail::folder *folder;
16
17       bool ok=mail->moveMessagesTo(const std::vector<size_t> &msgList,
18                                    mail::folder *copyTo);
19
20                                    std::string errmsg=mail->getErrmsg();
21

USAGE

23       msgList specifies a list of messages. Messages are numbered starting
24       with message #0 and up to one less than
25       mail::ACCOUNT::getFolderIndexSize(3x) (when
26       mail::account::getFolderIndexSize returns 6, the messages are numbered
27       0 through 5). Only the messages that appear in msgList are processed by
28       this request. When a message is removed from the folder, by
29       mail::ACCOUNT::updateFolderIndexInfo(3x), the following messages are
30       renumbered accordingly.
31
32           Note
33           Most mail servers allow multiple applications to open the same
34           folder. Therefore, changes to the folder's contents can occur at
35           any time. Before making this request, the application should use
36           mail::ACCOUNT::checkNewMail(3x) to verify that no unexpected
37           changes have been made to the folder's contents.
38
39       mail::ACCOUNT::moveMessagesTo moves messages in the currently-open
40       folder to another folder. It's similar to
41       mail::ACCOUNT::copyMessagesTo(3x), except that the messages are moved,
42       instead of copied.
43
44       copyTo is a pointer to a mail::folder object, representing the folder
45       where messages are moved to.  copyTo may be a folder in another mail
46       account, in which case this function transparently copies the indicated
47       messages using mail::ACCOUNT::copyMessagesTo(3x), then the original
48       messages are removed using mail::ACCOUNT::removeMessages(3x). Only SMAP
49       and maildir-based mail accounts can move messages directly between
50       folders; for all other accounts the copy/delete implementation will be
51       used automatically.
52

RETURN CODES

54       This method returns true if it succeeds, or false if it fails. If the
55       method fails, use mail::ACCOUNT::getErrmsg() to read a brief
56       description of the error.
57

SEE ALSO

59       mail::ACCOUNT::copyMessagesTo(3x), mail::ACCOUNT::removeMessages(3x).
60

AUTHOR

62       Sam Varshavchik
63
64
65
66Cone©                             08/25/2016          MAIL::ACCOUNT::MOVEM(3x)
Impressum