mail::folder::destroy(3x)

1MAIL::FOLDER::DESTRO(3x)Cone: COnsole Newsreader And EMAIL::FOLDER::DESTRO(3x)
2
3
4

NAME

6       mail::folder::destroy - Destroy an existing folder
7

SYNOPSIS

9       #include <libmail/mail.H>
10
11
12       class myCallback : public mail::callback {
13       public:
14           void success(std::string msg);
15           void fail(std::string msg);
16       };
17
18       folder->create(myCallback &callback, bool destroyDir);
19

USAGE

21       This function destroys the folder referenced by this mail::folder
22       object. The mail::folder object itself is not destroyed (the usual C++
23       delete operator does the trick there), only the actual folder is
24       destroyed.
25
26       Folders contain either messages, or other sub-folders (so-called
27       "folder directories"). Some mail accounts may contain dual-purpose
28       folders that contain both messages and sub-folders (see
29       mail::account::createSubFolder(3x) for more information). With some
30       account types, only completely empty folders may be deleted (the
31       operation will fail if the folder still contains messages or other
32       sub-folders).
33
34       destroyDir must be set to true when destroying a folder directory, and
35       to false when destroying a regular folder.
36

RETURN CODES AND CALLBACKS

38       The application must wait until callback´s success or fail method is
39       invoked. The success method is invoked when this request is succesfully
40       processed. The fail method is invoked if this request cannot be
41       processed. The application must not destroy callback until either the
42       success or fail method is invoked.
43
44           Note
45           callback´s fail method may be invoked even after other callback
46           methods were invoked. This indicates that the request was partially
47           completed before the error was encountered.
48

NAME

SYNOPSIS

USAGE

RETURN CODES AND CALLBACKS

SEE ALSO