mail::account::saveFolderIndexInfo(3x)

1mail::account::saveFoldmeariIln:d:eaxcIcnofuon(t3xN)ativmeaiAlP:I:arcecfoeurnetn:c:esaveFolderIndexInfo(3x)
2
3
4

NAME

6       mail::account::saveFolderIndexInfo - Update message status
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       mail::account *account;
19
20
21
22       account->saveFolderIndexInfo   (size_t  messageNum,  const  messageInfo
23       &msgInfo, myCallback &callback);
24

USAGE

26       mail::account::saveFolderIndexInfo changes the  status  of  a  message.
27       messageNum  must be between zero and one less than the return code from
28       mail::account::getFolderIndexSize(3x).  msgInfo contains the new status
29       flags  for this message.  See mail::account::getFolderIndexInfo(3x) for
30       a description of message status flags.
31
32              Note: The uid field in msgInfo is ignored.  The message is spec‐
33              ified  by messageNum, and unique IDs of existing messages cannot
34              be changed.
35

RETURN CODES

37       The application must wait until callback's success or  fail  method  is
38       invoked.   The  success  method is invoked when this request is succes‐
39       fully processed.  The fail method is invoked if this request cannot  be
40       processed.   The application must not destroy callback until either the
41       success or fail method is invoked.
42
43              Note: callback's fail method may be  invoked  even  after  other
44              callback  methods were invoked.  This indicates that the request
45              was partially completed before the error was encountered.
46
47              Note: The application is notified about when a message's  status
48              changes by by invoking the messageChanged callback method of the
49              currently opened folder's mail::folderCallback object.   Depend‐
50              ing on the mail server, the messageChanged method may be invoked
51              as part of processing this request, or  some  time  later  after
52              this  request  is  completed,  and callback's success method was
53              invoked.
54
55              Note: Multiple applications may have the same account and folder
56              opened  at  the same time.  It is possible that a message refer‐
57              enced by this request was already deleted  by  another  applica‐
58              tion.   Depending  on  the underlying server implementation this
59              will result in either a failed request, invoking  callback.fail,
60              or the request completing (callback.success invoked) but without
61              invoking any callback function that refer to the message.
62

NAME

SYNOPSIS

USAGE

RETURN CODES

SEE ALSO