mail::ACCOUNT::openFolder(3x)

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

NAME

6       mail::ACCOUNT::openFolder - Open a folder
7

SYNOPSIS

9       #include <libmail/sync.H>
10
11       mail::ACCOUNT *mail;
12
13       bool ok=mail->openFolder(const mail::folder *folder);
14
15                                std::string errmsg=mail->getErrmsg();
16

USAGE

18       A mail folder must be formally "opened" before the messages in the
19       folder may be accessed. Each mail account can have only one mail folder
20       at any time Opening another folder automatically "closes" the previous
21       folder.
22
23           Note
24           Different mail::account or mail::ACCOUNT objects may each have a
25           folder opened, at the same time. It is possible to create multiple
26           mail::account or mail::ACCOUNT objects that refer to the same
27           actual mail account. Whether it is possible to access the same
28           account multiple times, using different objects, and whether each
29           object may have the same folder opened depends on the account type
30           and/or the remote server.
31
32           ·   Whether it´s possible to open the same remote IMAP or POP3
33               account more than once depends on the remote IMAP/POP3 server.
34
35           ·   Whether it´s possible to open the same folder on a remote IMAP
36               server account more than once depends on the remote IMAP/POP3
37               server. Most IMAP servers allow the same account to be opened
38               more than once, as long as the different login sessions do not
39               try to open the same folder. Some IMAP servers allow the same
40               folder to be opened simultaneously by multiple sessions.
41
42           ·   It is generally possible to open the same local mail folder
43               simultaneously, via multiple mail::account objects, as long as
44               only one pending request is issued at a time. Concurrent access
45               to local maildirs generally works well, however simultaneous
46               access to the same mbox folder may be rather slow, due to the
47               overhead of locking and rescanning of the folder by each
48               mail::account object.
49
50       Any previously-opened folder is closed before the an attempt to open
51       this folder is made. If the new folder cannot be opened, the previous
52       folder is still considered closed.
53

RETURN CODES AND CALLBACKS

55       This method returns true if it succeeds, or false if it fails. If the
56       method fails, use mail::ACCOUNT::getErrmsg() to read a brief
57       description of the error.
58

NAME

SYNOPSIS

USAGE

RETURN CODES AND CALLBACKS

SEE ALSO