Class EmailTask
java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.apache.tools.ant.taskdefs.email.EmailTask
- 
Nested Class SummaryNested ClassesModifier and TypeClassDescriptionstatic classEnumerates the encoding constants.
- 
Field SummaryFieldsModifier and TypeFieldDescriptionstatic final StringConstant to show that the best available mailer should be used.static final StringConstant to allow the Mime mailer to be requestedstatic final StringConstant to allow the plaintext mailer to be requestedstatic final StringConstant to allow the UU mailer to be requestedFields inherited from class org.apache.tools.ant.ProjectComponentdescription, location, project
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionvoidaddBcc(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.Creates a Path as container for attachments.Create a nested header element.voidexecute()Send an email.Returns the character set of mail message.booleanGet whether file names should be included.voidsetBccList(String list) Shorthand to set the "bcc" address element.voidShorthand 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.voidSet the list of files to be attached.voidShorthand 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.voidsetMessageFileInputEncoding(String encoding) Sets the encoding to expect when reading 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.voidShorthand to set the "to" address element.voidSet the user for SMTP auth; this requires JavaMail.Methods inherited from class org.apache.tools.ant.TaskbindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskTypeMethods inherited from class org.apache.tools.ant.ProjectComponentclone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
- 
Field Details- 
AUTOConstant to show that the best available mailer should be used.- See Also:
 
- 
MIME
- 
UU
- 
PLAIN
 
- 
- 
Constructor Details- 
EmailTaskpublic EmailTask()
 
- 
- 
Method Details- 
setUserSet the user for SMTP auth; this requires JavaMail.- Parameters:
- user- the String username.
- Since:
- Ant 1.6
 
- 
setPasswordSet the password for SMTP auth; this requires JavaMail.- Parameters:
- password- the String password.
- Since:
- Ant 1.6
 
- 
setSSLpublic void setSSL(boolean ssl) Set whether to send data over SSL.- Parameters:
- ssl- boolean; if true SSL will be used.
- Since:
- Ant 1.6
 
- 
setEnableStartTLSpublic 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
 
- 
setEncodingSet the preferred encoding method.- Parameters:
- encoding- The encoding (one of AUTO, MIME, UU, PLAIN).
 
- 
setMailportpublic void setMailport(int port) Set the mail server port.- Parameters:
- port- The port to use.
 
- 
setMailhost
- 
setSubjectSet the subject line of the email.- Parameters:
- subject- Subject of this email.
 
- 
setMessageShorthand method to set the message.- Parameters:
- message- Message body of this email.
 
- 
setMessageFileShorthand method to set the message from a file.- Parameters:
- file- The file from which to take the message.
 
- 
setMessageMimeTypeShorthand 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.
 
- 
addMessageAdd a message element.- Parameters:
- message- The message object.
- Throws:
- BuildException- if a message has already been added.
 
- 
addFromAdd a from address element.- Parameters:
- address- The address to send from.
 
- 
setFromShorthand to set the from address element.- Parameters:
- address- The address to send mail from.
 
- 
addReplyToAdd a replyto address element.- Parameters:
- address- The address to reply to.
- Since:
- Ant 1.6
 
- 
setReplyToShorthand to set the replyto address element.- Parameters:
- address- The address to which replies should be directed.
- Since:
- Ant 1.6
 
- 
addToAdd a to address element.- Parameters:
- address- An email address.
 
- 
setToListShorthand to set the "to" address element.- Parameters:
- list- Comma-separated list of addresses.
 
- 
addCcAdd a "cc" address element.- Parameters:
- address- The email address.
 
- 
setCcListShorthand to set the "cc" address element.- Parameters:
- list- Comma separated list of addresses.
 
- 
addBccAdd a "bcc" address element.- Parameters:
- address- The email address.
 
- 
setBccListShorthand to set the "bcc" address element.- Parameters:
- list- comma separated list of addresses.
 
- 
setFailOnErrorpublic void setFailOnError(boolean failOnError) Set whether BuildExceptions should be passed back to the core.- Parameters:
- failOnError- The new FailOnError value.
 
- 
setFilesSet the list of files to be attached.- Parameters:
- filenames- Comma-separated list of files.
 
- 
addFilesetAdd a set of files (nested fileset attribute).- Parameters:
- fs- The fileset.
 
- 
createAttachmentsCreates a Path as container for attachments. Supports any filesystem resource-collections that way.- Returns:
- the path to be configured.
- Since:
- Ant 1.7
 
- 
createHeader
- 
setIncludefilenamespublic void setIncludefilenames(boolean includeFileNames) Set whether to include filenames.- Parameters:
- includeFileNames- Whether to include filenames in the text of the message.
 
- 
getIncludeFileNamespublic boolean getIncludeFileNames()Get whether file names should be included.- Returns:
- Identifies whether file names should be included.
 
- 
setIgnoreInvalidRecipientspublic 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
- Since:
- Ant 1.8.0
 
- 
execute
- 
setCharsetSets the character set of mail message. Will be ignored if mimeType contains ....; Charset=... substring or encoding is notmime.- Parameters:
- charset- the character encoding to use.
- Since:
- Ant 1.6
 
- 
getCharsetReturns the character set of mail message.- Returns:
- Charset of mail message.
- Since:
- Ant 1.6
 
- 
setMessageFileInputEncodingSets the encoding to expect when reading the message from a file.Will be ignored if the message has been specified inline. - Parameters:
- encoding- the name of the charset used
- Since:
- Ant 1.9.4
 
 
-