mail::ACCOUNT::deleteFolder.3x man page

Cone©

mail::ACCOUNT::deleteFolder — Delete a folder

Synopsis

#include <libmail/sync.H>

mail::ACCOUNT *mail;
mail::folder *folder;

bool ok=mail->deleteFolder(const mail::folder *folder, bool deleteDirectory);

std::string errmsg=mail->getErrmsg();

Usage

This function deletes an existing folder. deleteDirectory specifies whether the existing folder is regular folder, or a folder directory.

Note

This function only removes the actual folder in the mail account. The folder object is not affected, the application is still responsible for destroying the object, when it is no longer needed.

Return Codes and Callbacks

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

See Also

mail::ACCOUNT::getFolderFromPath(3x), mail::ACCOUNT::getFolderFromString(3x), mail::folder::createSubFolder(3x).

Author

Sam Varshavchik

Info

08/25/2013 Cone© Cone: COnsole Newsreader And E