mail::ACCOUNT::renameFolder(3x)

1mail::ACCOUNT::renamemFaoilld:e:rA(C3CxO)UNT Synchronous APmIairle:f:eArCeCnOcUeNT::renameFolder(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
14
15       mail::folder *folder=mail->renameFolder (const mail::folder *oldFolder,
16       const mail::folder *newParent, std::string name);
17
18       std::string errmsg=mail->getErrmsg();
19

USAGE

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

RETURN CODES AND CALLBACKS

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

NAME

SYNOPSIS

USAGE

RETURN CODES AND CALLBACKS

SEE ALSO