public class

SMTPMessage

extends MimeMessage

java.lang.Object
↳	com.google.code.javax.mail.Message
	↳	com.google.code.javax.mail.internet.MimeMessage
		↳	com.google.code.com.sun.mail.smtp.SMTPMessage

Class Overview

This class is a specialization of the MimeMessage class that allows you to specify various SMTP options and parameters that will be used when this message is sent over SMTP. Simply use this class instead of MimeMessage and set SMTP options using the methods on this class.

See the com.sun.mail.smtp package documentation for further information on the SMTP protocol provider.

Summary

Constants
int	NOTIFY_DELAY	Notify of delivery delay
int	NOTIFY_FAILURE	Notify of delivery failure
int	NOTIFY_NEVER	Never notify of delivery status
int	NOTIFY_SUCCESS	Notify of delivery success
int	RETURN_FULL	Return full message with delivery status notification
int	RETURN_HDRS	Return only message headers with delivery status notification

[Expand]

Inherited Constants

From interface com.google.code.javax.mail.Part

Fields
private boolean	allow8bitMIME
private String	envelopeFrom
private String	extension
private int	notifyOptions
private int	returnOption
private static final String[]	returnOptionString
private boolean	sendPartial
private String	submitter

[Expand]

Inherited Fields

From class com.google.code.javax.mail.internet.MimeMessage

private static final Flags	answeredFlag
Object	cachedContent	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.
protected byte[]	content	Byte array that holds the bytes of this Message's content.
protected InputStream	contentStream	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.
protected DataHandler	dh	The DataHandler object representing this Message's content.
protected Flags	flags	The Flags for this message.
protected InternetHeaders	headers	The InternetHeaders object that stores the header of this message.
private static final MailDateFormat	mailDateFormat
protected boolean	modified	A flag indicating whether the message has been modified.
protected boolean	saved	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 the `saveChanges` method.
private boolean	strict

From class com.google.code.javax.mail.Message

Public Constructors
	SMTPMessage(Session session) Default constructor.
	SMTPMessage(Session session, InputStream is) Constructs an SMTPMessage by reading and parsing the data from the specified MIME InputStream.
	SMTPMessage(MimeMessage source) Constructs a new SMTPMessage with content initialized from the `source` MimeMessage.

Public Methods
boolean	getAllow8bitMIME() Is use of the 8BITMIME extension is allowed?
String	getEnvelopeFrom() Return the envelope From address.
String	getMailExtension() Gets the extension string to use with the MAIL command.
int	getNotifyOptions() Get notification options.
int	getReturnOption() Return return option.
boolean	getSendPartial() Send message if some addresses are invalid?
String	getSubmitter() Gets the submitter to be used for the RFC 2554 AUTH= value in the MAIL FROM command.
void	setAllow8bitMIME(boolean allow) If set to true, and the server supports the 8BITMIME extension, text parts of this message that use the "quoted-printable" or "base64" encodings are converted to use "8bit" encoding if they follow the RFC 2045 rules for 8bit text.
void	setEnvelopeFrom(String from) Set the From address to appear in the SMTP envelope.
void	setMailExtension(String extension) Set the extension string to use with the MAIL command.
void	setNotifyOptions(int options) Set notification options to be used if the server supports Delivery Status Notification (RFC 1891).
void	setReturnOption(int option) Set return option to be used if server supports Delivery Status Notification (RFC 1891).
void	setSendPartial(boolean partial) If set to true, and this message has some valid and some invalid addresses, send the message anyway, reporting the partial failure with a SendFailedException.
void	setSubmitter(String submitter) Sets the submitter to be used for the RFC 2554 AUTH= value in the MAIL FROM command.

[Expand]

Inherited Methods

From class com.google.code.javax.mail.internet.MimeMessage

