ImapClient.ListMessagesAsync

Contents
[ ]

ListMessagesAsync(IConnection, int)

Gets the list of messages in the current folder.

public Task<ImapMessageInfoCollection> ListMessagesAsync(IConnection connection, 
    int maxNumberOfMessages)
ParameterTypeDescription
connectionIConnectionConnection to a server
maxNumberOfMessagesInt32Maximum number of messages.

Return Value

Task object, with delegate for this operation

Exceptions

exceptioncondition
ArgumentOutOfRangeExceptionmaxNumberOfMessages is negative.

See Also


ListMessagesAsync(int)

Gets the list of messages in the current folder.

public Task<ImapMessageInfoCollection> ListMessagesAsync(int maxNumberOfMessages)
ParameterTypeDescription
maxNumberOfMessagesInt32Maximum number of messages.

Return Value

Task object, with delegate for this operation

Exceptions

exceptioncondition
ArgumentOutOfRangeExceptionmaxNumberOfMessages is negative.

See Also


ListMessagesAsync(IConnection, string, long, bool, IEnumerable<string>, CancellationToken)

Gets the list of messages in the specified folder

public Task<ImapMessageInfoCollection> ListMessagesAsync(IConnection connection, string folderName, 
    long modificationSequence, bool retrieveRecursively, IEnumerable<string> messageExtraFields, 
    CancellationToken token)
ParameterTypeDescription
connectionIConnectionConnection to a server
folderNameStringFolder to retrieve messages.
modificationSequenceInt64Modification sequence
retrieveRecursivelyBooleanIndicates, if messages have to be retrieved recursively.
messageExtraFieldsIEnumerable`1List of extra parameters for a message wich will be requested.
tokenCancellationTokenPropagates notification that operations should be canceled.

Return Value

Task object, with delegate for this operation

See Also


ListMessagesAsync(IConnection, CancellationToken)

Gets the list of messages in the current folder

public Task<ImapMessageInfoCollection> ListMessagesAsync(IConnection connection, 
    CancellationToken token)
ParameterTypeDescription
connectionIConnectionConnection to a server
tokenCancellationTokenPropagates notification that operations should be canceled.

Return Value

Task object, with delegate for this operation

See Also


ListMessagesAsync(IConnection, string, CancellationToken)

Gets the list of messages in the specified folder

public Task<ImapMessageInfoCollection> ListMessagesAsync(IConnection connection, string folderName, 
    CancellationToken token)
ParameterTypeDescription
connectionIConnectionConnection to a server
folderNameStringFolder to retrieve messages.
tokenCancellationTokenPropagates notification that operations should be canceled.

Return Value

Task object, with delegate for this operation

See Also


ListMessagesAsync(IConnection, bool, CancellationToken)

Gets the list of messages in the current folder

public Task<ImapMessageInfoCollection> ListMessagesAsync(IConnection connection, 
    bool retrieveRecursively, CancellationToken token)
ParameterTypeDescription
connectionIConnectionConnection to a server
retrieveRecursivelyBooleanIndicates, if messages have to be retrieved recursively.
tokenCancellationTokenPropagates notification that operations should be canceled.

Return Value

Task object, with delegate for this operation

See Also


ListMessagesAsync(IConnection, long, CancellationToken)

Gets the list of messages in the current folder that have a modification sequence bigger than specified value. Please, see more https://tools.ietf.org/html/rfc7162

public Task<ImapMessageInfoCollection> ListMessagesAsync(IConnection connection, 
    long modificationSequence, CancellationToken token)
ParameterTypeDescription
connectionIConnectionConnection to a server
modificationSequenceInt64Modification sequence
tokenCancellationTokenPropagates notification that operations should be canceled.

Return Value

Task object, with delegate for this operation

See Also


ListMessagesAsync(IConnection, string, bool, CancellationToken)

Gets the list of messages in the specified folder

public Task<ImapMessageInfoCollection> ListMessagesAsync(IConnection connection, string folderName, 
    bool retrieveRecursively, CancellationToken token)
ParameterTypeDescription
connectionIConnectionConnection to a server
folderNameStringFolder to retrieve messages.
retrieveRecursivelyBooleanIndicates, if messages have to be retrieved recursively.
tokenCancellationTokenPropagates notification that operations should be canceled.

Return Value

Task object, with delegate for this operation

See Also


ListMessagesAsync(CancellationToken)

Gets the list of messages in the current folder

public Task<ImapMessageInfoCollection> ListMessagesAsync(CancellationToken token)
ParameterTypeDescription
tokenCancellationTokenPropagates notification that operations should be canceled.

Return Value

Task object, with delegate for this operation

See Also


ListMessagesAsync(IEnumerable<string>, CancellationToken)

Gets the list of messages in the current folder

public Task<ImapMessageInfoCollection> ListMessagesAsync(IEnumerable<string> messageExtraFields, 
    CancellationToken token)
ParameterTypeDescription
messageExtraFieldsIEnumerable`1List of extra parameters for a message wich will be requested.
tokenCancellationTokenPropagates notification that operations should be canceled.

