## Uses of Class
javax.mail.search.SearchTerm

- Packages that use SearchTerm
  Package | Description
  --- | ---
  com.sun.mail.gimap | An EXPERIMENTAL IMAP protocol provider that supports the Gmail-specific protocol extensions.
  com.sun.mail.imap | An IMAP protocol provider for the JavaMail API that provides access to an IMAP message store.
  javax.mail | The JavaMailTM API provides classes that model a mail system.
  javax.mail.search | Message search terms for the JavaMail API.

- - ### Uses of SearchTerm in com.sun.mail.gimap

    Subclasses of SearchTerm in com.sun.mail.gimap
    Modifier and Type | Class and Description
    --- | ---
    `class` | `GmailMsgIdTerm` This class implements searching for the Gmail message ID.
    `class` | `GmailRawSearchTerm` This class implements searching using the Gmail X-GM-RAW extension.
    `class` | `GmailThrIdTerm` This class implements searching for the Gmail thread ID.

  - ### Uses of SearchTerm in com.sun.mail.imap

    Methods in com.sun.mail.imap with parameters of type SearchTerm
    Modifier and Type | Method and Description
    --- | ---
    `Message[]` | IMAPFolder.`getSortedMessages(SortTerm[] term, SearchTerm sterm)` Sort the messages in the folder according to the sort criteria.
    `Message[]` | IMAPFolder.`search(SearchTerm term)` Search whole folder for messages matching the given term.
    `Message[]` | IMAPFolder.`search(SearchTerm term, Message[] msgs)` Search the folder for messages matching the given term.

  - ### Uses of SearchTerm in javax.mail

    Methods in javax.mail with parameters of type SearchTerm
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | Message.`match(SearchTerm term)` Apply the specified Search criterion to this message.
    `Message[]` | Folder.`search(SearchTerm term)` Search this Folder for messages matching the specified search criterion.
    `Message[]` | Folder.`search(SearchTerm term, Message[] msgs)` Search the given array of messages for those that match the specified search criterion.

  - ### Uses of SearchTerm in javax.mail.search

    Subclasses of SearchTerm in javax.mail.search
    Modifier and Type | Class and Description
    --- | ---
    `class` | `AddressStringTerm` This abstract class implements string comparisons for Message addresses.
    `class` | `AddressTerm` This class implements Message Address comparisons.
    `class` | `AndTerm` This class implements the logical AND operator on individual SearchTerms.
    `class` | `BodyTerm` This class implements searches on a message body.
    `class` | `ComparisonTerm` This class models the comparison operator.
    `class` | `DateTerm` This class implements comparisons for Dates
    `class` | `FlagTerm` This class implements comparisons for Message Flags.
    `class` | `FromStringTerm` This class implements string comparisons for the From Address header.
    `class` | `FromTerm` This class implements comparisons for the From Address header.
    `class` | `HeaderTerm` This class implements comparisons for Message headers.
    `class` | `IntegerComparisonTerm` This class implements comparisons for integers.
    `class` | `MessageIDTerm` This term models the RFC822 "MessageId" - a message-id for Internet messages that is supposed to be unique per message.
    `class` | `MessageNumberTerm` This class implements comparisons for Message numbers.
    `class` | `NotTerm` This class implements the logical NEGATION operator.
    `class` | `OrTerm` This class implements the logical OR operator on individual SearchTerms.
    `class` | `ReceivedDateTerm` This class implements comparisons for the Message Received date
    `class` | `RecipientStringTerm` This class implements string comparisons for the Recipient Address headers.
    `class` | `RecipientTerm` This class implements comparisons for the Recipient Address headers.
    `class` | `SentDateTerm` This class implements comparisons for the Message SentDate.
    `class` | `SizeTerm` This class implements comparisons for Message sizes.
    `class` | `StringTerm` This class implements the match method for Strings.
    `class` | `SubjectTerm` This class implements comparisons for the message Subject header.

    Fields in javax.mail.search declared as SearchTerm
    Modifier and Type | Field and Description
    --- | ---
    `protected SearchTerm` | NotTerm.`term` The search term to negate.
    `protected SearchTerm[]` | OrTerm.`terms` The array of terms on which the OR operator should be applied.
    `protected SearchTerm[]` | AndTerm.`terms` The array of terms on which the AND operator should be applied.

    Methods in javax.mail.search that return SearchTerm
    Modifier and Type | Method and Description
    --- | ---
    `SearchTerm` | NotTerm.`getTerm()` Return the term to negate.
    `SearchTerm[]` | OrTerm.`getTerms()` Return the search terms.
    `SearchTerm[]` | AndTerm.`getTerms()` Return the search terms.

    Constructors in javax.mail.search with parameters of type SearchTerm
    Constructor and Description
    `AndTerm(SearchTerm[] t)` Constructor that takes an array of SearchTerms.
    `AndTerm(SearchTerm t1, SearchTerm t2)` Constructor that takes two terms.
    `NotTerm(SearchTerm t)`
    `OrTerm(SearchTerm[] t)` Constructor that takes an array of SearchTerms.
    `OrTerm(SearchTerm t1, SearchTerm t2)` Constructor that takes two operands.

Copyright © 2013 Oracle. All Rights Reserved.