ExamineMailbox Method
Selects a Mailbox (Read-only mode).
Syntax
ANSI (Cross Platform) int ExamineMailbox(); Unicode (Windows) INT ExamineMailbox();
- (void)examineMailbox;
#define MID_IMAP_EXAMINEMAILBOX 15 IPWORKS_EXTERNAL int IPWORKS_CALL IPWorks_IMAP_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);
Remarks
This method asks the server to select the mailbox specified in the Mailbox property in read-only mode.
Example (Open a Mailbox in Read/Write Mode)
IMAPControl.Mailbox = "INBOX" IMAPControl.SelectMailbox
Example (Open a Mailbox in Read-Only Mode)
IMAPControl.Mailbox = "INBOX.Folder" IMAPControl.ExamineMailbox
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)