1mail::folder::getPath(3xm)ail::folder Native API referenmcaeil::folder::getPath(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
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 spe‐
21       cific interpretation.  Valid uses of the folder's server path are  lim‐
22       ited 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  mail::account::find‐
28         Folder(3x)  in  order to create a mail::folder object which refers to
29         this specific folder.
30
31       · The server path may  be  used  as  a  parameter  mail::folder::isPar‐
32         entOf(3x)  to  determine  whether  this  folder  is  contained within
33         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
42
43
44                                 10 April 2006       mail::folder::getPath(3x)
Impressum