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

NAME

8       mail::folder::getPath - Return the folder's server address
9

SYNOPSIS

11       #include <libmail/mail.H>
12
13       mail::folder *folder;
14
15       std::string pathStr=folder->getPath(void);
16

USAGE

18       This function returns folder's "server path". In general, this is the
19       folder's location on the mail server. Applications should generally
20       generally handle the path as an opaque text string that carries no
21       specific interpretation. Valid uses of the folder's server path are
22       limited to:
23
24       ·   If two mail::folder objects are linked to the same account and have
25           the same path, it means that both objects refer to the same folder.
26
27       ·   The server path may be used as a parameter
28           mail::account::findFolder(3x) in order to create a mail::folder
29           object which refers to this specific folder.
30
31       ·   The server path may be used as a parameter
32           mail::folder::isParentOf(3x) to determine whether this folder is
33           contained within another folder.
34

RETURN CODES

36       A string that specifies the folder's address on the mail server.
37

SEE ALSO

39       mail::account::findFolder(3x), mail::folder::isParentOf(3x),
40       mail::folder::getName(3x).
41

AUTHOR

43       Sam Varshavchik
44
45
46
47Cone©                             08/25/2016          MAIL::FOLDER::GETPAT(3x)
Impressum