Begins asynchronous Subscribe operation. Subscribes to a specified folder, adding it to a list of active folders that appear in the folder listings with ImapFolderListMode set to Subscribed.

Namespace:  Rebex.Net
Assembly:  Rebex.Imap (in Rebex.Imap.dll)

Syntax

Visual Basic
Public Function BeginSubscribe ( _
	folder As String, _
	callback As AsyncCallback, _
	state As Object _
) As IAsyncResult
C#
public IAsyncResult BeginSubscribe(
	string folder,
	AsyncCallback callback,
	Object state
)

Parameters

folder
Type: System..::..String
Folder to subscribe to.
callback
Type: System..::..AsyncCallback
An optional asynchronous callback to be called when the operation is complete.
state
Type: System..::..Object
A user-provided object that identifies this particular asynchronous operation.

Return Value

An IAsyncResult that references the asynchronous operation.

Remarks

The only difference between those folders that are subscribed and those that aren't is that a call to GetFolderList(String, ImapFolderListMode, Boolean) using the ImapFolderListMode.Subscribed will only return the subscribed (active) folders. This has absolutely NOTHING to do with notifications.

This method represents IMAP SUBSCRIBE command.

In builds for .NET 4.0 and higher, this method is available as an extension method. Add 'using Rebex.Legacy' (C#) or 'Import Rebex.Legacy' (VB.NET) to your code in order to use it.

Version Information

.NET Compact Framework

Supported in: 3.9, 3.5

See Also