void	addFrom(Address[] addresses) Add the specified addresses to the existing "From" field.
void	addHeader(String name, String value) Add this value to the existing values for this header_name.
void	addHeaderLine(String line) Add a raw RFC 822 header-line.
void	addRecipients(Message.RecipientType type, Address[] addresses) Add the given addresses to the specified recipient type.
void	addRecipients(Message.RecipientType type, String addresses) Add the given addresses to the specified recipient type.
InternetHeaders	createInternetHeaders(InputStream is) Create and return an InternetHeaders object that loads the headers from the given InputStream.
MimeMessage	createMimeMessage(Session session) Create and return a MimeMessage object.
Enumeration	getAllHeaderLines() Get all header lines as an Enumeration of Strings.
Enumeration	getAllHeaders() Return all the headers from this Message as an enumeration of Header objects.
Address[]	getAllRecipients() Get all the recipient addresses for the message.
Object	getContent() Return the content as a Java object.
String	getContentID() Returns the value of the "Content-ID" header field.
String[]	getContentLanguage() Get the languages specified in the "Content-Language" header field of this message.
String	getContentMD5() Return the value of the "Content-MD5" header field.
InputStream	getContentStream() Produce the raw bytes of the content.
String	getContentType() Returns the value of the RFC 822 "Content-Type" header field.
synchronized DataHandler	getDataHandler() Return a DataHandler for this Message's content.
String	getDescription() Returns the "Content-Description" header field of this Message.
String	getDisposition() Returns the value of the "Content-Disposition" header field.
String	getEncoding() Returns the content transfer encoding from the "Content-Transfer-Encoding" header field.
String	getFileName() Get the filename associated with this Message.
synchronized Flags	getFlags() Return a `Flags` object containing the flags for this message.
Address[]	getFrom() Returns the value of the RFC 822 "From" header fields.
String[]	getHeader(String name) Get all the headers for this header_name.
String	getHeader(String name, String delimiter) Get all the headers for this header name, returned as a single String, with headers separated by the delimiter.
InputStream	getInputStream() Return a decoded input stream for this Message's "content".
int	getLineCount() Return the number of lines for the content of this message.
Enumeration	getMatchingHeaderLines(String[] names) Get matching header lines as an Enumeration of Strings.
Enumeration	getMatchingHeaders(String[] names) Return matching headers from this Message as an Enumeration of Header objects.
String	getMessageID() Returns the value of the "Message-ID" header field.
Enumeration	getNonMatchingHeaderLines(String[] names) Get non-matching header lines as an Enumeration of Strings.
Enumeration	getNonMatchingHeaders(String[] names) Return non-matching headers from this Message as an Enumeration of Header objects.
InputStream	getRawInputStream() Return an InputStream to the raw data with any Content-Transfer-Encoding intact.
Date	getReceivedDate() Returns the Date on this message was received.
Address[]	getRecipients(Message.RecipientType type) Returns the recepients specified by the type.
Address[]	getReplyTo() Return the value of the RFC 822 "Reply-To" header field.
Address	getSender() Returns the value of the RFC 822 "Sender" header field.
Date	getSentDate() Returns the value of the RFC 822 "Date" field.
int	getSize() Return the size of the content of this message in bytes.
String	getSubject() Returns the value of the "Subject" header field.
boolean	isMimeType(String mimeType) Is this Part of the specified MIME type? This method compares only the `primaryType` and `subType`.
synchronized boolean	isSet(Flags.Flag flag) Check whether the flag specified in the `flag` argument is set in this message.
void	parse(InputStream is) Parse the InputStream setting the `headers` and `content` fields appropriately.
void	removeHeader(String name) Remove all headers with this name.
Message	reply(boolean replyToAll) Get a new Message suitable for a reply to this message.
void	saveChanges() Updates the appropriate header fields of this message to be consistent with the message's contents.
void	setContent(Object o, String type) A convenience method for setting this Message's content.
void	setContent(Multipart mp) This method sets the Message's content to a Multipart object.
void	setContentID(String cid) Set the "Content-ID" header field of this Message.
void	setContentLanguage(String[] languages) Set the "Content-Language" header of this MimePart.
void	setContentMD5(String md5) Set the "Content-MD5" header field of this Message.
synchronized void	setDataHandler(DataHandler dh) This method provides the mechanism to set this part's content.
void	setDescription(String description, String charset) Set the "Content-Description" header field for this Message.
void	setDescription(String description) Set the "Content-Description" header field for this Message.
void	setDisposition(String disposition) Set the "Content-Disposition" header field of this Message.
void	setFileName(String filename) Set the filename associated with this part, if possible.
synchronized void	setFlags(Flags flag, boolean set) Set the flags for this message.
void	setFrom() Set the RFC 822 "From" header field using the value of the `InternetAddress.getLocalAddress` method.
void	setFrom(Address address) Set the RFC 822 "From" header field.
void	setHeader(String name, String value) Set the value for this header_name.
void	setRecipients(Message.RecipientType type, Address[] addresses) Set the specified recipient type to the given addresses.
void	setRecipients(Message.RecipientType type, String addresses) Set the specified recipient type to the given addresses.
void	setReplyTo(Address[] addresses) Set the RFC 822 "Reply-To" header field.
void	setSender(Address address) Set the RFC 822 "Sender" header field.
void	setSentDate(Date d) Set the RFC 822 "Date" header field.
void	setSubject(String subject) Set the "Subject" header field.
void	setSubject(String subject, String charset) Set the "Subject" header field.
void	setText(String text) Convenience method that sets the given String as this part's content, with a MIME type of "text/plain".
void	setText(String text, String charset, String subtype) Convenience method that sets the given String as this part's content, with a primary MIME type of "text" and the specified MIME subtype.
void	setText(String text, String charset) Convenience method that sets the given String as this part's content, with a MIME type of "text/plain" and the specified charset.
void	updateHeaders() Called by the `saveChanges` method to actually update the MIME headers.
void	updateMessageID() Update the Message-ID header.
void	writeTo(OutputStream os, String[] ignoreList) Output the message as an RFC 822 format stream, without specified headers.
void	writeTo(OutputStream os) Output the message as an RFC 822 format stream.

