Edit C:\apache-ant-1.8.0\docs\manual\api\org\apache\tools\ant\taskdefs\email\Mailer.html
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!--NewPage--> <HTML> <HEAD> <!-- Generated by javadoc (build 1.5.0_22) on Mon Feb 01 19:35:42 EST 2010 --> <TITLE> Mailer (Apache Ant API) </TITLE> <META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.email.Mailer class"> <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style"> <SCRIPT type="text/javascript"> function windowTitle() { parent.document.title="Mailer (Apache Ant API)"; } </SCRIPT> <NOSCRIPT> </NOSCRIPT> </HEAD> <BODY BGCOLOR="white" onload="windowTitle();"> <!-- ========= START OF TOP NAVBAR ======= --> <A NAME="navbar_top"><!-- --></A> <A HREF="#skip-navbar_top" title="Skip navigation links"></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> <TR> <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_top_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> </EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Header.html" title="class in org.apache.tools.ant.taskdefs.email"><B>PREV CLASS</B></A> <A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Message.html" title="class in org.apache.tools.ant.taskdefs.email"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../../../index.html?org/apache/tools/ant/taskdefs/email/Mailer.html" target="_top"><B>FRAMES</B></A> <A HREF="Mailer.html" target="_top"><B>NO FRAMES</B></A> <SCRIPT type="text/javascript"> <!-- if(window==top) { document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> </SCRIPT> <NOSCRIPT> <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A> </NOSCRIPT> </FONT></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <A NAME="skip-navbar_top"></A> <!-- ========= END OF TOP NAVBAR ========= --> <HR> <!-- ======== START OF CLASS DATA ======== --> <H2> <FONT SIZE="-1"> org.apache.tools.ant.taskdefs.email</FONT> <BR> Class Mailer</H2> <PRE> java.lang.Object <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.tools.ant.taskdefs.email.Mailer</B> </PRE> <DL> <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/MimeMailer.html" title="class in org.apache.tools.ant.taskdefs.email">MimeMailer</A></DD> </DL> <HR> <DL> <DT><PRE>public abstract class <B>Mailer</B><DT>extends java.lang.Object</DL> </PRE> <P> Base class for the various emailing implementations. <P> <P> <DL> <DT><B>Since:</B></DT> <DD>Ant 1.5</DD> </DL> <HR> <P> <!-- =========== FIELD SUMMARY =========== --> <A NAME="field_summary"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> <B>Field Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected java.util.Vector</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Mailer.html#bccList">bccList</A></B></CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected java.util.Vector</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Mailer.html#ccList">ccList</A></B></CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected java.util.Vector</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Mailer.html#files">files</A></B></CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected <A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailAddress.html" title="class in org.apache.tools.ant.taskdefs.email">EmailAddress</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Mailer.html#from">from</A></B></CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected java.util.Vector</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Mailer.html#headers">headers</A></B></CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Mailer.html#host">host</A></B></CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Mailer.html#includeFileNames">includeFileNames</A></B></CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected <A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Message.html" title="class in org.apache.tools.ant.taskdefs.email">Message</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Mailer.html#message">message</A></B></CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Mailer.html#password">password</A></B></CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Mailer.html#port">port</A></B></CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected java.util.Vector</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Mailer.html#replyToList">replyToList</A></B></CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Mailer.html#SSL">SSL</A></B></CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Mailer.html#subject">subject</A></B></CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected <A HREF="../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Mailer.html#task">task</A></B></CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected java.util.Vector</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Mailer.html#toList">toList</A></B></CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Mailer.html#user">user</A></B></CODE> <BR> </TD> </TR> </TABLE> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <A NAME="constructor_summary"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> <B>Constructor Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Mailer.html#Mailer()">Mailer</A></B>()</CODE> <BR> </TD> </TR> </TABLE> <!-- ========== METHOD SUMMARY =========== --> <A NAME="method_summary"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> <B>Method Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Mailer.html#getDate()">getDate</A></B>()</CODE> <BR> Return the current Date in a format suitable for a SMTP date header.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Mailer.html#isStartTLSEnabled()">isStartTLSEnabled</A></B>()</CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>abstract void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Mailer.html#send()">send</A></B>()</CODE> <BR> Send the email.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Mailer.html#setBccList(java.util.Vector)">setBccList</A></B>(java.util.Vector list)</CODE> <BR> Set the bcc addresses.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Mailer.html#setCcList(java.util.Vector)">setCcList</A></B>(java.util.Vector list)</CODE> <BR> Set the cc addresses.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Mailer.html#setEnableStartTLS(boolean)">setEnableStartTLS</A></B>(boolean b)</CODE> <BR> Set whether to allow authentication to switch to a TLS connection via STARTTLS.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Mailer.html#setFiles(java.util.Vector)">setFiles</A></B>(java.util.Vector files)</CODE> <BR> Set the files to attach.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Mailer.html#setFrom(org.apache.tools.ant.taskdefs.email.EmailAddress)">setFrom</A></B>(<A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailAddress.html" title="class in org.apache.tools.ant.taskdefs.email">EmailAddress</A> from)</CODE> <BR> Set the address to send from.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Mailer.html#setHeaders(java.util.Vector)">setHeaders</A></B>(java.util.Vector v)</CODE> <BR> Set the generic headers to add to the email.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Mailer.html#setHost(java.lang.String)">setHost</A></B>(java.lang.String host)</CODE> <BR> Set the mail server.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Mailer.html#setIgnoreInvalidRecipients(boolean)">setIgnoreInvalidRecipients</A></B>(boolean b)</CODE> <BR> Whether invalid recipients should be ignored (but a warning will be logged) instead of making the task fail.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Mailer.html#setIncludeFileNames(boolean)">setIncludeFileNames</A></B>(boolean b)</CODE> <BR> Indicate whether filenames should be listed in the body.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Mailer.html#setMessage(org.apache.tools.ant.taskdefs.email.Message)">setMessage</A></B>(<A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Message.html" title="class in org.apache.tools.ant.taskdefs.email">Message</A> m)</CODE> <BR> Set the message.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Mailer.html#setPassword(java.lang.String)">setPassword</A></B>(java.lang.String password)</CODE> <BR> Set the password for smtp auth.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Mailer.html#setPort(int)">setPort</A></B>(int port)</CODE> <BR> Set the smtp port.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Mailer.html#setReplyToList(java.util.Vector)">setReplyToList</A></B>(java.util.Vector list)</CODE> <BR> Set the replyto addresses.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Mailer.html#setSSL(boolean)">setSSL</A></B>(boolean ssl)</CODE> <BR> Set whether to send the mail through SSL.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Mailer.html#setSubject(java.lang.String)">setSubject</A></B>(java.lang.String subject)</CODE> <BR> Set the subject.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Mailer.html#setTask(org.apache.tools.ant.Task)">setTask</A></B>(<A HREF="../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A> task)</CODE> <BR> Set the owning task.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Mailer.html#setToList(java.util.Vector)">setToList</A></B>(java.util.Vector list)</CODE> <BR> Set the to addresses.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Mailer.html#setUser(java.lang.String)">setUser</A></B>(java.lang.String user)</CODE> <BR> Set the user for smtp auth.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Mailer.html#shouldIgnoreInvalidRecipients()">shouldIgnoreInvalidRecipients</A></B>()</CODE> <BR> Whether invalid recipients should be ignored.</TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> </TR> </TABLE> <P> <!-- ============ FIELD DETAIL =========== --> <A NAME="field_detail"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> <B>Field Detail</B></FONT></TH> </TR> </TABLE> <A NAME="host"><!-- --></A><H3> host</H3> <PRE> protected java.lang.String <B>host</B></PRE> <DL> <DL> </DL> </DL> <HR> <A NAME="port"><!-- --></A><H3> port</H3> <PRE> protected int <B>port</B></PRE> <DL> <DL> </DL> </DL> <HR> <A NAME="user"><!-- --></A><H3> user</H3> <PRE> protected java.lang.String <B>user</B></PRE> <DL> <DL> </DL> </DL> <HR> <A NAME="password"><!-- --></A><H3> password</H3> <PRE> protected java.lang.String <B>password</B></PRE> <DL> <DL> </DL> </DL> <HR> <A NAME="SSL"><!-- --></A><H3> SSL</H3> <PRE> protected boolean <B>SSL</B></PRE> <DL> <DL> </DL> </DL> <HR> <A NAME="message"><!-- --></A><H3> message</H3> <PRE> protected <A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Message.html" title="class in org.apache.tools.ant.taskdefs.email">Message</A> <B>message</B></PRE> <DL> <DL> </DL> </DL> <HR> <A NAME="from"><!-- --></A><H3> from</H3> <PRE> protected <A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailAddress.html" title="class in org.apache.tools.ant.taskdefs.email">EmailAddress</A> <B>from</B></PRE> <DL> <DL> </DL> </DL> <HR> <A NAME="replyToList"><!-- --></A><H3> replyToList</H3> <PRE> protected java.util.Vector <B>replyToList</B></PRE> <DL> <DL> </DL> </DL> <HR> <A NAME="toList"><!-- --></A><H3> toList</H3> <PRE> protected java.util.Vector <B>toList</B></PRE> <DL> <DL> </DL> </DL> <HR> <A NAME="ccList"><!-- --></A><H3> ccList</H3> <PRE> protected java.util.Vector <B>ccList</B></PRE> <DL> <DL> </DL> </DL> <HR> <A NAME="bccList"><!-- --></A><H3> bccList</H3> <PRE> protected java.util.Vector <B>bccList</B></PRE> <DL> <DL> </DL> </DL> <HR> <A NAME="files"><!-- --></A><H3> files</H3> <PRE> protected java.util.Vector <B>files</B></PRE> <DL> <DL> </DL> </DL> <HR> <A NAME="subject"><!-- --></A><H3> subject</H3> <PRE> protected java.lang.String <B>subject</B></PRE> <DL> <DL> </DL> </DL> <HR> <A NAME="task"><!-- --></A><H3> task</H3> <PRE> protected <A HREF="../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A> <B>task</B></PRE> <DL> <DL> </DL> </DL> <HR> <A NAME="includeFileNames"><!-- --></A><H3> includeFileNames</H3> <PRE> protected boolean <B>includeFileNames</B></PRE> <DL> <DL> </DL> </DL> <HR> <A NAME="headers"><!-- --></A><H3> headers</H3> <PRE> protected java.util.Vector <B>headers</B></PRE> <DL> <DL> </DL> </DL> <!-- ========= CONSTRUCTOR DETAIL ======== --> <A NAME="constructor_detail"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> <B>Constructor Detail</B></FONT></TH> </TR> </TABLE> <A NAME="Mailer()"><!-- --></A><H3> Mailer</H3> <PRE> public <B>Mailer</B>()</PRE> <DL> </DL> <!-- ============ METHOD DETAIL ========== --> <A NAME="method_detail"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> <B>Method Detail</B></FONT></TH> </TR> </TABLE> <A NAME="setHost(java.lang.String)"><!-- --></A><H3> setHost</H3> <PRE> public void <B>setHost</B>(java.lang.String host)</PRE> <DL> <DD>Set the mail server. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>host</CODE> - the mail server name.</DL> </DD> </DL> <HR> <A NAME="setPort(int)"><!-- --></A><H3> setPort</H3> <PRE> public void <B>setPort</B>(int port)</PRE> <DL> <DD>Set the smtp port. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>port</CODE> - the SMTP port.</DL> </DD> </DL> <HR> <A NAME="setUser(java.lang.String)"><!-- --></A><H3> setUser</H3> <PRE> public void <B>setUser</B>(java.lang.String user)</PRE> <DL> <DD>Set the user for smtp auth. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>user</CODE> - the username.<DT><B>Since:</B></DT> <DD>Ant 1.6</DD> </DL> </DD> </DL> <HR> <A NAME="setPassword(java.lang.String)"><!-- --></A><H3> setPassword</H3> <PRE> public void <B>setPassword</B>(java.lang.String password)</PRE> <DL> <DD>Set the password for smtp auth. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>password</CODE> - the authentication password.<DT><B>Since:</B></DT> <DD>Ant 1.6</DD> </DL> </DD> </DL> <HR> <A NAME="setSSL(boolean)"><!-- --></A><H3> setSSL</H3> <PRE> public void <B>setSSL</B>(boolean ssl)</PRE> <DL> <DD>Set whether to send the mail through SSL. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>ssl</CODE> - if true use SSL transport.<DT><B>Since:</B></DT> <DD>Ant 1.6</DD> </DL> </DD> </DL> <HR> <A NAME="setEnableStartTLS(boolean)"><!-- --></A><H3> setEnableStartTLS</H3> <PRE> public void <B>setEnableStartTLS</B>(boolean b)</PRE> <DL> <DD>Set whether to allow authentication to switch to a TLS connection via STARTTLS. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>b</CODE> - boolean; if true STARTTLS will be supported.<DT><B>Since:</B></DT> <DD>Ant 1.8.0</DD> </DL> </DD> </DL> <HR> <A NAME="isStartTLSEnabled()"><!-- --></A><H3> isStartTLSEnabled</H3> <PRE> protected boolean <B>isStartTLSEnabled</B>()</PRE> <DL> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="setMessage(org.apache.tools.ant.taskdefs.email.Message)"><!-- --></A><H3> setMessage</H3> <PRE> public void <B>setMessage</B>(<A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Message.html" title="class in org.apache.tools.ant.taskdefs.email">Message</A> m)</PRE> <DL> <DD>Set the message. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>m</CODE> - the message content.</DL> </DD> </DL> <HR> <A NAME="setFrom(org.apache.tools.ant.taskdefs.email.EmailAddress)"><!-- --></A><H3> setFrom</H3> <PRE> public void <B>setFrom</B>(<A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailAddress.html" title="class in org.apache.tools.ant.taskdefs.email">EmailAddress</A> from)</PRE> <DL> <DD>Set the address to send from. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>from</CODE> - the sender.</DL> </DD> </DL> <HR> <A NAME="setReplyToList(java.util.Vector)"><!-- --></A><H3> setReplyToList</H3> <PRE> public void <B>setReplyToList</B>(java.util.Vector list)</PRE> <DL> <DD>Set the replyto addresses. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>list</CODE> - a vector of reployTo addresses.<DT><B>Since:</B></DT> <DD>Ant 1.6</DD> </DL> </DD> </DL> <HR> <A NAME="setToList(java.util.Vector)"><!-- --></A><H3> setToList</H3> <PRE> public void <B>setToList</B>(java.util.Vector list)</PRE> <DL> <DD>Set the to addresses. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>list</CODE> - a vector of recipient addresses.</DL> </DD> </DL> <HR> <A NAME="setCcList(java.util.Vector)"><!-- --></A><H3> setCcList</H3> <PRE> public void <B>setCcList</B>(java.util.Vector list)</PRE> <DL> <DD>Set the cc addresses. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>list</CODE> - a vector of cc addresses.</DL> </DD> </DL> <HR> <A NAME="setBccList(java.util.Vector)"><!-- --></A><H3> setBccList</H3> <PRE> public void <B>setBccList</B>(java.util.Vector list)</PRE> <DL> <DD>Set the bcc addresses. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>list</CODE> - a vector of the bcc addresses.</DL> </DD> </DL> <HR> <A NAME="setFiles(java.util.Vector)"><!-- --></A><H3> setFiles</H3> <PRE> public void <B>setFiles</B>(java.util.Vector files)</PRE> <DL> <DD>Set the files to attach. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>files</CODE> - list of files to attach to the email.</DL> </DD> </DL> <HR> <A NAME="setSubject(java.lang.String)"><!-- --></A><H3> setSubject</H3> <PRE> public void <B>setSubject</B>(java.lang.String subject)</PRE> <DL> <DD>Set the subject. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>subject</CODE> - the subject line.</DL> </DD> </DL> <HR> <A NAME="setTask(org.apache.tools.ant.Task)"><!-- --></A><H3> setTask</H3> <PRE> public void <B>setTask</B>(<A HREF="../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A> task)</PRE> <DL> <DD>Set the owning task. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>task</CODE> - the owning task instance.</DL> </DD> </DL> <HR> <A NAME="setIncludeFileNames(boolean)"><!-- --></A><H3> setIncludeFileNames</H3> <PRE> public void <B>setIncludeFileNames</B>(boolean b)</PRE> <DL> <DD>Indicate whether filenames should be listed in the body. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>b</CODE> - if true list attached file names in the body content.</DL> </DD> </DL> <HR> <A NAME="setHeaders(java.util.Vector)"><!-- --></A><H3> setHeaders</H3> <PRE> public void <B>setHeaders</B>(java.util.Vector v)</PRE> <DL> <DD>Set the generic headers to add to the email. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>v</CODE> - a Vector presumed to contain Header objects.<DT><B>Since:</B></DT> <DD>Ant 1.7</DD> </DL> </DD> </DL> <HR> <A NAME="send()"><!-- --></A><H3> send</H3> <PRE> public abstract void <B>send</B>() throws <A HREF="../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE> <DL> <DD>Send the email. <P> <DD><DL> <DT><B>Throws:</B> <DD><CODE><A HREF="../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if the email can't be sent.</DL> </DD> </DL> <HR> <A NAME="setIgnoreInvalidRecipients(boolean)"><!-- --></A><H3> setIgnoreInvalidRecipients</H3> <PRE> public void <B>setIgnoreInvalidRecipients</B>(boolean b)</PRE> <DL> <DD>Whether invalid recipients should be ignored (but a warning will be logged) instead of making the task fail. <p>Even with this property set to true the task will still fail if the mail couldn't be sent to any recipient at all.</p> <P> <DD><DL> <DT><B>Since:</B></DT> <DD>Ant 1.8.0</DD> </DL> </DD> </DL> <HR> <A NAME="shouldIgnoreInvalidRecipients()"><!-- --></A><H3> shouldIgnoreInvalidRecipients</H3> <PRE> protected boolean <B>shouldIgnoreInvalidRecipients</B>()</PRE> <DL> <DD>Whether invalid recipients should be ignored. <P> <DD><DL> <DT><B>Since:</B></DT> <DD>Ant 1.8.0</DD> </DL> </DD> </DL> <HR> <A NAME="getDate()"><!-- --></A><H3> getDate</H3> <PRE> protected final java.lang.String <B>getDate</B>()</PRE> <DL> <DD>Return the current Date in a format suitable for a SMTP date header. <P> <DD><DL> <DT><B>Returns:</B><DD>the current date in SMTP suitable format.<DT><B>Since:</B></DT> <DD>Ant 1.5</DD> </DL> </DD> </DL> <!-- ========= END OF CLASS DATA ========= --> <HR> <!-- ======= START OF BOTTOM NAVBAR ====== --> <A NAME="navbar_bottom"><!-- --></A> <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> <TR> <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_bottom_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> </EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Header.html" title="class in org.apache.tools.ant.taskdefs.email"><B>PREV CLASS</B></A> <A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Message.html" title="class in org.apache.tools.ant.taskdefs.email"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../../../index.html?org/apache/tools/ant/taskdefs/email/Mailer.html" target="_top"><B>FRAMES</B></A> <A HREF="Mailer.html" target="_top"><B>NO FRAMES</B></A> <SCRIPT type="text/javascript"> <!-- if(window==top) { document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> </SCRIPT> <NOSCRIPT> <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A> </NOSCRIPT> </FONT></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <A NAME="skip-navbar_bottom"></A> <!-- ======== END OF BOTTOM NAVBAR ======= --> <HR> </BODY> </HTML>
Ms-Dos/Windows
Unix
Write backup
jsp File Browser version 1.2 by
www.vonloesch.de