com.aspose.email

Class MailQueryBuilder

java.lang.Object

com.aspose.email.MailQueryBuilder

Direct Known Subclasses:

ContactQueryBuilder, ExchangeAdvancedSyntaxQueryBuilder, ExchangeQueryBuilder, GraphQueryBuilder, ImapQueryBuilder, PersonalStorageQueryBuilder

public class MailQueryBuilder
extends Object

Represents the builder of search expression.

Note: By default, the result is the intersection (AND function) of all the messages that match those keys. To join keys by OR function, please, use Or() method of this class

Constructor Summary

Constructors

Constructor and Description
MailQueryBuilder() Initializes a new instance of the MailQueryBuilder class.
MailQueryBuilder(Charset defaultEncoding) Initializes a new instance of the MailQueryBuilder class.

Method Summary

Methods

Modifier and Type	Method and Description
StringComparisonField	getBcc() Gets the field that allows to find messages that contain the specified string in the envelope structure's BCC field.
StringComparisonField	getBody() Gets the field that allows to find messages that contain the specified string in the body of the message.
StringComparisonField	getCc() Gets the field that allows to find messages that contain the specified string in the envelope structure's CC field.
Charset	getDefaultEncoding() Gets default encoding (charset) for query builder
StringComparisonField	getFrom() Gets the field that allows to find messages that contain the specified string in the envelope structure's FROM field.
DateComparisonField	getInternalDate() Gets the field that allows to find messages by internal date.
MailQuery	getQuery() Gets the query.
DateComparisonField	getSentDate() Gets the field that allows to find messages by sent date.
StringComparisonField	getSubject() Gets the field that allows to find messages that contain the specified string in the envelope structure's SUBJECT field.
StringComparisonField	getText() Gets the field that allows to find the messages that contain the specified string in the headers (subject, from, to, cc) and body of the message.
StringComparisonField	getTo() Gets the field that allows to find messages that contain the specified string in the envelope structure's TO field.
MailQuery	or(MailQuery query1, MailQuery query2) Search messages that match either search key.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MailQueryBuilder

public MailQueryBuilder()

Initializes a new instance of the MailQueryBuilder class.

MailQueryBuilder

public MailQueryBuilder(Charset defaultEncoding)

Initializes a new instance of the MailQueryBuilder class.

Parameters:

defaultEncoding - Contains default encoding (charset) for query builder.

Method Detail

getTo

public final StringComparisonField getTo()

Gets the field that allows to find messages that contain the specified string in the envelope structure's TO field.

Value: The DateComparisonField that represents TO search field.

getText

public final StringComparisonField getText()

Gets the field that allows to find the messages that contain the specified string in the headers (subject, from, to, cc) and body of the message.

Value: The DateComparisonField that represents text header or body search fields.

getBcc

public final StringComparisonField getBcc()

Gets the field that allows to find messages that contain the specified string in the envelope structure's BCC field.

Value: The DateComparisonField that represents BCC search field.

getBody

public final StringComparisonField getBody()

Gets the field that allows to find messages that contain the specified string in the body of the message.

Value: The DateComparisonField that represents body search field.

getCc

public final StringComparisonField getCc()

Gets the field that allows to find messages that contain the specified string in the envelope structure's CC field.

Value: The DateComparisonField that represents cc search field.

getFrom

public final StringComparisonField getFrom()

Gets the field that allows to find messages that contain the specified string in the envelope structure's FROM field.

Value: The DateComparisonField that represents from search field.

getSubject

public final StringComparisonField getSubject()

Gets the field that allows to find messages that contain the specified string in the envelope structure's SUBJECT field.

Value: The DateComparisonField that represents subject search field.

getDefaultEncoding

public final Charset getDefaultEncoding()

Gets default encoding (charset) for query builder

getInternalDate

public final DateComparisonField getInternalDate()

Gets the field that allows to find messages by internal date.

Value: The DateComparisonField that represents internal date search field.

getSentDate

public final DateComparisonField getSentDate()

Gets the field that allows to find messages by sent date.

Value: The DateComparisonField that represents sent date search field.

or

public MailQuery or(MailQuery query1,
           MailQuery query2)

Search messages that match either search key. Provides disjunction between two expressions (OR).

Parameters:

query1 - The query1.

query2 - The query2.

Returns:

MailQuery that represents search query (one searching criterion).

getQuery

public MailQuery getQuery()

Gets the query.

Returns:

MailQuery that represents search query.