Apache Ant Core 1.10.14 · org.apache.tools.ant.taskdefs.email.EmailTask

Modifier and Type	Class and Description
public static class	EmailTask.Encoding Enumerates the encoding constants.

Field Summary

Modifier and Type	Field and Description
private Path	attachments file list
public static final String	AUTO Constant to show that the best available mailer should be used.
private Vector<EmailAddress>	bccList BCC (Blind Carbon Copy) recipients
private Vector<EmailAddress>	ccList CC (Carbon Copy) recipients
private String	charset Character set for MimeMailer
private String	encoding
private boolean	failOnError failure flag
private EmailAddress	from sender
private Vector<Header>	headers generic headers
private String	host host running SMTP
private boolean	ignoreInvalidRecipients ignore invalid recipients?
private boolean	includeFileNames
private Message	message any text
private String	messageFileInputEncoding
private String	messageMimeType
public static final String	MIME Constant to allow the Mime mailer to be requested
private String	password Password for SMTP auth
public static final String	PLAIN Constant to allow the plaintext mailer to be requested
private Integer	port
private Vector<EmailAddress>	replyToList replyto
private static final int	SMTP_PORT
private boolean	ssl indicate if the user wishes SSL-TLS
private boolean	starttls indicate if the user wishes support for STARTTLS
private String	subject subject field
private Vector<EmailAddress>	toList TO recipients
private String	user User for SMTP auth
public static final String	UU Constant to allow the UU mailer to be requested

Inherited from org.apache.tools.ant.Task:: target taskName taskType wrapper

Constructor Summary

Access	Constructor and Description
public	EmailTask()

Method Summary

Modifier and Type	Method and Description
public void	addBcc(EmailAddress The email address. address) Add a "bcc" address element.
public void	addCc(EmailAddress The email address. address) Add a "cc" address element.
public void	addFileset(FileSet The fileset. fs) Add a set of files (nested fileset attribute).
public void	addFrom(EmailAddress The address to send from. address) Add a from address element.
public void	addMessage(Message The message object. message) Add a message element.
public void	addReplyTo(EmailAddress The address to reply to. address) Add a replyto address element.
public void	addTo(EmailAddress An email address. address) Add a to address element.
public Path	Returns: the path to be configured. createAttachments() Creates a Path as container for attachments.
public Header	Returns: a Header instance. createHeader() Create a nested header element.
public void	execute() Overrides org.apache.tools.ant.Task.execute. Send an email.
public String	Returns: Charset of mail message. getCharset() Returns the character set of mail message.
public boolean	Returns: Identifies whether file names should be included. getIncludeFileNames() Get whether file names should be included.
private String	getMailerImplementation()
private void	logBuildException(String reason, BuildException e)
public void	setBccList(String comma separated list of addresses. list) Shorthand to set the "bcc" address element.
public void	setCcList(String Comma separated list of addresses. list) Shorthand to set the "cc" address element.
public void	setCharset(String the character encoding to use. charset) Sets the character set of mail message.
public void	setEnableStartTLS(boolean boolean; if true STARTTLS will be supported. b) Set whether to allow authentication to switch to a TLS connection via STARTTLS.
public void	setEncoding(EmailTask.Encoding The encoding (one of AUTO, MIME, UU, PLAIN). encoding) Set the preferred encoding method.
public void	setFailOnError(boolean The new FailOnError value. failOnError) Set whether BuildExceptions should be passed back to the core.
public void	setFiles(String Comma-separated list of files. filenames) Set the list of files to be attached.
public void	setFrom(String The address to send mail from. address) Shorthand to set the from address element.
public void	setIgnoreInvalidRecipients(boolean boolean b) Whether invalid recipients should be ignored (but a warning will be logged) instead of making the task fail.
public void	setIncludefilenames(boolean Whether to include filenames in the text of the message. includeFileNames) Set whether to include filenames.
public void	setMailhost(String The host to connect to. host) Set the host.
public void	setMailport(int The port to use. port) Set the mail server port.
public void	setMessage(String Message body of this email. message) Shorthand method to set the message.
public void	setMessageFile(File The file from which to take the message. file) Shorthand method to set the message from a file.
public void	setMessageFileInputEncoding(String the name of the charset used encoding) Sets the encoding to expect when reading the message from a file.
public void	setMessageMimeType(String The new MessageMimeType value. type) Shorthand method to set type of the text message, text/plain by default but text/html or text/xml is quite feasible.
public void	setPassword(String the String password. password) Set the password for SMTP auth; this requires JavaMail.
public void	setReplyTo(String The address to which replies should be directed. address) Shorthand to set the replyto address element.
public void	setSSL(boolean boolean; if true SSL will be used. ssl) Set whether to send data over SSL.
public void	setSubject(String Subject of this email. subject) Set the subject line of the email.
public void	setToList(String Comma-separated list of addresses. list) Shorthand to set the "to" address element.
public void	setUser(String the String username. user) Set the user for SMTP auth; this requires JavaMail.

