Package org.apache.commons.net.imap

Enum IMAPClient.SEARCH_CRITERIA

java.lang.Object
java.lang.Enum<IMAPClient.SEARCH_CRITERIA>
org.apache.commons.net.imap.IMAPClient.SEARCH_CRITERIA
All Implemented Interfaces:
Serializable, Comparable<IMAPClient.SEARCH_CRITERIA>
Enclosing class:
IMAPClient
public static enum IMAPClient.SEARCH_CRITERIA extends Enum<IMAPClient.SEARCH_CRITERIA>
The search criteria defined in RFC 3501.

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    ALL
    All messages in the mailbox.
    ANSWERED
    Messages with the \Answered flag set.
    BCC
    Messages that contain the specified string in the envelope structure's BCC field.
    BEFORE
    Messages whose internal date (disregarding time and time zone) is earlier than the specified date.
    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).
    KEYWORD
    Messages with the specified keyword flag set.
    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.
    NOT
    Messages that do not match the specified search key.
    OLD
    Messages that do not have the \Recent flag set.
    ON
    Messages whose internal date (disregarding time and time zone) is within the specified date.
    OR
    Messages that match either search key.
    RECENT
    Messages that have the \Recent flag set.
    SEEN
    Messages that have the \Seen flag set.
    SENTBEFORE
    Messages whose [RFC-2822] Date: header (disregarding time and time zone) is earlier than the specified date.
    SENTON
    Messages whose [RFC-2822] Date: header (disregarding time and time zone) is within the specified date.
    SENTSINCE
    Messages whose [RFC-2822] Date: header (disregarding time and time zone) is within or later than the specified date.
    SINCE
    Messages whose internal date (disregarding time and time zone) is within or later than the specified date.
    SMALLER
    Messages with an [RFC-2822] size smaller than the specified number of octets.
    SUBJECT
    Messages that contain the specified string in the envelope structure's SUBJECT field.
    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.
    UID
    Messages with unique identifiers corresponding to the specified unique identifier set.
    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.

  • Method Summary

    Modifier and Type
    Method
    Description
    static IMAPClient.SEARCH_CRITERIA
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static IMAPClient.SEARCH_CRITERIA[]
    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