wodImapServer ActiveX Component - SubscribeFolder Method
      
 

Description

Called when user wants to subscribe the folder.


Return Type

None  


Syntax

object.SubscribeFolder Owner, User, Folder



The SubscribeFolder Method syntax has these parts:

Part Description
object An expression evaluating to an object of type IwodImapNotify.
Owner Required. A wodImapServer object.
User Required. An ImapUser object. Reference to user who is (un)subscribing folder.
Folder Required. An ImapFolder object. Reference to folder that is (un)subscribed.

Remarks

NOTE: This method is called only if you implemented IwodImapNotify interface in your application, and wodImapServer1.Notification property has received reference to instance of your implementation.

As on UNIX systems where much more folders are available than ones that deal with messages, IMAP protocol specification allows clients (and users) to subscribe to certain folders (mailboxes) which they plan to access (and ignore all other folders). To do so, users 'subscribe' to specific folder, so each time they access IMAP account only those folders are listed on the client.

Since information about subscribed folders can be stored on clients side - usually you will not have to worry about subscribed folders. Even more, most probably you will only list folders which are interesting for the user, because, unlike on UNIX systems, all your folders are in fact 'virtual' and do not exist on the system.

If you plan to support different clients for the same user, and want all those clients to automatically receive information on what other client subscribed to, you should also store this information locally, and each time you Add some folder you should immediately set his subscription information.