A B C D E F G H I J L M N O P Q R S T U V W X
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- add(FetchProfile.Item) - Method in class jakarta.mail.FetchProfile
-
Add the given special item as one of the attributes to be prefetched.
- add(Flags) - Method in class jakarta.mail.Flags
-
Add all the flags in the given Flags object to this Flags object.
- add(Flags.Flag) - Method in class jakarta.mail.Flags
-
Add the specified system flag to this Flags object.
- add(String) - Method in class jakarta.mail.FetchProfile
-
Add the specified header-field to the list of attributes to be prefetched.
- add(String) - Method in class jakarta.mail.Flags
-
Add the specified user flag to this Flags object.
- addBodyPart(BodyPart) - Method in class jakarta.mail.internet.MimeMultipart
-
Adds a Part to the multipart.
- addBodyPart(BodyPart) - Method in class jakarta.mail.Multipart
-
Adds a Part to the multipart.
- addBodyPart(BodyPart, int) - Method in class jakarta.mail.internet.MimeMultipart
-
Adds a BodyPart at position
index
. - addBodyPart(BodyPart, int) - Method in class jakarta.mail.Multipart
-
Adds a BodyPart at position
index
. - addConnectionListener(ConnectionListener) - Method in class jakarta.mail.Folder
-
Add a listener for Connection events on this Folder.
- addConnectionListener(ConnectionListener) - Method in class jakarta.mail.Service
-
Add a listener for Connection events on this service.
- ADDED - Static variable in class jakarta.mail.event.MessageCountEvent
-
The messages were added to their folder
- addFolderListener(FolderListener) - Method in class jakarta.mail.Folder
-
Add a listener for Folder events on this Folder.
- addFolderListener(FolderListener) - Method in class jakarta.mail.Store
-
Add a listener for Folder events on any Folder object obtained from this Store.
- addFrom(Address[]) - Method in class jakarta.mail.internet.MimeMessage
-
Add the specified addresses to the existing "From" field.
- addFrom(Address[]) - Method in class jakarta.mail.Message
-
Add these addresses to the existing "From" attribute
- addHeader(String, String) - Method in class jakarta.mail.internet.InternetHeaders
-
Add a header with the specified name and value to the header list.
- addHeader(String, String) - Method in class jakarta.mail.internet.MimeBodyPart
-
Add this value to the existing values for this header_name.
- addHeader(String, String) - Method in class jakarta.mail.internet.MimeMessage
-
Add this value to the existing values for this header_name.
- addHeader(String, String) - Method in interface jakarta.mail.Part
-
Add this value to the existing values for this header_name.
- addHeaderLine(String) - Method in class jakarta.mail.internet.InternetHeaders
-
Add an RFC822 header line to the header store.
- addHeaderLine(String) - Method in class jakarta.mail.internet.MimeBodyPart
-
Add a header line to this body part
- addHeaderLine(String) - Method in class jakarta.mail.internet.MimeMessage
-
Add a raw RFC 822 header-line.
- addHeaderLine(String) - Method in interface jakarta.mail.internet.MimePart
-
Add a raw RFC822 header-line.
- addMessageChangedListener(MessageChangedListener) - Method in class jakarta.mail.Folder
-
Add a listener for MessageChanged events on this Folder.
- addMessageCountListener(MessageCountListener) - Method in class jakarta.mail.Folder
-
Add a listener for MessageCount events on this Folder.
- addProvider(Provider) - Method in class jakarta.mail.Session
-
Add a provider to the session.
- addRecipient(Message.RecipientType, Address) - Method in class jakarta.mail.Message
-
Add this recipient address to the existing ones of the given type.
- addRecipients(Message.RecipientType, Address[]) - Method in class jakarta.mail.internet.MimeMessage
-
Add the given addresses to the specified recipient type.
- addRecipients(Message.RecipientType, Address[]) - Method in class jakarta.mail.Message
-
Add these recipient addresses to the existing ones of the given type.
- addRecipients(Message.RecipientType, String) - Method in class jakarta.mail.internet.MimeMessage
-
Add the given addresses to the specified recipient type.
- address - Variable in class jakarta.mail.internet.InternetAddress
-
The email address.
- address - Variable in class jakarta.mail.search.AddressTerm
-
The address.
- Address - Class in jakarta.mail
-
This abstract class models the addresses in a message.
- Address() - Constructor for class jakarta.mail.Address
-
Creates a default
Address
. - AddressException - Exception in jakarta.mail.internet
-
The exception thrown when a wrongly formatted address is encountered.
- AddressException() - Constructor for exception jakarta.mail.internet.AddressException
-
Constructs an AddressException with no detail message.
- AddressException(String) - Constructor for exception jakarta.mail.internet.AddressException
-
Constructs an AddressException with the specified detail message.
- AddressException(String, String) - Constructor for exception jakarta.mail.internet.AddressException
-
Constructs an AddressException with the specified detail message and reference info.
- AddressException(String, String, int) - Constructor for exception jakarta.mail.internet.AddressException
-
Constructs an AddressException with the specified detail message and reference info.
- AddressStringTerm - Class in jakarta.mail.search
-
This abstract class implements string comparisons for Message addresses.
- AddressStringTerm(String) - Constructor for class jakarta.mail.search.AddressStringTerm
-
Constructor.
- AddressTerm - Class in jakarta.mail.search
-
This class implements Message Address comparisons.
- AddressTerm(Address) - Constructor for class jakarta.mail.search.AddressTerm
-
Constructor.
- addStoreListener(StoreListener) - Method in class jakarta.mail.Store
-
Add a listener for StoreEvents on this Store.
- addTransportListener(TransportListener) - Method in class jakarta.mail.Transport
-
Add a listener for Transport events.
- ALERT - Static variable in class jakarta.mail.event.StoreEvent
-
Indicates that this message is an ALERT.
- ALL - Static variable in class jakarta.mail.internet.MimeUtility
- allowEmpty - Variable in class jakarta.mail.internet.MimeMultipart
-
Flag corresponding to the "mail.mime.multipart.allowempty" property, set in the
MimeMultipart.initializeProperties()
method called from constructors and the parse method. - AndTerm - Class in jakarta.mail.search
-
This class implements the logical AND operator on individual SearchTerms.
- AndTerm(SearchTerm[]) - Constructor for class jakarta.mail.search.AndTerm
-
Constructor that takes an array of SearchTerms.
- AndTerm(SearchTerm, SearchTerm) - Constructor for class jakarta.mail.search.AndTerm
-
Constructor that takes two terms.
- ANSWERED - Static variable in class jakarta.mail.Flags.Flag
-
This message has been answered.
- appendMessages(Message[]) - Method in class jakarta.mail.Folder
-
Append given Messages to this folder.
- applyLocalizedPattern(String) - Method in class jakarta.mail.internet.MailDateFormat
-
This method always throws an UnsupportedOperationException and should not be used because RFC 2822 mandates a specific pattern.
- applyPattern(String) - Method in class jakarta.mail.internet.MailDateFormat
-
This method always throws an UnsupportedOperationException and should not be used because RFC 2822 mandates a specific pattern.
- ATOM - Static variable in class jakarta.mail.internet.HeaderTokenizer.Token
-
Token type indicating an ATOM.
- attachFile(File) - Method in class jakarta.mail.internet.MimeBodyPart
-
Use the specified file to provide the data for this part.
- attachFile(File, String, String) - Method in class jakarta.mail.internet.MimeBodyPart
-
Use the specified file with the specified Content-Type and Content-Transfer-Encoding to provide the data for this part.
- attachFile(String) - Method in class jakarta.mail.internet.MimeBodyPart
-
Use the specified file to provide the data for this part.
- attachFile(String, String, String) - Method in class jakarta.mail.internet.MimeBodyPart
-
Use the specified file with the specified Content-Type and Content-Transfer-Encoding to provide the data for this part.
- ATTACHMENT - Static variable in interface jakarta.mail.Part
-
This part should be presented as an attachment.
- AuthenticationFailedException - Exception in jakarta.mail
-
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).
- AuthenticationFailedException() - Constructor for exception jakarta.mail.AuthenticationFailedException
-
Constructs an AuthenticationFailedException.
- AuthenticationFailedException(String) - Constructor for exception jakarta.mail.AuthenticationFailedException
-
Constructs an AuthenticationFailedException with the specified detail message.
- AuthenticationFailedException(String, Exception) - Constructor for exception jakarta.mail.AuthenticationFailedException
-
Constructs an AuthenticationFailedException with the specified detail message and embedded exception.
- Authenticator - Class in jakarta.mail
-
The class Authenticator represents an object that knows how to obtain authentication for a network connection.
- Authenticator() - Constructor for class jakarta.mail.Authenticator
-
Creates a default
Authenticator
. - available() - Method in class jakarta.mail.util.SharedFileInputStream
-
Returns the number of bytes that can be read from this input stream without blocking.
B
- B_ENCODER - jakarta.mail.util.StreamProvider.EncoderTypes
- BASE_64 - jakarta.mail.util.StreamProvider.EncoderTypes
- BCC - Static variable in class jakarta.mail.Message.RecipientType
-
The "Bcc" (blind carbon copy) recipients.
- BINARY_ENCODER - jakarta.mail.util.StreamProvider.EncoderTypes
- BIT7_ENCODER - jakarta.mail.util.StreamProvider.EncoderTypes
- BIT8_ENCODER - jakarta.mail.util.StreamProvider.EncoderTypes
- BodyPart - Class in jakarta.mail
-
This class models a Part that is contained within a Multipart.
- BodyPart() - Constructor for class jakarta.mail.BodyPart
-
Creates a default
BodyPart
. - BodyTerm - Class in jakarta.mail.search
-
This class implements searches on a message body.
- BodyTerm(String) - Constructor for class jakarta.mail.search.BodyTerm
-
Constructor
- bufpos - Variable in class jakarta.mail.util.SharedFileInputStream
-
The file offset that corresponds to the first byte in the read buffer.
- bufsize - Variable in class jakarta.mail.util.SharedFileInputStream
-
The normal size of the read buffer.
- ByteArrayDataSource - Class in jakarta.mail.util
-
A DataSource backed by a byte array.
- ByteArrayDataSource(byte[], String) - Constructor for class jakarta.mail.util.ByteArrayDataSource
-
Create a ByteArrayDataSource with data from the specified byte array and with the specified MIME type.
- ByteArrayDataSource(InputStream, String) - Constructor for class jakarta.mail.util.ByteArrayDataSource
-
Create a ByteArrayDataSource with data from the specified InputStream and with the specified MIME type.
- ByteArrayDataSource(String, String) - Constructor for class jakarta.mail.util.ByteArrayDataSource
-
Create a ByteArrayDataSource with data from the specified String and with the specified MIME type.
C
- cachedContent - Variable in class jakarta.mail.internet.MimeBodyPart
-
If our content is a Multipart of Message object, we save it the first time it's created by parsing a stream so that changes to the contained objects will not be lost.
- cachedContent - Variable in class jakarta.mail.internet.MimeMessage
-
If our content is a Multipart or Message object, we save it the first time it's created by parsing a stream so that changes to the contained objects will not be lost.
- CC - Static variable in class jakarta.mail.Message.RecipientType
-
The "Cc" (carbon copy) recipients.
- clearSystemFlags() - Method in class jakarta.mail.Flags
-
Clear all of the system flags.
- clearUserFlags() - Method in class jakarta.mail.Flags
-
Clear all of the user flags.
- clone() - Method in class jakarta.mail.Flags
-
Returns a clone of this Flags object.
- clone() - Method in class jakarta.mail.internet.InternetAddress
-
Return a copy of this InternetAddress object.
- clone() - Method in class jakarta.mail.internet.MailDateFormat
-
Overrides Cloneable.
- close() - Method in class jakarta.mail.Folder
-
Close this Folder and expunge deleted messages.
- close() - Method in class jakarta.mail.Service
-
Close this service and terminate its connection.
- close() - Method in class jakarta.mail.util.SharedFileInputStream
-
Closes this input stream and releases any system resources associated with the stream.
- close(boolean) - Method in class jakarta.mail.Folder
-
Close this Folder.
- closed(ConnectionEvent) - Method in class jakarta.mail.event.ConnectionAdapter
- closed(ConnectionEvent) - Method in interface jakarta.mail.event.ConnectionListener
-
Invoked when a Store/Folder/Transport is closed.
- CLOSED - Static variable in class jakarta.mail.event.ConnectionEvent
-
A connection was closed.
- combineSegments() - Method in class jakarta.mail.internet.ParameterList
-
Normal users of this class will use simple parameter names.
- COMMENT - Static variable in class jakarta.mail.internet.HeaderTokenizer.Token
-
Token type indicating a comment.
- comparison - Variable in class jakarta.mail.search.ComparisonTerm
-
The comparison.
- ComparisonTerm - Class in jakarta.mail.search
-
This class models the comparison operator.
- ComparisonTerm() - Constructor for class jakarta.mail.search.ComparisonTerm
-
Creates a default
ComparisonTerm
. - complete - Variable in class jakarta.mail.internet.MimeMultipart
-
Have we seen the final bounary line?
- connect() - Method in class jakarta.mail.Service
-
A generic connect method that takes no parameters.
- connect(String, int, String, String) - Method in class jakarta.mail.Service
-
Similar to connect(host, user, password) except a specific port can be specified.
- connect(String, String) - Method in class jakarta.mail.Service
-
Connect to the current host using the specified username and password.
- connect(String, String, String) - Method in class jakarta.mail.Service
-
Connect to the specified address.
- ConnectionAdapter - Class in jakarta.mail.event
-
The adapter which receives connection events.
- ConnectionAdapter() - Constructor for class jakarta.mail.event.ConnectionAdapter
-
Creates a default
ConnectionAdapter
. - ConnectionEvent - Class in jakarta.mail.event
-
This class models Connection events.
- ConnectionEvent(Object, int) - Constructor for class jakarta.mail.event.ConnectionEvent
-
Construct a ConnectionEvent.
- ConnectionListener - Interface in jakarta.mail.event
-
This is the Listener interface for Connection events.
- contains(FetchProfile.Item) - Method in class jakarta.mail.FetchProfile
-
Returns true if the fetch profile contains the given special item.
- contains(Flags) - Method in class jakarta.mail.Flags
-
Check whether all the flags in the specified Flags object are present in this Flags object.
- contains(Flags.Flag) - Method in class jakarta.mail.Flags
-
Check whether the specified system flag is present in this Flags object.
- contains(String) - Method in class jakarta.mail.FetchProfile
-
Returns true if the fetch profile contains the given header name.
- contains(String) - Method in class jakarta.mail.Flags
-
Check whether the specified user flag is present in this Flags object.
- content - Variable in class jakarta.mail.internet.MimeBodyPart
-
Byte array that holds the bytes of the content of this Part.
- content - Variable in class jakarta.mail.internet.MimeMessage
-
Byte array that holds the bytes of this Message's content.
- CONTENT_INFO - Static variable in class jakarta.mail.FetchProfile.Item
-
This item is for fetching information about the content of the message.
- ContentDisposition - Class in jakarta.mail.internet
-
This class represents a MIME ContentDisposition value.
- ContentDisposition() - Constructor for class jakarta.mail.internet.ContentDisposition
-
No-arg Constructor.
- ContentDisposition(String) - Constructor for class jakarta.mail.internet.ContentDisposition
-
Constructor that takes a ContentDisposition string.
- ContentDisposition(String, ParameterList) - Constructor for class jakarta.mail.internet.ContentDisposition
-
Constructor.
- contentStream - Variable in class jakarta.mail.internet.MimeBodyPart
-
If the data for this body part was supplied by an InputStream that implements the SharedInputStream interface,
contentStream
is another such stream representing the content of this body part. - contentStream - Variable in class jakarta.mail.internet.MimeMessage
-
If the data for this message was supplied by an InputStream that implements the SharedInputStream interface,
contentStream
is another such stream representing the content of this message. - contentType - Variable in class jakarta.mail.Multipart
-
This field specifies the content-type of this multipart object.
- ContentType - Class in jakarta.mail.internet
-
This class represents a MIME Content-Type value.
- ContentType() - Constructor for class jakarta.mail.internet.ContentType
-
No-arg Constructor.
- ContentType(String) - Constructor for class jakarta.mail.internet.ContentType
-
Constructor that takes a Content-Type string.
- ContentType(String, String, ParameterList) - Constructor for class jakarta.mail.internet.ContentType
-
Constructor.
- copyMessages(Message[], Folder) - Method in class jakarta.mail.Folder
-
Copy the specified Messages from this Folder into another Folder.
- create(int) - Method in class jakarta.mail.Folder
-
Create this folder on the Store.
- CREATED - Static variable in class jakarta.mail.event.FolderEvent
-
The folder was created.
- createInternetHeaders(InputStream) - Method in class jakarta.mail.internet.MimeMessage
-
Create and return an InternetHeaders object that loads the headers from the given InputStream.
- createInternetHeaders(InputStream) - Method in class jakarta.mail.internet.MimeMultipart
-
Create and return an InternetHeaders object that loads the headers from the given InputStream.
- createMimeBodyPart(InternetHeaders, byte[]) - Method in class jakarta.mail.internet.MimeMultipart
-
Create and return a MimeBodyPart object to represent a body part parsed from the InputStream.
- createMimeBodyPart(InputStream) - Method in class jakarta.mail.internet.MimeMultipart
-
Create and return a MimeBodyPart object to represent a body part parsed from the InputStream.
- createMimeMessage(Session) - Method in class jakarta.mail.internet.MimeMessage
-
Create and return a MimeMessage object.
D
- datalen - Variable in class jakarta.mail.util.SharedFileInputStream
-
The amount of data in this subset of the file.
- date - Variable in class jakarta.mail.search.DateTerm
-
The date.
- DateTerm - Class in jakarta.mail.search
-
This class implements comparisons for Dates
- DateTerm(int, Date) - Constructor for class jakarta.mail.search.DateTerm
-
Constructor.
- debug - Variable in class jakarta.mail.Service
-
Debug flag for this service.
- decode(InputStream, String) - Static method in class jakarta.mail.internet.MimeUtility
-
Decode the given input stream.
- decodeText(String) - Static method in class jakarta.mail.internet.MimeUtility
-
Decode "unstructured" headers, that is, headers that are defined as '*text' as per RFC 822.
- decodeWord(String) - Static method in class jakarta.mail.internet.MimeUtility
-
The string is parsed using the rules in RFC 2047 and RFC 2231 for parsing an "encoded-word".
- delete(boolean) - Method in class jakarta.mail.Folder
-
Delete this Folder.
- DELETED - Static variable in class jakarta.mail.event.FolderEvent
-
The folder was deleted.
- DELETED - Static variable in class jakarta.mail.Flags.Flag
-
This message is marked deleted.
- description() - Method in annotation type jakarta.mail.MailSessionDefinition
-
Description of this mail session.
- dh - Variable in class jakarta.mail.internet.MimeBodyPart
-
The DataHandler object representing this Part's content.
- dh - Variable in class jakarta.mail.internet.MimeMessage
-
The DataHandler object representing this Message's content.
- disconnected(ConnectionEvent) - Method in class jakarta.mail.event.ConnectionAdapter
- disconnected(ConnectionEvent) - Method in interface jakarta.mail.event.ConnectionListener
-
Invoked when a Store is disconnected.
- DISCONNECTED - Static variable in class jakarta.mail.event.ConnectionEvent
-
A connection was disconnected (not currently used).
- dispatch(Object) - Method in class jakarta.mail.event.ConnectionEvent
-
Invokes the appropriate ConnectionListener method
- dispatch(Object) - Method in class jakarta.mail.event.FolderEvent
-
Invokes the appropriate FolderListener method
- dispatch(Object) - Method in class jakarta.mail.event.MailEvent
-
This method invokes the appropriate method on a listener for this event.
- dispatch(Object) - Method in class jakarta.mail.event.MessageChangedEvent
-
Invokes the appropriate MessageChangedListener method.
- dispatch(Object) - Method in class jakarta.mail.event.MessageCountEvent
-
Invokes the appropriate MessageCountListener method.
- dispatch(Object) - Method in class jakarta.mail.event.StoreEvent
-
Invokes the appropriate StoreListener method.
- dispatch(Object) - Method in class jakarta.mail.event.TransportEvent
-
Invokes the appropriate TransportListener method.
- DRAFT - Static variable in class jakarta.mail.Flags.Flag
-
This message is a draft.
- ds - Variable in class jakarta.mail.internet.MimeMultipart
-
The DataSource supplying our InputStream.
E
- encode(OutputStream, String) - Static method in class jakarta.mail.internet.MimeUtility
-
Wrap an encoder around the given output stream.
- encode(OutputStream, String, String) - Static method in class jakarta.mail.internet.MimeUtility
-
Wrap an encoder around the given output stream.
- encodedPersonal - Variable in class jakarta.mail.internet.InternetAddress
-
The RFC 2047 encoded version of the personal name.
- encodeText(String) - Static method in class jakarta.mail.internet.MimeUtility
-
Encode a RFC 822 "text" token into mail-safe form as per RFC 2047.
- encodeText(String, String, String) - Static method in class jakarta.mail.internet.MimeUtility
-
Encode a RFC 822 "text" token into mail-safe form as per RFC 2047.
- encodeWord(String) - Static method in class jakarta.mail.internet.MimeUtility
-
Encode a RFC 822 "word" token into mail-safe form as per RFC 2047.
- encodeWord(String, String, String) - Static method in class jakarta.mail.internet.MimeUtility
-
Encode a RFC 822 "word" token into mail-safe form as per RFC 2047.
- EncodingAware - Interface in jakarta.mail
-
A
DataSource
that also implementsEncodingAware
may specify the Content-Transfer-Encoding to use for its data. - ENVELOPE - Static variable in class jakarta.mail.FetchProfile.Item
-
This is the Envelope item.
- ENVELOPE_CHANGED - Static variable in class jakarta.mail.event.MessageChangedEvent
-
The message's envelope (headers, but not body) changed.
- EOF - Static variable in class jakarta.mail.internet.HeaderTokenizer.Token
-
Token type indicating end of input.
- EQ - Static variable in class jakarta.mail.search.ComparisonTerm
-
Equal to, "
=
", comparison. - equals(Object) - Method in class jakarta.mail.Address
-
The equality operator.
- equals(Object) - Method in class jakarta.mail.Flags
-
Check whether the two Flags objects are equal.
- equals(Object) - Method in class jakarta.mail.Header
- equals(Object) - Method in class jakarta.mail.internet.InternetAddress
-
The equality operator.
- equals(Object) - Method in class jakarta.mail.internet.NewsAddress
-
The equality operator.
- equals(Object) - Method in class jakarta.mail.search.AddressStringTerm
-
Equality comparison.
- equals(Object) - Method in class jakarta.mail.search.AddressTerm
-
Equality comparison.
- equals(Object) - Method in class jakarta.mail.search.AndTerm
-
Equality comparison.
- equals(Object) - Method in class jakarta.mail.search.BodyTerm
-
Equality comparison.
- equals(Object) - Method in class jakarta.mail.search.ComparisonTerm
-
Equality comparison.
- equals(Object) - Method in class jakarta.mail.search.DateTerm
-
Equality comparison.
- equals(Object) - Method in class jakarta.mail.search.FlagTerm
-
Equality comparison.
- equals(Object) - Method in class jakarta.mail.search.FromStringTerm
-
Equality comparison.
- equals(Object) - Method in class jakarta.mail.search.FromTerm
-
Equality comparison.
- equals(Object) - Method in class jakarta.mail.search.HeaderTerm
-
Equality comparison.
- equals(Object) - Method in class jakarta.mail.search.IntegerComparisonTerm
-
Equality comparison.
- equals(Object) - Method in class jakarta.mail.search.MessageIDTerm
-
Equality comparison.
- equals(Object) - Method in class jakarta.mail.search.MessageNumberTerm
-
Equality comparison.
- equals(Object) - Method in class jakarta.mail.search.NotTerm
-
Equality comparison.
- equals(Object) - Method in class jakarta.mail.search.OrTerm
-
Equality comparison.
- equals(Object) - Method in class jakarta.mail.search.ReceivedDateTerm
-
Equality comparison.
- equals(Object) - Method in class jakarta.mail.search.RecipientStringTerm
-
Equality comparison.
- equals(Object) - Method in class jakarta.mail.search.RecipientTerm
-
Equality comparison.
- equals(Object) - Method in class jakarta.mail.search.SentDateTerm
-
Equality comparison.
- equals(Object) - Method in class jakarta.mail.search.SizeTerm
-
Equality comparison.
- equals(Object) - Method in class jakarta.mail.search.StringTerm
-
Equality comparison.
- equals(Object) - Method in class jakarta.mail.search.SubjectTerm
-
Equality comparison.
- equals(Object) - Method in class jakarta.mail.URLName
-
Compares two URLNames.
- exists() - Method in class jakarta.mail.Folder
-
Tests if this folder physically exists on the Store.
- expunge() - Method in class jakarta.mail.Folder
-
Expunge (permanently remove) messages marked DELETED.
- expunged - Variable in class jakarta.mail.Message
-
True if this message has been expunged.
F
- fetch(Message[], FetchProfile) - Method in class jakarta.mail.Folder
-
Prefetch the items specified in the FetchProfile for the given Messages.
- FetchProfile - Class in jakarta.mail
-
Clients use a FetchProfile to list the Message attributes that it wishes to prefetch from the server for a range of messages.
- FetchProfile() - Constructor for class jakarta.mail.FetchProfile
-
Create an empty FetchProfile.
- FetchProfile.Item - Class in jakarta.mail
-
This inner class is the base class of all items that can be requested in a FetchProfile.
- FetchProfileItem(String) - Constructor for class jakarta.mail.UIDFolder.FetchProfileItem
-
Constructor for an item.
- finalize() - Method in class jakarta.mail.Folder
- finalize() - Method in class jakarta.mail.Service
-
Stop the event dispatcher thread so the queue can be garbage collected.
- finalize() - Method in class jakarta.mail.util.SharedFileInputStream
-
Force this stream to close.
- FLAGGED - Static variable in class jakarta.mail.Flags.Flag
-
This message is flagged.
- flags - Variable in class jakarta.mail.internet.MimeMessage
-
The Flags for this message.
- Flags - Class in jakarta.mail
-
The Flags class represents the set of flags on a Message.
- Flags() - Constructor for class jakarta.mail.Flags
-
Construct an empty Flags object.
- Flags(Flags) - Constructor for class jakarta.mail.Flags
-
Construct a Flags object initialized with the given flags.
- Flags(Flags.Flag) - Constructor for class jakarta.mail.Flags
-
Construct a Flags object initialized with the given system flag.
- Flags(String) - Constructor for class jakarta.mail.Flags
-
Construct a Flags object initialized with the given user flag.
- FLAGS - Static variable in class jakarta.mail.FetchProfile.Item
-
This is the Flags item.
- FLAGS_CHANGED - Static variable in class jakarta.mail.event.MessageChangedEvent
-
The message's flags changed.
- Flags.Flag - Class in jakarta.mail
-
This inner class represents an individual system flag.
- FlagTerm - Class in jakarta.mail.search
-
This class implements comparisons for Message Flags.
- FlagTerm(Flags, boolean) - Constructor for class jakarta.mail.search.FlagTerm
-
Constructor.
- fold(int, String) - Static method in class jakarta.mail.internet.MimeUtility
-
Fold a string at linear whitespace so that each line is no longer than 76 characters, if possible.
- folder - Variable in class jakarta.mail.event.FolderEvent
-
The folder the event occurred on.
- folder - Variable in class jakarta.mail.Message
-
The containing folder, if this message is obtained from a folder
- Folder - Class in jakarta.mail
-
Folder is an abstract class that represents a folder for mail messages.
- Folder(Store) - Constructor for class jakarta.mail.Folder
-
Constructor that takes a Store object.
- FolderAdapter - Class in jakarta.mail.event
-
The adapter which receives Folder events.
- FolderAdapter() - Constructor for class jakarta.mail.event.FolderAdapter
-
Creates a default
FolderAdapter
. - FolderClosedException - Exception in jakarta.mail
-
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.
- FolderClosedException(Folder) - Constructor for exception jakarta.mail.FolderClosedException
-
Constructs a FolderClosedException.
- FolderClosedException(Folder, String) - Constructor for exception jakarta.mail.FolderClosedException
-
Constructs a FolderClosedException with the specified detail message.
- FolderClosedException(Folder, String, Exception) - Constructor for exception jakarta.mail.FolderClosedException
-
Constructs a FolderClosedException with the specified detail message and embedded exception.
- folderCreated(FolderEvent) - Method in class jakarta.mail.event.FolderAdapter
- folderCreated(FolderEvent) - Method in interface jakarta.mail.event.FolderListener
-
Invoked when a Folder is created.
- folderDeleted(FolderEvent) - Method in class jakarta.mail.event.FolderAdapter
- folderDeleted(FolderEvent) - Method in interface jakarta.mail.event.FolderListener
-
Invoked when a folder is deleted.
- FolderEvent - Class in jakarta.mail.event
-
This class models Folder existence events.
- FolderEvent(Object, Folder, int) - Constructor for class jakarta.mail.event.FolderEvent
-
Constructor.
- FolderEvent(Object, Folder, Folder, int) - Constructor for class jakarta.mail.event.FolderEvent
-
Constructor.
- FolderListener - Interface in jakarta.mail.event
-
This is the Listener interface for Folder events.
- FolderNotFoundException - Exception in jakarta.mail
-
This exception is thrown by Folder methods, when those methods are invoked on a non existent folder.
- FolderNotFoundException() - Constructor for exception jakarta.mail.FolderNotFoundException
-
Constructs a FolderNotFoundException with no detail message.
- FolderNotFoundException(Folder) - Constructor for exception jakarta.mail.FolderNotFoundException
-
Constructs a FolderNotFoundException.
- FolderNotFoundException(Folder, String) - Constructor for exception jakarta.mail.FolderNotFoundException
-
Constructs a FolderNotFoundException with the specified detail message.
- FolderNotFoundException(Folder, String, Exception) - Constructor for exception jakarta.mail.FolderNotFoundException
-
Constructs a FolderNotFoundException with the specified detail message and embedded exception.
- FolderNotFoundException(String, Folder) - Constructor for exception jakarta.mail.FolderNotFoundException
-
Constructs a FolderNotFoundException with the specified detail message and the specified folder.
- folderRenamed(FolderEvent) - Method in class jakarta.mail.event.FolderAdapter
- folderRenamed(FolderEvent) - Method in interface jakarta.mail.event.FolderListener
-
Invoked when a folder is renamed.
- format(Date, StringBuffer, FieldPosition) - Method in class jakarta.mail.internet.MailDateFormat
-
Formats the given date in the format specified by RFC 2822 in the current TimeZone.
- from() - Method in annotation type jakarta.mail.MailSessionDefinition
-
From address for the user.
- FromStringTerm - Class in jakarta.mail.search
-
This class implements string comparisons for the From Address header.
- FromStringTerm(String) - Constructor for class jakarta.mail.search.FromStringTerm
-
Constructor.
- FromTerm - Class in jakarta.mail.search
-
This class implements comparisons for the From Address header.
- FromTerm(Address) - Constructor for class jakarta.mail.search.FromTerm
-
Constructor
- fullURL - Variable in class jakarta.mail.URLName
-
The full version of the URL
G
- GE - Static variable in class jakarta.mail.search.ComparisonTerm
-
Greater than or equal to, "
>=
", comparison. - get(String) - Method in class jakarta.mail.internet.ParameterList
-
Returns the value of the specified parameter.
- get2DigitYearStart() - Method in class jakarta.mail.internet.MailDateFormat
-
This method always throws an UnsupportedOperationException and should not be used because RFC 2822 mandates another strategy for interpreting 2-digits years.
- getAddress() - Method in class jakarta.mail.internet.InternetAddress
-
Get the email address.
- getAddress() - Method in class jakarta.mail.search.AddressTerm
-
Return the address to match with.
- getAllHeaderLines() - Method in class jakarta.mail.internet.InternetHeaders
-
Return all the header lines as an Enumeration of Strings.
- getAllHeaderLines() - Method in class jakarta.mail.internet.MimeBodyPart
-
Get all header lines as an Enumeration of Strings.
- getAllHeaderLines() - Method in class jakarta.mail.internet.MimeMessage
-
Get all header lines as an Enumeration of Strings.
- getAllHeaderLines() - Method in interface jakarta.mail.internet.MimePart
-
Get all header lines as an Enumeration of Strings.
- getAllHeaders() - Method in class jakarta.mail.internet.InternetHeaders
-
Return all the headers as an Enumeration of
Header
objects. - getAllHeaders() - Method in class jakarta.mail.internet.MimeBodyPart
-
Return all the headers from this Message as an Enumeration of Header objects.
- getAllHeaders() - Method in class jakarta.mail.internet.MimeMessage
-
Return all the headers from this Message as an enumeration of Header objects.
- getAllHeaders() - Method in interface jakarta.mail.Part
-
Return all the headers from this part as an Enumeration of Header objects.
- getAllRecipients() - Method in class jakarta.mail.internet.MimeMessage
-
Get all the recipient addresses for the message.
- getAllRecipients() - Method in class jakarta.mail.Message
-
Get all the recipient addresses for the message.
- getBaseType() - Method in class jakarta.mail.internet.ContentType
-
Return the MIME type string, without the parameters.
- getBodyPart(int) - Method in class jakarta.mail.internet.MimeMultipart
-
Get the specified BodyPart.
- getBodyPart(int) - Method in class jakarta.mail.Multipart
-
Get the specified Part.
- getBodyPart(int) - Method in interface jakarta.mail.MultipartDataSource
-
Get the specified Part.
- getBodyPart(String) - Method in class jakarta.mail.internet.MimeMultipart
-
Get the MimeBodyPart referred to by the given ContentID (CID).
- getBytes(InputStream) - Static method in class jakarta.mail.internet.MimeUtility
- getBytes(String) - Static method in class jakarta.mail.internet.MimeUtility
- getCause() - Method in exception jakarta.mail.MessagingException
-
Overrides the
getCause
method ofThrowable
to return the next exception in the chain of nested exceptions. - getClassName() - Method in class jakarta.mail.Provider
-
Returns the name of the class that implements the protocol.
- getComparison() - Method in class jakarta.mail.search.DateTerm
-
Return the type of comparison.
- getComparison() - Method in class jakarta.mail.search.IntegerComparisonTerm
-
Return the type of comparison.
- getContent() - Method in class jakarta.mail.internet.MimeBodyPart
-
Return the content as a Java object.
- getContent() - Method in class jakarta.mail.internet.MimeMessage
-
Return the content as a Java object.
- getContent() - Method in interface jakarta.mail.Part
-
Return the content as a Java object.
- getContentID() - Method in class jakarta.mail.internet.MimeBodyPart
-
Returns the value of the "Content-ID" header field.
- getContentID() - Method in class jakarta.mail.internet.MimeMessage
-
Returns the value of the "Content-ID" header field.
- getContentID() - Method in interface jakarta.mail.internet.MimePart
-
Get the Content-ID of this part.
- getContentLanguage() - Method in class jakarta.mail.internet.MimeBodyPart
-
Get the languages specified in the Content-Language header of this MimePart.
- getContentLanguage() - Method in class jakarta.mail.internet.MimeMessage
-
Get the languages specified in the "Content-Language" header field of this message.
- getContentLanguage() - Method in interface jakarta.mail.internet.MimePart
-
Get the language tags specified in the Content-Language header of this MimePart.
- getContentMD5() - Method in class jakarta.mail.internet.MimeBodyPart
-
Return the value of the "Content-MD5" header field.
- getContentMD5() - Method in class jakarta.mail.internet.MimeMessage
-
Return the value of the "Content-MD5" header field.
- getContentMD5() - Method in interface jakarta.mail.internet.MimePart
-
Get the Content-MD5 digest of this part.
- getContentStream() - Method in class jakarta.mail.internet.MimeBodyPart
-
Produce the raw bytes of the content.
- getContentStream() - Method in class jakarta.mail.internet.MimeMessage
-
Produce the raw bytes of the content.
- getContentType() - Method in class jakarta.mail.internet.MimeBodyPart
-
Returns the value of the RFC 822 "Content-Type" header field.
- getContentType() - Method in class jakarta.mail.internet.MimeMessage
-
Returns the value of the RFC 822 "Content-Type" header field.
- getContentType() - Method in class jakarta.mail.internet.MimePartDataSource
-
Returns the content-type of this DataSource.
- getContentType() - Method in class jakarta.mail.Multipart
-
Return the content-type of this Multipart.
- getContentType() - Method in interface jakarta.mail.Part
-
Returns the Content-Type of the content of this part.
- getContentType() - Method in class jakarta.mail.util.ByteArrayDataSource
-
Get the MIME content type of the data.
- getCount() - Method in class jakarta.mail.internet.MimeMultipart
-
Return the number of enclosed BodyPart objects.
- getCount() - Method in class jakarta.mail.Multipart
-
Return the number of enclosed BodyPart objects.
- getCount() - Method in interface jakarta.mail.MultipartDataSource
-
Return the number of enclosed BodyPart objects.
- getDataHandler() - Method in class jakarta.mail.internet.MimeBodyPart
-
Return a DataHandler for this body part's content.
- getDataHandler() - Method in class jakarta.mail.internet.MimeMessage
-
Return a DataHandler for this Message's content.
- getDataHandler() - Method in interface jakarta.mail.Part
-
Return a DataHandler for the content within this part.
- getDate() - Method in class jakarta.mail.search.DateTerm
-
Return the Date to compare with.
- getDebug() - Method in class jakarta.mail.Session
-
Get the debug setting for this Session.
- getDebugOut() - Method in class jakarta.mail.Session
-
Returns the stream to be used for debugging output.
- getDefaultFolder() - Method in class jakarta.mail.Store
-
Returns a Folder object that represents the 'root' of the default namespace presented to the user by the Store.
- getDefaultInstance(Properties) - Static method in class jakarta.mail.Session
-
Get the default Session object.
- getDefaultInstance(Properties, Authenticator) - Static method in class jakarta.mail.Session
-
Get the default Session object.
- getDefaultJavaCharset() - Static method in class jakarta.mail.internet.MimeUtility
-
Get the default charset corresponding to the system's current default locale.
- getDefaultUserName() - Method in class jakarta.mail.Authenticator
- getDeletedMessageCount() - Method in class jakarta.mail.Folder
-
Get the number of deleted messages in this Folder.
- getDescription() - Method in class jakarta.mail.internet.MimeBodyPart
-
Returns the "Content-Description" header field of this body part.
- getDescription() - Method in class jakarta.mail.internet.MimeMessage
-
Returns the "Content-Description" header field of this Message.
- getDescription() - Method in interface jakarta.mail.Part
-
Return a description String for this part.
- getDisposition() - Method in class jakarta.mail.internet.ContentDisposition
-
Return the disposition value.
- getDisposition() - Method in class jakarta.mail.internet.MimeBodyPart
-
Returns the disposition from the "Content-Disposition" header field.
- getDisposition() - Method in class jakarta.mail.internet.MimeMessage
-
Returns the disposition from the "Content-Disposition" header field.
- getDisposition() - Method in interface jakarta.mail.Part
-
Return the disposition of this part.
- getEncoder() - Method in enum jakarta.mail.util.StreamProvider.EncoderTypes
- getEncoding() - Method in interface jakarta.mail.EncodingAware
-
Return the MIME Content-Transfer-Encoding to use for this data, or null to indicate that an appropriate value should be chosen by the caller.
- getEncoding() - Method in class jakarta.mail.internet.MimeBodyPart
-
Returns the content transfer encoding from the "Content-Transfer-Encoding" header field.
- getEncoding() - Method in class jakarta.mail.internet.MimeMessage
-
Returns the content transfer encoding from the "Content-Transfer-Encoding" header field.
- getEncoding() - Method in interface jakarta.mail.internet.MimePart
-
Get the transfer encoding of this part.
- getEncoding() - Method in class jakarta.mail.internet.PreencodedMimeBodyPart
-
Returns the content transfer encoding specified when this object was created.
- getEncoding(DataHandler) - Static method in class jakarta.mail.internet.MimeUtility
-
Same as
getEncoding(DataSource)
except that instead of reading the data from anInputStream
it uses thewriteTo
method to examine the data. - getEncoding(DataSource) - Static method in class jakarta.mail.internet.MimeUtility
-
Get the Content-Transfer-Encoding that should be applied to the input stream of this DataSource, to make it mail-safe.
- getFile() - Method in class jakarta.mail.URLName
-
Returns the file name of this URLName.
- getFileName() - Method in class jakarta.mail.internet.MimeBodyPart
-
Get the filename associated with this body part.
- getFileName() - Method in class jakarta.mail.internet.MimeMessage
-
Get the filename associated with this Message.
- getFileName() - Method in interface jakarta.mail.Part
-
Get the filename associated with this part, if possible.
- getFlags() - Method in class jakarta.mail.internet.MimeMessage
-
Return a
Flags
object containing the flags for this message. - getFlags() - Method in class jakarta.mail.Message
-
Returns a
Flags
object containing the flags for this message. - getFlags() - Method in class jakarta.mail.search.FlagTerm
-
Return the Flags to test.
- getFolder() - Method in class jakarta.mail.event.FolderEvent
-
Return the affected folder.
- getFolder() - Method in exception jakarta.mail.FolderClosedException
-
Returns the dead Folder object
- getFolder() - Method in exception jakarta.mail.FolderNotFoundException
-
Returns the offending Folder object.
- getFolder() - Method in class jakarta.mail.Message
-
Get the folder from which this message was obtained.
- getFolder() - Method in exception jakarta.mail.ReadOnlyFolderException
-
Returns the Folder object.
- getFolder(URLName) - Method in class jakarta.mail.Session
-
Get a closed Folder object for the given URLName.
- getFolder(URLName) - Method in class jakarta.mail.Store
-
Return a closed Folder object, corresponding to the given URLName.
- getFolder(String) - Method in class jakarta.mail.Folder
-
Return the Folder object corresponding to the given name.
- getFolder(String) - Method in class jakarta.mail.Store
-
Return the Folder object corresponding to the given name.
- getFrom() - Method in class jakarta.mail.internet.MimeMessage
-
Returns the value of the RFC 822 "From" header fields.
- getFrom() - Method in class jakarta.mail.Message
-
Returns the "From" attribute.
- getFullName() - Method in class jakarta.mail.Folder
-
Returns the full name of this Folder.
- getGroup(boolean) - Method in class jakarta.mail.internet.InternetAddress
-
Return the members of a group address.
- getHeader(String) - Method in class jakarta.mail.internet.InternetHeaders
-
Return all the values for the specified header.
- getHeader(String) - Method in class jakarta.mail.internet.MimeBodyPart
-
Get all the headers for this header_name.
- getHeader(String) - Method in class jakarta.mail.internet.MimeMessage
-
Get all the headers for this header_name.
- getHeader(String) - Method in interface jakarta.mail.Part
-
Get all the headers for this header name.
- getHeader(String, String) - Method in class jakarta.mail.internet.InternetHeaders
-
Get all the headers for this header name, returned as a single String, with headers separated by the delimiter.
- getHeader(String, String) - Method in class jakarta.mail.internet.MimeBodyPart
-
Get all the headers for this header name, returned as a single String, with headers separated by the delimiter.
- getHeader(String, String) - Method in class jakarta.mail.internet.MimeMessage
-
Get all the headers for this header name, returned as a single String, with headers separated by the delimiter.
- getHeader(String, String) - Method in interface jakarta.mail.internet.MimePart
-
Get the values of all header fields available for this header, returned as a single String, with the values separated by the delimiter.
- getHeaderName() - Method in class jakarta.mail.search.HeaderTerm
-
Return the name of the header to compare with.
- getHeaderNames() - Method in class jakarta.mail.FetchProfile
-
Get the names of the header-fields set in this profile.
- getHost() - Method in class jakarta.mail.internet.NewsAddress
-
Get the host.
- getHost() - Method in class jakarta.mail.URLName
-
Returns the host of this URLName.
- getIgnoreCase() - Method in class jakarta.mail.search.StringTerm
-
Return true if we should ignore case when matching.
- getInputStream() - Method in class jakarta.mail.internet.MimeBodyPart
-
Return a decoded input stream for this body part's "content".
- getInputStream() - Method in class jakarta.mail.internet.MimeMessage
-
Return a decoded input stream for this Message's "content".
- getInputStream() - Method in class jakarta.mail.internet.MimePartDataSource
-
Returns an input stream from this MimePart.
- getInputStream() - Method in interface jakarta.mail.Part
-
Return an input stream for this part's "content".
- getInputStream() - Method in class jakarta.mail.util.ByteArrayDataSource
-
Return an InputStream for the data.
- getInstance(Properties) - Static method in class jakarta.mail.Session
-
Get a new Session object.
- getInstance(Properties, Authenticator) - Static method in class jakarta.mail.Session
-
Get a new Session object.
- getInvalidAddresses() - Method in class jakarta.mail.event.TransportEvent
-
Return the addresses to which this message could not be sent.
- getInvalidAddresses() - Method in exception jakarta.mail.SendFailedException
-
Return the addresses to which this message could not be sent.
- getItems() - Method in class jakarta.mail.FetchProfile
-
Get the items set in this profile.
- getLineCount() - Method in class jakarta.mail.internet.MimeBodyPart
-
Return the number of lines for the content of this Part.
- getLineCount() - Method in class jakarta.mail.internet.MimeMessage
-
Return the number of lines for the content of this message.
- getLineCount() - Method in interface jakarta.mail.Part
-
Return the number of lines in the content of this part.
- getLocalAddress(Session) - Static method in class jakarta.mail.internet.InternetAddress
-
Return an InternetAddress object representing the current user.
- getMatchingHeaderLines(String[]) - Method in class jakarta.mail.internet.InternetHeaders
-
Return all matching header lines as an Enumeration of Strings.
- getMatchingHeaderLines(String[]) - Method in class jakarta.mail.internet.MimeBodyPart
-
Get matching header lines as an Enumeration of Strings.
- getMatchingHeaderLines(String[]) - Method in class jakarta.mail.internet.MimeMessage
-
Get matching header lines as an Enumeration of Strings.
- getMatchingHeaderLines(String[]) - Method in interface jakarta.mail.internet.MimePart
-
Get matching header lines as an Enumeration of Strings.
- getMatchingHeaders(String[]) - Method in class jakarta.mail.internet.InternetHeaders
-
Return all matching
Header
objects. - getMatchingHeaders(String[]) - Method in class jakarta.mail.internet.MimeBodyPart
-
Return matching headers from this Message as an Enumeration of Header objects.
- getMatchingHeaders(String[]) - Method in class jakarta.mail.internet.MimeMessage
-
Return matching headers from this Message as an Enumeration of Header objects.
- getMatchingHeaders(String[]) - Method in interface jakarta.mail.Part
-
Return matching headers from this part as an Enumeration of Header objects.
- getMessage() - Method in class jakarta.mail.event.MessageChangedEvent
-
Return the changed Message.
- getMessage() - Method in class jakarta.mail.event.StoreEvent
-
Get the message from the Store.
- getMessage() - Method in class jakarta.mail.event.TransportEvent
-
Get the Message object associated with this Transport Event.
- getMessage() - Method in class jakarta.mail.MessageContext
-
Return the Message that contains the content.
- getMessage(int) - Method in class jakarta.mail.Folder
-
Get the Message object corresponding to the given message number.
- getMessageByUID(long) - Method in interface jakarta.mail.UIDFolder
-
Get the Message corresponding to the given UID.
- getMessageChangeType() - Method in class jakarta.mail.event.MessageChangedEvent
-
Return the type of this event.
- getMessageContext() - Method in class jakarta.mail.internet.MimePartDataSource
-
Return the
MessageContext
for the current part. - getMessageContext() - Method in interface jakarta.mail.MessageAware
-
Return the message context.
- getMessageCount() - Method in class jakarta.mail.Folder
-
Get total number of messages in this Folder.
- getMessageID() - Method in class jakarta.mail.internet.MimeMessage
-
Returns the value of the "Message-ID" header field.
- getMessageNumber() - Method in class jakarta.mail.Message
-
Get the Message number for this Message.
- getMessages() - Method in class jakarta.mail.event.MessageCountEvent
-
Return the array of messages added or removed.
- getMessages() - Method in class jakarta.mail.Folder
-
Get all Message objects from this Folder.
- getMessages(int[]) - Method in class jakarta.mail.Folder
-
Get the Message objects for message numbers specified in the array.
- getMessages(int, int) - Method in class jakarta.mail.Folder
-
Get the Message objects for message numbers ranging from start through end, both start and end inclusive.
- getMessagesByUID(long[]) - Method in interface jakarta.mail.UIDFolder
-
Get the Messages specified by the given array of UIDs.
- getMessagesByUID(long, long) - Method in interface jakarta.mail.UIDFolder
-
Get the Messages specified by the given range.
- getMessageType() - Method in class jakarta.mail.event.StoreEvent
-
Return the type of this event.
- getMode() - Method in class jakarta.mail.Folder
-
Return the open mode of this folder.
- getName() - Method in class jakarta.mail.Folder
-
Returns the name of this Folder.
- getName() - Method in class jakarta.mail.Header
-
Returns the name of this header.
- getName() - Method in class jakarta.mail.internet.MimePartDataSource
-
DataSource method to return a name.
- getName() - Method in class jakarta.mail.util.ByteArrayDataSource
-
Get the name of the data.
- getNames() - Method in class jakarta.mail.internet.ParameterList
-
Return an enumeration of the names of all parameters in this list.
- getNewFolder() - Method in class jakarta.mail.event.FolderEvent
-
If this event indicates that a folder is renamed, (i.e, the event type is RENAMED), then this method returns the Folder object representing the new name.
- getNewMessageCount() - Method in class jakarta.mail.Folder
-
Get the number of new messages in this Folder.
- getNewsgroup() - Method in class jakarta.mail.internet.NewsAddress
-
Get the newsgroup.
- getNextException() - Method in exception jakarta.mail.MessagingException
-
Get the next exception chained to this one.
- getNonMatchingHeaderLines(String[]) - Method in class jakarta.mail.internet.InternetHeaders
-
Return all non-matching header lines
- getNonMatchingHeaderLines(String[]) - Method in class jakarta.mail.internet.MimeBodyPart
-
Get non-matching header lines as an Enumeration of Strings.
- getNonMatchingHeaderLines(String[]) - Method in class jakarta.mail.internet.MimeMessage
-
Get non-matching header lines as an Enumeration of Strings.
- getNonMatchingHeaderLines(String[]) - Method in interface jakarta.mail.internet.MimePart
-
Get non-matching header lines as an Enumeration of Strings.
- getNonMatchingHeaders(String[]) - Method in class jakarta.mail.internet.InternetHeaders
-
Return all non-matching
Header
objects. - getNonMatchingHeaders(String[]) - Method in class jakarta.mail.internet.MimeBodyPart
-
Return non-matching headers from this Message as an Enumeration of Header objects.
- getNonMatchingHeaders(String[]) - Method in class jakarta.mail.internet.MimeMessage
-
Return non-matching headers from this Message as an Enumeration of Header objects.
- getNonMatchingHeaders(String[]) - Method in interface jakarta.mail.Part
-
Return non-matching headers from this envelope as an Enumeration of Header objects.
- getNumber() - Method in class jakarta.mail.search.IntegerComparisonTerm
-
Return the number to compare with.
- getOutputStream() - Method in class jakarta.mail.internet.MimePartDataSource
-
DataSource method to return an output stream.
- getOutputStream() - Method in class jakarta.mail.util.ByteArrayDataSource
-
Return an OutputStream for the data.
- getParameter(String) - Method in class jakarta.mail.internet.ContentDisposition
-
Return the specified parameter value.
- getParameter(String) - Method in class jakarta.mail.internet.ContentType
-
Return the specified parameter value.
- getParameterList() - Method in class jakarta.mail.internet.ContentDisposition
-
Return a ParameterList object that holds all the available parameters.
- getParameterList() - Method in class jakarta.mail.internet.ContentType
-
Return a ParameterList object that holds all the available parameters.
- getParent() - Method in class jakarta.mail.BodyPart
-
Return the containing
Multipart
object, ornull
if not known. - getParent() - Method in class jakarta.mail.Folder
-
Returns the parent folder of this folder.
- getParent() - Method in class jakarta.mail.Multipart
-
Return the
Part
that contains thisMultipart
object, ornull
if not known. - getPart() - Method in class jakarta.mail.MessageContext
-
Return the Part that contains the content.
- getPassword() - Method in class jakarta.mail.PasswordAuthentication
- getPassword() - Method in class jakarta.mail.URLName
-
Returns the password of this URLName.
- getPasswordAuthentication() - Method in class jakarta.mail.Authenticator
-
Called when password authentication is needed.
- getPasswordAuthentication(URLName) - Method in class jakarta.mail.Session
-
Return any saved PasswordAuthentication for this (store or transport) URLName.
- getPattern() - Method in class jakarta.mail.search.StringTerm
-
Return the string to match with.
- getPermanentFlags() - Method in class jakarta.mail.Folder
-
Get the permanent flags supported by this Folder.
- getPersonal() - Method in class jakarta.mail.internet.InternetAddress
-
Get the personal name.
- getPersonalNamespaces() - Method in class jakarta.mail.Store
-
Return a set of folders representing the personal namespaces for the current user.
- getPort() - Method in class jakarta.mail.URLName
-
Returns the port number of this URLName.
- getPos() - Method in exception jakarta.mail.internet.AddressException
-
Get the position with the reference string where the error was detected (-1 if not relevant).
- getPosition() - Method in interface jakarta.mail.internet.SharedInputStream
-
Return the current position in the InputStream, as an offset from the beginning of the InputStream.
- getPosition() - Method in class jakarta.mail.util.SharedByteArrayInputStream
-
Return the current position in the InputStream, as an offset from the beginning of the InputStream.
- getPosition() - Method in class jakarta.mail.util.SharedFileInputStream
-
Return the current position in the InputStream, as an offset from the beginning of the InputStream.
- getPreamble() - Method in class jakarta.mail.internet.MimeMultipart
-
Get the preamble text, if any, that appears before the first body part of this multipart.
- getPrimaryType() - Method in class jakarta.mail.internet.ContentType
-
Return the primary type.
- getProperties() - Method in class jakarta.mail.Session
-
Returns the Properties object associated with this Session
- getProperty(String) - Method in class jakarta.mail.Session
-
Returns the value of the specified property.
- getProtocol() - Method in class jakarta.mail.Provider
-
Returns the protocol supported by this Provider.
- getProtocol() - Method in class jakarta.mail.URLName
-
Returns the protocol of this URLName.
- getProvider(String) - Method in class jakarta.mail.Session
-
Returns the default Provider for the protocol specified.
- getProviders() - Method in class jakarta.mail.Session
-
This method returns an array of all the implementations installed via the javamail.[default.]providers files that can be loaded using the ClassLoader available to this application.
- getQuota(String) - Method in interface jakarta.mail.QuotaAwareStore
-
Get the quotas for the named folder.
- getRawInputStream() - Method in class jakarta.mail.internet.MimeBodyPart
-
Return an InputStream to the raw data with any Content-Transfer-Encoding intact.
- getRawInputStream() - Method in class jakarta.mail.internet.MimeMessage
-
Return an InputStream to the raw data with any Content-Transfer-Encoding intact.
- getReceivedDate() - Method in class jakarta.mail.internet.MimeMessage
-
Returns the Date on this message was received.
- getReceivedDate() - Method in class jakarta.mail.Message
-
Get the date this message was received.
- getRecipients(Message.RecipientType) - Method in class jakarta.mail.internet.MimeMessage
-
Returns the recepients specified by the type.
- getRecipients(Message.RecipientType) - Method in class jakarta.mail.Message
-
Get all the recipient addresses of the given type.
- getRecipientType() - Method in class jakarta.mail.search.RecipientStringTerm
-
Return the type of recipient to match with.
- getRecipientType() - Method in class jakarta.mail.search.RecipientTerm
-
Return the type of recipient to match with.
- getRef() - Method in exception jakarta.mail.internet.AddressException
-
Get the string that was being parsed when the error was detected (null if not relevant).
- getRef() - Method in class jakarta.mail.URLName
-
Returns the reference of this URLName.
- getRemainder() - Method in class jakarta.mail.internet.HeaderTokenizer
-
Return the rest of the Header.
- getReplyTo() - Method in class jakarta.mail.internet.MimeMessage
-
Return the value of the RFC 822 "Reply-To" header field.
- getReplyTo() - Method in class jakarta.mail.Message
-
Get the addresses to which replies should be directed.
- getRequestingPort() - Method in class jakarta.mail.Authenticator
- getRequestingPrompt() - Method in class jakarta.mail.Authenticator
- getRequestingProtocol() - Method in class jakarta.mail.Authenticator
-
Give the protocol that's requesting the connection.
- getRequestingSite() - Method in class jakarta.mail.Authenticator
- getSender() - Method in class jakarta.mail.internet.MimeMessage
-
Returns the value of the RFC 822 "Sender" header field.
- getSentDate() - Method in class jakarta.mail.internet.MimeMessage
-
Returns the value of the RFC 822 "Date" field.
- getSentDate() - Method in class jakarta.mail.Message
-
Get the date this message was sent.
- getSeparator() - Method in class jakarta.mail.Folder
-
Return the delimiter character that separates this Folder's pathname from the names of immediate subfolders.
- getSession() - Method in class jakarta.mail.Message
-
Return the Session used when this message was created.
- getSession() - Method in class jakarta.mail.MessageContext
-
Return the Session we're operating in.
- getSharedNamespaces() - Method in class jakarta.mail.Store
-
Return a set of folders representing the shared namespaces.
- getSize() - Method in class jakarta.mail.internet.MimeBodyPart
-
Return the size of the content of this body part in bytes.
- getSize() - Method in class jakarta.mail.internet.MimeMessage
-
Return the size of the content of this message in bytes.
- getSize() - Method in interface jakarta.mail.Part
-
Return the size of the content of this part in bytes.
- getStore() - Method in class jakarta.mail.Folder
-
Returns the Store that owns this Folder object.
- getStore() - Method in class jakarta.mail.Session
-
Get a Store object that implements this user's desired Store protocol.
- getStore() - Method in exception jakarta.mail.StoreClosedException
-
Returns the dead Store object.
- getStore(Provider) - Method in class jakarta.mail.Session
-
Get an instance of the store specified by Provider.
- getStore(URLName) - Method in class jakarta.mail.Session
-
Get a Store object for the given URLName.
- getStore(String) - Method in class jakarta.mail.Session
-
Get a Store object that implements the specified protocol.
- getStreamProvider() - Method in class jakarta.mail.Session
-
Get the stream provider instance of the session.
- getSubject() - Method in class jakarta.mail.internet.MimeMessage
-
Returns the value of the "Subject" header field.
- getSubject() - Method in class jakarta.mail.Message
-
Get the subject of this message.
- getSubType() - Method in class jakarta.mail.internet.ContentType
-
Return the subType.
- getSystemFlags() - Method in class jakarta.mail.Flags
-
Return all the system flags in this Flags object.
- getTerm() - Method in class jakarta.mail.search.NotTerm
-
Return the term to negate.
- getTerms() - Method in class jakarta.mail.search.AndTerm
-
Return the search terms.
- getTerms() - Method in class jakarta.mail.search.OrTerm
-
Return the search terms.
- getTestSet() - Method in class jakarta.mail.search.FlagTerm
-
Return true if testing whether the flags are set.
- getTransport() - Method in class jakarta.mail.Session
-
Get a Transport object that implements this user's desired Transport protcol.
- getTransport(Address) - Method in class jakarta.mail.Session
-
Get a Transport object that can transport a Message of the specified address type.
- getTransport(Provider) - Method in class jakarta.mail.Session
-
Get an instance of the transport specified in the Provider.
- getTransport(URLName) - Method in class jakarta.mail.Session
-
Get a Transport object for the given URLName.
- getTransport(String) - Method in class jakarta.mail.Session
-
Get a Transport object that implements the specified protocol.
- getType() - Method in class jakarta.mail.Address
-
Return a type string that identifies this address type.
- getType() - Method in class jakarta.mail.event.ConnectionEvent
-
Return the type of this event
- getType() - Method in class jakarta.mail.event.FolderEvent
-
Return the type of this event.
- getType() - Method in class jakarta.mail.event.MessageCountEvent
-
Return the type of this event.
- getType() - Method in class jakarta.mail.event.TransportEvent
-
Return the type of this event.
- getType() - Method in class jakarta.mail.Folder
-
Returns the type of this Folder, that is, whether this folder can hold messages or subfolders or both.
- getType() - Method in class jakarta.mail.internet.HeaderTokenizer.Token
-
Return the type of the token.
- getType() - Method in class jakarta.mail.internet.InternetAddress
-
Return the type of this address.
- getType() - Method in class jakarta.mail.internet.NewsAddress
-
Return the type of this address.
- getType() - Method in class jakarta.mail.Provider
-
Returns the type of this Provider.
- getUID(Message) - Method in interface jakarta.mail.UIDFolder
-
Get the UID for the specified message.
- getUIDNext() - Method in interface jakarta.mail.UIDFolder
-
Returns the predicted UID that will be assigned to the next message that is appended to this folder.
- getUIDValidity() - Method in interface jakarta.mail.UIDFolder
-
Returns the UIDValidity value associated with this folder.
- getUnreadMessageCount() - Method in class jakarta.mail.Folder
-
Get the total number of unread messages in this Folder.
- getURL() - Method in class jakarta.mail.URLName
-
Constructs a URL from the URLName.
- getURLName() - Method in class jakarta.mail.Folder
-
Return a URLName representing this folder.
- getURLName() - Method in class jakarta.mail.Service
-
Return a URLName representing this service.
- getUserFlags() - Method in class jakarta.mail.Flags
-
Return all the user flags in this Flags object.
- getUsername() - Method in class jakarta.mail.URLName
-
Returns the user name of this URLName.
- getUserName() - Method in class jakarta.mail.PasswordAuthentication
- getUserNamespaces(String) - Method in class jakarta.mail.Store
-
Return a set of folders representing the namespaces for
user
. - getValidSentAddresses() - Method in class jakarta.mail.event.TransportEvent
-
Return the addresses to which this message was sent succesfully.
- getValidSentAddresses() - Method in exception jakarta.mail.SendFailedException
-
Return the addresses to which this message was sent succesfully.
- getValidUnsentAddresses() - Method in class jakarta.mail.event.TransportEvent
-
Return the addresses that are valid but to which this message was not sent.
- getValidUnsentAddresses() - Method in exception jakarta.mail.SendFailedException
-
Return the addresses that are valid but to which this message was not sent.
- getValue() - Method in class jakarta.mail.Header
-
Returns the value of this header.
- getValue() - Method in class jakarta.mail.internet.HeaderTokenizer.Token
-
Returns the value of the token just read.
- getValue() - Method in class jakarta.mail.internet.InternetHeaders.InternetHeader
-
Return the "value" part of the header line.
- getVendor() - Method in class jakarta.mail.Provider
-
Returns the name of the vendor associated with this implementation or null.
- getVersion() - Method in class jakarta.mail.Provider
-
Returns the version of this implementation or null if no version.
- GT - Static variable in class jakarta.mail.search.ComparisonTerm
-
Greater than, "
>
", comparison.
H
- hashCode() - Method in class jakarta.mail.Flags
-
Compute a hash code for this Flags object.
- hashCode() - Method in class jakarta.mail.Header
- hashCode() - Method in class jakarta.mail.internet.InternetAddress
-
Compute a hash code for the address.
- hashCode() - Method in class jakarta.mail.internet.NewsAddress
-
Compute a hash code for the address.
- hashCode() - Method in class jakarta.mail.search.AddressTerm
-
Compute a hashCode for this object.
- hashCode() - Method in class jakarta.mail.search.AndTerm
-
Compute a hashCode for this object.
- hashCode() - Method in class jakarta.mail.search.ComparisonTerm
-
Compute a hashCode for this object.
- hashCode() - Method in class jakarta.mail.search.DateTerm
-
Compute a hashCode for this object.
- hashCode() - Method in class jakarta.mail.search.FlagTerm
-
Compute a hashCode for this object.
- hashCode() - Method in class jakarta.mail.search.HeaderTerm
-
Compute a hashCode for this object.
- hashCode() - Method in class jakarta.mail.search.IntegerComparisonTerm
-
Compute a hashCode for this object.
- hashCode() - Method in class jakarta.mail.search.NotTerm
-
Compute a hashCode for this object.
- hashCode() - Method in class jakarta.mail.search.OrTerm
-
Compute a hashCode for this object.
- hashCode() - Method in class jakarta.mail.search.RecipientStringTerm
-
Compute a hashCode for this object.
- hashCode() - Method in class jakarta.mail.search.RecipientTerm
-
Compute a hashCode for this object.
- hashCode() - Method in class jakarta.mail.search.StringTerm
-
Compute a hashCode for this object.
- hashCode() - Method in class jakarta.mail.URLName
-
Compute the hash code for this URLName.
- hasNewMessages() - Method in class jakarta.mail.Folder
-
Returns true if this Folder has new messages since the last time this indication was reset.
- Header - Class in jakarta.mail
-
The Header class stores a name/value pair to represent headers.
- Header(String, String) - Constructor for class jakarta.mail.Header
-
Construct a Header object.
- headers - Variable in class jakarta.mail.internet.InternetHeaders
-
The actual list of Headers, including placeholder entries.
- headers - Variable in class jakarta.mail.internet.MimeBodyPart
-
The InternetHeaders object that stores all the headers of this body part.
- headers - Variable in class jakarta.mail.internet.MimeMessage
-
The InternetHeaders object that stores the header of this message.
- HeaderTerm - Class in jakarta.mail.search
-
This class implements comparisons for Message headers.
- HeaderTerm(String, String) - Constructor for class jakarta.mail.search.HeaderTerm
-
Constructor.
- HeaderTokenizer - Class in jakarta.mail.internet
-
This class tokenizes RFC822 and MIME headers into the basic symbols specified by RFC822 and MIME.
- HeaderTokenizer(String) - Constructor for class jakarta.mail.internet.HeaderTokenizer
-
Constructor.
- HeaderTokenizer(String, String) - Constructor for class jakarta.mail.internet.HeaderTokenizer
-
Constructor.
- HeaderTokenizer(String, String, boolean) - Constructor for class jakarta.mail.internet.HeaderTokenizer
-
Constructor that takes a rfc822 style header.
- HeaderTokenizer.Token - Class in jakarta.mail.internet
-
The Token class represents tokens returned by the HeaderTokenizer.
- HOLDS_FOLDERS - Static variable in class jakarta.mail.Folder
-
This folder can contain other folders
- HOLDS_MESSAGES - Static variable in class jakarta.mail.Folder
-
This folder can contain messages
- host - Variable in class jakarta.mail.internet.NewsAddress
-
The host.
- host() - Method in annotation type jakarta.mail.MailSessionDefinition
-
Host name for the mail server.
I
- ignoreCase - Variable in class jakarta.mail.search.StringTerm
-
Ignore case when comparing?
- ignoreExistingBoundaryParameter - Variable in class jakarta.mail.internet.MimeMultipart
-
Flag corresponding to the "mail.mime.multipart.ignoreexistingboundaryparameter" property, set in the
MimeMultipart.initializeProperties()
method called from constructors and the parse method. - ignoreMissingBoundaryParameter - Variable in class jakarta.mail.internet.MimeMultipart
-
Flag corresponding to the "mail.mime.multipart.ignoremissingboundaryparameter" property, set in the
MimeMultipart.initializeProperties()
method called from constructors and the parse method. - ignoreMissingEndBoundary - Variable in class jakarta.mail.internet.MimeMultipart
-
Flag corresponding to the "mail.mime.multipart.ignoremissingendboundary" property, set in the
MimeMultipart.initializeProperties()
method called from constructors and the parse method. - IllegalWriteException - Exception in jakarta.mail
-
The exception thrown when a write is attempted on a read-only attribute of any Messaging object.
- IllegalWriteException() - Constructor for exception jakarta.mail.IllegalWriteException
-
Constructs an IllegalWriteException with no detail message.
- IllegalWriteException(String) - Constructor for exception jakarta.mail.IllegalWriteException
-
Constructs an IllegalWriteException with the specified detail message.
- IllegalWriteException(String, Exception) - Constructor for exception jakarta.mail.IllegalWriteException
-
Constructs an IllegalWriteException with the specified detail message and embedded exception.
- in - Variable in class jakarta.mail.util.SharedFileInputStream
-
The file containing the data.
- initializeProperties() - Method in class jakarta.mail.internet.MimeMultipart
-
Initialize flags that control parsing behavior, based on System properties described above in the class documentation.
- INLINE - Static variable in interface jakarta.mail.Part
-
This part should be presented inline.
- inputBase64(InputStream) - Method in interface jakarta.mail.util.StreamProvider
-
Creates a 'base64' decoder from the InputStream.
- inputBinary(InputStream) - Method in interface jakarta.mail.util.StreamProvider
-
Creates a 'binary', '7bit' and '8bit' decoder from the InputStream.
- inputLineStream(InputStream, boolean) - Method in interface jakarta.mail.util.StreamProvider
-
Creates a new LineInputStream that supports reading CRLF terminated lines containing only US-ASCII characters from an input stream
- inputQ(InputStream) - Method in interface jakarta.mail.util.StreamProvider
-
Creates a 'q' decoder from the InputStream.
- inputQP(InputStream) - Method in interface jakarta.mail.util.StreamProvider
-
Creates a 'quoted-printable' decoder from the InputStream.
- inputSharedByteArray(byte[]) - Method in interface jakarta.mail.util.StreamProvider
-
Creates a new InputStream from the underlying byte array to be shared between multiple readers.
- inputUU(InputStream) - Method in interface jakarta.mail.util.StreamProvider
-
Creates a 'uuencode', 'x-uuencode' and 'x-uue' decoder from the InputStream.
- IntegerComparisonTerm - Class in jakarta.mail.search
-
This class implements comparisons for integers.
- IntegerComparisonTerm(int, int) - Constructor for class jakarta.mail.search.IntegerComparisonTerm
-
Constructor.
- InternetAddress - Class in jakarta.mail.internet
-
This class represents an Internet email address using the syntax of RFC822.
- InternetAddress() - Constructor for class jakarta.mail.internet.InternetAddress
-
Default constructor.
- InternetAddress(String) - Constructor for class jakarta.mail.internet.InternetAddress
-
Constructor.
- InternetAddress(String, boolean) - Constructor for class jakarta.mail.internet.InternetAddress
-
Parse the given string and create an InternetAddress.
- InternetAddress(String, String) - Constructor for class jakarta.mail.internet.InternetAddress
-
Construct an InternetAddress given the address and personal name.
- InternetAddress(String, String, String) - Constructor for class jakarta.mail.internet.InternetAddress
-
Construct an InternetAddress given the address and personal name.
- InternetHeader(String) - Constructor for class jakarta.mail.internet.InternetHeaders.InternetHeader
-
Constructor that takes a line and splits out the header name.
- InternetHeader(String, String) - Constructor for class jakarta.mail.internet.InternetHeaders.InternetHeader
-
Constructor that takes a header name and value.
- InternetHeaders - Class in jakarta.mail.internet
-
InternetHeaders is a utility class that manages RFC822 style headers.
- InternetHeaders() - Constructor for class jakarta.mail.internet.InternetHeaders
-
Create an empty InternetHeaders object.
- InternetHeaders(InputStream) - Constructor for class jakarta.mail.internet.InternetHeaders
-
Read and parse the given RFC822 message stream till the blank line separating the header from the body.
- InternetHeaders(InputStream, boolean) - Constructor for class jakarta.mail.internet.InternetHeaders
-
Read and parse the given RFC822 message stream till the blank line separating the header from the body.
- InternetHeaders.InternetHeader - Class in jakarta.mail.internet
-
An individual internet header.
- invalid - Variable in class jakarta.mail.event.TransportEvent
-
The invalid addresses.
- invalid - Variable in exception jakarta.mail.SendFailedException
-
The invalid addresses.
- isComplete() - Method in class jakarta.mail.internet.MimeMultipart
-
Return true if the final boundary line for this multipart was seen.
- isConnected() - Method in class jakarta.mail.Service
-
Is this service currently connected?
- isExpunged() - Method in class jakarta.mail.Message
-
Checks whether this message is expunged.
- isGroup() - Method in class jakarta.mail.internet.InternetAddress
-
Indicates whether this address is an RFC 822 group address.
- isMimeType(String) - Method in class jakarta.mail.internet.MimeBodyPart
-
Is this Part of the specified MIME type? This method compares only the
primaryType
andsubType
. - isMimeType(String) - Method in class jakarta.mail.internet.MimeMessage
-
Is this Part of the specified MIME type? This method compares only the
primaryType
andsubType
. - isMimeType(String) - Method in interface jakarta.mail.Part
-
Is this Part of the specified MIME type? This method compares only the
primaryType
andsubType
. - isOpen() - Method in class jakarta.mail.Folder
-
Indicates whether this Folder is in the 'open' state.
- isRemoved() - Method in class jakarta.mail.event.MessageCountEvent
-
Indicates whether this event is the result of an explicit expunge by this client, or due to an expunge from external sources.
- isSet(Flags.Flag) - Method in class jakarta.mail.internet.MimeMessage
-
Check whether the flag specified in the
flag
argument is set in this message. - isSet(Flags.Flag) - Method in class jakarta.mail.Message
-
Check whether the flag specified in the
flag
argument is set in this message. - isSubscribed() - Method in class jakarta.mail.Folder
-
Returns true if this Folder is subscribed.
- Item(String) - Constructor for class jakarta.mail.FetchProfile.Item
-
Constructor for an item.
J
- jakarta.mail - module jakarta.mail
-
Jakarta Mail API
- jakarta.mail - package jakarta.mail
-
The Jakarta Mail API provides classes that model a mail system.
- jakarta.mail.event - package jakarta.mail.event
-
Listeners and events for the Jakarta Mail API.
- jakarta.mail.internet - package jakarta.mail.internet
-
Classes specific to Internet mail systems.
- jakarta.mail.search - package jakarta.mail.search
-
Message search terms for the Jakarta Mail API.
- jakarta.mail.util - package jakarta.mail.util
-
Jakarta Mail API utility classes.
- javaCharset(String) - Static method in class jakarta.mail.internet.MimeUtility
-
Convert a MIME charset name into a valid Java charset name.
L
- LASTUID - Static variable in interface jakarta.mail.UIDFolder
-
This is a special value that can be used as the
end
parameter ingetMessagesByUID(start, end)
, to denote the UID of the last message in the folder. - LE - Static variable in class jakarta.mail.search.ComparisonTerm
-
Less than or equal to, "
<=
", comparison. - limit - Variable in class jakarta.mail.Quota.Resource
-
The usage limit for the resource.
- LineInputStream - Interface in jakarta.mail.util
-
LineInputStream supports reading CRLF terminated lines that contain only US-ASCII characters from an input stream.
- LineOutputStream - Interface in jakarta.mail.util
-
This interface is to support writing out Strings as a sequence of bytes terminated by a CRLF sequence.
- list() - Method in class jakarta.mail.Folder
-
Convenience method that returns the list of folders under this Folder.
- list(String) - Method in class jakarta.mail.Folder
-
Returns a list of Folders belonging to this Folder's namespace that match the specified pattern.
- listSubscribed() - Method in class jakarta.mail.Folder
-
Convenience method that returns the list of subscribed folders under this Folder.
- listSubscribed(String) - Method in class jakarta.mail.Folder
-
Returns a list of subscribed Folders belonging to this Folder's namespace that match the specified pattern.
- load(InputStream) - Method in class jakarta.mail.internet.InternetHeaders
-
Read and parse the given RFC822 message stream till the blank line separating the header from the body.
- load(InputStream, boolean) - Method in class jakarta.mail.internet.InternetHeaders
-
Read and parse the given RFC822 message stream till the blank line separating the header from the body.
- LT - Static variable in class jakarta.mail.search.ComparisonTerm
-
Less than, "
<
", comparison.
M
- MailDateFormat - Class in jakarta.mail.internet
-
Formats and parses date specification based on RFC 2822.
- MailDateFormat() - Constructor for class jakarta.mail.internet.MailDateFormat
-
Create a new date format for the RFC2822 specification with lenient parsing.
- MailEvent - Class in jakarta.mail.event
-
Common base class for mail events, defining the dispatch method.
- MailEvent(Object) - Constructor for class jakarta.mail.event.MailEvent
-
Construct a MailEvent referring to the given source.
- MailSessionDefinition - Annotation Type in jakarta.mail
-
Annotation used by Jakarta EE applications to define a
MailSession
to be registered with JNDI. - MailSessionDefinitions - Annotation Type in jakarta.mail
-
Declares one or more
MailSessionDefinition
annotations. - mark(int) - Method in class jakarta.mail.util.SharedFileInputStream
-
See the general contract of the
mark
method ofInputStream
. - markSupported() - Method in class jakarta.mail.util.SharedFileInputStream
-
Tests if this input stream supports the
mark
andreset
methods. - match(int) - Method in class jakarta.mail.search.IntegerComparisonTerm
-
Match against the argument
i
. - match(Address) - Method in class jakarta.mail.search.AddressStringTerm
-
Check whether the address pattern specified in the constructor is a substring of the string representation of the given Address object.
- match(Address) - Method in class jakarta.mail.search.AddressTerm
-
Match against the argument Address.
- match(ContentType) - Method in class jakarta.mail.internet.ContentType
-
Match with the specified ContentType object.
- match(Message) - Method in class jakarta.mail.search.AndTerm
-
The AND operation.
- match(Message) - Method in class jakarta.mail.search.BodyTerm
-
The match method.
- match(Message) - Method in class jakarta.mail.search.FlagTerm
-
The comparison method.
- match(Message) - Method in class jakarta.mail.search.FromStringTerm
-
Check whether the address string specified in the constructor is a substring of the From address of this Message.
- match(Message) - Method in class jakarta.mail.search.FromTerm
-
The address comparator.
- match(Message) - Method in class jakarta.mail.search.HeaderTerm
-
The header match method.
- match(Message) - Method in class jakarta.mail.search.MessageIDTerm
-
The match method.
- match(Message) - Method in class jakarta.mail.search.MessageNumberTerm
-
The match method.
- match(Message) - Method in class jakarta.mail.search.NotTerm
- match(Message) - Method in class jakarta.mail.search.OrTerm
-
The OR operation.
- match(Message) - Method in class jakarta.mail.search.ReceivedDateTerm
-
The match method.
- match(Message) - Method in class jakarta.mail.search.RecipientStringTerm
-
Check whether the address specified in the constructor is a substring of the recipient address of this Message.
- match(Message) - Method in class jakarta.mail.search.RecipientTerm
-
The match method.
- match(Message) - Method in class jakarta.mail.search.SearchTerm
-
This method applies a specific match criterion to the given message and returns the result.
- match(Message) - Method in class jakarta.mail.search.SentDateTerm
-
The match method.
- match(Message) - Method in class jakarta.mail.search.SizeTerm
-
The match method.
- match(Message) - Method in class jakarta.mail.search.SubjectTerm
-
The match method.
- match(SearchTerm) - Method in class jakarta.mail.Message
-
Apply the specified Search criterion to this message.
- match(String) - Method in class jakarta.mail.internet.ContentType
-
Match with the specified content-type string.
- match(String) - Method in class jakarta.mail.search.StringTerm
-
The match method.
- match(Date) - Method in class jakarta.mail.search.DateTerm
-
The date comparison method.
- MAXUID - Static variable in interface jakarta.mail.UIDFolder
-
The largest value possible for a UID, a 32-bit unsigned integer.
- message - Variable in class jakarta.mail.event.StoreEvent
-
The message text to be presented to the user.
- Message - Class in jakarta.mail
-
This class models an email message.
- Message() - Constructor for class jakarta.mail.Message
-
No-arg version of the constructor.
- Message(Folder, int) - Constructor for class jakarta.mail.Message
-
Constructor that takes a Folder and a message number.
- Message(Session) - Constructor for class jakarta.mail.Message
-
Constructor that takes a Session.
- MESSAGE_DELIVERED - Static variable in class jakarta.mail.event.TransportEvent
-
Message has been successfully delivered to all recipients by the transport firing this event.
- MESSAGE_NOT_DELIVERED - Static variable in class jakarta.mail.event.TransportEvent
-
Message was not sent for some reason.
- MESSAGE_PARTIALLY_DELIVERED - Static variable in class jakarta.mail.event.TransportEvent
-
Message was successfully sent to some recipients but not to all.
- Message.RecipientType - Class in jakarta.mail
-
This inner class defines the types of recipients allowed by the Message class.
- MessageAware - Interface in jakarta.mail
-
An interface optionally implemented by
DataSources
to supply information to aDataContentHandler
about the message context in which the data content object is operating. - messageChanged(MessageChangedEvent) - Method in interface jakarta.mail.event.MessageChangedListener
-
Invoked when a message is changed.
- MessageChangedEvent - Class in jakarta.mail.event
-
This class models Message change events.
- MessageChangedEvent(Object, int, Message) - Constructor for class jakarta.mail.event.MessageChangedEvent
-
Constructor.
- MessageChangedListener - Interface in jakarta.mail.event
-
This is the Listener interface for MessageChanged events
- MessageContext - Class in jakarta.mail
-
The context in which a piece of Message content is contained.
- MessageContext(Part) - Constructor for class jakarta.mail.MessageContext
-
Create a MessageContext object describing the context of the given Part.
- MessageCountAdapter - Class in jakarta.mail.event
-
The adapter which receives MessageCount events.
- MessageCountAdapter() - Constructor for class jakarta.mail.event.MessageCountAdapter
-
Creates a default
MessageCountAdapter
. - MessageCountEvent - Class in jakarta.mail.event
-
This class notifies changes in the number of messages in a folder.
- MessageCountEvent(Folder, int, boolean, Message[]) - Constructor for class jakarta.mail.event.MessageCountEvent
-
Constructor.
- MessageCountListener - Interface in jakarta.mail.event
-
This is the Listener interface for MessageCount events.
- messageDelivered(TransportEvent) - Method in class jakarta.mail.event.TransportAdapter
- messageDelivered(TransportEvent) - Method in interface jakarta.mail.event.TransportListener
-
Invoked when a Message is succesfully delivered.
- MessageIDTerm - Class in jakarta.mail.search
-
This term models the RFC822 "MessageId" - a message-id for Internet messages that is supposed to be unique per message.
- MessageIDTerm(String) - Constructor for class jakarta.mail.search.MessageIDTerm
-
Constructor.
- messageNotDelivered(TransportEvent) - Method in class jakarta.mail.event.TransportAdapter
- messageNotDelivered(TransportEvent) - Method in interface jakarta.mail.event.TransportListener
-
Invoked when a Message is not delivered.
- MessageNumberTerm - Class in jakarta.mail.search
-
This class implements comparisons for Message numbers.
- MessageNumberTerm(int) - Constructor for class jakarta.mail.search.MessageNumberTerm
-
Constructor.
- messagePartiallyDelivered(TransportEvent) - Method in class jakarta.mail.event.TransportAdapter
- messagePartiallyDelivered(TransportEvent) - Method in interface jakarta.mail.event.TransportListener
-
Invoked when a Message is partially delivered.
- MessageRemovedException - Exception in jakarta.mail
-
The exception thrown when an invalid method is invoked on an expunged Message.
- MessageRemovedException() - Constructor for exception jakarta.mail.MessageRemovedException
-
Constructs a MessageRemovedException with no detail message.
- MessageRemovedException(String) - Constructor for exception jakarta.mail.MessageRemovedException
-
Constructs a MessageRemovedException with the specified detail message.
- MessageRemovedException(String, Exception) - Constructor for exception jakarta.mail.MessageRemovedException
-
Constructs a MessageRemovedException with the specified detail message and embedded exception.
- messagesAdded(MessageCountEvent) - Method in class jakarta.mail.event.MessageCountAdapter
- messagesAdded(MessageCountEvent) - Method in interface jakarta.mail.event.MessageCountListener
-
Invoked when messages are added into a folder.
- messagesRemoved(MessageCountEvent) - Method in class jakarta.mail.event.MessageCountAdapter
- messagesRemoved(MessageCountEvent) - Method in interface jakarta.mail.event.MessageCountListener
-
Invoked when messages are removed (expunged) from a folder.
- MessagingException - Exception in jakarta.mail
-
The base class for all exceptions thrown by the Messaging classes
- MessagingException() - Constructor for exception jakarta.mail.MessagingException
-
Constructs a MessagingException with no detail message.
- MessagingException(String) - Constructor for exception jakarta.mail.MessagingException
-
Constructs a MessagingException with the specified detail message.
- MessagingException(String, Exception) - Constructor for exception jakarta.mail.MessagingException
-
Constructs a MessagingException with the specified Exception and detail message.
- MethodNotSupportedException - Exception in jakarta.mail
-
The exception thrown when a method is not supported by the implementation
- MethodNotSupportedException() - Constructor for exception jakarta.mail.MethodNotSupportedException
-
Constructs a MethodNotSupportedException with no detail message.
- MethodNotSupportedException(String) - Constructor for exception jakarta.mail.MethodNotSupportedException
-
Constructs a MethodNotSupportedException with the specified detail message.
- MethodNotSupportedException(String, Exception) - Constructor for exception jakarta.mail.MethodNotSupportedException
-
Constructs a MethodNotSupportedException with the specified detail message and embedded exception.
- MIME - Static variable in class jakarta.mail.internet.HeaderTokenizer
-
MIME specials
- MimeBodyPart - Class in jakarta.mail.internet
-
This class represents a MIME body part.
- MimeBodyPart() - Constructor for class jakarta.mail.internet.MimeBodyPart
-
An empty MimeBodyPart object is created.
- MimeBodyPart(InternetHeaders, byte[]) - Constructor for class jakarta.mail.internet.MimeBodyPart
-
Constructs a MimeBodyPart using the given header and content bytes.
- MimeBodyPart(InputStream) - Constructor for class jakarta.mail.internet.MimeBodyPart
-
Constructs a MimeBodyPart by reading and parsing the data from the specified input stream.
- mimeCharset(String) - Static method in class jakarta.mail.internet.MimeUtility
-
Convert a java charset into its MIME charset name.
- MimeMessage - Class in jakarta.mail.internet
-
This class represents a MIME style email message.
- MimeMessage(Folder, int) - Constructor for class jakarta.mail.internet.MimeMessage
-
Constructs an empty MimeMessage object with the given Folder and message number.
- MimeMessage(Folder, InternetHeaders, byte[], int) - Constructor for class jakarta.mail.internet.MimeMessage
-
Constructs a MimeMessage from the given InternetHeaders object and content.
- MimeMessage(Folder, InputStream, int) - Constructor for class jakarta.mail.internet.MimeMessage
-
Constructs a MimeMessage by reading and parsing the data from the specified MIME InputStream.
- MimeMessage(MimeMessage) - Constructor for class jakarta.mail.internet.MimeMessage
-
Constructs a new MimeMessage with content initialized from the
source
MimeMessage. - MimeMessage(Session) - Constructor for class jakarta.mail.internet.MimeMessage
-
Default constructor.
- MimeMessage(Session, InputStream) - Constructor for class jakarta.mail.internet.MimeMessage
-
Constructs a MimeMessage by reading and parsing the data from the specified MIME InputStream.
- MimeMessage.RecipientType - Class in jakarta.mail.internet
-
This inner class extends the jakarta.mail.Message.RecipientType class to add additional RecipientTypes.
- MimeMultipart - Class in jakarta.mail.internet
-
The MimeMultipart class is an implementation of the abstract Multipart class that uses MIME conventions for the multipart data.
- MimeMultipart() - Constructor for class jakarta.mail.internet.MimeMultipart
-
Default constructor.
- MimeMultipart(DataSource) - Constructor for class jakarta.mail.internet.MimeMultipart
-
Constructs a MimeMultipart object and its bodyparts from the given DataSource.
- MimeMultipart(BodyPart...) - Constructor for class jakarta.mail.internet.MimeMultipart
-
Construct a MimeMultipart object of the default "mixed" subtype, and with the given body parts.
- MimeMultipart(String) - Constructor for class jakarta.mail.internet.MimeMultipart
-
Construct a MimeMultipart object of the given subtype.
- MimeMultipart(String, BodyPart...) - Constructor for class jakarta.mail.internet.MimeMultipart
-
Construct a MimeMultipart object of the given subtype and with the given body parts.
- MimePart - Interface in jakarta.mail.internet
-
The MimePart interface models an Entity as defined by MIME (RFC2045, Section 2.4).
- MimePartDataSource - Class in jakarta.mail.internet
-
A utility class that implements a DataSource out of a MimePart.
- MimePartDataSource(MimePart) - Constructor for class jakarta.mail.internet.MimePartDataSource
-
Constructor, that constructs a DataSource from a MimePart.
- MimeUtility - Class in jakarta.mail.internet
-
This is a utility class that provides various MIME related functionality.
- mode - Variable in class jakarta.mail.Folder
-
The open mode of this folder.
- modified - Variable in class jakarta.mail.internet.MimeMessage
-
A flag indicating whether the message has been modified.
- msg - Variable in class jakarta.mail.event.MessageChangedEvent
-
The message that changed.
- msg - Variable in class jakarta.mail.event.TransportEvent
-
The Message to which this event applies.
- msgnum - Variable in class jakarta.mail.Message
-
The number of this message within its folder, or zero if the message was not retrieved from a folder.
- msgs - Variable in class jakarta.mail.event.MessageCountEvent
-
The messages.
- Multipart - Class in jakarta.mail
-
Multipart is a container that holds multiple body parts.
- Multipart() - Constructor for class jakarta.mail.Multipart
-
Default constructor.
- MultipartDataSource - Interface in jakarta.mail
-
MultipartDataSource is a
DataSource
that contains body parts.
N
- name - Variable in class jakarta.mail.Header
-
The name of the header.
- name - Variable in class jakarta.mail.Quota.Resource
-
The name of the resource.
- name() - Method in annotation type jakarta.mail.MailSessionDefinition
-
JNDI name by which the mail session will be registered.
- NE - Static variable in class jakarta.mail.search.ComparisonTerm
-
Not equal to, "
!=
", comparison. - newFolder - Variable in class jakarta.mail.event.FolderEvent
-
The folder that represents the new name, in case of a RENAMED event.
- NewsAddress - Class in jakarta.mail.internet
-
This class models an RFC1036 newsgroup address.
- NewsAddress() - Constructor for class jakarta.mail.internet.NewsAddress
-
Default constructor.
- NewsAddress(String) - Constructor for class jakarta.mail.internet.NewsAddress
-
Construct a NewsAddress with the given newsgroup.
- NewsAddress(String, String) - Constructor for class jakarta.mail.internet.NewsAddress
-
Construct a NewsAddress with the given newsgroup and host.
- newsgroup - Variable in class jakarta.mail.internet.NewsAddress
-
The newsgroup.
- NEWSGROUPS - Static variable in class jakarta.mail.internet.MimeMessage.RecipientType
-
The "Newsgroup" (Usenet news) recipients.
- newStream(long, long) - Method in interface jakarta.mail.internet.SharedInputStream
-
Return a new InputStream representing a subset of the data from this InputStream, starting at
start
(inclusive) up toend
(exclusive). - newStream(long, long) - Method in class jakarta.mail.util.SharedByteArrayInputStream
-
Return a new InputStream representing a subset of the data from this InputStream, starting at
start
(inclusive) up toend
(exclusive). - newStream(long, long) - Method in class jakarta.mail.util.SharedFileInputStream
-
Return a new InputStream representing a subset of the data from this InputStream, starting at
start
(inclusive) up toend
(exclusive). - next() - Method in class jakarta.mail.internet.HeaderTokenizer
-
Parses the next token from this String.
- next(char) - Method in class jakarta.mail.internet.HeaderTokenizer
-
Parses the next token from this String.
- next(char, boolean) - Method in class jakarta.mail.internet.HeaderTokenizer
-
Parses the next token from this String.
- NoSuchProviderException - Exception in jakarta.mail
-
This exception is thrown when Session attempts to instantiate a Provider that doesn't exist.
- NoSuchProviderException() - Constructor for exception jakarta.mail.NoSuchProviderException
-
Constructs a NoSuchProviderException with no detail message.
- NoSuchProviderException(String) - Constructor for exception jakarta.mail.NoSuchProviderException
-
Constructs a NoSuchProviderException with the specified detail message.
- NoSuchProviderException(String, Exception) - Constructor for exception jakarta.mail.NoSuchProviderException
-
Constructs a NoSuchProviderException with the specified detail message and embedded exception.
- NOTICE - Static variable in class jakarta.mail.event.StoreEvent
-
Indicates that this message is a NOTICE.
- notification(StoreEvent) - Method in interface jakarta.mail.event.StoreListener
-
Invoked when the Store generates a notification event.
- notifyConnectionListeners(int) - Method in class jakarta.mail.Folder
-
Notify all ConnectionListeners.
- notifyConnectionListeners(int) - Method in class jakarta.mail.Service
-
Notify all ConnectionListeners.
- notifyFolderListeners(int) - Method in class jakarta.mail.Folder
-
Notify all FolderListeners registered on this Folder and this folder's Store.
- notifyFolderListeners(int, Folder) - Method in class jakarta.mail.Store
-
Notify all FolderListeners.
- notifyFolderRenamedListeners(Folder) - Method in class jakarta.mail.Folder
-
Notify all FolderListeners registered on this Folder and this folder's Store about the renaming of this folder.
- notifyFolderRenamedListeners(Folder, Folder) - Method in class jakarta.mail.Store
-
Notify all FolderListeners about the renaming of a folder.
- notifyMessageAddedListeners(Message[]) - Method in class jakarta.mail.Folder
-
Notify all MessageCountListeners about the addition of messages into this folder.
- notifyMessageChangedListeners(int, Message) - Method in class jakarta.mail.Folder
-
Notify all MessageChangedListeners.
- notifyMessageRemovedListeners(boolean, Message[]) - Method in class jakarta.mail.Folder
-
Notify all MessageCountListeners about the removal of messages from this Folder.
- notifyStoreListeners(int, String) - Method in class jakarta.mail.Store
-
Notify all StoreListeners.
- notifyTransportListeners(int, Address[], Address[], Address[], Message) - Method in class jakarta.mail.Transport
-
Notify all TransportListeners.
- NotTerm - Class in jakarta.mail.search
-
This class implements the logical NEGATION operator.
- NotTerm(SearchTerm) - Constructor for class jakarta.mail.search.NotTerm
-
Constructor.
- number - Variable in class jakarta.mail.search.IntegerComparisonTerm
-
The number.
O
- open(int) - Method in class jakarta.mail.Folder
-
Open this Folder.
- opened(ConnectionEvent) - Method in class jakarta.mail.event.ConnectionAdapter
- opened(ConnectionEvent) - Method in interface jakarta.mail.event.ConnectionListener
-
Invoked when a Store/Folder/Transport is opened.
- OPENED - Static variable in class jakarta.mail.event.ConnectionEvent
-
A connection was opened.
- OrTerm - Class in jakarta.mail.search
-
This class implements the logical OR operator on individual SearchTerms.
- OrTerm(SearchTerm[]) - Constructor for class jakarta.mail.search.OrTerm
-
Constructor that takes an array of SearchTerms.
- OrTerm(SearchTerm, SearchTerm) - Constructor for class jakarta.mail.search.OrTerm
-
Constructor that takes two operands.
- outputB(OutputStream) - Method in interface jakarta.mail.util.StreamProvider
-
Creates a 'b' encoder from the OutputStream.
- outputBase64(OutputStream) - Method in interface jakarta.mail.util.StreamProvider
-
Creates a 'base64' encoder from the OutputStream.
- outputBinary(OutputStream) - Method in interface jakarta.mail.util.StreamProvider
-
Creates a 'binary', '7bit' and '8bit' encoder from the OutputStream.
- outputLineStream(OutputStream, boolean) - Method in interface jakarta.mail.util.StreamProvider
-
Creates a new LineOutputStream that supports writing out Strings as a sequence of bytes terminated by a CRLF sequence.
- outputQ(OutputStream, boolean) - Method in interface jakarta.mail.util.StreamProvider
-
Creates a 'q' encoder.
- outputQP(OutputStream) - Method in interface jakarta.mail.util.StreamProvider
-
Creates a 'quoted-printable' encoder from the OutputStream.
- outputUU(OutputStream, String) - Method in interface jakarta.mail.util.StreamProvider
-
Creates a 'uuencode', 'x-uuencode' and 'x-uue' encoder from the OutputStream.
P
- ParameterList - Class in jakarta.mail.internet
-
This class holds MIME parameters (attribute-value pairs).
- ParameterList() - Constructor for class jakarta.mail.internet.ParameterList
-
No-arg Constructor.
- ParameterList(String) - Constructor for class jakarta.mail.internet.ParameterList
-
Constructor that takes a parameter-list string.
- parent - Variable in class jakarta.mail.BodyPart
-
The
Multipart
object containing thisBodyPart
, if known. - parent - Variable in class jakarta.mail.Multipart
-
The
Part
containing thisMultipart
, if known. - parse() - Method in class jakarta.mail.internet.MimeMultipart
-
Parse the InputStream from our DataSource, constructing the appropriate MimeBodyParts.
- parse(InputStream) - Method in class jakarta.mail.internet.MimeMessage
-
Parse the InputStream setting the
headers
andcontent
fields appropriately. - parse(String) - Static method in class jakarta.mail.internet.InternetAddress
-
Parse the given comma separated sequence of addresses into InternetAddress objects.
- parse(String) - Static method in class jakarta.mail.internet.NewsAddress
-
Parse the given comma separated sequence of newsgroups into NewsAddress objects.
- parse(String, boolean) - Static method in class jakarta.mail.internet.InternetAddress
-
Parse the given sequence of addresses into InternetAddress objects.
- parse(String, ParsePosition) - Method in class jakarta.mail.internet.MailDateFormat
-
Parses the given date in the format specified by RFC 2822.
- parsed - Variable in class jakarta.mail.internet.MimeMultipart
-
Have we parsed the data from our InputStream yet? Defaults to true; set to false when our constructor is given a DataSource with an InputStream that we need to parse.
- ParseException - Exception in jakarta.mail.internet
-
The exception thrown due to an error in parsing RFC822 or MIME headers, including multipart bodies.
- ParseException() - Constructor for exception jakarta.mail.internet.ParseException
-
Constructs a ParseException with no detail message.
- ParseException(String) - Constructor for exception jakarta.mail.internet.ParseException
-
Constructs a ParseException with the specified detail message.
- parseHeader(String, boolean) - Static method in class jakarta.mail.internet.InternetAddress
-
Parse the given sequence of addresses into InternetAddress objects.
- parseString(String) - Method in class jakarta.mail.URLName
-
Method which does all of the work of parsing the string.
- part - Variable in class jakarta.mail.internet.MimePartDataSource
-
The MimePart that provides the data for this DataSource.
- Part - Interface in jakarta.mail
-
The
Part
interface is the common base interface for Messages and BodyParts. - parts - Variable in class jakarta.mail.Multipart
-
Vector of BodyPart objects.
- password() - Method in annotation type jakarta.mail.MailSessionDefinition
-
Password to use for authentication.
- PasswordAuthentication - Class in jakarta.mail
-
The class PasswordAuthentication is a data holder that is used by Authenticator.
- PasswordAuthentication(String, String) - Constructor for class jakarta.mail.PasswordAuthentication
-
Initialize a new PasswordAuthentication
- pattern - Variable in class jakarta.mail.search.StringTerm
-
The pattern.
- peek() - Method in class jakarta.mail.internet.HeaderTokenizer
-
Peek at the next token, without actually removing the token from the parse stream.
- personal - Variable in class jakarta.mail.internet.InternetAddress
-
The personal name.
- pos - Variable in exception jakarta.mail.internet.AddressException
-
The index in the string where the error occurred, or -1 if not known.
- preamble - Variable in class jakarta.mail.internet.MimeMultipart
-
The MIME multipart preamble text, the text that occurs before the first boundary line.
- PreencodedMimeBodyPart - Class in jakarta.mail.internet
-
A MimeBodyPart that handles data that has already been encoded.
- PreencodedMimeBodyPart(String) - Constructor for class jakarta.mail.internet.PreencodedMimeBodyPart
-
Create a PreencodedMimeBodyPart that assumes the data is encoded using the specified encoding.
- properties() - Method in annotation type jakarta.mail.MailSessionDefinition
-
Properties to include in the Session.
- protocolConnect(String, int, String, String) - Method in class jakarta.mail.Service
-
The service implementation should override this method to perform the actual protocol-specific connection attempt.
- provider() - Static method in interface jakarta.mail.util.StreamProvider
-
Creates a stream provider object.
- Provider - Class in jakarta.mail
-
The Provider is a class that describes a protocol implementation.
- Provider(Provider.Type, String, String, String, String) - Constructor for class jakarta.mail.Provider
-
Create a new provider of the specified type for the specified protocol.
- Provider.Type - Class in jakarta.mail
-
This inner class defines the Provider type.
Q
- Q_ENCODER - jakarta.mail.util.StreamProvider.EncoderTypes
- queueEvent(MailEvent, Vector<? extends EventListener>) - Method in class jakarta.mail.Service
-
Add the event and vector of listeners to the queue to be delivered.
- Quota - Class in jakarta.mail
-
This class represents a set of quotas for a given quota root.
- Quota(String) - Constructor for class jakarta.mail.Quota
-
Create a Quota object for the named quotaroot with no associated resources.
- Quota.Resource - Class in jakarta.mail
-
An individual resource in a quota root.
- QuotaAwareStore - Interface in jakarta.mail
-
An interface implemented by Stores that support quotas.
- quotaRoot - Variable in class jakarta.mail.Quota
-
The name of the quota root.
- quote(String, String) - Static method in class jakarta.mail.internet.MimeUtility
-
A utility method to quote a word, if the word contains any characters from the specified 'specials' list.
- QUOTED_PRINTABLE_ENCODER - jakarta.mail.util.StreamProvider.EncoderTypes
- QUOTEDSTRING - Static variable in class jakarta.mail.internet.HeaderTokenizer.Token
-
Token type indicating a quoted string.
R
- read() - Method in class jakarta.mail.util.SharedFileInputStream
-
See the general contract of the
read
method ofInputStream
. - read(byte[], int, int) - Method in class jakarta.mail.util.SharedFileInputStream
-
Reads bytes from this stream into the specified byte array, starting at the given offset.
- READ_ONLY - Static variable in class jakarta.mail.Folder
-
The Folder is read only.
- READ_WRITE - Static variable in class jakarta.mail.Folder
-
The state and contents of this folder can be modified.
- readLine() - Method in interface jakarta.mail.util.LineInputStream
-
Read a line containing only ASCII characters from the input stream.
- ReadOnlyFolderException - Exception in jakarta.mail
-
This exception is thrown when an attempt is made to open a folder read-write access when the folder is marked read-only.
- ReadOnlyFolderException(Folder) - Constructor for exception jakarta.mail.ReadOnlyFolderException
-
Constructs a ReadOnlyFolderException with the specified folder and no detail message.
- ReadOnlyFolderException(Folder, String) - Constructor for exception jakarta.mail.ReadOnlyFolderException
-
Constructs a ReadOnlyFolderException with the specified detail message.
- ReadOnlyFolderException(Folder, String, Exception) - Constructor for exception jakarta.mail.ReadOnlyFolderException
-
Constructs a ReadOnlyFolderException with the specified detail message and embedded exception.
- readResolve() - Method in class jakarta.mail.internet.MimeMessage.RecipientType
- readResolve() - Method in class jakarta.mail.Message.RecipientType
-
When deserializing a RecipientType, we need to make sure to return only one of the known static final instances defined in this class.
- ReceivedDateTerm - Class in jakarta.mail.search
-
This class implements comparisons for the Message Received date
- ReceivedDateTerm(int, Date) - Constructor for class jakarta.mail.search.ReceivedDateTerm
-
Constructor.
- RECENT - Static variable in class jakarta.mail.Flags.Flag
-
This message is recent.
- RecipientStringTerm - Class in jakarta.mail.search
-
This class implements string comparisons for the Recipient Address headers.
- RecipientStringTerm(Message.RecipientType, String) - Constructor for class jakarta.mail.search.RecipientStringTerm
-
Constructor.
- RecipientTerm - Class in jakarta.mail.search
-
This class implements comparisons for the Recipient Address headers.
- RecipientTerm(Message.RecipientType, Address) - Constructor for class jakarta.mail.search.RecipientTerm
-
Constructor.
- RecipientType(String) - Constructor for class jakarta.mail.internet.MimeMessage.RecipientType
-
Constructor for use by subclasses.
- RecipientType(String) - Constructor for class jakarta.mail.Message.RecipientType
-
Constructor for use by subclasses.
- ref - Variable in exception jakarta.mail.internet.AddressException
-
The string being parsed.
- remove(Flags) - Method in class jakarta.mail.Flags
-
Remove all flags in the given Flags object from this Flags object.
- remove(Flags.Flag) - Method in class jakarta.mail.Flags
-
Remove the specified system flag from this Flags object.
- remove(String) - Method in class jakarta.mail.Flags
-
Remove the specified user flag from this Flags object.
- remove(String) - Method in class jakarta.mail.internet.ParameterList
-
Removes the specified parameter from this ParameterList.
- removeBodyPart(int) - Method in class jakarta.mail.internet.MimeMultipart
-
Remove the part at specified location (starting from 0).
- removeBodyPart(int) - Method in class jakarta.mail.Multipart
-
Remove the part at specified location (starting from 0).
- removeBodyPart(BodyPart) - Method in class jakarta.mail.internet.MimeMultipart
-
Remove the specified part from the multipart message.
- removeBodyPart(BodyPart) - Method in class jakarta.mail.Multipart
-
Remove the specified part from the multipart message.
- removeConnectionListener(ConnectionListener) - Method in class jakarta.mail.Folder
-
Remove a Connection event listener.
- removeConnectionListener(ConnectionListener) - Method in class jakarta.mail.Service
-
Remove a Connection event listener.
- removed - Variable in class jakarta.mail.event.MessageCountEvent
-
If true, this event is the result of an explicit expunge by this client, and the messages in this folder have been renumbered to account for this.
- REMOVED - Static variable in class jakarta.mail.event.MessageCountEvent
-
The messages were removed from their folder
- removeFolderListener(FolderListener) - Method in class jakarta.mail.Folder
-
Remove a Folder event listener.
- removeFolderListener(FolderListener) - Method in class jakarta.mail.Store
-
Remove a listener for Folder events.
- removeHeader(String) - Method in class jakarta.mail.internet.InternetHeaders
-
Remove all header entries that match the given name
- removeHeader(String) - Method in class jakarta.mail.internet.MimeBodyPart
-
Remove all headers with this name.
- removeHeader(String) - Method in class jakarta.mail.internet.MimeMessage
-
Remove all headers with this name.
- removeHeader(String) - Method in interface jakarta.mail.Part
-
Remove all headers with this name.
- removeMessageChangedListener(MessageChangedListener) - Method in class jakarta.mail.Folder
-
Remove a MessageChanged listener.
- removeMessageCountListener(MessageCountListener) - Method in class jakarta.mail.Folder
-
Remove a MessageCount listener.
- removeStoreListener(StoreListener) - Method in class jakarta.mail.Store
-
Remove a listener for Store events.
- removeTransportListener(TransportListener) - Method in class jakarta.mail.Transport
-
Remove a listener for Transport events.
- RENAMED - Static variable in class jakarta.mail.event.FolderEvent
-
The folder was renamed.
- renameTo(Folder) - Method in class jakarta.mail.Folder
-
Rename this Folder.
- reply(boolean) - Method in class jakarta.mail.internet.MimeMessage
-
Get a new Message suitable for a reply to this message.
- reply(boolean) - Method in class jakarta.mail.Message
-
Get a new Message suitable for a reply to this message.
- reply(boolean, boolean) - Method in class jakarta.mail.internet.MimeMessage
-
Get a new Message suitable for a reply to this message.
- requestPasswordAuthentication(InetAddress, int, String, String, String) - Method in class jakarta.mail.Session
-
Call back to the application to get the needed user name and password.
- reset() - Method in class jakarta.mail.util.SharedFileInputStream
-
See the general contract of the
reset
method ofInputStream
. - Resource(String, long, long) - Constructor for class jakarta.mail.Quota.Resource
-
Construct a Resource object with the given name, usage, and limit.
- resources - Variable in class jakarta.mail.Quota
-
The set of resources associated with this quota root.
- retainAll(Flags) - Method in class jakarta.mail.Flags
-
Remove any flags not in the given Flags object.
- RFC822 - Static variable in class jakarta.mail.internet.HeaderTokenizer
-
RFC822 specials
S
- saveChanges() - Method in class jakarta.mail.internet.MimeMessage
-
Updates the appropriate header fields of this message to be consistent with the message's contents.
- saveChanges() - Method in class jakarta.mail.Message
-
Save any changes made to this message into the message-store when the containing folder is closed, if the message is contained in a folder.
- saved - Variable in class jakarta.mail.internet.MimeMessage
-
Does the
saveChanges
method need to be called on this message? This flag is set to false by the public constructor and set to true by thesaveChanges
method. - saveFile(File) - Method in class jakarta.mail.internet.MimeBodyPart
-
Save the contents of this part in the specified file.
- saveFile(String) - Method in class jakarta.mail.internet.MimeBodyPart
-
Save the contents of this part in the specified file.
- search(SearchTerm) - Method in class jakarta.mail.Folder
-
Search this Folder for messages matching the specified search criterion.
- search(SearchTerm, Message[]) - Method in class jakarta.mail.Folder
-
Search the given array of messages for those that match the specified search criterion.
- SearchException - Exception in jakarta.mail.search
-
The exception thrown when a Search expression could not be handled.
- SearchException() - Constructor for exception jakarta.mail.search.SearchException
-
Constructs a SearchException with no detail message.
- SearchException(String) - Constructor for exception jakarta.mail.search.SearchException
-
Constructs a SearchException with the specified detail message.
- SearchTerm - Class in jakarta.mail.search
-
Search criteria are expressed as a tree of search-terms, forming a parse-tree for the search expression.
- SearchTerm() - Constructor for class jakarta.mail.search.SearchTerm
-
Creates a default
SearchTerm
. - SEEN - Static variable in class jakarta.mail.Flags.Flag
-
This message is seen.
- send(Message) - Static method in class jakarta.mail.Transport
-
Send a message.
- send(Message, Address[]) - Static method in class jakarta.mail.Transport
-
Send the message to the specified addresses, ignoring any recipients specified in the message itself.
- send(Message, Address[], String, String) - Static method in class jakarta.mail.Transport
-
Send the message to the specified addresses, ignoring any recipients specified in the message itself.
- send(Message, String, String) - Static method in class jakarta.mail.Transport
-
Send a message.
- SendFailedException - Exception in jakarta.mail
-
This exception is thrown when the message cannot be sent.
- SendFailedException() - Constructor for exception jakarta.mail.SendFailedException
-
Constructs a SendFailedException with no detail message.
- SendFailedException(String) - Constructor for exception jakarta.mail.SendFailedException
-
Constructs a SendFailedException with the specified detail message.
- SendFailedException(String, Exception) - Constructor for exception jakarta.mail.SendFailedException
-
Constructs a SendFailedException with the specified Exception and detail message.
- SendFailedException(String, Exception, Address[], Address[], Address[]) - Constructor for exception jakarta.mail.SendFailedException
-
Constructs a SendFailedException with the specified string and the specified address objects.
- sendMessage(Message, Address[]) - Method in class jakarta.mail.Transport
-
Send the Message to the specified list of addresses.
- SentDateTerm - Class in jakarta.mail.search
-
This class implements comparisons for the Message SentDate.
- SentDateTerm(int, Date) - Constructor for class jakarta.mail.search.SentDateTerm
-
Constructor.
- Service - Class in jakarta.mail
-
An abstract class that contains the functionality common to messaging services, such as stores and transports.
- Service(Session, URLName) - Constructor for class jakarta.mail.Service
-
Constructor.
- session - Variable in class jakarta.mail.Message
-
The Session object for this Message
- session - Variable in class jakarta.mail.Service
-
The session from which this service was created.
- Session - Class in jakarta.mail
-
The Session class represents a mail session and is not subclassed.
- set(String, String) - Method in class jakarta.mail.internet.ParameterList
-
Set a parameter.
- set(String, String, String) - Method in class jakarta.mail.internet.ParameterList
-
Set a parameter.
- set2DigitYearStart(Date) - Method in class jakarta.mail.internet.MailDateFormat
-
This method always throws an UnsupportedOperationException and should not be used because RFC 2822 mandates another strategy for interpreting 2-digits years.
- setAddress(String) - Method in class jakarta.mail.internet.InternetAddress
-
Set the email address.
- setCalendar(Calendar) - Method in class jakarta.mail.internet.MailDateFormat
-
This method always throws an UnsupportedOperationException and should not be used because RFC 2822 mandates a specific calendar.
- setConnected(boolean) - Method in class jakarta.mail.Service
-
Set the connection state of this service.
- setContent(Multipart) - Method in class jakarta.mail.internet.MimeBodyPart
-
This method sets the body part's content to a Multipart object.
- setContent(Multipart) - Method in class jakarta.mail.internet.MimeMessage
-
This method sets the Message's content to a Multipart object.
- setContent(Multipart) - Method in interface jakarta.mail.Part
-
This method sets the given Multipart object as this message's content.
- setContent(Object, String) - Method in class jakarta.mail.internet.MimeBodyPart
-
A convenience method for setting this body part's content.
- setContent(Object, String) - Method in class jakarta.mail.internet.MimeMessage
-
A convenience method for setting this Message's content.
- setContent(Object, String) - Method in interface jakarta.mail.Part
-
A convenience method for setting this part's content.
- setContentID(String) - Method in class jakarta.mail.internet.MimeBodyPart
-
Set the "Content-ID" header field of this body part.
- setContentID(String) - Method in class jakarta.mail.internet.MimeMessage
-
Set the "Content-ID" header field of this Message.
- setContentLanguage(String[]) - Method in class jakarta.mail.internet.MimeBodyPart
-
Set the Content-Language header of this MimePart.
- setContentLanguage(String[]) - Method in class jakarta.mail.internet.MimeMessage
-
Set the "Content-Language" header of this MimePart.
- setContentLanguage(String[]) - Method in interface jakarta.mail.internet.MimePart
-
Set the Content-Language header of this MimePart.
- setContentMD5(String) - Method in class jakarta.mail.internet.MimeBodyPart
-
Set the "Content-MD5" header field of this body part.
- setContentMD5(String) - Method in class jakarta.mail.internet.MimeMessage
-
Set the "Content-MD5" header field of this Message.
- setContentMD5(String) - Method in interface jakarta.mail.internet.MimePart
-
Set the Content-MD5 of this part.
- setDataHandler(DataHandler) - Method in class jakarta.mail.internet.MimeBodyPart
-
This method provides the mechanism to set this body part's content.
- setDataHandler(DataHandler) - Method in class jakarta.mail.internet.MimeMessage
-
This method provides the mechanism to set this part's content.
- setDataHandler(DataHandler) - Method in interface jakarta.mail.Part
-
This method provides the mechanism to set this part's content.
- setDateFormatSymbols(DateFormatSymbols) - Method in class jakarta.mail.internet.MailDateFormat
-
This method always throws an UnsupportedOperationException and should not be used because RFC 2822 mandates specific date format symbols.
- setDebug(boolean) - Method in class jakarta.mail.Session
-
Set the debug setting for this Session.
- setDebugOut(PrintStream) - Method in class jakarta.mail.Session
-
Set the stream to be used for debugging output for this session.
- setDescription(String) - Method in class jakarta.mail.internet.MimeBodyPart
-
Set the "Content-Description" header field for this body part.
- setDescription(String) - Method in class jakarta.mail.internet.MimeMessage
-
Set the "Content-Description" header field for this Message.
- setDescription(String) - Method in interface jakarta.mail.Part
-
Set a description String for this part.
- setDescription(String, String) - Method in class jakarta.mail.internet.MimeBodyPart
-
Set the "Content-Description" header field for this body part.
- setDescription(String, String) - Method in class jakarta.mail.internet.MimeMessage
-
Set the "Content-Description" header field for this Message.
- setDisposition(String) - Method in class jakarta.mail.internet.ContentDisposition
-
Set the disposition.
- setDisposition(String) - Method in class jakarta.mail.internet.MimeBodyPart
-
Set the disposition in the "Content-Disposition" header field of this body part.
- setDisposition(String) - Method in class jakarta.mail.internet.MimeMessage
-
Set the disposition in the "Content-Disposition" header field of this body part.
- setDisposition(String) - Method in interface jakarta.mail.Part
-
Set the disposition of this part.
- setExpunged(boolean) - Method in class jakarta.mail.Message
-
Sets the expunged flag for this Message.
- setFileName(String) - Method in class jakarta.mail.internet.MimeBodyPart
-
Set the filename associated with this body part, if possible.
- setFileName(String) - Method in class jakarta.mail.internet.MimeMessage
-
Set the filename associated with this part, if possible.
- setFileName(String) - Method in interface jakarta.mail.Part
-
Set the filename associated with this part, if possible.
- setFlag(Flags.Flag, boolean) - Method in class jakarta.mail.Message
-
Set the specified flag on this message to the specified value.
- setFlags(int[], Flags, boolean) - Method in class jakarta.mail.Folder
-
Set the specified flags on the messages whose message numbers are in the array.
- setFlags(int, int, Flags, boolean) - Method in class jakarta.mail.Folder
-
Set the specified flags on the messages numbered from start through end, both start and end inclusive.
- setFlags(Flags, boolean) - Method in class jakarta.mail.internet.MimeMessage
-
Set the flags for this message.
- setFlags(Flags, boolean) - Method in class jakarta.mail.Message
-
Set the specified flags on this message to the specified value.
- setFlags(Message[], Flags, boolean) - Method in class jakarta.mail.Folder
-
Set the specified flags on the messages specified in the array.
- setFrom() - Method in class jakarta.mail.internet.MimeMessage
-
Set the RFC 822 "From" header field using the value of the
InternetAddress.getLocalAddress
method. - setFrom() - Method in class jakarta.mail.Message
-
Set the "From" attribute in this Message.
- setFrom(Address) - Method in class jakarta.mail.internet.MimeMessage
-
Set the RFC 822 "From" header field.
- setFrom(Address) - Method in class jakarta.mail.Message
-
Set the "From" attribute in this Message.
- setFrom(String) - Method in class jakarta.mail.internet.MimeMessage
-
Set the RFC 822 "From" header field.
- setHeader(String, String) - Method in class jakarta.mail.internet.InternetHeaders
-
Change the first header line that matches name to have value, adding a new header if no existing header matches.
- setHeader(String, String) - Method in class jakarta.mail.internet.MimeBodyPart
-
Set the value for this header_name.
- setHeader(String, String) - Method in class jakarta.mail.internet.MimeMessage
-
Set the value for this header_name.
- setHeader(String, String) - Method in interface jakarta.mail.Part
-
Set the value for this header_name.
- setHost(String) - Method in class jakarta.mail.internet.NewsAddress
-
Set the host.
- setMessageNumber(int) - Method in class jakarta.mail.Message
-
Set the Message number for this Message.
- setMultipartDataSource(MultipartDataSource) - Method in class jakarta.mail.Multipart
-
Setup this Multipart object from the given MultipartDataSource.
- setName(String) - Method in class jakarta.mail.util.ByteArrayDataSource
-
Set the name of the data.
- setNewsgroup(String) - Method in class jakarta.mail.internet.NewsAddress
-
Set the newsgroup.
- setNextException(Exception) - Method in exception jakarta.mail.MessagingException
-
Add an exception to the end of the chain.
- setNumberFormat(NumberFormat) - Method in class jakarta.mail.internet.MailDateFormat
-
This method always throws an UnsupportedOperationException and should not be used because RFC 2822 mandates a specific number format.
- setParameter(String, String) - Method in class jakarta.mail.internet.ContentDisposition
-
Set the specified parameter.
- setParameter(String, String) - Method in class jakarta.mail.internet.ContentType
-
Set the specified parameter.
- setParameterList(ParameterList) - Method in class jakarta.mail.internet.ContentDisposition
-
Set a new ParameterList.
- setParameterList(ParameterList) - Method in class jakarta.mail.internet.ContentType
-
Set a new ParameterList.
- setParent(Part) - Method in class jakarta.mail.Multipart
-
Set the parent of this
Multipart
to be the specifiedPart
. - setPasswordAuthentication(URLName, PasswordAuthentication) - Method in class jakarta.mail.Session
-
Save a PasswordAuthentication for this (store or transport) URLName.
- setPersonal(String) - Method in class jakarta.mail.internet.InternetAddress
-
Set the personal name.
- setPersonal(String, String) - Method in class jakarta.mail.internet.InternetAddress
-
Set the personal name.
- setPreamble(String) - Method in class jakarta.mail.internet.MimeMultipart
-
Set the preamble text to be included before the first body part.
- setPrimaryType(String) - Method in class jakarta.mail.internet.ContentType
-
Set the primary type.
- setProtocolForAddress(String, String) - Method in class jakarta.mail.Session
-
Set the default transport protocol to use for addresses of the specified type.
- setProvider(Provider) - Method in class jakarta.mail.Session
-
Set the passed Provider to be the default implementation for the protocol in Provider.protocol overriding any previous values.
- setQuota(Quota) - Method in interface jakarta.mail.QuotaAwareStore
-
Set the quotas for the quota root specified in the quota argument.
- setRecipient(Message.RecipientType, Address) - Method in class jakarta.mail.Message
-
Set the recipient address.
- setRecipients(Message.RecipientType, Address[]) - Method in class jakarta.mail.internet.MimeMessage
-
Set the specified recipient type to the given addresses.
- setRecipients(Message.RecipientType, Address[]) - Method in class jakarta.mail.Message
-
Set the recipient addresses.
- setRecipients(Message.RecipientType, String) - Method in class jakarta.mail.internet.MimeMessage
-
Set the specified recipient type to the given addresses.
- setReplyTo(Address[]) - Method in class jakarta.mail.internet.MimeMessage
-
Set the RFC 822 "Reply-To" header field.
- setReplyTo(Address[]) - Method in class jakarta.mail.Message
-
Set the addresses to which replies should be directed.
- setResourceLimit(String, long) - Method in class jakarta.mail.Quota
-
Set a resource limit for this quota root.
- setSender(Address) - Method in class jakarta.mail.internet.MimeMessage
-
Set the RFC 822 "Sender" header field.
- setSentDate(Date) - Method in class jakarta.mail.internet.MimeMessage
-
Set the RFC 822 "Date" header field.
- setSentDate(Date) - Method in class jakarta.mail.Message
-
Set the sent date of this message.
- setSubject(String) - Method in class jakarta.mail.internet.MimeMessage
-
Set the "Subject" header field.
- setSubject(String) - Method in class jakarta.mail.Message
-
Set the subject of this message.
- setSubject(String, String) - Method in class jakarta.mail.internet.MimeMessage
-
Set the "Subject" header field.
- setSubscribed(boolean) - Method in class jakarta.mail.Folder
-
Subscribe or unsubscribe this Folder.
- setSubType(String) - Method in class jakarta.mail.internet.ContentType
-
Set the subType.
- setSubType(String) - Method in class jakarta.mail.internet.MimeMultipart
-
Set the subtype.
- setText(String) - Method in class jakarta.mail.internet.MimeBodyPart
-
Convenience method that sets the given String as this part's content, with a MIME type of "text/plain".
- setText(String) - Method in class jakarta.mail.internet.MimeMessage
-
Convenience method that sets the given String as this part's content, with a MIME type of "text/plain".
- setText(String) - Method in interface jakarta.mail.internet.MimePart
-
Convenience method that sets the given String as this part's content, with a MIME type of "text/plain".
- setText(String) - Method in interface jakarta.mail.Part
-
A convenience method that sets the given String as this part's content with a MIME type of "text/plain".
- setText(String, String) - Method in class jakarta.mail.internet.MimeBodyPart
-
Convenience method that sets the given String as this part's content, with a MIME type of "text/plain" and the specified charset.
- setText(String, String) - Method in class jakarta.mail.internet.MimeMessage
-
Convenience method that sets the given String as this part's content, with a MIME type of "text/plain" and the specified charset.
- setText(String, String) - Method in interface jakarta.mail.internet.MimePart
-
Convenience method that sets the given String as this part's content, with a MIME type of "text/plain" and the specified charset.
- setText(String, String, String) - Method in class jakarta.mail.internet.MimeBodyPart
-
Convenience method that sets the given String as this part's content, with a primary MIME type of "text" and the specified MIME subtype.
- setText(String, String, String) - Method in class jakarta.mail.internet.MimeMessage
-
Convenience method that sets the given String as this part's content, with a primary MIME type of "text" and the specified MIME subtype.
- setText(String, String, String) - Method in interface jakarta.mail.internet.MimePart
-
Convenience method that sets the given String as this part's content, with a primary MIME type of "text" and the specified MIME subtype.
- setURLName(URLName) - Method in class jakarta.mail.Service
-
Set the URLName representing this service.
- SharedByteArrayInputStream - Class in jakarta.mail.util
-
A ByteArrayInputStream that implements the SharedInputStream interface, allowing the underlying byte array to be shared between multiple readers.
- SharedByteArrayInputStream(byte[]) - Constructor for class jakarta.mail.util.SharedByteArrayInputStream
-
Create a SharedByteArrayInputStream representing the entire byte array.
- SharedByteArrayInputStream(byte[], int, int) - Constructor for class jakarta.mail.util.SharedByteArrayInputStream
-
Create a SharedByteArrayInputStream representing the part of the byte array from
offset
forlength
bytes. - SharedFileInputStream - Class in jakarta.mail.util
-
A
SharedFileInputStream
is aBufferedInputStream
that buffers data from the file and supports themark
andreset
methods. - SharedFileInputStream(File) - Constructor for class jakarta.mail.util.SharedFileInputStream
-
Creates a
SharedFileInputStream
for the file. - SharedFileInputStream(File, int) - Constructor for class jakarta.mail.util.SharedFileInputStream
-
Creates a
SharedFileInputStream
with the specified buffer size. - SharedFileInputStream(String) - Constructor for class jakarta.mail.util.SharedFileInputStream
-
Creates a
SharedFileInputStream
for the named file - SharedFileInputStream(String, int) - Constructor for class jakarta.mail.util.SharedFileInputStream
-
Creates a
SharedFileInputStream
with the specified buffer size. - SharedInputStream - Interface in jakarta.mail.internet
-
An InputStream that is backed by data that can be shared by multiple readers may implement this interface.
- size() - Method in class jakarta.mail.internet.ParameterList
-
Return the number of parameters in this list.
- SIZE - Static variable in class jakarta.mail.FetchProfile.Item
-
SIZE is a fetch profile item that can be included in a
FetchProfile
during a fetch request to a Folder. - SizeTerm - Class in jakarta.mail.search
-
This class implements comparisons for Message sizes.
- SizeTerm(int, int) - Constructor for class jakarta.mail.search.SizeTerm
-
Constructor.
- skip(long) - Method in class jakarta.mail.util.SharedFileInputStream
-
See the general contract of the
skip
method ofInputStream
. - start - Variable in class jakarta.mail.util.SharedByteArrayInputStream
-
Position within shared buffer that this stream starts at.
- start - Variable in class jakarta.mail.util.SharedFileInputStream
-
The file offset of the start of data in this subset of the file.
- store - Variable in class jakarta.mail.Folder
-
The parent store.
- Store - Class in jakarta.mail
-
An abstract class that models a message store and its access protocol, for storing and retrieving messages.
- Store(Session, URLName) - Constructor for class jakarta.mail.Store
-
Constructor.
- STORE - Static variable in class jakarta.mail.Provider.Type
-
The Provider of type
STORE
. - StoreClosedException - Exception in jakarta.mail
-
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.
- StoreClosedException(Store) - Constructor for exception jakarta.mail.StoreClosedException
-
Constructs a StoreClosedException with no detail message.
- StoreClosedException(Store, String) - Constructor for exception jakarta.mail.StoreClosedException
-
Constructs a StoreClosedException with the specified detail message.
- StoreClosedException(Store, String, Exception) - Constructor for exception jakarta.mail.StoreClosedException
-
Constructs a StoreClosedException with the specified detail message and embedded exception.
- StoreEvent - Class in jakarta.mail.event
-
This class models notifications from the Store connection.
- StoreEvent(Store, int, String) - Constructor for class jakarta.mail.event.StoreEvent
-
Construct a StoreEvent.
- StoreListener - Interface in jakarta.mail.event
-
This is the Listener interface for Store Notifications.
- storeProtocol() - Method in annotation type jakarta.mail.MailSessionDefinition
-
Store protocol name.
- streamProvider - Variable in class jakarta.mail.BodyPart
-
Instance of stream provider.
- streamProvider - Variable in class jakarta.mail.Multipart
-
Instance of stream provider.
- StreamProvider - Interface in jakarta.mail.util
-
Service lookup is used to find implementations of this interface.
- StreamProvider.EncoderTypes - Enum in jakarta.mail.util
-
Enumeration with the different encoder types supported by the Mail API.
- StringTerm - Class in jakarta.mail.search
-
This class implements the match method for Strings.
- StringTerm(String) - Constructor for class jakarta.mail.search.StringTerm
-
Construct a StringTerm with the given pattern.
- StringTerm(String, boolean) - Constructor for class jakarta.mail.search.StringTerm
-
Construct a StringTerm with the given pattern and ignoreCase flag.
- SubjectTerm - Class in jakarta.mail.search
-
This class implements comparisons for the message Subject header.
- SubjectTerm(String) - Constructor for class jakarta.mail.search.SubjectTerm
-
Constructor.
T
- TO - Static variable in class jakarta.mail.Message.RecipientType
-
The "To" (primary) recipients.
- Token(int, String) - Constructor for class jakarta.mail.internet.HeaderTokenizer.Token
-
Constructor.
- toString() - Method in class jakarta.mail.Address
-
Return a String representation of this address object.
- toString() - Method in class jakarta.mail.FetchProfile.Item
-
Include the name in the toString return value for debugging.
- toString() - Method in class jakarta.mail.Flags
-
Return a string representation of this Flags object.
- toString() - Method in class jakarta.mail.Folder
-
override the default toString(), it will return the String from Folder.getFullName() or if that is null, it will use the default toString() behavior.
- toString() - Method in exception jakarta.mail.internet.AddressException
- toString() - Method in class jakarta.mail.internet.ContentDisposition
-
Retrieve a RFC2045 style string representation of this ContentDisposition.
- toString() - Method in class jakarta.mail.internet.ContentType
-
Retrieve a RFC2045 style string representation of this Content-Type.
- toString() - Method in class jakarta.mail.internet.InternetAddress
-
Convert this address into a RFC 822 / RFC 2047 encoded address.
- toString() - Method in class jakarta.mail.internet.NewsAddress
-
Convert this address into a RFC 1036 address.
- toString() - Method in class jakarta.mail.internet.ParameterList
-
Convert this ParameterList into a MIME String.
- toString() - Method in class jakarta.mail.Message.RecipientType
- toString() - Method in exception jakarta.mail.MessagingException
-
Override toString method to provide information on nested exceptions.
- toString() - Method in class jakarta.mail.Provider
-
Overrides Object.toString()
- toString() - Method in class jakarta.mail.Provider.Type
- toString() - Method in class jakarta.mail.Service
-
Return
getURLName.toString()
if this service has a URLName, otherwise it will return the defaulttoString
. - toString() - Method in class jakarta.mail.URLName
-
Constructs a string representation of this URLName.
- toString(int) - Method in class jakarta.mail.internet.ParameterList
-
Convert this ParameterList into a MIME String.
- toString(Address[]) - Static method in class jakarta.mail.internet.InternetAddress
-
Convert the given array of InternetAddress objects into a comma separated sequence of address strings.
- toString(Address[]) - Static method in class jakarta.mail.internet.NewsAddress
-
Convert the given array of NewsAddress objects into a comma separated sequence of address strings.
- toString(Address[], int) - Static method in class jakarta.mail.internet.InternetAddress
-
Convert the given array of InternetAddress objects into a comma separated sequence of address strings.
- toUnicodeString() - Method in class jakarta.mail.internet.InternetAddress
-
Returns a properly formatted address (RFC 822 syntax) of Unicode characters.
- toUnicodeString(Address[]) - Static method in class jakarta.mail.internet.InternetAddress
-
Convert the given array of InternetAddress objects into a comma separated sequence of address strings.
- toUnicodeString(Address[], int) - Static method in class jakarta.mail.internet.InternetAddress
-
Convert the given array of InternetAddress objects into a comma separated sequence of address strings.
- Transport - Class in jakarta.mail
-
An abstract class that models a message transport.
- Transport(Session, URLName) - Constructor for class jakarta.mail.Transport
-
Constructor.
- TRANSPORT - Static variable in class jakarta.mail.Provider.Type
-
The Provider of type
TRANSPORT
. - TransportAdapter - Class in jakarta.mail.event
-
The adapter which receives Transport events.
- TransportAdapter() - Constructor for class jakarta.mail.event.TransportAdapter
-
Creates a default
TransportAdapter
. - TransportEvent - Class in jakarta.mail.event
-
This class models Transport events.
- TransportEvent(Transport, int, Address[], Address[], Address[], Message) - Constructor for class jakarta.mail.event.TransportEvent
-
Constructor.
- TransportListener - Interface in jakarta.mail.event
-
This is the Listener interface for Transport events
- transportProtocol() - Method in annotation type jakarta.mail.MailSessionDefinition
-
Transport protocol name.
- type - Variable in class jakarta.mail.event.ConnectionEvent
-
The event type.
- type - Variable in class jakarta.mail.event.FolderEvent
-
The event type.
- type - Variable in class jakarta.mail.event.MessageChangedEvent
-
The event type.
- type - Variable in class jakarta.mail.event.MessageCountEvent
-
The event type.
- type - Variable in class jakarta.mail.event.StoreEvent
-
The event type.
- type - Variable in class jakarta.mail.event.TransportEvent
-
The event type.
- type - Variable in class jakarta.mail.Message.RecipientType
-
The type of recipient, usually the name of a corresponding Internet standard header.
U
- UID - Static variable in class jakarta.mail.UIDFolder.FetchProfileItem
-
UID is a fetch profile item that can be included in a
FetchProfile
during a fetch request to a Folder. - UIDFolder - Interface in jakarta.mail
-
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 - Class in jakarta.mail
-
A fetch profile item for fetching UIDs.
- unfold(String) - Static method in class jakarta.mail.internet.MimeUtility
-
Unfold a folded header.
- updateHeaders() - Method in class jakarta.mail.internet.MimeBodyPart
-
Examine the content of this body part and update the appropriate MIME headers.
- updateHeaders() - Method in class jakarta.mail.internet.MimeMessage
-
Called by the
saveChanges
method to actually update the MIME headers. - updateHeaders() - Method in class jakarta.mail.internet.MimeMultipart
-
Update headers.
- updateHeaders() - Method in class jakarta.mail.internet.PreencodedMimeBodyPart
-
Force the
Content-Transfer-Encoding
header to use the encoding that was specified when this object was created. - updateMessageID() - Method in class jakarta.mail.internet.MimeMessage
-
Update the Message-ID header.
- url - Variable in class jakarta.mail.Service
-
The
URLName
of this service. - URLName - Class in jakarta.mail
-
The name of a URL.
- URLName(String) - Constructor for class jakarta.mail.URLName
-
Construct a URLName from the string.
- URLName(String, String, int, String, String, String) - Constructor for class jakarta.mail.URLName
-
Creates a URLName object from the specified protocol, host, port number, file, username, and password.
- URLName(URL) - Constructor for class jakarta.mail.URLName
-
Construct a URLName from a java.net.URL object.
- usage - Variable in class jakarta.mail.Quota.Resource
-
The current usage of the resource.
- user() - Method in annotation type jakarta.mail.MailSessionDefinition
-
User name to use for authentication.
- USER - Static variable in class jakarta.mail.Flags.Flag
-
A special flag that indicates that this folder supports user defined flags.
- UU_ENCODER - jakarta.mail.util.StreamProvider.EncoderTypes
V
- validate() - Method in class jakarta.mail.internet.InternetAddress
-
Validate that this address conforms to the syntax rules of RFC 822.
- validSent - Variable in class jakarta.mail.event.TransportEvent
-
The valid address to which the message was sent.
- validSent - Variable in exception jakarta.mail.SendFailedException
-
Valid addresses to which message was sent.
- validUnsent - Variable in class jakarta.mail.event.TransportEvent
-
The valid address to which the message was not sent.
- validUnsent - Variable in exception jakarta.mail.SendFailedException
-
Valid addresses to which message was not sent.
- value - Variable in class jakarta.mail.Header
-
The value of the header.
- value() - Method in annotation type jakarta.mail.MailSessionDefinitions
- valueOf(String) - Static method in enum jakarta.mail.util.StreamProvider.EncoderTypes
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum jakarta.mail.util.StreamProvider.EncoderTypes
-
Returns an array containing the constants of this enum type, in the order they are declared.
W
- write(byte[]) - Method in interface jakarta.mail.util.LineOutputStream
-
Writes
b.length
bytes to this output stream. - writeln() - Method in interface jakarta.mail.util.LineOutputStream
-
Writes a new line (CRLF).
- writeln(String) - Method in interface jakarta.mail.util.LineOutputStream
-
Writes the input string and a new line (CRLF).
- writeTo(OutputStream) - Method in class jakarta.mail.internet.MimeBodyPart
-
Output the body part as an RFC 822 format stream.
- writeTo(OutputStream) - Method in class jakarta.mail.internet.MimeMessage
-
Output the message as an RFC 822 format stream.
- writeTo(OutputStream) - Method in class jakarta.mail.internet.MimeMultipart
-
Iterates through all the parts and outputs each MIME part separated by a boundary.
- writeTo(OutputStream) - Method in class jakarta.mail.internet.PreencodedMimeBodyPart
-
Output the body part as an RFC 822 format stream.
- writeTo(OutputStream) - Method in class jakarta.mail.Multipart
-
Output an appropriately encoded bytestream to the given OutputStream.
- writeTo(OutputStream) - Method in interface jakarta.mail.Part
-
Output a bytestream for this Part.
- writeTo(OutputStream, String[]) - Method in class jakarta.mail.internet.MimeMessage
-
Output the message as an RFC 822 format stream, without specified headers.
X
- X_UU_ENCODER - jakarta.mail.util.StreamProvider.EncoderTypes
- X_UUE - jakarta.mail.util.StreamProvider.EncoderTypes
All Classes All Packages