TElIMAPClient.List method

TElIMAPClient.List

Retrieves the list of folders (mailboxes) available to the account.

Declaration

[C#]
void List(string RefName, string MailBox, TElIMAPMailBoxesList List);

[VB.NET]
Sub List(ByVal RefName As String, ByVal MailBox As String, ByVal List As TElIMAPMailBoxesList)

[Pascal]
procedure List(RefName : TWideString; MailBox : TWideString; List : TElIMAPMailBoxesList);

[C++]
    void List(const sb_u16string &RefName, const sb_u16string &MailBox, TElIMAPMailBoxesList &List);
    void List(const sb_u16string &RefName, const sb_u16string &MailBox, TElIMAPMailBoxesList *List);
    void List(const std::wstring &RefName, const std::wstring &MailBox, TElIMAPMailBoxesList &List);
    void List(const std::wstring &RefName, const std::wstring &MailBox, TElIMAPMailBoxesList *List);

[PHP]
void List(string $RefName, string $MailBox, TElIMAPMailBoxesList $List)

[Java]
void list(String RefName, String MailBox, TElIMAPMailBoxesList List);

Parameters

RefName - specifies the reference name, i.e., the starting point in the hierarchy to be retrieved. It can be empty or contain the hierarchy delimiter (such as slash '/') depending on server requirements.
MailBox - desired mailbox name (with possible wildcards). To retrieve the list of folders in one level, pass "%"; to recursively retrieve the list of folders, use "*".
List - the list of mailboxes returned by the server.

Description

Use this property to obtain the list of folders (mailboxes) available to the user.