org.apache.tools.ant.taskdefs.email
public class EmailTask extends Task
Since: Ant 1.5
UNKNOWN: name="mail" category="network"
Nested Class Summary | |
---|---|
static class | EmailTask.Encoding
Enumerates the encoding constants. |
Field Summary | |
---|---|
static String | AUTO Constant to show that the best available mailer should be used. |
static String | MIME Constant to allow the Mime mailer to be requested |
static String | PLAIN Constant to allow the plaintext mailer to be requested |
static String | UU Constant to allow the UU mailer to be requested |
Method Summary | |
---|---|
void | addBcc(EmailAddress address)
Add a "bcc" address element.
|
void | addCc(EmailAddress address)
Add a "cc" address element.
|
void | addFileset(FileSet fs)
Add a set of files (nested fileset attribute).
|
void | addFrom(EmailAddress address)
Add a from address element.
|
void | addMessage(Message message)
Add a message element.
|
void | addReplyTo(EmailAddress address)
Add a replyto address element.
|
void | addTo(EmailAddress address)
Add a to address element.
|
Path | createAttachments()
Creates a Path as container for attachments. |
Header | createHeader()
Create a nested header element. |
void | execute()
Send an email. |
String | getCharset()
Returns the character set of mail message.
|
boolean | getIncludeFileNames()
Get whether file names should be included.
|
void | setBccList(String list)
Shorthand to set the "bcc" address element.
|
void | setCcList(String list)
Shorthand to set the "cc" address element.
|
void | setCharset(String charset)
Sets the character set of mail message.
|
void | setEncoding(EmailTask.Encoding encoding)
Set the preferred encoding method.
|
void | setFailOnError(boolean failOnError)
Set whether BuildExceptions should be passed back to the core.
|
void | setFiles(String filenames)
Set the list of files to be attached.
|
void | setFrom(String address)
Shorthand to set the from address element.
|
void | setIncludefilenames(boolean includeFileNames)
Set whether to include filenames.
|
void | setMailhost(String host)
Set the host.
|
void | setMailport(int port)
Set the mail server port.
|
void | setMessage(String message)
Shorthand method to set the message.
|
void | setMessageFile(File file)
Shorthand method to set the message from a file.
|
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.
|
void | setPassword(String password)
Set the password for SMTP auth; this requires JavaMail. |
void | setReplyTo(String address)
Shorthand to set the replyto address element.
|
void | setSSL(boolean ssl)
Set whether to send data over SSL. |
void | setSubject(String subject)
Set the subject line of the email.
|
void | setToList(String list)
Shorthand to set the "to" address element.
|
void | setUser(String user)
Set the user for SMTP auth; this requires JavaMail. |
Parameters: address The email address.
Parameters: address The email address.
Parameters: fs The fileset.
Parameters: address The address to send from.
Parameters: message The message object.
Throws: BuildException if a message has already been added.
Parameters: address The address to reply to.
Since: Ant 1.6
Parameters: address An email address.
Returns: the path to be configured.
Since: Ant 1.7
Returns: a Header instance.
Returns: Charset of mail message.
Since: Ant 1.6
Returns: Identifies whether file names should be included.
Parameters: list comma separated list of addresses.
Parameters: list Comma separated list of addresses.
mime
.Parameters: charset the character encoding to use.
Since: Ant 1.6
Parameters: encoding The encoding (one of AUTO, MIME, UU, PLAIN).
Parameters: failOnError The new FailOnError value.
Parameters: filenames Comma-separated list of files.
Parameters: address The address to send mail from.
Parameters: includeFileNames Whether to include filenames in the text of the message.
Parameters: host The host to connect to.
Parameters: port The port to use.
Parameters: message Message body of this email.
Parameters: file The file from which to take the message.
Parameters: type The new MessageMimeType value.
Parameters: password the String password.
Since: Ant 1.6
Parameters: address The address to which replies should be directed.
Since: Ant 1.6
Parameters: ssl boolean; if true SSL will be used.
Since: Ant 1.6
Parameters: subject Subject of this email.
Parameters: list Comma-separated list of addresses.
Parameters: user the String username.
Since: Ant 1.6