ListMailboxes Method

Lists all mailboxes matching all criteria in the Mailbox property.

Syntax

ANSI (Cross Platform)
int ListMailboxes();

Unicode (Windows)
INT ListMailboxes();
- (void)listMailboxes;
#define MID_IMAP_LISTMAILBOXES 24

IPWORKSEDI_EXTERNAL int IPWORKSEDI_CALL IPWorksEDI_IMAP_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);

Remarks

This method lists all of the mailboxes matching the criteria in the Mailbox property. Matching mailboxes are returned through the MailboxList event.

Example (List All Mailboxes)


IMAPControl.Mailbox = "*"
IMAPControl.ListMailboxes()

Example (List All Mailboxes Inside INBOX)


IMAPControl.Mailbox = "INBOX.*"
IMAPControl.ListMailboxes()

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.)

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks EDI 2020 C++ Edition - Version 20.0 [Build 8203]