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

NAME

8       mail::ACCOUNT::checkNewMail - Check for new mail in the current folder
9

SYNOPSIS

11       #include <libmail/sync.H>
12
13       mail::ACCOUNT *mail;
14
15       bool ok=mail->checkNewMail(void);
16

USAGE

18       This method returns an indication whether the current open folder was
19       changed. The name is slightly misleading; mail::ACCOUNT::checkNewMail
20       also indicates whether messages have been removed from the folder, and
21       whether the status of any message has changed.
22
23       Most mail servers allow multiple applications to use the same folder.
24       Therefore, changes to the folder's contents may occur at any time. This
25       method should be used prior to starting any operation that intends to
26       use an existing message. If mail::ACCOUNT::checkNewMail returns true,
27       the application should then use mail::ACCOUNT::getFolderIndexSize(3x)
28       and mail::ACCOUNT::getFolderIndexInfo(3x) to read the current folder
29       index, and compare the current list of message UIDs against the
30       previously obtained list in order to determine which messages were
31       added or removed from the folder.
32

RETURN CODES

34       This function returns true if there were any changes to the folder's
35       contents after the folder was opened, or since the previous call to
36       mail::ACCOUNT::checkNewMail.
37
38           Note
39           Calling mail::ACCOUNT::updateFolderIndexInfo(3x),
40           mail::ACCOUNT::updateFolderIndexFlags(3x), and all other methods
41           that modify the contents of the current folder will usually result
42           in the next call to mail::ACCOUNT::checkNewMail returning true.
43

SEE ALSO

45       mail::ACCOUNT::saveFolderIndexInfo(3x),
46       mail::ACCOUNT::getFolderIndexInfo(3x).
47

AUTHOR

49       Sam Varshavchik
50
51
52
53Cone©                             08/25/2016          MAIL::ACCOUNT::CHECK(3x)
Impressum