4D v13.2

IMAP_SubscribeMB

Home

 
4D v13.2
IMAP_SubscribeMB

IMAP_SubscribeMB 


 

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

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.

 
PROPERTIES 

Product: 4D
Theme: IC IMAP Review Mail
Number: 88880

 
INDEX

Alphabetical list of commands

 
HISTORY 

Created: 4D Internet Commands 6.8.1

 
SEE ALSO 

IMAP_ListMBs