Return Value

Task object, with delegate for this operation

See Also


ListMessagesAsync(bool, CancellationToken)

Gets the list of messages in the current folder

public Task<ImapMessageInfoCollection> ListMessagesAsync(bool retrieveRecursively, 
    CancellationToken token)
ParameterTypeDescription
retrieveRecursivelyBooleanIndicates, if messages have to be retrieved recursively.
tokenCancellationTokenPropagates notification that operations should be canceled.

Return Value

Task object, with delegate for this operation

See Also


ListMessagesAsync(string, CancellationToken)

Gets the list of messages in the specified folder

public Task<ImapMessageInfoCollection> ListMessagesAsync(string folderName, CancellationToken token)
ParameterTypeDescription
folderNameStringFolder to retrieve messages.
tokenCancellationTokenPropagates notification that operations should be canceled.

Return Value

Task object, with delegate for this operation

See Also


ListMessagesAsync(string, bool, CancellationToken)

Gets the list of messages in the specified folder

public Task<ImapMessageInfoCollection> ListMessagesAsync(string folderName, 
    bool retrieveRecursively, CancellationToken token)
ParameterTypeDescription
folderNameStringFolder to retrieve messages.
retrieveRecursivelyBooleanIndicates, if messages have to be retrieved recursively.
tokenCancellationTokenPropagates notification that operations should be canceled.

Return Value

Task object, with delegate for this operation

See Also


ListMessagesAsync(string, bool, IEnumerable<string>, CancellationToken)

Gets the list of messages in the specified folder

public Task<ImapMessageInfoCollection> ListMessagesAsync(string folderName, 
    bool retrieveRecursively, IEnumerable<string> messageExtraFields, CancellationToken token)
