org.apache.tools.ant.taskdefs.email

Class EmailTask

public class EmailTask extends Task

A task to send SMTP email. This is a refactoring of the SendMail and MimeMail tasks such that both are within a single task.

Since: Ant 1.5

UNKNOWN: name="mail" category="network"

Nested Class Summary
static classEmailTask.Encoding
Enumerates the encoding constants.
Field Summary
static StringAUTO
Constant to show that the best available mailer should be used.
static StringMIME
Constant to allow the Mime mailer to be requested
static StringPLAIN
Constant to allow the plaintext mailer to be requested
static StringUU
Constant to allow the UU mailer to be requested
Method Summary
voidaddBcc(EmailAddress address)
Add a "bcc" address element.
voidaddCc(EmailAddress address)
Add a "cc" address element.
voidaddFileset(FileSet fs)
Add a set of files (nested fileset attribute).
voidaddFrom(EmailAddress address)
Add a from address element.
voidaddMessage(Message message)
Add a message element.
voidaddReplyTo(EmailAddress address)
Add a replyto address element.
voidaddTo(EmailAddress address)
Add a to address element.
PathcreateAttachments()
Creates a Path as container for attachments.
HeadercreateHeader()
Create a nested header element.
voidexecute()
Send an email.
StringgetCharset()
Returns the character set of mail message.
booleangetIncludeFileNames()
Get whether file names should be included.
voidsetBccList(String list)
Shorthand to set the "bcc" address element.
voidsetCcList(String list)
Shorthand to set the "cc" address element.
voidsetCharset(String charset)
Sets the character set of mail message.
voidsetEnableStartTLS(boolean b)
Set whether to allow authentication to switch to a TLS connection via STARTTLS.
voidsetEncoding(EmailTask.Encoding encoding)
Set the preferred encoding method.
voidsetFailOnError(boolean failOnError)
Set whether BuildExceptions should be passed back to the core.
voidsetFiles(String filenames)
Set the list of files to be attached.
voidsetFrom(String address)
Shorthand to set the from address element.
voidsetIgnoreInvalidRecipients(boolean b)
Whether invalid recipients should be ignored (but a warning will be logged) instead of making the task fail.
voidsetIncludefilenames(boolean includeFileNames)
Set whether to include filenames.
voidsetMailhost(String host)
Set the host.
voidsetMailport(int port)
Set the mail server port.
voidsetMessage(String message)
Shorthand method to set the message.
voidsetMessageFile(File file)
Shorthand method to set the message from a file.
voidsetMessageMimeType(String type)
Shorthand method to set type of the text message, text/plain by default but text/html or text/xml is quite feasible.
voidsetPassword(String password)
Set the password for SMTP auth; this requires JavaMail.
voidsetReplyTo(String address)
Shorthand to set the replyto address element.
voidsetSSL(boolean ssl)
Set whether to send data over SSL.
voidsetSubject(String subject)
Set the subject line of the email.
voidsetToList(String list)
Shorthand to set the "to" address element.
voidsetUser(String user)
Set the user for SMTP auth; this requires JavaMail.

Field Detail

AUTO

public static final String AUTO
Constant to show that the best available mailer should be used.

MIME

public static final String MIME
Constant to allow the Mime mailer to be requested

PLAIN

public static final String PLAIN
Constant to allow the plaintext mailer to be requested

UU

public static final String UU
Constant to allow the UU mailer to be requested

Method Detail

addBcc

public void addBcc(EmailAddress address)
Add a "bcc" address element.

Parameters: address The email address.

addCc

public void addCc(EmailAddress address)
Add a "cc" address element.

Parameters: address The email address.

addFileset

public void addFileset(FileSet fs)
Add a set of files (nested fileset attribute).

Parameters: fs The fileset.

addFrom

public void addFrom(EmailAddress address)
Add a from address element.

Parameters: address The address to send from.

addMessage

public void addMessage(Message message)
Add a message element.

Parameters: message The message object.

Throws: BuildException if a message has already been added.

addReplyTo

