# All Classes and Interfaces

Class
Description
ACL
An access control list entry for a particular authentication identifier (user or group).
Address
This abstract class models the addresses in a message.
AddressException
The exception thrown when a wrongly formatted address is encountered.
AddressStringTerm
This abstract class implements string comparisons for Message addresses.
AddressTerm
This class implements Message Address comparisons.
AndTerm
This class implements the logical AND operator on individual SearchTerms.
AppendStream
A stream for writing to the temp file, and when done can return a stream for reading the data just written.
AppendUID
Information from the APPENDUID response code defined by the UIDPLUS extension - RFC 4315.
Argument
AsciiOutputStream
An OutputStream that determines whether the data written to it is all ASCII, mostly ASCII, or mostly non-ASCII.
ASCIIUtility
AString
Atom
AuthenticationFailedException
This exception is thrown when the connect method on a Store or Transport object fails due to an authentication failure (e.g., bad user name or password).
Authenticator
The class Authenticator represents an object that knows how to obtain authentication for a network connection.
BadCommandException
BASE64DecoderStream
This class implements a BASE64 Decoder.
BASE64EncoderStream
This class implements a BASE64 encoder.
BASE64MailboxDecoder
See the BASE64MailboxEncoder for a description of the RFC2060 and how mailbox names should be encoded.
BASE64MailboxEncoder
From RFC2060:
BEncoderStream
This class implements a 'B' Encoder as defined by RFC2047 for encoding MIME headers.
BODY
The BODY fetch response item.
BodyPart
This class models a Part that is contained within a Multipart.
BODYSTRUCTURE
A BODYSTRUCTURE response.
BodyTerm
This class implements searches on a message body.
ByteArray
A simple wrapper around a byte array, with a start position and count of bytes.
ByteArrayDataSource
A DataSource backed by a byte array.
CollectorFormatter
A LogRecord formatter that takes a sequence of LogRecords and combines them into a single summary result.
CommandFailedException
CompactFormatter
A plain text formatter that can produce fixed width output.
ComparisonTerm
This class models the comparison operator.
ConnectionAdapter
The adapter which receives connection events.
ConnectionEvent
This class models Connection events.
ConnectionException
ConnectionListener
This is the Listener interface for Connection events.
ContentDisposition
This class represents a MIME ContentDisposition value.
ContentType
This class represents a MIME Content-Type value.
CopyUID
Information from the COPYUID response code defined by the UIDPLUS extension - RFC 4315.
CRLFOutputStream
Convert lines into the canonical format, that is, terminate lines with the CRLF sequence.
DateTerm
This class implements comparisons for Dates
DecodingException
A special IOException that indicates a failure to decode data due to an error in the formatting of the data.
DefaultFolder
The default IMAP folder (root of the naming hierarchy).
DefaultFolder
The POP3 DefaultFolder.
DefaultProvider
Annotation to mark the default providers that are part of Jakarta Mail.
DeliveryStatus
A message/delivery-status message content, as defined in RFC 3464.
DigestMD5
DIGEST-MD5 authentication support.
DispositionNotification
A message/disposition-notification message content, as defined in RFC 3798.
DurationFilter
A filter used to limit log records based on a maximum generation rate.
EncodingAware
A `DataSource` that also implements `EncodingAware` may specify the Content-Transfer-Encoding to use for its data.
ENVELOPE
The ENEVELOPE item of an IMAP FETCH response.
EventQueue
Package private class used by Store & Folder to dispatch events.
FetchItem
Metadata describing a FETCH item.
FetchProfile
Clients use a FetchProfile to list the Message attributes that it wishes to prefetch from the server for a range of messages.
FetchProfile.Item
This inner class is the base class of all items that can be requested in a FetchProfile.
FetchResponse
This class represents a FETCH response obtained from the input stream of an IMAP server.
Flags
The Flags class represents the set of flags on a Message.
FLAGS
This class
Flags.Flag
This inner class represents an individual system flag.
FlagTerm
This class implements comparisons for Message Flags.
Folder
Folder is an abstract class that represents a folder for mail messages.
FolderAdapter
The adapter which receives Folder events.
FolderClosedException
This exception is thrown when a method is invoked on a Messaging object and the Folder that owns that object has died due to some reason.
FolderClosedIOException
A variant of FolderClosedException that can be thrown from methods that only throw IOException.
FolderEvent
This class models Folder existence events.
FolderListener
This is the Listener interface for Folder events.
FolderNotFoundException
This exception is thrown by Folder methods, when those methods are invoked on a non existent folder.
FromStringTerm
This class implements string comparisons for the From Address header.
FromTerm
This class implements comparisons for the From Address header.
GmailFolder
A Gmail folder.
GmailFolder.FetchProfileItem
A fetch profile item for fetching headers.
GmailMessage
A Gmail message.
GmailMsgIdTerm
This class implements searching for the Gmail message ID.
GmailProtocol
Extend IMAP support to handle Gmail-specific protocol extensions.
GmailProvider
The Gmail IMAP protocol provider.
GmailRawSearchTerm
This class implements searching using the Gmail X-GM-RAW extension.
GmailSearchSequence
Support Gmail-specific search extensions.
GmailSSLProvider
The Gmail IMAP protocol provider.
GmailSSLStore
Support "gimaps" protocol name.
GmailStore
A Gmail Store.
GmailThrIdTerm
This class implements searching for the Gmail thread ID.
handler_base
Base class for other DataContentHandlers.
Header
The Header class stores a name/value pair to represent headers.
HeaderTerm
This class implements comparisons for Message headers.
HeaderTokenizer
This class tokenizes RFC822 and MIME headers into the basic symbols specified by RFC822 and MIME.
HeaderTokenizer.Token
The Token class represents tokens returned by the HeaderTokenizer.
ID
This class represents the response to the ID command.
IdleManager
IdleManager uses the optional IMAP IDLE command (RFC 2177) to watch multiple folders for new messages.
IllegalWriteException
The exception thrown when a write is attempted on a read-only attribute of any Messaging object.
image_gif
DataContentHandler for image/gif.
image_jpeg
DataContentHandler for image/jpeg.
IMAPAddress
IMAPBodyPart
An IMAP body part.
IMAPFolder
This class implements an IMAP folder.
IMAPFolder.FetchProfileItem
A fetch profile item for fetching headers.
IMAPFolder.ProtocolCommand
A simple interface for user-defined IMAP protocol commands.
IMAPInputStream
This class implements an IMAP data stream.
IMAPMessage
This class implements an IMAPMessage object.
IMAPMessage.FetchProfileCondition
This class implements the test to be done on each message in the folder.
IMAPMultipartDataSource
This class
IMAPNestedMessage
This class implements a nested IMAP message
IMAPProtocol
This class extends the iap.Protocol object and implements IMAP semantics.
IMAPProvider
The IMAP protocol provider.
IMAPReferralException
A ProtocolException that includes IMAP login referral information.
IMAPResponse
This class represents a response obtained from the input stream of an IMAP server.
IMAPSaslAuthenticator
This class contains a single method that does authentication using SASL.
IMAPSSLProvider
The IMAP SSL protocol provider.
IMAPSSLStore
This class provides access to an IMAP message store over SSL.
IMAPStore
This class provides access to an IMAP message store.
IntegerComparisonTerm
This class implements comparisons for integers.
INTERNALDATE
An INTERNALDATE FETCH item.
InternetAddress
This class represents an Internet email address using the syntax of RFC822.
InternetHeaders
InternetHeaders is a utility class that manages RFC822 style headers.
InternetHeaders.InternetHeader
An individual internet header.
Item
A tagging interface for all IMAP data items.
LengthCounter
Count the number of bytes written to the stream.
LineInputStream
LineInputStream supports reading CRLF terminated lines that contain only US-ASCII characters from an input stream.
LineOutputStream
This class is to support writing out Strings as a sequence of bytes terminated by a CRLF sequence.
ListInfo
A LIST response.
Literal
An interface for objects that provide data dynamically for use in a literal protocol element.
LiteralException
LogManagerProperties
An adapter class to allow the Mail API to access the LogManager properties.
LogOutputStream
Capture output lines and send them to the mail logger.
MailboxInfo
Information collected when opening a mailbox.
MailConnectException
A MessagingException that indicates a socket connection attempt failed.
MailDateFormat
Formats and parses date specification based on RFC 2822.
MailEvent
Common base class for mail events, defining the dispatch method.
MailHandler
`Handler` that formats log records as an email message.
MailLogger
A simplified logger used by Jakarta Mail to handle logging to a PrintStream and logging through a java.util.logging.Logger.
MailSessionDefinition
Annotation used by Jakarta EE applications to define a `MailSession` to be registered with JNDI.
MailSessionDefinitions
Declares one or more `MailSessionDefinition` annotations.
MailSSLSocketFactory
An SSL socket factory that makes it easier to specify trust.
MD4
The MD4 class is used to compute an MD4 message digest over a given buffer of bytes.
Message
This class models an email message.
message_deliverystatus
DataContentHandler for message/delivery-status MIME type.
message_dispositionnotification
DataContentHandler for message/disposition-notification MIME type.
message_rfc822
Message.RecipientType
This inner class defines the types of recipients allowed by the Message class.
MessageAware
An interface optionally implemented by `DataSources` to supply information to a `DataContentHandler` about the message context in which the data content object is operating.
MessageCache
A cache of IMAPMessage objects along with the mapping from message number to IMAP sequence number.
MessageChangedEvent
This class models Message change events.
MessageChangedListener
This is the Listener interface for MessageChanged events
MessageContext
The context in which a piece of Message content is contained.
MessageCountAdapter
The adapter which receives MessageCount events.
MessageCountEvent
This class notifies changes in the number of messages in a folder.
MessageCountListener
This is the Listener interface for MessageCount events.
MessageHeaders
A special MimeMessage object that contains only message headers, no content.
MessageIDTerm
This term models the RFC822 "MessageId" - a message-id for Internet messages that is supposed to be unique per message.
MessageLiteral
An object that holds a Message object and reports its size and writes it to another OutputStream on demand.
MessageNumberTerm
This class implements comparisons for Message numbers.
MessageRemovedException
The exception thrown when an invalid method is invoked on an expunged Message.
MessageRemovedIOException
A variant of MessageRemovedException that can be thrown from methods that only throw IOException.
MessageSet
This class holds the 'start' and 'end' for a range of messages.
MessageVanishedEvent
This class provides notification of messages that have been removed since the folder was last synchronized.
MessagingException
The base class for all exceptions thrown by the Messaging classes
MethodNotSupportedException
The exception thrown when a method is not supported by the implementation
MimeBodyPart
This class represents a MIME body part.
MimeMessage
This class represents a MIME style email message.
MimeMessage.RecipientType
This inner class extends the javax.mail.Message.RecipientType class to add additional RecipientTypes.
MimeMultipart
The MimeMultipart class is an implementation of the abstract Multipart class that uses MIME conventions for the multipart data.
MimePart
The MimePart interface models an Entity as defined by MIME (RFC2045, Section 2.4).
MimePartDataSource
A utility class that implements a DataSource out of a MimePart.
MimeUtil
General MIME-related utility methods.
MimeUtility
This is a utility class that provides various MIME related functionality.
ModifiedSinceTerm
Find messages that have been modified since a given MODSEQ value.
MODSEQ
This class represents the MODSEQ data item.
Multipart
Multipart is a container that holds multiple body parts.
multipart_mixed
multipart_report
DataContentHandler for multipart/report MIME type.
MultipartDataSource
MultipartDataSource is a `DataSource` that contains body parts.
MultipartReport
A multipart/report message content, as defined in RFC 3462.
Namespaces
This class and its inner class represent the response to the NAMESPACE command.
Namespaces.Namespace
A single namespace entry.
NewsAddress
This class models an RFC1036 newsgroup address.
NoSuchProviderException
This exception is thrown when Session attempts to instantiate a Provider that doesn't exist.
NotTerm
This class implements the logical NEGATION operator.
NString
Ntlm
NTLMAuthentication:
OAuth2SaslClient
Jakarta Mail SASL client for OAUTH2.
OAuth2SaslClientFactory
Jakarta Mail SASL client factory for OAUTH2.
OlderTerm
Find messages that are older than a given interval (in seconds).
OrTerm
This class implements the logical OR operator on individual SearchTerms.
ParameterList
This class holds MIME parameters (attribute-value pairs).
ParseException
The exception thrown due to an error in parsing RFC822 or MIME headers, including multipart bodies.
ParsingException
Part
The `Part` interface is the common base interface for Messages and BodyParts.
PasswordAuthentication
The class PasswordAuthentication is a data holder that is used by Authenticator.
POP3Folder
A POP3 Folder (can only be "INBOX").
POP3Message
A POP3 Message.
POP3Provider
The POP3 protocol provider.
POP3SSLProvider
The POP3 SSL protocol provider.
POP3SSLStore
A POP3 Message Store using SSL.
POP3Store
A POP3 Message Store.
PreencodedMimeBodyPart
A MimeBodyPart that handles data that has already been encoded.
PropUtil
Utilities to make it easier to get property values.
Protocol
General protocol handling code for IMAP-like protocols.
Protocol
This class provides a POP3 connection and implements the POP3 protocol requests.
ProtocolException
Provider
The Provider is a class that describes a protocol implementation.
Provider.Type
This inner class defines the Provider type.
QDecoderStream
This class implements a Q Decoder as defined in RFC 2047 for decoding MIME headers.
QEncoderStream
This class implements a Q Encoder as defined by RFC 2047 for encoding MIME headers.
QPDecoderStream
This class implements a QP Decoder.
QPEncoderStream
This class implements a Quoted Printable Encoder.
Quota
This class represents a set of quotas for a given quota root.
Quota.Resource
An individual resource in a quota root.
QuotaAwareStore
An interface implemented by Stores that support quotas.
ReadableMime
A Message or message Part whose data can be read as a MIME format stream.
ReadOnlyFolderException
This exception is thrown when an attempt is made to open a folder read-write access when the folder is marked read-only.
ReceivedDateTerm
This class implements comparisons for the Message Received date
RecipientStringTerm
This class implements string comparisons for the Recipient Address headers.
RecipientTerm
This class implements comparisons for the Recipient Address headers.
ReferralException
A special kind of AuthenticationFailedException that indicates that the reason for the failure was an IMAP REFERRAL in the response code.
Report
An abstract report type, to be included in a MultipartReport.
Response
This class represents a response obtained from the input stream of an IMAP server.
Response
ResponseHandler
This class
ResponseInputStream
Inputstream that is used to read a Response.
ResyncData
Resynchronization data as defined by the QRESYNC extension (RFC 5162).
RFC822DATA
The RFC822 response data item.
RFC822SIZE
An RFC822SIZE FETCH item.
Rights
The Rights class represents the set of rights for an authentication identifier (for instance, a user or a group).
Rights.Right
This inner class represents an individual right.
SaslAuthenticator
Interface to make it easier to call IMAPSaslAuthenticator.
SaslAuthenticator
Interface to make it easier to call SMTPSaslAuthenticator.
SearchException
The exception thrown when a Search expression could not be handled.
SearchSequence
This class traverses a search-tree and generates the corresponding IMAP search sequence.
SearchTerm
Search criteria are expressed as a tree of search-terms, forming a parse-tree for the search expression.
SendFailedException
This exception is thrown when the message cannot be sent.
SentDateTerm
This class implements comparisons for the Message SentDate.
Service
An abstract class that contains the functionality common to messaging services, such as stores and transports.
Session
The Session class represents a mail session and is not subclassed.
SeverityComparator
Orders log records by level, thrown, sequence, and time.
SharedByteArrayInputStream
A ByteArrayInputStream that implements the SharedInputStream interface, allowing the underlying byte array to be shared between multiple readers.
SharedByteArrayOutputStream
A ByteArrayOutputStream that allows us to share the byte array rather than copy it.
SharedFileInputStream
A `SharedFileInputStream` is a `BufferedInputStream` that buffers data from the file and supports the `mark` and `reset` methods.
SharedInputStream
An InputStream that is backed by data that can be shared by multiple readers may implement this interface.
SizeTerm
This class implements comparisons for Message sizes.
SMTPAddressFailedException
This exception is thrown when the message cannot be sent.
SMTPAddressSucceededException
This exception is chained off a SendFailedException when the `mail.smtp.reportsuccess` property is true.
SMTPMessage
This class is a specialization of the MimeMessage class that allows you to specify various SMTP options and parameters that will be used when this message is sent over SMTP.
SMTPOutputStream
In addition to converting lines into the canonical format, i.e., terminating lines with the CRLF sequence, escapes the "." by adding another "." to any "." that appears in the beginning of a line.
SMTPProvider
The SMTP protocol provider.
SMTPSaslAuthenticator
This class contains a single method that does authentication using SASL.
SMTPSenderFailedException
This exception is thrown when the message cannot be sent.
SMTPSendFailedException
This exception is thrown when the message cannot be sent.
SMTPSSLProvider
The SMTP SSL protocol provider.
SMTPSSLTransport
This class implements the Transport abstract class using SMTP over SSL for message submission and transport.
SMTPTransport
This class implements the Transport abstract class using SMTP for message submission and transport.
SocketConnectException
An IOException that indicates a socket connection attempt failed.
SocketFetcher
This class is used to get Sockets.
SortTerm
A particular sort criteria, as defined by RFC 5256.
Status
STATUS response.
Status
Result of POP3 STAT command.
Store
An abstract class that models a message store and its access protocol, for storing and retrieving messages.
StoreClosedException
This exception is thrown when a method is invoked on a Messaging object and the Store that owns that object has died due to some reason.
StoreEvent
This class models notifications from the Store connection.
StoreListener
This is the Listener interface for Store Notifications.
StreamLoader
Support interface to generalize code that loads resources from stream.
StringTerm
This class implements the match method for Strings.
SubjectTerm
This class implements comparisons for the message Subject header.
TempFile
A temporary file used to cache POP3 messages.
text_html
DataContentHandler for text/html.
text_plain
DataContentHandler for text/plain.
text_rfc822headers
DataContentHandler for text/rfc822-headers MIME type.
text_xml
DataContentHandler for text/xml.
TimeoutOutputStream
An OutputStream that wraps the Socket's OutputStream and uses the ScheduledExecutorService to schedule a task to close the socket (aborting the write) if the timeout expires.
TraceInputStream
This class is a FilterInputStream that writes the bytes being read from the given input stream into the given output stream.
TraceOutputStream
This class is a subclass of DataOutputStream that copies the data being written into the DataOutputStream into another output stream.
Transport
An abstract class that models a message transport.
TransportAdapter
The adapter which receives Transport events.
TransportEvent
This class models Transport events.
TransportListener
This is the Listener interface for Transport events
UID
This class represents the UID data item.
UIDFolder
The `UIDFolder` interface is implemented by Folders that can support the "disconnected" mode of operation, by providing unique-ids for messages in the folder.
UIDFolder.FetchProfileItem
A fetch profile item for fetching UIDs.
UIDSet
This class holds the 'start' and 'end' for a range of UIDs.
UniqueValue
This is a utility class that generates unique values.
URLName
The name of a URL.
Utility
Holder for some static utility methods.
Utility.Condition
This interface defines the test to be executed in `toMessageSet()`.
UUDecoderStream
This class implements a UUDecoder.
UUEncoderStream
This class implements a UUEncoder.
Version
Package-private class that defines the version of Jakarta Mail.
WritableSharedFile
A subclass of SharedFileInputStream that also allows writing.
WriteTimeoutSocket
A special Socket that uses a ScheduledExecutorService to implement timeouts for writes.
YoungerTerm
Find messages that are younger than a given interval (in seconds).