jodd.mail

Class EmailFilter

java.lang.Object

jodd.mail.EmailFilter

public class EmailFilter
extends java.lang.Object

EmailFilter helps in building boolean queries of search terms. There are two ways how it can be used, both can be combined.

First way is constructing boolean expression using groups. Just use and(EmailFilter...), or(EmailFilter...) and not(EmailFilter) methods that takes any number of filters that will be joined with chosen boolean operator.

Second way is more fluent. It may not be used to express some complex queries, but for every-day use it would be enough. Use methods and() and or() to define how all next terms will be joined. Method not() marks the one next term to be added as NOT term.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EmailFilter.Operator Comparison operator.

Field Summary

Fields

Modifier and Type	Field and Description
protected jakarta.mail.search.SearchTerm	searchTerm The SearchTerm to be used.

Constructor Summary

Constructors

Constructor and Description
EmailFilter()

Method Summary

Modifier and Type	Method and Description
EmailFilter	and() Changes concatenation mode to AND.
EmailFilter	and(EmailFilter... emailFilters) Defines AND group of filters.
protected void	and(jakarta.mail.search.SearchTerm searchTerm) Sets AndTerm as searchTerm.
EmailFilter	bcc(java.lang.String bccAddress) Defines filter for BCC field.
EmailFilter	cc(java.lang.String ccAddress) Defines filter for CC field.
protected void	concat(jakarta.mail.search.SearchTerm searchTerm) Concatenates last search term with new one.
static EmailFilter	filter() Creates new Email filter.
EmailFilter	flag(jakarta.mail.Flags.Flag flag, boolean value) Defines filter for single flag.
EmailFilter	flags(jakarta.mail.Flags flags, boolean value) Defines filter for many flags at once.
EmailFilter	from(java.lang.String fromAddress) Defines filter for FROM field.
jakarta.mail.search.SearchTerm	getSearchTerm() Returns search term.
EmailFilter	header(java.lang.String headerName, java.lang.String pattern) Defines filter for Header.
EmailFilter	messageId(java.lang.String messageId) Defines filter for message id.
EmailFilter	messageNumber(int messageNumber) Defines filteer for message number.
EmailFilter	not() Marks next condition to be NOT.
EmailFilter	not(EmailFilter emailFilter) Appends single filter as NOT.
EmailFilter	or() Changes concatenation mode to OR.
EmailFilter	or(EmailFilter... emailFilters) Defines OR group of filters.
protected void	or(jakarta.mail.search.SearchTerm searchTerm) Sets OrTerm searchTerm.
EmailFilter	receivedDate(EmailFilter.Operator operator, long milliseconds) Defines filter for received date.
EmailFilter	sentDate(EmailFilter.Operator operator, long milliseconds) Defines filter for sent date.
EmailFilter	size(EmailFilter.Operator comparison, int size) Defines filter for message size.
EmailFilter	subject(java.lang.String subject) Defines filter for SUBJECT field.
EmailFilter	text(java.lang.String pattern) Defines filter on a message body.
EmailFilter	to(java.lang.String toAddress) Defines filter for TO field.

Methods inherited from class java.lang.Object

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

Field Detail

searchTerm

protected jakarta.mail.search.SearchTerm searchTerm

The SearchTerm to be used.

Constructor Detail

EmailFilter

public EmailFilter()

Method Detail

filter

public static EmailFilter filter()

Creates new Email filter.

subject

public EmailFilter subject(java.lang.String subject)

Defines filter for SUBJECT field.

Parameters:

subject - The SUBJECT.

Returns:

this

messageId

public EmailFilter messageId(java.lang.String messageId)

Defines filter for message id.

Parameters:

messageId - The message ID.

Returns:

this

messageNumber

public EmailFilter messageNumber(int messageNumber)

Defines filteer for message number.

Parameters:

messageNumber - The message number.

Returns:

this

from

public EmailFilter from(java.lang.String fromAddress)

Defines filter for FROM field.

Parameters:

fromAddress - The FROM address

Returns:

this

to

public EmailFilter to(java.lang.String toAddress)

Defines filter for TO field.

Parameters:

toAddress - The TO address.

Returns:

this

cc

public EmailFilter cc(java.lang.String ccAddress)

Defines filter for CC field.

Parameters:

ccAddress - CC addreses.

Returns:

this

bcc

public EmailFilter bcc(java.lang.String bccAddress)

Defines filter for BCC field.

Parameters:

bccAddress - BCC address.

Returns:

this

flags

public EmailFilter flags(jakarta.mail.Flags flags,
                         boolean value)

Defines filter for many flags at once.

Parameters:

flags - The Flags to filter on.

value - The flag setting to check for.

Returns:

this

flag

public EmailFilter flag(jakarta.mail.Flags.Flag flag,
                        boolean value)

Defines filter for single flag.

Parameters:

flag - The flag to filter on.

value - The flag setting to check for.

Returns:

this

receivedDate

public EmailFilter receivedDate(EmailFilter.Operator operator,
                                long milliseconds)

Defines filter for received date.

Returns:

this

sentDate

public EmailFilter sentDate(EmailFilter.Operator operator,
                            long milliseconds)

Defines filter for sent date.

Parameters:

operator - EmailFilter.Operator to use.

milliseconds - the milliseconds since January 1, 1970, 00:00:00 GMT.

Returns:

this

text

public EmailFilter text(java.lang.String pattern)

Defines filter on a message body. All parts of the message that are of MIME type "text/*" are searched.

Parameters:

pattern - String pattern use in body.

Returns:

this

header

public EmailFilter header(java.lang.String headerName,
                          java.lang.String pattern)

Defines filter for Header.

Parameters:

headerName - The name of the Header.

pattern - String pattern to use for headerName.

Returns:

this

size

public EmailFilter size(EmailFilter.Operator comparison,
                        int size)

Defines filter for message size.

Parameters:

comparison - EmailFilter.Operator.

size - size of message.

Returns:

this

and

public EmailFilter and()

Changes concatenation mode to AND.

Returns:

this

or

public EmailFilter or()

Changes concatenation mode to OR.

Returns:

this

not

public EmailFilter not()

Marks next condition to be NOT.

Returns:

this

and

public EmailFilter and(EmailFilter... emailFilters)

Defines AND group of filters.

Parameters:

emailFilters - array of EmailFilters to AND.

Returns:

this

or

public EmailFilter or(EmailFilter... emailFilters)

Defines OR group of filters.

Parameters:

emailFilters - array of EmailFilters to OR.

Returns:

this

not

public EmailFilter not(EmailFilter emailFilter)

Appends single filter as NOT.

Parameters:

emailFilter - EmailFilter to append.

Returns:

this

concat

protected void concat(jakarta.mail.search.SearchTerm searchTerm)

Concatenates last search term with new one.

Parameters:

searchTerm - searchTerm SearchTerm concatenate.

See Also:

and(SearchTerm), or(SearchTerm)

and

protected void and(jakarta.mail.search.SearchTerm searchTerm)

Sets AndTerm as searchTerm.

Parameters:

searchTerm - SearchTerm to set as AND.

or

protected void or(jakarta.mail.search.SearchTerm searchTerm)

Sets OrTerm searchTerm.

Parameters:

searchTerm - SearchTerm to set as OR.

getSearchTerm

public jakarta.mail.search.SearchTerm getSearchTerm()

Returns search term.

Returns:

SearchTerm.