ParameterTypeDescription
folderNameStringFolder to retrieve messages.
retrieveRecursivelyBooleanIndicates, if messages have to be retrieved recursively.
messageExtraFieldsIEnumerable`1List of extra parameters for a message wich will be requested.
tokenCancellationTokenPropagates notification that operations should be canceled.

Return Value

Task object, with delegate for this operation

See Also


ListMessagesAsync(long, CancellationToken)

Gets the list of messages in the current folder that have a modification sequence bigger than specified value. Please, see more https://tools.ietf.org/html/rfc7162

public Task<ImapMessageInfoCollection> ListMessagesAsync(long modificationSequence, 
    CancellationToken token)
ParameterTypeDescription
modificationSequenceInt64Modification sequence
tokenCancellationTokenPropagates notification that operations should be canceled.

Return Value

Task object, with delegate for this operation

See Also


ListMessagesAsync(IConnection, string, MailQuery, int, CancellationToken)

Gets the list of messages in the current folder.

public Task<ImapMessageInfoCollection> ListMessagesAsync(IConnection connection, string folderName, 
    MailQuery query, int maxNumberOfMessages, CancellationToken token)
ParameterTypeDescription
connectionIConnectionConnection to a server
folderNameStringMessages location
queryMailQueryMailQuery that represents search query.
maxNumberOfMessagesInt32Maximum number of messages.
tokenCancellationTokenPropagates notification that operations should be canceled.

Return Value

Collection of ImapMessageInfo objects.

See Also


ListMessagesAsync(IConnection, MailQuery, CancellationToken)

Gets the list of messages in the current folder.

public Task<ImapMessageInfoCollection> ListMessagesAsync(IConnection connection, MailQuery query, 
    CancellationToken token)
ParameterTypeDescription
connectionIConnectionConnection to a server
queryMailQueryMailQuery that represents search query.
tokenCancellationTokenPropagates notification that operations should be canceled.

Return Value

Collection of ImapMessageInfo objects.

See Also


ListMessagesAsync(IConnection, MailQuery, int, CancellationToken)

Gets the list of messages in the current folder.

public Task<ImapMessageInfoCollection> ListMessagesAsync(IConnection connection, MailQuery query, 
    int maxNumberOfMessages, CancellationToken token)
ParameterTypeDescription
connectionIConnectionConnection to a server
queryMailQueryMailQuery that represents search query.
maxNumberOfMessagesInt32Maximum number of messages.
tokenCancellationTokenPropagates notification that operations should be canceled.

Return Value

Collection of ImapMessageInfo objects.

See Also


ListMessagesAsync(MailQuery, CancellationToken)

Gets the list of messages in the current folder.

public Task<ImapMessageInfoCollection> ListMessagesAsync(MailQuery query, CancellationToken token)
ParameterTypeDescription
queryMailQueryMailQuery that represents search query.
tokenCancellationTokenPropagates notification that operations should be canceled.

Return Value

Collection of ImapMessageInfo objects.

See Also


ListMessagesAsync(string, MailQuery, int, CancellationToken)

Gets the list of messages in the current folder.

public Task<ImapMessageInfoCollection> ListMessagesAsync(string folderName, MailQuery query, 
    int maxNumberOfMessages, CancellationToken token)
ParameterTypeDescription
folderNameStringMessages location
queryMailQueryMailQuery that represents search query.
maxNumberOfMessagesInt32Maximum number of messages.
tokenCancellationTokenPropagates notification that operations should be canceled.

Return Value

Collection of ImapMessageInfo objects.

See Also


ListMessagesAsync(MailQuery, int, CancellationToken)

Gets the list of messages in the current folder.

public Task<ImapMessageInfoCollection> ListMessagesAsync(MailQuery query, int maxNumberOfMessages, 
    CancellationToken token)
ParameterTypeDescription
queryMailQueryMailQuery that represents search query.
maxNumberOfMessagesInt32Maximum number of messages.
tokenCancellationTokenPropagates notification that operations should be canceled.

Return Value

Collection of ImapMessageInfo objects.

See Also


ListMessagesAsync(IConnection, int, CancellationToken)

Gets the list of messages in the current folder.

public Task<ImapMessageInfoCollection> ListMessagesAsync(IConnection connection, 
    int maxNumberOfMessages, CancellationToken token)
ParameterTypeDescription
connectionIConnectionConnection to a server
maxNumberOfMessagesInt32Maximum number of messages.
tokenCancellationTokenPropagates notification that operations should be canceled.

Return Value

Task object, with delegate for this operation

Exceptions

exceptioncondition
ArgumentOutOfRangeExceptionmaxNumberOfMessages is negative.

See Also


ListMessagesAsync(int, CancellationToken)

Gets the list of messages in the current folder.

public Task<ImapMessageInfoCollection> ListMessagesAsync(int maxNumberOfMessages, 
    CancellationToken token)
ParameterTypeDescription
maxNumberOfMessagesInt32Maximum number of messages.
tokenCancellationTokenPropagates notification that operations should be canceled.

Return Value

Task object, with delegate for this operation

Exceptions

exceptioncondition
ArgumentOutOfRangeExceptionmaxNumberOfMessages is negative.

See Also


ListMessagesAsync(IConnection, string, long, bool, IEnumerable<string>)

Gets the list of messages in the specified folder

public Task<ImapMessageInfoCollection> ListMessagesAsync(IConnection connection, string folderName, 
    long modificationSequence, bool retrieveRecursively, IEnumerable<string> messageExtraFields)
ParameterTypeDescription
connectionIConnectionConnection to a server
folderNameStringFolder to retrieve messages.
modificationSequenceInt64Modification sequence
retrieveRecursivelyBooleanIndicates, if messages have to be retrieved recursively.
messageExtraFieldsIEnumerable`1List of extra parameters for a message wich will be requested.