From class com.google.code.javax.mail.Message

abstract void	addFrom(Address[] addresses) Add these addresses to the existing "From" attribute
void	addRecipient(Message.RecipientType type, Address address) Add this recipient address to the existing ones of the given type.
abstract void	addRecipients(Message.RecipientType type, Address[] addresses) Add these recipient addresses to the existing ones of the given type.
Address[]	getAllRecipients() Get all the recipient addresses for the message.
abstract Flags	getFlags() Returns a `Flags` object containing the flags for this message.
Folder	getFolder() Get the folder from which this message was obtained.
abstract Address[]	getFrom() Returns the "From" attribute.
int	getMessageNumber() Get the Message number for this Message.
abstract Date	getReceivedDate() Get the date this message was received.
abstract Address[]	getRecipients(Message.RecipientType type) Get all the recipient addresses of the given type.
Address[]	getReplyTo() Get the addresses to which replies should be directed.
abstract Date	getSentDate() Get the date this message was sent.
abstract String	getSubject() Get the subject of this message.
boolean	isExpunged() Checks whether this message is expunged.
boolean	isSet(Flags.Flag flag) Check whether the flag specified in the `flag` argument is set in this message.
boolean	match(SearchTerm term) Apply the specified Search criterion to this message.
abstract Message	reply(boolean replyToAll) Get a new Message suitable for a reply to this message.
abstract void	saveChanges() 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.
void	setExpunged(boolean expunged) Sets the expunged flag for this Message.
void	setFlag(Flags.Flag flag, boolean set) Set the specified flag on this message to the specified value.
abstract void	setFlags(Flags flag, boolean set) Set the specified flags on this message to the specified value.
abstract void	setFrom() Set the "From" attribute in this Message.
abstract void	setFrom(Address address) Set the "From" attribute in this Message.
void	setMessageNumber(int msgnum) Set the Message number for this Message.
void	setRecipient(Message.RecipientType type, Address address) Set the recipient address.
abstract void	setRecipients(Message.RecipientType type, Address[] addresses) Set the recipient addresses.
void	setReplyTo(Address[] addresses) Set the addresses to which replies should be directed.
abstract void	setSentDate(Date date) Set the sent date of this message.
abstract void	setSubject(String subject) Set the subject of this message.

From class java.lang.Object

From interface com.google.code.javax.mail.HasRawInputStream

From interface com.google.code.javax.mail.Part

