SearchKey (== GreenMail Core == 1.4.0 API)

java.lang.Object
- java.lang.Enum<SearchKey>
- - com.icegreen.greenmail.imap.commands.SearchKey

All Implemented Interfaces:

Serializable, Comparable<SearchKey>
```
public enum SearchKey
extends Enum<SearchKey>
```
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 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 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 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

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ALL`
`ANSWERED`
`BCC`
`CC`
`DELETED`
`DRAFT`
`FLAGGED`
`FROM`
`HEADER`
`KEYWORD`
`NEW`
`OLD`
`RECENT`
`SEEN`
`TO`
`UNANSWERED`
`UNDELETED`
`UNDRAFT`
`UNFLAGGED`
`UNKEYWORD`
`UNSEEN`

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`getNumberOfParameters()`
`static SearchKey`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static SearchKey[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ALL
```
public static final SearchKey ALL
```

ANSWERED
```
public static final SearchKey ANSWERED
```

BCC
```
public static final SearchKey BCC
```

CC
```
public static final SearchKey CC
```

DELETED
```
public static final SearchKey DELETED
```

DRAFT
```
public static final SearchKey DRAFT
```

FLAGGED
```
public static final SearchKey FLAGGED
```

FROM
```
public static final SearchKey FROM
```

HEADER
```
public static final SearchKey HEADER
```

KEYWORD
```
public static final SearchKey KEYWORD
```

NEW
```
public static final SearchKey NEW
```

OLD
```
public static final SearchKey OLD
```

RECENT
```
public static final SearchKey RECENT
```

SEEN
```
public static final SearchKey SEEN
```

TO
```
public static final SearchKey TO
```

UNANSWERED

public static final SearchKey UNANSWERED

UNDELETED

public static final SearchKey UNDELETED

UNDRAFT
```
public static final SearchKey UNDRAFT
```

UNFLAGGED

public static final SearchKey UNFLAGGED

UNKEYWORD

public static final SearchKey UNKEYWORD

UNSEEN
```
public static final SearchKey UNSEEN
```

Method Detail
- values
```
public static SearchKey[] values()
```
  Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (SearchKey c : SearchKey.values())
    System.out.println(c);
```
  Returns:
  an array containing the constants of this enum type, in the order they are declared
- valueOf
```
public static SearchKey valueOf(String name)
```
  Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name
  
  NullPointerException - if the argument is null
- getNumberOfParameters
```
public int getNumberOfParameters()
```

Enum SearchKey

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

ALL

ANSWERED

BCC

CC

DELETED

DRAFT

FLAGGED

FROM

HEADER

KEYWORD

NEW

OLD

RECENT

SEEN

TO

UNANSWERED

UNDELETED

UNDRAFT

UNFLAGGED

UNKEYWORD

UNSEEN

Method Detail

values

valueOf

getNumberOfParameters