Java Doc for EmailTask.java in  » Build » ANT » org » apache » tools » ant » taskdefs » email » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Build » ANT » org.apache.tools.ant.taskdefs.email 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.apache.tools.ant.Task
   org.apache.tools.ant.taskdefs.email.EmailTask

All known Subclasses:   org.apache.tools.ant.taskdefs.SendEmail,  org.apache.tools.ant.taskdefs.optional.net.MimeMail,
EmailTask
public class EmailTask extends Task (Code)
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

Inner Class :public static class Encoding extends EnumeratedAttribute

Field Summary
final public static  StringAUTO
     Constant to show that the best available mailer should be used.
final public static  StringMIME
    
final public static  StringPLAIN
    
final public static  StringUU
    


Method Summary
public  voidaddBcc(EmailAddress address)
     Add a "bcc" address element.
public  voidaddCc(EmailAddress address)
     Add a "cc" address element.
public  voidaddFileset(FileSet fs)
     Add a set of files (nested fileset attribute).
public  voidaddFrom(EmailAddress address)
     Add a from address element.
public  voidaddMessage(Message message)
     Add a message element.
public  voidaddReplyTo(EmailAddress address)
     Add a replyto address element.
public  voidaddTo(EmailAddress address)
     Add a to address element.
public  PathcreateAttachments()
     Creates a Path as container for attachments.
public  HeadercreateHeader()
     Create a nested header element.
public  voidexecute()
     Send an email.
public  StringgetCharset()
     Returns the character set of mail message.
public  booleangetIncludeFileNames()
     Get whether file names should be included.
public  voidsetBccList(String list)
     Shorthand to set the "bcc" address element.
public  voidsetCcList(String list)
     Shorthand to set the "cc" address element.
public  voidsetCharset(String charset)
     Sets the character set of mail message. Will be ignored if mimeType contains ....; Charset=...
public  voidsetEncoding(Encoding encoding)
     Set the preferred encoding method.
public  voidsetFailOnError(boolean failOnError)
     Set whether BuildExceptions should be passed back to the core.
public  voidsetFiles(String filenames)
     Set the list of files to be attached.
public  voidsetFrom(String address)
     Shorthand to set the from address element.
public  voidsetIncludefilenames(boolean includeFileNames)
     Set whether to include filenames.
public  voidsetMailhost(String host)
     Set the host.
public  voidsetMailport(int port)
     Set the mail server port.
public  voidsetMessage(String message)
     Shorthand method to set the message.
public  voidsetMessageFile(File file)
     Shorthand method to set the message from a file.
public  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.
public  voidsetPassword(String password)
     Set the password for SMTP auth; this requires JavaMail.
public  voidsetReplyTo(String address)
     Shorthand to set the replyto address element.
public  voidsetSSL(boolean ssl)
     Set whether to send data over SSL.
public  voidsetSubject(String subject)
     Set the subject line of the email.
public  voidsetToList(String list)
     Shorthand to set the "to" address element.
public  voidsetUser(String user)
     Set the user for SMTP auth; this requires JavaMail.

Field Detail
AUTO
final public static String AUTO(Code)
Constant to show that the best available mailer should be used.



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



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



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





Method Detail
addBcc
public void addBcc(EmailAddress address)(Code)
Add a "bcc" address element.
Parameters:
  address - The email address.



addCc
public void addCc(EmailAddress address)(Code)
Add a "cc" address element.
Parameters:
  address - The email address.



addFileset
public void addFileset(FileSet fs)(Code)
Add a set of files (nested fileset attribute).
Parameters:
  fs - The fileset.



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



addMessage
public void addMessage(Message message) throws BuildException(Code)
Add a message element.
Parameters:
  message - The message object.
throws:
  BuildException - if a message has already been added.



addReplyTo
public void addReplyTo(EmailAddress address)(Code)
Add a replyto address element.
Parameters:
  address - The address to reply to.
since:
   Ant 1.6



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



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



createHeader
public Header createHeader()(Code)
Create a nested header element. a Header instance.



execute
public void execute()(Code)
Send an email.



