1MAIL::FOLDER::DESTROY(3xm)ail::folder Native API referenMcAeIL::FOLDER::DESTROY(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
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 opera‐
33       tion will fail if the folder still contains messages or other sub-fold‐
34       ers).
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  succes‐
42       fully  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:  callback's  fail  method  may be invoked even after other
47              callback methods were invoked.  This indicates that the  request
48              was partially completed before the error was encountered.
49

SEE ALSO

51       mail::account::createSubFolder(3x).
52
53
54
55                                 10 April 2006       MAIL::FOLDER::DESTROY(3x)
Impressum