Return Value

Task object, with delegate for this operation

See Also


ListMessagesAsync(IConnection)

Gets the list of messages in the current folder

public Task<ImapMessageInfoCollection> ListMessagesAsync(IConnection connection)
ParameterTypeDescription
connectionIConnectionConnection to a server

Return Value

Task object, with delegate for this operation

See Also


ListMessagesAsync(IConnection, string)

Gets the list of messages in the specified folder

public Task<ImapMessageInfoCollection> ListMessagesAsync(IConnection connection, string folderName)
ParameterTypeDescription
connectionIConnectionConnection to a server
folderNameStringFolder to retrieve messages.

Return Value

Task object, with delegate for this operation

See Also


ListMessagesAsync(IConnection, bool)

Gets the list of messages in the current folder

public Task<ImapMessageInfoCollection> ListMessagesAsync(IConnection connection, 
    bool retrieveRecursively)
ParameterTypeDescription
connectionIConnectionConnection to a server
retrieveRecursivelyBooleanIndicates, if messages have to be retrieved recursively.

Return Value

Task object, with delegate for this operation

See Also


ListMessagesAsync(IConnection, long)

Gets the list of messages in the current folder that have a modification sequence bigger than specified value. Please, see more https://tools.ietf.org/html/rfc7162

public Task<ImapMessageInfoCollection> ListMessagesAsync(IConnection connection, 
    long modificationSequence)
ParameterTypeDescription
connectionIConnectionConnection to a server
modificationSequenceInt64Modification sequence

Return Value

Task object, with delegate for this operation

See Also


ListMessagesAsync(IConnection, string, bool)

Gets the list of messages in the specified folder

public Task<ImapMessageInfoCollection> ListMessagesAsync(IConnection connection, string folderName, 
    bool retrieveRecursively)
ParameterTypeDescription
connectionIConnectionConnection to a server
folderNameStringFolder to retrieve messages.
retrieveRecursivelyBooleanIndicates, if messages have to be retrieved recursively.

Return Value

Task object, with delegate for this operation

See Also


ListMessagesAsync()

Gets the list of messages in the current folder

public Task<ImapMessageInfoCollection> ListMessagesAsync()

Return Value

Task object, with delegate for this operation

See Also


ListMessagesAsync(IEnumerable<string>)

Gets the list of messages in the current folder

