TElIMAPClient.LSub method

TElIMAPClient.LSub

Returns the list of newsgroups available on the server.

Declaration

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

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

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

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

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

[Java]
void lSub(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 newsgroup names returned by the server.

Description

Use this method to retrieve the list of newsgroups from the server. Essentially, the LSUB response returns the list of names that are marked as 'active' or 'subscribed' by the user.