Enum Class SearchKey
- All Implemented Interfaces:
Serializable
,Comparable<SearchKey>
,Constable
SearchKey as defined in "RFC3501" section "6.4.4. SEARCH Command"
Read more: http://www.faqs.org/rfcs/rfc3501.html
TODO: Add search keys that are missing
ALL All messages in the mailbox; the default initial key for ANDing
ANSWERED Messages with the \Answered flag set.
BCC Messages that contain the specified string in the envelope structure's BCC field.
TODO: BEFORE Messages whose internal date (disregarding time and timezone) is earlier than the specified date.
TODO: BODY Messages that contain the specified string in the body of the message.
CC Messages that contain the specified string in the envelope structure's CC field.
DELETED Messages with the \Deleted flag set.
DRAFT Messages with the \Draft flag set.
FLAGGED Messages with the \Flagged flag set.
FROM Messages that contain the specified string in the envelope structure's FROM field.
HEADER <field-name> Messages that have a header with the specified field-name (as defined in [RFC-2822]) and
that contains the specified string in the text of the header (what comes after the colon). If the string to search is
zero-length, this matches all messages that have a header line with the specified field-name regardless of the contents.
KEYWORD Messages with the specified keyword flag set.
TODO: LARGER Messages with an [RFC-2822] size larger than the specified number of octets.
NEW Messages that have the \Recent flag set but not the \Seen flag. This is functionally equivalent to "(RECENT
UNSEEN)".
TODO: NOT <search-key> Messages that do not match the specified search key.
OLD Messages that do not have the \Recent flag set. This is functionally equivalent to "NOT RECENT" (as opposed to
"NOT NEW").
TODO: ON Messages whose internal date (disregarding time and timezone) is within the specified date.
TODO: OR <search-key1> <search-key2> Messages that match either search key.
RECENT Messages that have the \Recent flag set.
SEEN Messages that have the \Seen flag set.
TODO: SENTBEFORE Messages whose [RFC-2822] Date: header (disregarding time and timezone) is earlier than the specified date.
TODO: SENTON Messages whose [RFC-2822] Date: header (disregarding time and timezone) is within the specified date.
TODO: SENTSINCE Messages whose [RFC-2822] Date: header (disregarding time and timezone) is within or later than the specified date.
TODO: SINCE Messages whose internal date (disregarding time and timezone) is within or later than the specified date.
TODO: SMALLER Messages with an [RFC-2822] size smaller than the specified number of octets.
TODO: SUBJECT Messages that contain the specified string in the envelope structure's SUBJECT field.
TODO: TEXT Messages that contain the specified string in the header or body of the message.
TO Messages that contain the specified string in the envelope structure's TO field.
TODO: UID Messages with unique identifiers corresponding to the specified unique identifier set. Sequence set ranges are permitted.
UNANSWERED Messages that do not have the \Answered flag set.
UNDELETED Messages that do not have the \Deleted flag set.
UNDRAFT Messages that do not have the \Draft flag set.
UNFLAGGED Messages that do not have the \Flagged flag set.
UNKEYWORD Messages that do not have the specified keyword flag set.
UNSEEN Messages that do not have the \Seen flag set.
- Since:
- 12.01.2010
- Author:
- Torsten Buchert
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum Constants -
Method Summary
-
Enum Constant Details
-
ALL
-
ANSWERED
-
BCC
-
CC
-
DELETED
-
DRAFT
-
FLAGGED
-
FROM
-
HEADER
-
KEYWORD
-
NEW
-
OLD
-
RECENT
-
SEEN
-
TO
-
UNANSWERED
-
UNDELETED
-
UNDRAFT
-
UNFLAGGED
-
UNKEYWORD
-
UNSEEN
-
BEFORE
-
BODY
-
LARGER
-
NOT
-
ON
-
OR
-
SENTBEFORE
-
SENTON
-
SENTSINCE
-
SINCE
-
SMALLER
-
SUBJECT
-
TEXT
-
UID
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum class has no constant with the specified nameNullPointerException
- if the argument is null
-
getNumberOfParameters
public int getNumberOfParameters() -
isParameterExpression
public boolean isParameterExpression()
-