| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Object
  |
  +--org.apache.tools.ant.ProjectComponent
        |
        +--org.apache.tools.ant.Task
              |
              +--org.apache.tools.ant.taskdefs.email.EmailTask
A task to send SMTP email. This is a refactoring of the SendMail and MimeMail tasks such that both are within a single task.
| Nested Class Summary | |
| static class | EmailTask.EncodingEnumerates the encoding constants | 
| Field Summary | |
| static java.lang.String | AUTOConstant to show that the best available mailer should be used. | 
| static java.lang.String | MIMEConstant to allow the Mime mailer to be requested | 
| static java.lang.String | PLAINConstant to allow the plaintext mailer to be requested | 
| static java.lang.String | UUConstant to allow the UU mailer to be requested | 
| Fields inherited from class org.apache.tools.ant.Task | 
| description, location, target, taskName, taskType, wrapper | 
| Fields inherited from class org.apache.tools.ant.ProjectComponent | 
| project | 
| Constructor Summary | |
| EmailTask() | |
| Method Summary | |
|  void | addBcc(EmailAddress address)Adds "bcc" address elements | 
|  void | addCc(EmailAddress address)Adds "cc" address element | 
|  void | addFileset(FileSet fs)Adds a set of files (nested fileset attribute). | 
|  void | addFrom(EmailAddress address)Adds a from address element | 
|  void | addMessage(Message message)Add a message element | 
|  void | addReplyTo(EmailAddress address)Adds a replyto address element | 
|  void | addTo(EmailAddress address)Adds a to address element | 
|  void | execute()Sends an email | 
|  java.lang.String | getCharset()Returns the character set of mail message. | 
|  boolean | getIncludeFileNames()Identifies whether file names should be included | 
|  void | setBccList(java.lang.String list)Adds "bcc" address elements | 
|  void | setCcList(java.lang.String list)Adds "cc" address elements | 
|  void | setCharset(java.lang.String charset)Sets the character set of mail message. | 
|  void | setEncoding(EmailTask.Encoding encoding)Allows the build writer to choose the preferred encoding method | 
|  void | setFailOnError(boolean failOnError)Indicates whether BuildExceptions should be passed back to the core | 
|  void | setFiles(java.lang.String filenames)Adds a list of files to be attached | 
|  void | setFrom(java.lang.String address)Shorthand to set the from address element | 
|  void | setIncludefilenames(boolean includeFileNames)Sets Includefilenames attribute | 
|  void | setMailhost(java.lang.String host)Sets the host | 
|  void | setMailport(int port)Sets the mail server port | 
|  void | setMessage(java.lang.String message)Shorthand method to set the message | 
|  void | setMessageFile(java.io.File file)Shorthand method to set the message from a file | 
|  void | setMessageMimeType(java.lang.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(java.lang.String password)sets the password for SMTP auth; this requires JavaMail | 
|  void | setReplyTo(java.lang.String address)Shorthand to set the replyto address element | 
|  void | setSSL(boolean SSL)tells if the user needs to send his data over SSL | 
|  void | setSubject(java.lang.String subject)Sets the subject line of the email | 
|  void | setToList(java.lang.String list)Adds "to" address elements | 
|  void | setUser(java.lang.String user)sets the user for SMTP auth; this requires JavaMail | 
| Methods inherited from class org.apache.tools.ant.Task | 
| getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, reconfigure, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType | 
| Methods inherited from class org.apache.tools.ant.ProjectComponent | 
| getProject, setProject | 
| Methods inherited from class java.lang.Object | 
| clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
| Field Detail | 
public static final java.lang.String AUTO
public static final java.lang.String MIME
public static final java.lang.String UU
public static final java.lang.String PLAIN
| Constructor Detail | 
public EmailTask()
| Method Detail | 
public void setUser(java.lang.String user)
user - public void setPassword(java.lang.String password)
password - public void setSSL(boolean SSL)
SSL - public void setEncoding(EmailTask.Encoding encoding)
encoding - The encoding (one of AUTO,MIME,UU,PLAIN)public void setMailport(int port)
port - The port to usepublic void setMailhost(java.lang.String host)
host - The host to connect topublic void setSubject(java.lang.String subject)
subject - Subject of this email.public void setMessage(java.lang.String message)
message - Message body of this email.public void setMessageFile(java.io.File file)
file - The file from which to take the messagepublic void setMessageMimeType(java.lang.String type)
type - The new MessageMimeType value
public void addMessage(Message message)
                throws BuildException
message - The message object
BuildException - if a message has already been addedpublic void addFrom(EmailAddress address)
address - The address to send frompublic void setFrom(java.lang.String address)
address - The address to send mail frompublic void addReplyTo(EmailAddress address)
address - The address to reply topublic void setReplyTo(java.lang.String address)
address - The address to which replies should be directedpublic void addTo(EmailAddress address)
address - An email addresspublic void setToList(java.lang.String list)
list - Comma separated list of addressespublic void addCc(EmailAddress address)
address - The email addresspublic void setCcList(java.lang.String list)
list - Comma separated list of addressespublic void addBcc(EmailAddress address)
address - The email addresspublic void setBccList(java.lang.String list)
list - comma separated list of addressespublic void setFailOnError(boolean failOnError)
failOnError - The new FailOnError valuepublic void setFiles(java.lang.String filenames)
filenames - Comma separated list of filespublic void addFileset(FileSet fs)
fs - The filesetpublic void setIncludefilenames(boolean includeFileNames)
includeFileNames - Whether to include filenames in the text of the
      messagepublic boolean getIncludeFileNames()
public void execute()
execute in class Taskpublic void setCharset(java.lang.String charset)
mime
public java.lang.String getCharset()
| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||