public void addReplyTo(EmailAddress address)
Add a replyto address element.

Parameters: address The address to reply to.

Since: Ant 1.6

addTo

public void addTo(EmailAddress address)
Add a to address element.

Parameters: address An email address.

createAttachments

public Path createAttachments()
Creates a Path as container for attachments. Supports any filesystem resource-collections that way.

Returns: the path to be configured.

Since: Ant 1.7

createHeader

public Header createHeader()
Create a nested header element.

Returns: a Header instance.

execute

public void execute()
Send an email.

getCharset

public String getCharset()
Returns the character set of mail message.

Returns: Charset of mail message.

Since: Ant 1.6

getIncludeFileNames

public boolean getIncludeFileNames()
Get whether file names should be included.

Returns: Identifies whether file names should be included.

setBccList

public void setBccList(String list)
Shorthand to set the "bcc" address element.

Parameters: list comma separated list of addresses.

setCcList

public void setCcList(String list)
Shorthand to set the "cc" address element.

Parameters: list Comma separated list of addresses.

setCharset

public void setCharset(String charset)
Sets the character set of mail message. Will be ignored if mimeType contains ....; Charset=... substring or encoding is not a mime.

Parameters: charset the character encoding to use.

Since: Ant 1.6

setEnableStartTLS

public void setEnableStartTLS(boolean b)
Set whether to allow authentication to switch to a TLS connection via STARTTLS.

Parameters: b boolean; if true STARTTLS will be supported.

Since: Ant 1.8.0

setEncoding

public void setEncoding(EmailTask.Encoding encoding)
Set the preferred encoding method.

Parameters: encoding The encoding (one of AUTO, MIME, UU, PLAIN).

setFailOnError

public void setFailOnError(boolean failOnError)
Set whether BuildExceptions should be passed back to the core.

Parameters: failOnError The new FailOnError value.

setFiles

public void setFiles(String filenames)
Set the list of files to be attached.

Parameters: filenames Comma-separated list of files.

setFrom

public void setFrom(String address)
Shorthand to set the from address element.

Parameters: address The address to send mail from.

setIgnoreInvalidRecipients

public void setIgnoreInvalidRecipients(boolean b)
Whether invalid recipients should be ignored (but a warning will be logged) instead of making the task fail.

Even with this property set to true the task will still fail if the mail couldn't be sent to any recipient at all.

Since: Ant 1.8.0

setIncludefilenames

public void setIncludefilenames(boolean includeFileNames)
Set whether to include filenames.

Parameters: includeFileNames Whether to include filenames in the text of the message.

setMailhost

public void setMailhost(String host)
Set the host.

Parameters: host The host to connect to.

setMailport

public void setMailport(int port)
Set the mail server port.

Parameters: port The port to use.

setMessage

public void setMessage(String message)
Shorthand method to set the message.

Parameters: message Message body of this email.

setMessageFile

public void setMessageFile(File file)
Shorthand method to set the message from a file.

Parameters: file The file from which to take the message.

setMessageMimeType

public void setMessageMimeType(String type)
Shorthand method to set type of the text message, text/plain by default but text/html or text/xml is quite feasible.

Parameters: type The new MessageMimeType value.

setPassword

public void setPassword(String password)
Set the password for SMTP auth; this requires JavaMail.

Parameters: password the String password.

Since: Ant 1.6

setReplyTo

public void setReplyTo(String address)
Shorthand to set the replyto address element.

Parameters: address The address to which replies should be directed.

Since: Ant 1.6

setSSL

public void setSSL(boolean ssl)
Set whether to send data over SSL.

Parameters: ssl boolean; if true SSL will be used.

Since: Ant 1.6

setSubject

public void setSubject(String subject)
Set the subject line of the email.

Parameters: subject Subject of this email.

setToList

public void setToList(String list)
Shorthand to set the "to" address element.

Parameters: list Comma-separated list of addresses.

setUser

public void setUser(String user)
Set the user for SMTP auth; this requires JavaMail.

Parameters: user the String username.

Since: Ant 1.6