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

NAME

8       mail::ACCOUNT::renameFolder - Rename a folder
9

SYNOPSIS

11       #include <libmail/sync.H>
12
13       mail::ACCOUNT *mail;
14
15       mail::folder *folder=mail->renameFolder(const mail::folder *oldFolder,
16                                               const mail::folder *newParent,
17                                               std::string name);
18
19                                               std::string errmsg=mail->getErrmsg();
20

USAGE

22       This function renames an existing folder.  oldFolder is an existing
23       folder or a folder directory (see mail::folder::createSubFolder(3x) for
24       more information on folders and folder directories).  newParent, if not
25       NULL, specifies the new parent folder directory. A NULL newParent
26       specifies that the folder should be be moved to the top level of the
27       mail account's folder hierarchy.
28
29       name specifies the new name of the folder, in the application's
30       character set.
31
32           Note
33           Some mail servers reserve certain characters which cannot be used
34           in folder names. IMAP mail servers use a special character (usually
35           "/" or ".") as a separator between names in a hierarchical folder
36           path. The actual character varies from server to server. An attempt
37           to create/rename a folder whose name includes a reserved character
38           will fail. Different IMAP servers use different hierarchy separator
39           characters. An attempt to create a folder may fail on one IMAP
40           server even if another IMAP server can succesfully create a folder
41           with the same name. This is, unfortunately, a design flaw in the
42           IMAP protocol.
43
44           Note
45           Maildir folders created by are compatible and can be read by the
46           Courier-IMAP[1] server. Names of maildir folders may contain any
47           character, including the characters ":", "/", ".", "~", and ":".
48           However, if the same folders are exported via IMAP, folders whose
49           name includes these characters may not be readable by some IMAP
50           clients. Even a LibMAIL application may not be able to read one of
51           these folders via IMAP.
52
53           Note
54           Mbox mail folders created by LibMAIL are mostly compatible and can
55           be exported by IMAP servers that read mbox-formatted mail folders
56           (with some limitations, such as that the same mbox folder cannot be
57           open by LibMAIL and another application at the same time). Names of
58           mbox folders can contain any character, including the characters
59           "/", and "~". However if mbox folders are exported via IMAP,
60           folders whose name includes these characters may not be readable by
61           some IMAP clients.
62

RETURN CODES AND CALLBACKS

64       This function returns a pointer to the renamed mail::folder object, or
65       a NULL pointer if the folder cannot be renamed for some reason. The
66       application is responsible for destroying the new mail::folder object,
67       when it is no longer needed.
68

SEE ALSO

70       mail::ACCOUNT::createFolder(3x).
71

AUTHOR

73       Sam Varshavchik
74

NOTES

76        1. Courier-IMAP
77           http://www.courier-mta.org
78
79
80
81Cone©                             08/25/2016          MAIL::ACCOUNT::RENAM(3x)
Impressum