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

NAME

6       mail::ACCOUNT::renameFolder - Rename a folder
7

SYNOPSIS

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

USAGE

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

RETURN CODES AND CALLBACKS

73       This function returns a pointer to the renamed mail::folder object, or
74       a NULL pointer if the folder cannot be renamed for some reason. The
75       application is responsible for destroying the new mail::folder object,
76       when it is no longer needed.
77

SEE ALSO

79       mail::ACCOUNT::createFolder(3x).
80

NOTES

82        1. Courier-IMAP
83           http://www.courier-mta.org
84
85
86
87[FIXME: source]                   05/08/2010          MAIL::ACCOUNT::RENAM(3x)
Impressum