Represents the search criteria, that are used to match several message properties in the mailbox. More...
Inherits IEquatable< System::SharedPtr< Aspose::Email::Tools::Search::MailQuery > >.
Inherited by Aspose::Email::Clients::Exchange::ExchangeAdvancedSyntaxMailQuery.
Public Member Functions | |
virtual System::String | get_QueryString () |
The query string. More... | |
virtual void | set_QueryString (System::String value) |
The query string. More... | |
System::String | get_OrderByString () const |
The sort query string. More... | |
virtual System::SharedPtr< System::Collections::Generic::Dictionary< System::String, System::SharedPtr< System::Object > > > | get_Options () |
The query options. More... | |
virtual void | set_Options (System::SharedPtr< System::Collections::Generic::Dictionary< System::String, System::SharedPtr< System::Object >>> value) |
The query options. More... | |
MailQuery (System::String queryString) | |
Initializes a new instance of the MailQuery class. More... | |
MailQuery (System::String queryString, System::String orderByString) | |
Initializes a new instance of the MailQuery class. More... | |
MailQuery () | |
Initializes a new instance of the MailQuery class. More... | |
MailQuery (System::String queryString, bool validate) | |
Initializes a new instance of the MailQuery class. More... | |
MailQuery (System::String queryString, System::String orderByString, bool validate) | |
Initializes a new instance of the MailQuery class. More... | |
MailQuery (System::String queryString, System::String orderByString, System::SharedPtr< System::Collections::Generic::Dictionary< System::String, System::SharedPtr< System::Object >>> options, bool validate) | |
MailQuery (System::String fieldName, System::String value, System::String comparsionOperator) | |
Initializes a new instance of the MailQuery class. More... | |
MailQuery (System::String fieldName, System::String value, System::String comparsionOperator, System::String parameters) | |
Initializes a new instance of the MailQuery class. More... | |
System::SharedPtr< System::Xml::Schema::XmlSchema > | GetSchema () |
This method is reserved and should not be used. When implementing the IXmlSerializable interface, you should return null (Nothing in Visual Basic) from this method, and instead, if specifying a custom schema is required, apply the T:System::Xml::Serialization::XmlSchemaProviderAttribute to the class. More... | |
virtual void | ReadXml (System::SharedPtr< System::Xml::XmlReader > reader) |
Generates an object from its XML representation. More... | |
virtual void | WriteXml (System::SharedPtr< System::Xml::XmlWriter > writer) |
Converts an object into its XML representation. More... | |
virtual void | WriteOrderByXml (System::SharedPtr< System::Xml::XmlWriter > writer) |
Converts an object into its XML representation. More... | |
bool | Equals (System::SharedPtr< MailQuery > other) override |
Indicates whether the current object is equal to another object of the same type. More... | |
int32_t | GetHashCode () const override |
Returns a hash code for this instance. More... | |
bool | Equals (System::SharedPtr< System::Object > obj) override |
Determines whether the specified System::Object, is equal to this instance. More... | |
System::String | ToString () const override |
Returns a System::String that represents this instance. More... | |
Static Public Member Functions | |
static bool | ValidateExpression (System::String expression) |
Validates the expression. More... | |
static System::String | NormalizeExpression (System::String expression) |
Normalizes the expression. More... | |
Protected Member Functions | |
virtual | ~MailQuery () |
Represents the search criteria, that are used to match several message properties in the mailbox.
Aspose::Email::Tools::Search::MailQuery::MailQuery | ( | System::String | queryString | ) |
Initializes a new instance of the MailQuery class.
The query string should have the following view.
The example of a simple expression:
'<Field name>' <Comparison operator> '<Field value>',
where <Field Name> - the name of a message field through which filtering is made, <Comparison operator> - comparison operators, as their name implies, allow to compare message field and specified value, <Field value> - value to be compared with a message field.
The number of simple expressions can make a compound one, ex.: (<Simple expression 1> & <Simple expression 2>) | <Simple expression 3>,
where "&" - logical-AND operator, "|" - logical-OR operator
At present the following values are allowed as a field name (<Field name>):
"To" - represents a TO field of message, "Text" - represents string in the header or body of the message, "Bcc" - represents a BCC field of message, "Body" - represents a string in the body of message, "Cc" - represents a CC field of message, "From" - represents a From field of message, "Subject" - represents a string in the subject of message, "InternalDate" - represents an internal date of message, "SentDate" - represents a sent date of message
Additionally, the following field names are allowed for IMAP-protocol:
"Answered" - represents an /Answered flag of message "Seen" - represents a /Seen flag of message "Flagged" - represents a /Flagged flag of message "Draft" - represents a /Draft flag of message "Deleted" - represents a Deleted/ flag of message "Recent" - represents a Deleted/ flag of message "MessageSize" - represents a size (in bytes) of message
Additionally, the following field names are allowed for Exchange:
"IsRead" - Indicates whether the message has been read "HasAttachment" - Indicates whether or not the message has attachments "IsSubmitted" - Indicates whether the message has been submitted to the Outbox "ContentClass" - represents a content class of item
Additionally, the following field names are allowed for pst/ost files:
"MessageClass" - Represents a message class "ContainerClass" - Represents a folder container class "Importance" - Represents a message importance "MessageSize" - represents a size (in bytes) of message "FolderName" - represents a folder name "ContentsCount" - represents a total number of items in the folder "UnreadContentsCount" - represents the number of unread items in the folder. "Subfolders" - Indicates whether or not the folder has subfolders "Read" - the message is marked as having been read "HasAttachment" - the message has at least one attachment "Unsent" - the message is still being composed "Unmodified" - the message has not been modified since it was first saved (if unsent) or it was delivered (if sent) "FromMe" - the user receiving the message was also the user who sent the message "Resend" - the message includes a request for a resend operation with a non-delivery report "NotifyRead" - the user who sent the message has requested notification when a recipient first reads it "NotifyUnread" - the user who sent the message has requested notification when a recipient deletes it before reading or the Message object expires "EverRead" - the message has been read at least once
The field value (<Field value>) can take the following values: For text fields - any string, For date type fields - the string of "d-MMM-yyy" format, ex. "10-Feb-2009", For flags (fields of boolean type) - either "True", or "False"
queryString | The query string. |
Aspose::Email::Tools::Search::MailQuery::MailQuery | ( | System::String | queryString, |
System::String | orderByString | ||
) |
Initializes a new instance of the MailQuery class.
The sort query string should have the following view.
The example of a simple expression:
'<Field name>' OrderBy ['ASC'|'DESC'],
where <Field Name> - the name of a message field through which sorting is made, ['ASC'|'DESC'] - sorting operators, allow to sort Ascending or Descending,
The number of simple expressions can make a compound one, ex.: (<Simple expression 1> & <Simple expression 2>),
Aspose::Email::Tools::Search::MailQuery::MailQuery | ( | ) |
Initializes a new instance of the MailQuery class.
Aspose::Email::Tools::Search::MailQuery::MailQuery | ( | System::String | queryString, |
bool | validate | ||
) |
Initializes a new instance of the MailQuery class.
queryString | The query string. |
validate | If true, then query string must be validate. |
Aspose::Email::Tools::Search::MailQuery::MailQuery | ( | System::String | queryString, |
System::String | orderByString, | ||
bool | validate | ||
) |
Initializes a new instance of the MailQuery class.
queryString | The query string. |
orderByString | The sort query string. |
validate | If true, then query string must be validate. |
Aspose::Email::Tools::Search::MailQuery::MailQuery | ( | System::String | queryString, |
System::String | orderByString, | ||
System::SharedPtr< System::Collections::Generic::Dictionary< System::String, System::SharedPtr< System::Object >>> | options, | ||
bool | validate | ||
) |
Aspose::Email::Tools::Search::MailQuery::MailQuery | ( | System::String | fieldName, |
System::String | value, | ||
System::String | comparsionOperator | ||
) |
Initializes a new instance of the MailQuery class.
fieldName | Name of the field. |
value | The value. |
comparsionOperator | The comparsion operator. |
Aspose::Email::Tools::Search::MailQuery::MailQuery | ( | System::String | fieldName, |
System::String | value, | ||
System::String | comparsionOperator, | ||
System::String | parameters | ||
) |
Initializes a new instance of the MailQuery class.
fieldName | Name of the field. |
value | The value. |
comparsionOperator | The comparsion operator. |
parameters | Parameters. |
|
protectedvirtual |
|
override |
Indicates whether the current object is equal to another object of the same type.
other | An object to compare with this object. |
|
override |
Determines whether the specified System::Object, is equal to this instance.
obj | The System::Object to compare with this instance. |
true
if the specified System::Object is equal to this instance; otherwise, false
.
|
virtual |
The query options.
System::String Aspose::Email::Tools::Search::MailQuery::get_OrderByString | ( | ) | const |
The sort query string.
|
virtual |
The query string.
Reimplemented in Aspose::Email::Clients::Exchange::ExchangeAdvancedSyntaxMailQuery.
|
override |
Returns a hash code for this instance.
System::SharedPtr<System::Xml::Schema::XmlSchema> Aspose::Email::Tools::Search::MailQuery::GetSchema | ( | ) |
This method is reserved and should not be used. When implementing the IXmlSerializable interface, you should return null (Nothing in Visual Basic) from this method, and instead, if specifying a custom schema is required, apply the T:System::Xml::Serialization::XmlSchemaProviderAttribute to the class.
|
static |
Normalizes the expression.
expression | The expression. |
|
virtual |
Generates an object from its XML representation.
reader | The T:System::Xml::XmlReader stream from which the object is deserialized. |
Reimplemented in Aspose::Email::Clients::Exchange::ExchangeAdvancedSyntaxMailQuery.
|
virtual |
The query options.
|
virtual |
The query string.
Reimplemented in Aspose::Email::Clients::Exchange::ExchangeAdvancedSyntaxMailQuery.
|
override |
Returns a System::String that represents this instance.
|
static |
Validates the expression.
expression | The expression. |
|
virtual |
Converts an object into its XML representation.
writer | The T:System::Xml::XmlWriter stream to which the object is serialized. |
|
virtual |
Converts an object into its XML representation.
writer | The T:System::Xml::XmlWriter stream to which the object is serialized. |
Reimplemented in Aspose::Email::Clients::Exchange::ExchangeAdvancedSyntaxMailQuery.
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |