public class MailQueryBuilder extends Object
Represents the builder of search expression.
Constructor and Description |
---|
MailQueryBuilder()
Initializes a new instance of the
MailQueryBuilder class. |
MailQueryBuilder(Charset defaultEncoding)
Initializes a new instance of the
MailQueryBuilder class. |
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.
|
StringComparisonField |
getMessageId()
Deprecated.
|
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 header or
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.
|
public MailQueryBuilder()
Initializes a new instance of the MailQueryBuilder
class.
public MailQueryBuilder(Charset defaultEncoding)
Initializes a new instance of the MailQueryBuilder
class.
defaultEncoding
- Contains default encoding (charset) for query builder.@Deprecated public StringComparisonField getMessageId()
Gets the field that allows to find messages that contain the specified string in the envelope structure's MessageId field.
Value: TheDateComparisonField
that represents MessageId search field.StringComparisonField
object.public StringComparisonField getTo()
Gets the field that allows to find messages that contain the specified string in the envelope structure's TO field.
Value: TheDateComparisonField
that represents TO search field.StringComparisonField
object.public StringComparisonField getText()
Gets the field that allows to find the messages that contain the specified string in the header or body of the message.
Value: TheDateComparisonField
that represents text header or
body search fields.StringComparisonField
object.public StringComparisonField getBcc()
Gets the field that allows to find messages that contain the specified string in the envelope structure's BCC field.
Value: TheDateComparisonField
that represents BCC search field.StringComparisonField
object.public StringComparisonField getBody()
Gets the field that allows to find messages that contain the specified string in the body of the message.
Value: TheDateComparisonField
that represents body search field.StringComparisonField
object.public StringComparisonField getCc()
Gets the field that allows to find messages that contain the specified string in the envelope structure's CC field.
Value: TheDateComparisonField
that represents cc search field.StringComparisonField
object.public StringComparisonField getFrom()
Gets the field that allows to find messages that contain the specified string in the envelope structure's FROM field.
Value: TheDateComparisonField
that represents from search field.StringComparisonField
object.public StringComparisonField getSubject()
Gets the field that allows to find messages that contain the specified string in the envelope structure's SUBJECT field.
Value: TheDateComparisonField
that represents subject search field.StringComparisonField
object.public Charset getDefaultEncoding()
Gets default encoding (charset) for query builder
Charset
object.public DateComparisonField getInternalDate()
Gets the field that allows to find messages by internal date.
Value: TheDateComparisonField
that represents internal date search field.DateComparisonField
object.public DateComparisonField getSentDate()
Gets the field that allows to find messages by sent date.
Value: TheDateComparisonField
that represents sent date search field.DateComparisonField
object.public MailQuery or(MailQuery query1, MailQuery query2)
Search messages that match either search key. Provides disjunction between two expressions (OR).
query1
- The query1.query2
- The query2.MailQuery
that represents search query
(one searching criterion).public MailQuery getQuery()
Gets the query.
MailQuery
that represents search query.Copyright (c) 2008-2016 Aspose Pty Ltd. All Rights Reserved.