IMAP_SubscribeMB

Home

4D v19

IMAP_SubscribeMB


IMAP_SubscribeMB ( imap_ID ; mbName ; mbSubscribe ) -> Function result

Parameter	Type	Description
imap_ID	Longint	Reference to an IMAP login
mbName	Text	Name of the mailbox to subscribe or unsubscribe
mbSubscribe	Integer	0 = Do not subscribe; 1= Subscribe
Function result	Integer	Error code

Description

The IMAP_SubscribeMB command allows adding or removing of the specified mailbox name to/from the IMAP server’s set of “subscribed” user mailboxes.

As such, the user can choose to narrow down a large list of available mailboxes by subscribing to those that he usually wants to see. To do this, he simply has to use the IMAP_ListMBs command with the subscribedMB optional parameter set to 1 (see IMAP_ListMBs).

imap_ID is a long integer reference to an open connection created with IMAP_Login.

mbName is the full name of the mailbox to be subscribed or unsubscribed.

Pass 0 in mbSubscribe to not subscribe to the mailbox; pass 1 to subscribe.