public Task<ImapMessageInfoCollection> ListMessagesAsync(IEnumerable<string> messageExtraFields)
ParameterTypeDescription
messageExtraFieldsIEnumerable`1List of extra parameters for a message wich will be requested.

Return Value

Task object, with delegate for this operation

See Also


ListMessagesAsync(bool)

Gets the list of messages in the current folder

public Task<ImapMessageInfoCollection> ListMessagesAsync(bool retrieveRecursively)
ParameterTypeDescription
retrieveRecursivelyBooleanIndicates, if messages have to be retrieved recursively.

Return Value

Task object, with delegate for this operation

See Also


ListMessagesAsync(string)

Gets the list of messages in the specified folder

public Task<ImapMessageInfoCollection> ListMessagesAsync(string folderName)
ParameterTypeDescription
folderNameStringFolder to retrieve messages.

Return Value

Task object, with delegate for this operation

See Also


ListMessagesAsync(string, bool)

Gets the list of messages in the specified folder

public Task<ImapMessageInfoCollection> ListMessagesAsync(string folderName, 
    bool retrieveRecursively)
ParameterTypeDescription
folderNameStringFolder to retrieve messages.
retrieveRecursivelyBooleanIndicates, if messages have to be retrieved recursively.

Return Value

Task object, with delegate for this operation

See Also


ListMessagesAsync(string, bool, IEnumerable<string>)

Gets the list of messages in the specified folder

public Task<ImapMessageInfoCollection> ListMessagesAsync(string folderName, 
    bool retrieveRecursively, IEnumerable<string> messageExtraFields)
ParameterTypeDescription
folderNameStringFolder to retrieve messages.
retrieveRecursivelyBooleanIndicates, if messages have to be retrieved recursively.
messageExtraFieldsIEnumerable`1List of extra parameters for a message wich will be requested.

Return Value

Task object, with delegate for this operation

See Also


ListMessagesAsync(long)

Gets the list of messages in the current folder that have a modification sequence bigger than specified value. Please, see more https://tools.ietf.org/html/rfc7162

public Task<ImapMessageInfoCollection> ListMessagesAsync(long modificationSequence)
ParameterTypeDescription
modificationSequenceInt64Modification sequence

Return Value

Task object, with delegate for this operation

See Also


ListMessagesAsync(IConnection, string, MailQuery, int)

Gets the list of messages in the current folder.

public Task<ImapMessageInfoCollection> ListMessagesAsync(IConnection connection, string folderName, 
    MailQuery query, int maxNumberOfMessages)
ParameterTypeDescription
connectionIConnectionConnection to a server
folderNameStringMessages location
queryMailQueryMailQuery that represents search query.
maxNumberOfMessagesInt32Maximum number of messages.

Return Value

Collection of ImapMessageInfo objects.

See Also


ListMessagesAsync(IConnection, MailQuery)

Gets the list of messages in the current folder.

public Task<ImapMessageInfoCollection> ListMessagesAsync(IConnection connection, MailQuery query)
ParameterTypeDescription
connectionIConnectionConnection to a server
queryMailQueryMailQuery that represents search query.

Return Value

Collection of ImapMessageInfo objects.

See Also


ListMessagesAsync(IConnection, MailQuery, int)

Gets the list of messages in the current folder.

public Task<ImapMessageInfoCollection> ListMessagesAsync(IConnection connection, MailQuery query, 
    int maxNumberOfMessages)
ParameterTypeDescription
connectionIConnectionConnection to a server
queryMailQueryMailQuery that represents search query.
maxNumberOfMessagesInt32Maximum number of messages.

Return Value

Collection of ImapMessageInfo objects.

See Also


ListMessagesAsync(MailQuery)

Gets the list of messages in the current folder.

public Task<ImapMessageInfoCollection> ListMessagesAsync(MailQuery query)
ParameterTypeDescription
queryMailQueryMailQuery that represents search query.

Return Value

Collection of ImapMessageInfo objects.

See Also


ListMessagesAsync(string, MailQuery, int)

Gets the list of messages in the current folder.

public Task<ImapMessageInfoCollection> ListMessagesAsync(string folderName, MailQuery query, 
    int maxNumberOfMessages)
ParameterTypeDescription
folderNameStringMessages location
queryMailQueryMailQuery that represents search query.
maxNumberOfMessagesInt32Maximum number of messages.

Return Value

Collection of ImapMessageInfo objects.

See Also


ListMessagesAsync(MailQuery, int)

Gets the list of messages in the current folder.

public Task<ImapMessageInfoCollection> ListMessagesAsync(MailQuery query, int maxNumberOfMessages)
ParameterTypeDescription
queryMailQueryMailQuery that represents search query.
maxNumberOfMessagesInt32Maximum number of messages.

Return Value

Collection of ImapMessageInfo objects.

See Also