A way to specify certain criteria for searching mail. Each instance of SearchMailRequestClause can specify different types of mail to identify. Each SearchMailRequestClause will result in a corresponding SearchMailResponseClause More...

Public Attributes
string	name
	The name of the clause must be unique, and should describe the filter this particular clause performs. When the mail request clause is processed, it will produce a SearchMailResponseClause. The resulting SearchMailResponseClause.name field will match the value of this name field.

bool	onlyCount
	When true, the SearchMailResponseClause will only count the number of mail objects that met the SearchMailRequestClause, and the actual SearchMailResponseClause.content field will be empty.

string[]	categories
	The categories of mail to include in this filter clause. A category can be any string.

string[]	states
	The various states of mail to include in this filter clause. Valid states include, "Unread", "Read", and "Deleted"

long?	forSender
	An optional player id that selects mail coming from the specific player.

long?	limit
	An optional maximum number of MailMessage to accept in the resulting SearchMailResponseClause.content list. This will also max out the SearchMailResponseClause.count field. This can be used with the start field to page the player's mail.

long?	start
	An optional offset into the players mail. This can be used with the limit field to page the player's mail.

Detailed Description

A way to specify certain criteria for searching mail. Each instance of SearchMailRequestClause can specify different types of mail to identify. Each SearchMailRequestClause will result in a corresponding SearchMailResponseClause

The documentation for this class was generated from the following file:

Public Member Functions