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

NAME

8       mail::folder::destroy - Destroy an existing folder
9

SYNOPSIS

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

USAGE

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

RETURN CODES AND CALLBACKS

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

SEE ALSO

52       mail::account::createSubFolder(3x).
53

AUTHOR

55       Sam Varshavchik
56
57
58
59Cone©                             08/25/2016          MAIL::FOLDER::DESTRO(3x)
Impressum