GetSubscribedFolders Method (filter)

Get user subscribed folders list.

Declaration Syntax

Visual Basic

Visual C++

public IMAP_r_u_LSub[] GetSubscribedFolders(
	string filter
)

Public Function GetSubscribedFolders ( 
	filter As String
) As IMAP_r_u_LSub()

public:
array<IMAP_r_u_LSub^>^ GetSubscribedFolders(
	String^ filter
)

member GetSubscribedFolders : 
        filter : string -> IMAP_r_u_LSub[]

Parameters

filter (String): Folders filter. If this value is null, all folders are returned.

Return Value

array<IMAP_r_u_LSub>[]()[][]
Returns subscribed folders list.

Remarks

The character "*" is a wildcard, and matches zero or more characters at this position. The character "%" is similar to "*", but it does not match a hierarchy delimiter. If the "%" wildcard is the last character of a mailbox name argument, matching levels of hierarchy are also returned.

Exceptions

Exception	Condition
ObjectDisposedException	Is raised when this object is disposed and and this method is accessed.
InvalidOperationException	Is raised when IMAP client is not in valid state. For example 'not connected'.
IMAP_ClientException	Is raised when server refuses to complete this command and returns error.

Assembly: LumiSoft.Net (Module: LumiSoft.Net.dll) Version: 4.5.5510.19119