abstract void	addHeader(String header_name, String header_value) Add this value to the existing values for this header_name.
abstract Enumeration	getAllHeaders() Return all the headers from this part as an Enumeration of Header objects.
abstract Object	getContent() Return the content as a Java object.
abstract String	getContentType() Returns the Content-Type of the content of this part.
abstract DataHandler	getDataHandler() Return a DataHandler for the content within this part.
abstract String	getDescription() Return a description String for this part.
abstract String	getDisposition() Return the disposition of this part.
abstract String	getFileName() Get the filename associated with this part, if possible.
abstract String[]	getHeader(String header_name) Get all the headers for this header name.
abstract InputStream	getInputStream() Return an input stream for this part's "content".
abstract int	getLineCount() Return the number of lines in the content of this part.
abstract Enumeration	getMatchingHeaders(String[] header_names) Return matching headers from this part as an Enumeration of Header objects.
abstract Enumeration	getNonMatchingHeaders(String[] header_names) Return non-matching headers from this envelope as an Enumeration of Header objects.
abstract int	getSize() Return the size of the content of this part in bytes.
abstract boolean	isMimeType(String mimeType) Is this Part of the specified MIME type? This method compares only the `primaryType` and `subType`.
abstract void	removeHeader(String header_name) Remove all headers with this name.
abstract void	setContent(Object obj, String type) A convenience method for setting this part's content.
abstract void	setContent(Multipart mp) This method sets the given Multipart object as this message's content.
abstract void	setDataHandler(DataHandler dh) This method provides the mechanism to set this part's content.
abstract void	setDescription(String description) Set a description String for this part.
abstract void	setDisposition(String disposition) Set the disposition of this part.
abstract void	setFileName(String filename) Set the filename associated with this part, if possible.
abstract void	setHeader(String header_name, String header_value) Set the value for this header_name.
abstract void	setText(String text) A convenience method that sets the given String as this part's content with a MIME type of "text/plain".
abstract void	writeTo(OutputStream os) Output a bytestream for this Part.

From interface com.google.code.javax.mail.internet.MimePart

abstract void	addHeaderLine(String line) Add a raw RFC822 header-line.
abstract Enumeration	getAllHeaderLines() Get all header lines as an Enumeration of Strings.
abstract String	getContentID() Get the Content-ID of this part.
abstract String[]	getContentLanguage() Get the language tags specified in the Content-Language header of this MimePart.
abstract String	getContentMD5() Get the Content-MD5 digest of this part.
abstract String	getEncoding() Get the transfer encoding of this part.
abstract String	getHeader(String name, String delimiter) Get the values of all header fields available for this header, returned as a single String, with the values separated by the delimiter.
abstract Enumeration	getMatchingHeaderLines(String[] names) Get matching header lines as an Enumeration of Strings.
abstract Enumeration	getNonMatchingHeaderLines(String[] names) Get non-matching header lines as an Enumeration of Strings.
abstract void	setContentLanguage(String[] languages) Set the Content-Language header of this MimePart.
abstract void	setContentMD5(String md5) Set the Content-MD5 of this part.
abstract void	setText(String text) Convenience method that sets the given String as this part's content, with a MIME type of "text/plain".
abstract void	setText(String text, String charset, String subtype) Convenience method that sets the given String as this part's content, with a primary MIME type of "text" and the specified MIME subtype.
abstract void	setText(String text, String charset) Convenience method that sets the given String as this part's content, with a MIME type of "text/plain" and the specified charset.

Constants

public static final int NOTIFY_DELAY

Notify of delivery delay

Constant Value: 4 (0x00000004)

public static final int NOTIFY_FAILURE

Notify of delivery failure

Constant Value: 2 (0x00000002)

public static final int NOTIFY_NEVER

Never notify of delivery status

Constant Value: -1 (0xffffffff)

public static final int NOTIFY_SUCCESS

Notify of delivery success

Constant Value: 1 (0x00000001)

public static final int RETURN_FULL

Return full message with delivery status notification

Constant Value: 1 (0x00000001)

public static final int RETURN_HDRS

Return only message headers with delivery status notification

Constant Value: 2 (0x00000002)

Fields

private boolean allow8bitMIME

private String envelopeFrom

private String extension

private int notifyOptions

private int returnOption

private static final String[] returnOptionString

private boolean sendPartial

private String submitter

Public Constructors

public SMTPMessage (Session session)

Default constructor. An empty message object is created. The headers field is set to an empty InternetHeaders object. The flags field is set to an empty Flags object. The modified flag is set to true.

Parameters

session

public SMTPMessage (Session session, InputStream is)

Constructs an SMTPMessage by reading and parsing the data from the specified MIME InputStream. The InputStream will be left positioned at the end of the data for the message. Note that the input stream parse is done within this constructor itself.

Parameters

session	Session object for this message
is	The message input stream

Throws

MessagingException

public SMTPMessage (MimeMessage source)

Constructs a new SMTPMessage with content initialized from the source MimeMessage. The new message is independent of the original.

Note: The current implementation is rather inefficient, copying the data more times than strictly necessary.

Parameters

source	The message to copy content from

Throws

MessagingException

Public Methods

public boolean getAllow8bitMIME ()

Is use of the 8BITMIME extension is allowed?

Returns

allow 8-bit flag

public String getEnvelopeFrom ()

