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

NAME

6       mail::folder::getPath - Return the folder´s server address
7

SYNOPSIS

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

USAGE

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

RETURN CODES

34       A string that specifies the folder´s address on the mail server.
35

SEE ALSO

37       mail::account::findFolder(3x), mail::folder::isParentOf(3x),
38       mail::folder::getName(3x).
39
40
41
42[FIXME: source]                   05/08/2010          MAIL::FOLDER::GETPAT(3x)
Impressum