Field Detail

attachments	back to summary
private Path attachments file list

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

bccList	back to summary
private Vector<EmailAddress> bccList BCC (Blind Carbon Copy) recipients

ccList	back to summary
private Vector<EmailAddress> ccList CC (Carbon Copy) recipients

charset	back to summary
private String charset Character set for MimeMailer

encoding	back to summary
private String encoding

failOnError	back to summary
private boolean failOnError failure flag

from	back to summary
private EmailAddress from sender

headers	back to summary
private Vector<Header> headers generic headers

host	back to summary
private String host host running SMTP

ignoreInvalidRecipients	back to summary
private boolean ignoreInvalidRecipients ignore invalid recipients?

includeFileNames	back to summary
private boolean includeFileNames

message	back to summary
private Message message any text

messageFileInputEncoding	back to summary
private String messageFileInputEncoding

messageMimeType	back to summary
private String messageMimeType

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

password	back to summary
private String password Password for SMTP auth

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

port	back to summary
private Integer port

replyToList	back to summary
private Vector<EmailAddress> replyToList replyto

SMTP_PORT	back to summary
private static final int SMTP_PORT

ssl	back to summary
private boolean ssl indicate if the user wishes SSL-TLS

starttls	back to summary
private boolean starttls indicate if the user wishes support for STARTTLS

subject	back to summary
private String subject subject field

toList	back to summary
private Vector<EmailAddress> toList TO recipients

user	back to summary
private String user User for SMTP auth

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

Constructor Detail

EmailTask	back to summary
public EmailTask()

Method Detail

addBcc	back to summary
public void addBcc(EmailAddress address) Add a "bcc" address element. Parameters address:EmailAddress The email address.

addBcc

back to summary

public void addBcc(EmailAddress address)

Add a "bcc" address element.

Parameters

address:EmailAddress: The email address.

addCc	back to summary
public void addCc(EmailAddress address) Add a "cc" address element. Parameters address:EmailAddress The email address.

addCc

back to summary

public void addCc(EmailAddress address)

Add a "cc" address element.

Parameters

address:EmailAddress: The email address.

addFileset	back to summary
public void addFileset(FileSet fs) Add a set of files (nested fileset attribute). Parameters fs:FileSet The fileset.

addFileset

back to summary

public void addFileset(FileSet fs)

Add a set of files (nested fileset attribute).

Parameters

fs:FileSet: The fileset.

addFrom	back to summary
public void addFrom(EmailAddress address) Add a from address element. Parameters address:EmailAddress The address to send from.

addFrom

back to summary

public void addFrom(EmailAddress address)

Add a from address element.

Parameters

address:EmailAddress: The address to send from.

addMessage	back to summary
public void addMessage(Message message) throws BuildException Add a message element. Parameters message:Message The message object. Exceptions BuildException: if a message has already been added.

addMessage

back to summary

public void addMessage(Message message) throws BuildException

Add a message element.

Parameters

message:Message: The message object.

Exceptions

BuildException:: if a message has already been added.

addReplyTo	back to summary
public void addReplyTo(EmailAddress address) Add a replyto address element. Parameters address:EmailAddress The address to reply to. Since Ant 1.6

addReplyTo

back to summary

public void addReplyTo(EmailAddress address)

Add a replyto address element.

Parameters

address:EmailAddress: The address to reply to.

Since

Ant 1.6

addTo	back to summary
public void addTo(EmailAddress address) Add a to address element. Parameters address:EmailAddress An email address.

addTo

back to summary

public void addTo(EmailAddress address)

Add a to address element.

Parameters

address:EmailAddress: An email address.

createAttachments	back to summary
public Path createAttachments() Creates a Path as container for attachments. Supports any filesystem resource-collections that way. Returns:Path the path to be configured. Since Ant 1.7

createAttachments

back to summary

public Path createAttachments()

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

Returns:Path: the path to be configured.
Since: Ant 1.7

createHeader	back to summary
public Header createHeader() Create a nested header element. Returns:Header a Header instance.

createHeader

back to summary

public Header createHeader()

Create a nested header element.

Returns:Header: a Header instance.

execute	back to summary
public void execute() Overrides org.apache.tools.ant.Task.execute. Send an email. Annotations @Override

execute

back to summary

public void execute()

Overrides org.apache.tools.ant.Task.execute.

Send an email.

Annotations

@Override

getCharset	back to summary
public String getCharset() Returns the character set of mail message. Returns:String Charset of mail message. Since Ant 1.6