getCharset
public String getCharset()(Code)
Returns the character set of mail message. Charset of mail message.
since:
   Ant 1.6



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



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



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



setCharset
public void setCharset(String charset)(Code)
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



setEncoding
public void setEncoding(Encoding encoding)(Code)
Set the preferred encoding method.
Parameters:
  encoding - The encoding (one of AUTO, MIME, UU, PLAIN).



setFailOnError
public void setFailOnError(boolean failOnError)(Code)
Set whether BuildExceptions should be passed back to the core.
Parameters:
  failOnError - The new FailOnError value.



setFiles
public void setFiles(String filenames)(Code)
Set the list of files to be attached.
Parameters:
  filenames - Comma-separated list of files.



setFrom
public void setFrom(String address)(Code)
Shorthand to set the from address element.
Parameters:
  address - The address to send mail from.



setIncludefilenames
public void setIncludefilenames(boolean includeFileNames)(Code)
Set whether to include filenames.
Parameters:
  includeFileNames - Whether to include filenames in the text of themessage.



setMailhost
public void setMailhost(String host)(Code)
Set the host.
Parameters:
  host - The host to connect to.



setMailport
public void setMailport(int port)(Code)
Set the mail server port.
Parameters:
  port - The port to use.



setMessage
public void setMessage(String message)(Code)
Shorthand method to set the message.
Parameters:
  message - Message body of this email.



setMessageFile
public void setMessageFile(File file)(Code)
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)(Code)
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)(Code)
Set the password for SMTP auth; this requires JavaMail.
Parameters:
  password - the String password.
since:
   Ant 1.6



setReplyTo
public void setReplyTo(String address)(Code)
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)(Code)
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)(Code)
Set the subject line of the email.
Parameters:
  subject - Subject of this email.



setToList
public void setToList(String list)(Code)
Shorthand to set the "to" address element.
Parameters:
  list - Comma-separated list of addresses.



setUser
public void setUser(String user)(Code)
Set the user for SMTP auth; this requires JavaMail.
Parameters:
  user - the String username.
since:
   Ant 1.6



Fields inherited from org.apache.tools.ant.Task
protected Target target(Code)(Java Doc)
protected String taskName(Code)(Java Doc)
protected String taskType(Code)(Java Doc)
protected RuntimeConfigurable wrapper(Code)(Java Doc)

Methods inherited from org.apache.tools.ant.Task
final public void bindToOwner(Task owner)(Code)(Java Doc)
public void execute() throws BuildException(Code)(Java Doc)
public Target getOwningTarget()(Code)(Java Doc)
public RuntimeConfigurable getRuntimeConfigurableWrapper()(Code)(Java Doc)
public String getTaskName()(Code)(Java Doc)
public String getTaskType()(Code)(Java Doc)
protected RuntimeConfigurable getWrapper()(Code)(Java Doc)
protected void handleErrorFlush(String output)(Code)(Java Doc)
protected void handleErrorOutput(String output)(Code)(Java Doc)
protected void handleFlush(String output)(Code)(Java Doc)
protected int handleInput(byte[] buffer, int offset, int length) throws IOException(Code)(Java Doc)
protected void handleOutput(String output)(Code)(Java Doc)
public void init() throws BuildException(Code)(Java Doc)
final protected boolean isInvalid()(Code)(Java Doc)
public void log(String msg)(Code)(Java Doc)
public void log(String msg, int msgLevel)(Code)(Java Doc)
public void log(Throwable t, int msgLevel)(Code)(Java Doc)
public void log(String msg, Throwable t, int msgLevel)(Code)(Java Doc)
public void maybeConfigure() throws BuildException(Code)(Java Doc)
final public void perform()(Code)(Java Doc)
public void reconfigure()(Code)(Java Doc)
public void setOwningTarget(Target target)(Code)(Java Doc)
public void setRuntimeConfigurableWrapper(RuntimeConfigurable wrapper)(Code)(Java Doc)
public void setTaskName(String name)(Code)(Java Doc)
public void setTaskType(String type)(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.