Return the envelope From address.

Returns

the envelope From address, or null if not set

public String getMailExtension ()

Gets the extension string to use with the MAIL command.

Returns

the extension string

public int getNotifyOptions ()

Get notification options. Returns zero if no options set.

Returns

notification options

public int getReturnOption ()

Return return option. Returns zero if no option set.

Returns

return option

public boolean getSendPartial ()

Send message if some addresses are invalid?

Returns

send partial flag

public String getSubmitter ()

Gets the submitter to be used for the RFC 2554 AUTH= value in the MAIL FROM command.

Returns

the name of the submitter.

public void setAllow8bitMIME (boolean allow)

If set to true, and the server supports the 8BITMIME extension, text parts of this message that use the "quoted-printable" or "base64" encodings are converted to use "8bit" encoding if they follow the RFC 2045 rules for 8bit text.

If true, overrides the mail.smtp.allow8bitmime property.

Parameters

allow	Allow 8-bit flag

public void setEnvelopeFrom (String from)

Set the From address to appear in the SMTP envelope. Note that this is different than the From address that appears in the message itself. The envelope From address is typically used when reporting errors. See RFC 821 for details.

If set, overrides the mail.smtp.from property.

Parameters

from	The envelope From address

public void setMailExtension (String extension)

Set the extension string to use with the MAIL command. The extension string can be used to specify standard SMTP service extensions as well as vendor-specific extensions. Typically the application should use the com.sun.mail.smtp.SMTPTransport SMTPTransport method com.sun.mail.smtp.SMTPTransport#supportsExtension supportsExtension to verify that the server supports the desired service extension. See RFC 1869 and other RFCs that define specific extensions.

For example:

 if (smtpTransport.supportsExtension("DELIVERBY"))
    smtpMsg.setMailExtension("BY=60;R");

Parameters

extension

public void setNotifyOptions (int options)

Set notification options to be used if the server supports Delivery Status Notification (RFC 1891). Either NOTIFY_NEVER or some combination of NOTIFY_SUCCESS, NOTIFY_FAILURE, and NOTIFY_DELAY.

If set, overrides the mail.smtp.dsn.notify property.

Parameters

options	Notification options

public void setReturnOption (int option)

Set return option to be used if server supports Delivery Status Notification (RFC 1891). Either RETURN_FULL or RETURN_HDRS.

If set, overrides the mail.smtp.dsn.ret property.

Parameters

option	Return option

public void setSendPartial (boolean partial)

If set to true, and this message has some valid and some invalid addresses, send the message anyway, reporting the partial failure with a SendFailedException. If set to false (the default), the message is not sent to any of the recipients if there is an invalid recipient address.

If true, overrides the mail.smtp.sendpartial property.

Parameters

partial	Send partial flag

public void setSubmitter (String submitter)

Sets the submitter to be used for the RFC 2554 AUTH= value in the MAIL FROM command. Normally only used by a server that's relaying a message. Clients will typically not set a submitter. See RFC 2554 for details.

Parameters

submitter	The name of the submitter

Interfaces

Classes

Exceptions

SMTPMessage

Class Overview

See Also

Summary

Constants

public static final int NOTIFY_DELAY

public static final int NOTIFY_FAILURE

public static final int NOTIFY_NEVER

public static final int NOTIFY_SUCCESS

public static final int RETURN_FULL

public static final int RETURN_HDRS

Fields

private boolean allow8bitMIME

private String envelopeFrom

private String extension

private int notifyOptions

private int returnOption

private static final String[] returnOptionString

private boolean sendPartial

private String submitter

Public Constructors

public SMTPMessage (Session session)

Parameters

public SMTPMessage (Session session, InputStream is)

Parameters

Throws

public SMTPMessage (MimeMessage source)

Parameters

Throws

Public Methods

public boolean getAllow8bitMIME ()

Returns

public String getEnvelopeFrom ()

Returns

public String getMailExtension ()

Returns

public int getNotifyOptions ()

Returns

public int getReturnOption ()

Returns

public boolean getSendPartial ()

Returns

public String getSubmitter ()

Returns

public void setAllow8bitMIME (boolean allow)

Parameters

public void setEnvelopeFrom (String from)

Parameters

public void setMailExtension (String extension)

Parameters

public void setNotifyOptions (int options)

Parameters

public void setReturnOption (int option)

Parameters

public void setSendPartial (boolean partial)

Parameters

public void setSubmitter (String submitter)

Parameters