getCharset

back to summary

public String getCharset()

Returns the character set of mail message.

Returns:String: Charset of mail message.
Since: Ant 1.6

getIncludeFileNames	back to summary
public boolean getIncludeFileNames() Get whether file names should be included. Returns:boolean Identifies whether file names should be included.

getIncludeFileNames

back to summary

public boolean getIncludeFileNames()

Get whether file names should be included.

Returns:boolean: Identifies whether file names should be included.

getMailerImplementation	back to summary
private String getMailerImplementation()

logBuildException	back to summary
private void logBuildException(String reason, BuildException e)

setBccList	back to summary
public void setBccList(String list) Shorthand to set the "bcc" address element. Parameters list:String comma separated list of addresses.

setBccList

back to summary

public void setBccList(String list)

Shorthand to set the "bcc" address element.

Parameters

list:String: comma separated list of addresses.

setCcList	back to summary
public void setCcList(String list) Shorthand to set the "cc" address element. Parameters list:String Comma separated list of addresses.

setCcList

back to summary

public void setCcList(String list)

Shorthand to set the "cc" address element.

Parameters

list:String: Comma separated list of addresses.

setCharset back to summary

setCharset	back to summary
public void setCharset(String charset) Sets the character set of mail message. Will be ignored if mimeType contains ....; Charset=... substring or encoding is not `mime`. Parameters charset:String the character encoding to use. Since Ant 1.6

public void setCharset(String charset)

Sets the character set of mail message. Will be ignored if mimeType contains ....; Charset=... substring or encoding is not mime.

Parameters

charset:String: the character encoding to use.

Since

Ant 1.6

setEnableStartTLS	back to summary
public void setEnableStartTLS(boolean b) Set whether to allow authentication to switch to a TLS connection via STARTTLS. Parameters b:boolean boolean; if true STARTTLS will be supported. Since Ant 1.8.0

setEnableStartTLS

back to summary

public void setEnableStartTLS(boolean b)

Set whether to allow authentication to switch to a TLS connection via STARTTLS.

Parameters

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

Since

Ant 1.8.0

setEncoding

back to summary

public void setEncoding(EmailTask.Encoding encoding)

Set the preferred encoding method.

Parameters

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

setFailOnError

back to summary

public void setFailOnError(boolean failOnError)

Set whether BuildExceptions should be passed back to the core.

Parameters

failOnError:boolean: The new FailOnError value.

setFiles

back to summary

public void setFiles(String filenames)

Set the list of files to be attached.

Parameters

filenames:String: Comma-separated list of files.

setFrom

back to summary

public void setFrom(String address)

Shorthand to set the from address element.

Parameters

address:String: The address to send mail from.

setIgnoreInvalidRecipients

back to summary

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.

Parameters

b:boolean: boolean

Since

Ant 1.8.0

setIncludefilenames

back to summary

public void setIncludefilenames(boolean includeFileNames)

Set whether to include filenames.

Parameters

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

setMailhost

back to summary

public void setMailhost(String host)

Set the host.

Parameters

host:String: The host to connect to.

setMailport

back to summary

public void setMailport(int port)

Set the mail server port.

Parameters

port:int: The port to use.

setMessage

back to summary

public void setMessage(String message)

Shorthand method to set the message.

Parameters

message:String: Message body of this email.

setMessageFile

back to summary

public void setMessageFile(File file)

Shorthand method to set the message from a file.

Parameters

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

setMessageFileInputEncoding

back to summary

public void setMessageFileInputEncoding(String encoding)

Sets the encoding to expect when reading the message from a file.

Will be ignored if the message has been specified inline.

Parameters

encoding:String: the name of the charset used

Since

Ant 1.9.4

setMessageMimeType

back to summary

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:String: The new MessageMimeType value.

setPassword

back to summary

public void setPassword(String password)

Set the password for SMTP auth; this requires JavaMail.

Parameters

password:String: the String password.

Since

Ant 1.6

setReplyTo

back to summary

public void setReplyTo(String address)

Shorthand to set the replyto address element.

Parameters

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

Since

Ant 1.6

setSSL

back to summary

public void setSSL(boolean ssl)

Set whether to send data over SSL.

Parameters

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

Since

Ant 1.6

setSubject

back to summary

public void setSubject(String subject)

Set the subject line of the email.

Parameters

subject:String: Subject of this email.

setToList

back to summary

public void setToList(String list)

Shorthand to set the "to" address element.

Parameters

list:String: Comma-separated list of addresses.

setUser

back to summary

public void setUser(String user)

Set the user for SMTP auth; this requires JavaMail.

Parameters

user:String: the String username.

Since

Ant 1.6

public Class EmailTask

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class EmailTask.Encoding

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail