mail::folder::hasMessages.3x

Langue: en

Autres versions - même langue

Version: 11/28/2008 (fedora - 01/12/10)

Section: 3 (Bibliothèques de fonctions)

NAME

mail::folder::hasMessages - Determine if the folder is capable of storing messages

SYNOPSIS

 
 
 
 #include <libmail/mail.H>
 
 mail::folder *folder;
 
bool flag=folder->hasMessages(void);

USAGE

Some folders contain messages. Other folders contain other folder (subfolders). Some IMAP servers are capable of creating dual-purpose folders that contain both messages and other subfolders. The hasMessages method indicates whether folder is capable of storing messages.

RETURN CODES

A true result indicates that folder is capable of storing messages. It may not necessarily mean that folder actually contains any messages, it might very well be an empty folder.


Note

POP3 folders return a true, even though application cannot directly add messages to POP3 folders. Applications should interpret a true result to mean that:

* mail::folder::open(3x) may be used to open this folder.
*This folder's mail::folder::addmessage(3x) method, and using this folder as a parameter to mail::folder::copyMessagesTo(3x) will probably work.

Applications should interpret a false result as a guarantee that neither of the above procedures will work.

SEE ALSO

mail::folder::hasSubFolders(3x).