Mailbox Property

Name of the mailbox selected on the server.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
char* GetMailbox();
int SetMailbox(const char* lpszMailbox);

Unicode (Windows)
LPWSTR GetMailbox();
INT SetMailbox(LPCWSTR lpszMailbox);

@property (nonatomic,readwrite,assign,getter=mailbox,setter=setMailbox:) NSString* mailbox;
- (NSString*)mailbox;
- (void)setMailbox:(NSString*)newMailbox;

#define PID_IMAP_MAILBOX 16

IPWORKS_EXTERNAL void* IPWORKS_CALL IPWorks_IMAP_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);
IPWORKS_EXTERNAL int IPWORKS_CALL IPWorks_IMAP_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);

Default Value

"Inbox"

Remarks

This method contains the name of the mailbox selected on the server, and is also used as argument to most methods. Please refer to the class methods for more information.

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

Data Type

String