OrderBy Class

Specifies a sort order for search results.

Inheritance Hierarchy

Namespace: MailKit.Search
Assembly: MailKit (in MailKit.dll) Version: 4.10.0

Syntax

public class OrderBy

The OrderBy type exposes the following members.

Constructors

	Name	Description
	OrderBy	Initializes a new instance of the OrderBy class.

Properties

	Name	Description
	Order	Gets the sort order.
	Type	Gets the field used for sorting.

Methods

Fields

	Name	Description
	Arrival	Sort results by arrival date in ascending order.
	Cc	Sort results by the first email address in the Cc header in ascending order.
	Date	Sort results by the sent date in ascending order.
	DisplayFrom	Sort results by the first display name in the From header in ascending order.
	DisplayTo	Sort results by the first display name in the To header in ascending order.
	From	Sort results by the first email address in the From header in ascending order.
	ReverseArrival	Sort results by arrival date in descending order.
	ReverseCc	Sort results by the first email address in the Cc header in descending order.
	ReverseDate	Sort results by the sent date in descending order.
	ReverseDisplayFrom	Sort results by the first display name in the From header in descending order.
	ReverseDisplayTo	Sort results by the first display name in the To header in descending order.
	ReverseFrom	Sort results by the first email address in the From header in descending order.
	ReverseSize	Sort results by the message size in descending order.
	ReverseSubject	Sort results by the Subject header in descending order.
	ReverseTo	Sort results by the first email address in the To header in descending order.
	Size	Sort results by the message size in ascending order.
	Subject	Sort results by the Subject header in ascending order.
	To	Sort results by the first email address in the To header in ascending order.

Remarks

You can combine multiple OrderBy rules to specify the sort order that Sort(SearchQuery, IListOrderBy, CancellationToken) should return the results in.