Context Navigation

← Previous Revision
Latest Revision
Next Revision →
Blame
Revision Log

source: other-projects/trunk/gs3-release-maker/apache-ant-1.6.5/build/javadocs/org/apache/tools/ant/taskdefs/email/EmailTask.html@ 14627

Last change on this file since 14627 was 14627, checked in by oranfry, 17 years ago
initial import of the gs3-release-maker
File size: 43.3 KB

Line
1	<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2	<!--NewPage-->
3	<HTML>
4	<HEAD>
5	<!-- Generated by javadoc (build 1.4.2_13) on Mon Oct 01 14:33:23 NZST 2007 -->
6	<TITLE>
7	EmailTask (Apache Ant API)
8	</TITLE>
9
10	<META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.email.EmailTask class">
11
12	<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style">
13
14	<SCRIPT type="text/javascript">
15	function windowTitle()
16	{
17	parent.document.title="EmailTask (Apache Ant API)";
18	}
19	</SCRIPT>
20
21	</HEAD>
22
23	<BODY BGCOLOR="white" onload="windowTitle();">
24
25
26	<!-- ========= START OF TOP NAVBAR ======= -->
27	<A NAME="navbar_top"><!-- --></A>
28	<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
29	<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
30	<TR>
31	<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
32	<A NAME="navbar_top_firstrow"><!-- --></A>
33	<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
34	<TR ALIGN="center" VALIGN="top">
35	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
36	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
37	<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
38	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
39	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
40	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
41	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
42	</TR>
43	</TABLE>
44	</TD>
45	<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
46	</EM>
47	</TD>
48	</TR>
49
50	<TR>
51	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
52	<A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailAddress.html" title="class in org.apache.tools.ant.taskdefs.email"><B>PREV CLASS</B></A>
53	<A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailTask.Encoding.html" title="class in org.apache.tools.ant.taskdefs.email"><B>NEXT CLASS</B></A></FONT></TD>
54	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
55	<A HREF="../../../../../../index.html" target="_top"><B>FRAMES</B></A>
56	<A HREF="EmailTask.html" target="_top"><B>NO FRAMES</B></A>
57	<SCRIPT type="text/javascript">
58	<!--
59	if(window==top) {
60	document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
61	}
62	//-->
63	</SCRIPT>
64	<NOSCRIPT>
65	<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
66	</NOSCRIPT>
67
68	</FONT></TD>
69	</TR>
70	<TR>
71	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
72	SUMMARY: <A HREF="#nested_class_summary">NESTED</A> \| <A HREF="#field_summary">FIELD</A> \| <A HREF="#constructor_summary">CONSTR</A> \| <A HREF="#method_summary">METHOD</A></FONT></TD>
73	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
74	DETAIL: <A HREF="#field_detail">FIELD</A> \| <A HREF="#constructor_detail">CONSTR</A> \| <A HREF="#method_detail">METHOD</A></FONT></TD>
75	</TR>
76	</TABLE>
77	<A NAME="skip-navbar_top"></A>
78	<!-- ========= END OF TOP NAVBAR ========= -->
79
80	<HR>
81	<!-- ======== START OF CLASS DATA ======== -->
82	<H2>
83	<FONT SIZE="-1">
84	org.apache.tools.ant.taskdefs.email</FONT>
85	<BR>
86	Class EmailTask</H2>
87	<PRE>
88	java.lang.Object
89	<IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">org.apache.tools.ant.ProjectComponent</A>
90	<IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">org.apache.tools.ant.Task</A>
91	<IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.taskdefs.email.EmailTask</B>
92	</PRE>
93	<DL>
94	<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/net/MimeMail.html" title="class in org.apache.tools.ant.taskdefs.optional.net">MimeMail</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/SendEmail.html" title="class in org.apache.tools.ant.taskdefs">SendEmail</A></DD>
95	</DL>
96	<HR>
97	<DL>
98	<DT>public class <B>EmailTask</B><DT>extends <A HREF="../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></DL>
99
100	<P>
101	A task to send SMTP email. This is a refactoring of the SendMail and
102	MimeMail tasks such that both are within a single task.
103	<P>
104
105	<P>
106	<DL>
107	<DT><B>Since:</B></DT>
108	<DD>Ant 1.5</DD>
109	</DL>
110	<HR>
111
112	<P>
113	<!-- ======== NESTED CLASS SUMMARY ======== -->
114
115	<A NAME="nested_class_summary"><!-- --></A>
116	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
117	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
118	<TD COLSPAN=2><FONT SIZE="+2">
119	<B>Nested Class Summary</B></FONT></TD>
120	</TR>
121	<TR BGCOLOR="white" CLASS="TableRowColor">
122	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
123	<CODE>static class</CODE></FONT></TD>
124	<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailTask.Encoding.html" title="class in org.apache.tools.ant.taskdefs.email">EmailTask.Encoding</A></B></CODE>
125
126	<BR>
127	Enumerates the encoding constants</TD>
128	</TR>
129	</TABLE>
130
131	<!-- =========== FIELD SUMMARY =========== -->
132
133	<A NAME="field_summary"><!-- --></A>
134	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
135	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
136	<TD COLSPAN=2><FONT SIZE="+2">
137	<B>Field Summary</B></FONT></TD>
138	</TR>
139	<TR BGCOLOR="white" CLASS="TableRowColor">
140	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
141	<CODE>static java.lang.String</CODE></FONT></TD>
142	<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailTask.html#AUTO">AUTO</A></B></CODE>
143
144	<BR>
145	Constant to show that the best available mailer should be used.</TD>
146	</TR>
147	<TR BGCOLOR="white" CLASS="TableRowColor">
148	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
149	<CODE>static java.lang.String</CODE></FONT></TD>
150	<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailTask.html#MIME">MIME</A></B></CODE>
151
152	<BR>
153	Constant to allow the Mime mailer to be requested</TD>
154	</TR>
155	<TR BGCOLOR="white" CLASS="TableRowColor">
156	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
157	<CODE>static java.lang.String</CODE></FONT></TD>
158	<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailTask.html#PLAIN">PLAIN</A></B></CODE>
159
160	<BR>
161	Constant to allow the plaintext mailer to be requested</TD>
162	</TR>
163	<TR BGCOLOR="white" CLASS="TableRowColor">
164	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
165	<CODE>static java.lang.String</CODE></FONT></TD>
166	<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailTask.html#UU">UU</A></B></CODE>
167
168	<BR>
169	Constant to allow the UU mailer to be requested</TD>
170	</TR>
171	</TABLE>
172	<A NAME="fields_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
173	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
174	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
175	<TD><B>Fields inherited from class org.apache.tools.ant.<A HREF="../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></B></TD>
176	</TR>
177	<TR BGCOLOR="white" CLASS="TableRowColor">
178	<TD><CODE><A HREF="../../../../../../org/apache/tools/ant/Task.html#description">description</A>, <A HREF="../../../../../../org/apache/tools/ant/Task.html#location">location</A>, <A HREF="../../../../../../org/apache/tools/ant/Task.html#target">target</A>, <A HREF="../../../../../../org/apache/tools/ant/Task.html#taskName">taskName</A>, <A HREF="../../../../../../org/apache/tools/ant/Task.html#taskType">taskType</A>, <A HREF="../../../../../../org/apache/tools/ant/Task.html#wrapper">wrapper</A></CODE></TD>
179	</TR>
180	</TABLE>
181	<A NAME="fields_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
182	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
183	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
184	<TD><B>Fields inherited from class org.apache.tools.ant.<A HREF="../../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">ProjectComponent</A></B></TD>
185	</TR>
186	<TR BGCOLOR="white" CLASS="TableRowColor">
187	<TD><CODE><A HREF="../../../../../../org/apache/tools/ant/ProjectComponent.html#project">project</A></CODE></TD>
188	</TR>
189	</TABLE>
190
191	<!-- ======== CONSTRUCTOR SUMMARY ======== -->
192
193	<A NAME="constructor_summary"><!-- --></A>
194	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
195	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
196	<TD COLSPAN=2><FONT SIZE="+2">
197	<B>Constructor Summary</B></FONT></TD>
198	</TR>
199	<TR BGCOLOR="white" CLASS="TableRowColor">
200	<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailTask.html#EmailTask()">EmailTask</A></B>()</CODE>
201
202	<BR>
203	</TD>
204	</TR>
205	</TABLE>
206
207	<!-- ========== METHOD SUMMARY =========== -->
208
209	<A NAME="method_summary"><!-- --></A>
210	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
211	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
212	<TD COLSPAN=2><FONT SIZE="+2">
213	<B>Method Summary</B></FONT></TD>
214	</TR>
215	<TR BGCOLOR="white" CLASS="TableRowColor">
216	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
217	<CODE> void</CODE></FONT></TD>
218	<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailTask.html#addBcc(org.apache.tools.ant.taskdefs.email.EmailAddress)">addBcc</A></B>(<A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailAddress.html" title="class in org.apache.tools.ant.taskdefs.email">EmailAddress</A> address)</CODE>
219
220	<BR>
221	Adds "bcc" address elements</TD>
222	</TR>
223	<TR BGCOLOR="white" CLASS="TableRowColor">
224	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
225	<CODE> void</CODE></FONT></TD>
226	<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailTask.html#addCc(org.apache.tools.ant.taskdefs.email.EmailAddress)">addCc</A></B>(<A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailAddress.html" title="class in org.apache.tools.ant.taskdefs.email">EmailAddress</A> address)</CODE>
227
228	<BR>
229	Adds "cc" address element</TD>
230	</TR>
231	<TR BGCOLOR="white" CLASS="TableRowColor">
232	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
233	<CODE> void</CODE></FONT></TD>
234	<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailTask.html#addFileset(org.apache.tools.ant.types.FileSet)">addFileset</A></B>(<A HREF="../../../../../../org/apache/tools/ant/types/FileSet.html" title="class in org.apache.tools.ant.types">FileSet</A> fs)</CODE>
235
236	<BR>
237	Adds a set of files (nested fileset attribute).</TD>
238	</TR>
239	<TR BGCOLOR="white" CLASS="TableRowColor">
240	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
241	<CODE> void</CODE></FONT></TD>
242	<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailTask.html#addFrom(org.apache.tools.ant.taskdefs.email.EmailAddress)">addFrom</A></B>(<A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailAddress.html" title="class in org.apache.tools.ant.taskdefs.email">EmailAddress</A> address)</CODE>
243
244	<BR>
245	Adds a from address element</TD>
246	</TR>
247	<TR BGCOLOR="white" CLASS="TableRowColor">
248	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
249	<CODE> void</CODE></FONT></TD>
250	<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailTask.html#addMessage(org.apache.tools.ant.taskdefs.email.Message)">addMessage</A></B>(<A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Message.html" title="class in org.apache.tools.ant.taskdefs.email">Message</A> message)</CODE>
251
252	<BR>
253	Add a message element</TD>
254	</TR>
255	<TR BGCOLOR="white" CLASS="TableRowColor">
256	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
257	<CODE> void</CODE></FONT></TD>
258	<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailTask.html#addReplyTo(org.apache.tools.ant.taskdefs.email.EmailAddress)">addReplyTo</A></B>(<A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailAddress.html" title="class in org.apache.tools.ant.taskdefs.email">EmailAddress</A> address)</CODE>
259
260	<BR>
261	Adds a replyto address element</TD>
262	</TR>
263	<TR BGCOLOR="white" CLASS="TableRowColor">
264	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
265	<CODE> void</CODE></FONT></TD>
266	<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailTask.html#addTo(org.apache.tools.ant.taskdefs.email.EmailAddress)">addTo</A></B>(<A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailAddress.html" title="class in org.apache.tools.ant.taskdefs.email">EmailAddress</A> address)</CODE>
267
268	<BR>
269	Adds a to address element</TD>
270	</TR>
271	<TR BGCOLOR="white" CLASS="TableRowColor">
272	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
273	<CODE> void</CODE></FONT></TD>
274	<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailTask.html#execute()">execute</A></B>()</CODE>
275
276	<BR>
277	Sends an email</TD>
278	</TR>
279	<TR BGCOLOR="white" CLASS="TableRowColor">
280	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
281	<CODE> java.lang.String</CODE></FONT></TD>
282	<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailTask.html#getCharset()">getCharset</A></B>()</CODE>
283
284	<BR>
285	Returns the character set of mail message.</TD>
286	</TR>
287	<TR BGCOLOR="white" CLASS="TableRowColor">
288	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
289	<CODE> boolean</CODE></FONT></TD>
290	<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailTask.html#getIncludeFileNames()">getIncludeFileNames</A></B>()</CODE>
291
292	<BR>
293	Identifies whether file names should be included</TD>
294	</TR>
295	<TR BGCOLOR="white" CLASS="TableRowColor">
296	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
297	<CODE> void</CODE></FONT></TD>
298	<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailTask.html#setBccList(java.lang.String)">setBccList</A></B>(java.lang.String list)</CODE>
299
300	<BR>
301	Adds "bcc" address elements</TD>
302	</TR>
303	<TR BGCOLOR="white" CLASS="TableRowColor">
304	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
305	<CODE> void</CODE></FONT></TD>
306	<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailTask.html#setCcList(java.lang.String)">setCcList</A></B>(java.lang.String list)</CODE>
307
308	<BR>
309	Adds "cc" address elements</TD>
310	</TR>
311	<TR BGCOLOR="white" CLASS="TableRowColor">
312	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
313	<CODE> void</CODE></FONT></TD>
314	<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailTask.html#setCharset(java.lang.String)">setCharset</A></B>(java.lang.String charset)</CODE>
315
316	<BR>
317	Sets the character set of mail message.</TD>
318	</TR>
319	<TR BGCOLOR="white" CLASS="TableRowColor">
320	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
321	<CODE> void</CODE></FONT></TD>
322	<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailTask.html#setEncoding(org.apache.tools.ant.taskdefs.email.EmailTask.Encoding)">setEncoding</A></B>(<A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailTask.Encoding.html" title="class in org.apache.tools.ant.taskdefs.email">EmailTask.Encoding</A> encoding)</CODE>
323
324	<BR>
325	Allows the build writer to choose the preferred encoding method</TD>
326	</TR>
327	<TR BGCOLOR="white" CLASS="TableRowColor">
328	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
329	<CODE> void</CODE></FONT></TD>
330	<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailTask.html#setFailOnError(boolean)">setFailOnError</A></B>(boolean failOnError)</CODE>
331
332	<BR>
333	Indicates whether BuildExceptions should be passed back to the core</TD>
334	</TR>
335	<TR BGCOLOR="white" CLASS="TableRowColor">
336	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
337	<CODE> void</CODE></FONT></TD>
338	<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailTask.html#setFiles(java.lang.String)">setFiles</A></B>(java.lang.String filenames)</CODE>
339
340	<BR>
341	Adds a list of files to be attached</TD>
342	</TR>
343	<TR BGCOLOR="white" CLASS="TableRowColor">
344	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
345	<CODE> void</CODE></FONT></TD>
346	<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailTask.html#setFrom(java.lang.String)">setFrom</A></B>(java.lang.String address)</CODE>
347
348	<BR>
349	Shorthand to set the from address element</TD>
350	</TR>
351	<TR BGCOLOR="white" CLASS="TableRowColor">
352	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
353	<CODE> void</CODE></FONT></TD>
354	<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailTask.html#setIncludefilenames(boolean)">setIncludefilenames</A></B>(boolean includeFileNames)</CODE>
355
356	<BR>
357	Sets Includefilenames attribute</TD>
358	</TR>
359	<TR BGCOLOR="white" CLASS="TableRowColor">
360	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
361	<CODE> void</CODE></FONT></TD>
362	<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailTask.html#setMailhost(java.lang.String)">setMailhost</A></B>(java.lang.String host)</CODE>
363
364	<BR>
365	Sets the host</TD>
366	</TR>
367	<TR BGCOLOR="white" CLASS="TableRowColor">
368	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
369	<CODE> void</CODE></FONT></TD>
370	<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailTask.html#setMailport(int)">setMailport</A></B>(int port)</CODE>
371
372	<BR>
373	Sets the mail server port</TD>
374	</TR>
375	<TR BGCOLOR="white" CLASS="TableRowColor">
376	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
377	<CODE> void</CODE></FONT></TD>
378	<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailTask.html#setMessage(java.lang.String)">setMessage</A></B>(java.lang.String message)</CODE>
379
380	<BR>
381	Shorthand method to set the message</TD>
382	</TR>
383	<TR BGCOLOR="white" CLASS="TableRowColor">
384	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
385	<CODE> void</CODE></FONT></TD>
386	<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailTask.html#setMessageFile(java.io.File)">setMessageFile</A></B>(java.io.File file)</CODE>
387
388	<BR>
389	Shorthand method to set the message from a file</TD>
390	</TR>
391	<TR BGCOLOR="white" CLASS="TableRowColor">
392	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
393	<CODE> void</CODE></FONT></TD>
394	<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailTask.html#setMessageMimeType(java.lang.String)">setMessageMimeType</A></B>(java.lang.String type)</CODE>
395
396	<BR>
397	Shorthand method to set type of the text message, text/plain by default
398	but text/html or text/xml is quite feasible.</TD>
399	</TR>
400	<TR BGCOLOR="white" CLASS="TableRowColor">
401	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
402	<CODE> void</CODE></FONT></TD>
403	<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailTask.html#setPassword(java.lang.String)">setPassword</A></B>(java.lang.String password)</CODE>
404
405	<BR>
406	sets the password for SMTP auth; this requires JavaMail</TD>
407	</TR>
408	<TR BGCOLOR="white" CLASS="TableRowColor">
409	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
410	<CODE> void</CODE></FONT></TD>
411	<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailTask.html#setReplyTo(java.lang.String)">setReplyTo</A></B>(java.lang.String address)</CODE>
412
413	<BR>
414	Shorthand to set the replyto address element</TD>
415	</TR>
416	<TR BGCOLOR="white" CLASS="TableRowColor">
417	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
418	<CODE> void</CODE></FONT></TD>
419	<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailTask.html#setSSL(boolean)">setSSL</A></B>(boolean SSL)</CODE>
420
421	<BR>
422	tells if the user needs to send his data over SSL</TD>
423	</TR>
424	<TR BGCOLOR="white" CLASS="TableRowColor">
425	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
426	<CODE> void</CODE></FONT></TD>
427	<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailTask.html#setSubject(java.lang.String)">setSubject</A></B>(java.lang.String subject)</CODE>
428
429	<BR>
430	Sets the subject line of the email</TD>
431	</TR>
432	<TR BGCOLOR="white" CLASS="TableRowColor">
433	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
434	<CODE> void</CODE></FONT></TD>
435	<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailTask.html#setToList(java.lang.String)">setToList</A></B>(java.lang.String list)</CODE>
436
437	<BR>
438	Adds "to" address elements</TD>
439	</TR>
440	<TR BGCOLOR="white" CLASS="TableRowColor">
441	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
442	<CODE> void</CODE></FONT></TD>
443	<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailTask.html#setUser(java.lang.String)">setUser</A></B>(java.lang.String user)</CODE>
444
445	<BR>
446	sets the user for SMTP auth; this requires JavaMail</TD>
447	</TR>
448	</TABLE>
449	<A NAME="methods_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
450	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
451	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
452	<TD><B>Methods inherited from class org.apache.tools.ant.<A HREF="../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></B></TD>
453	</TR>
454	<TR BGCOLOR="white" CLASS="TableRowColor">
455	<TD><CODE><A HREF="../../../../../../org/apache/tools/ant/Task.html#getDescription()">getDescription</A>, <A HREF="../../../../../../org/apache/tools/ant/Task.html#getLocation()">getLocation</A>, <A HREF="../../../../../../org/apache/tools/ant/Task.html#getOwningTarget()">getOwningTarget</A>, <A HREF="../../../../../../org/apache/tools/ant/Task.html#getRuntimeConfigurableWrapper()">getRuntimeConfigurableWrapper</A>, <A HREF="../../../../../../org/apache/tools/ant/Task.html#getTaskName()">getTaskName</A>, <A HREF="../../../../../../org/apache/tools/ant/Task.html#getTaskType()">getTaskType</A>, <A HREF="../../../../../../org/apache/tools/ant/Task.html#getWrapper()">getWrapper</A>, <A HREF="../../../../../../org/apache/tools/ant/Task.html#handleErrorFlush(java.lang.String)">handleErrorFlush</A>, <A HREF="../../../../../../org/apache/tools/ant/Task.html#handleErrorOutput(java.lang.String)">handleErrorOutput</A>, <A HREF="../../../../../../org/apache/tools/ant/Task.html#handleFlush(java.lang.String)">handleFlush</A>, <A HREF="../../../../../../org/apache/tools/ant/Task.html#handleInput(byte[], int, int)">handleInput</A>, <A HREF="../../../../../../org/apache/tools/ant/Task.html#handleOutput(java.lang.String)">handleOutput</A>, <A HREF="../../../../../../org/apache/tools/ant/Task.html#init()">init</A>, <A HREF="../../../../../../org/apache/tools/ant/Task.html#isInvalid()">isInvalid</A>, <A HREF="../../../../../../org/apache/tools/ant/Task.html#log(java.lang.String)">log</A>, <A HREF="../../../../../../org/apache/tools/ant/Task.html#log(java.lang.String, int)">log</A>, <A HREF="../../../../../../org/apache/tools/ant/Task.html#maybeConfigure()">maybeConfigure</A>, <A HREF="../../../../../../org/apache/tools/ant/Task.html#perform()">perform</A>, <A HREF="../../../../../../org/apache/tools/ant/Task.html#reconfigure()">reconfigure</A>, <A HREF="../../../../../../org/apache/tools/ant/Task.html#setDescription(java.lang.String)">setDescription</A>, <A HREF="../../../../../../org/apache/tools/ant/Task.html#setLocation(org.apache.tools.ant.Location)">setLocation</A>, <A HREF="../../../../../../org/apache/tools/ant/Task.html#setOwningTarget(org.apache.tools.ant.Target)">setOwningTarget</A>, <A HREF="../../../../../../org/apache/tools/ant/Task.html#setRuntimeConfigurableWrapper(org.apache.tools.ant.RuntimeConfigurable)">setRuntimeConfigurableWrapper</A>, <A HREF="../../../../../../org/apache/tools/ant/Task.html#setTaskName(java.lang.String)">setTaskName</A>, <A HREF="../../../../../../org/apache/tools/ant/Task.html#setTaskType(java.lang.String)">setTaskType</A></CODE></TD>
456	</TR>
457	</TABLE>
458	<A NAME="methods_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
459	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
460	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
461	<TD><B>Methods inherited from class org.apache.tools.ant.<A HREF="../../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">ProjectComponent</A></B></TD>
462	</TR>
463	<TR BGCOLOR="white" CLASS="TableRowColor">
464	<TD><CODE><A HREF="../../../../../../org/apache/tools/ant/ProjectComponent.html#getProject()">getProject</A>, <A HREF="../../../../../../org/apache/tools/ant/ProjectComponent.html#setProject(org.apache.tools.ant.Project)">setProject</A></CODE></TD>
465	</TR>
466	</TABLE>
467	<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
468	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
469	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
470	<TD><B>Methods inherited from class java.lang.Object</B></TD>
471	</TR>
472	<TR BGCOLOR="white" CLASS="TableRowColor">
473	<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
474	</TR>
475	</TABLE>
476
477	<P>
478
479	<!-- ============ FIELD DETAIL =========== -->
480
481	<A NAME="field_detail"><!-- --></A>
482	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
483	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
484	<TD COLSPAN=1><FONT SIZE="+2">
485	<B>Field Detail</B></FONT></TD>
486	</TR>
487	</TABLE>
488
489	<A NAME="AUTO"><!-- --></A><H3>
490	AUTO</H3>
491	<PRE>
492	public static final java.lang.String <B>AUTO</B></PRE>
493	<DL>
494	<DD>Constant to show that the best available mailer should be used.
495	<P>
496	<DL>
497	<DT><B>See Also:</B><DD><A HREF="../../../../../../constant-values.html#org.apache.tools.ant.taskdefs.email.EmailTask.AUTO">Constant Field Values</A></DL>
498	</DL>
499	<HR>
500
501	<A NAME="MIME"><!-- --></A><H3>
502	MIME</H3>
503	<PRE>
504	public static final java.lang.String <B>MIME</B></PRE>
505	<DL>
506	<DD>Constant to allow the Mime mailer to be requested
507	<P>
508	<DL>
509	<DT><B>See Also:</B><DD><A HREF="../../../../../../constant-values.html#org.apache.tools.ant.taskdefs.email.EmailTask.MIME">Constant Field Values</A></DL>
510	</DL>
511	<HR>
512
513	<A NAME="UU"><!-- --></A><H3>
514	UU</H3>
515	<PRE>
516	public static final java.lang.String <B>UU</B></PRE>
517	<DL>
518	<DD>Constant to allow the UU mailer to be requested
519	<P>
520	<DL>
521	<DT><B>See Also:</B><DD><A HREF="../../../../../../constant-values.html#org.apache.tools.ant.taskdefs.email.EmailTask.UU">Constant Field Values</A></DL>
522	</DL>
523	<HR>
524
525	<A NAME="PLAIN"><!-- --></A><H3>
526	PLAIN</H3>
527	<PRE>
528	public static final java.lang.String <B>PLAIN</B></PRE>
529	<DL>
530	<DD>Constant to allow the plaintext mailer to be requested
531	<P>
532	<DL>
533	<DT><B>See Also:</B><DD><A HREF="../../../../../../constant-values.html#org.apache.tools.ant.taskdefs.email.EmailTask.PLAIN">Constant Field Values</A></DL>
534	</DL>
535
536	<!-- ========= CONSTRUCTOR DETAIL ======== -->
537
538	<A NAME="constructor_detail"><!-- --></A>
539	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
540	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
541	<TD COLSPAN=1><FONT SIZE="+2">
542	<B>Constructor Detail</B></FONT></TD>
543	</TR>
544	</TABLE>
545
546	<A NAME="EmailTask()"><!-- --></A><H3>
547	EmailTask</H3>
548	<PRE>
549	public <B>EmailTask</B>()</PRE>
550	<DL>
551	</DL>
552
553	<!-- ============ METHOD DETAIL ========== -->
554
555	<A NAME="method_detail"><!-- --></A>
556	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
557	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
558	<TD COLSPAN=1><FONT SIZE="+2">
559	<B>Method Detail</B></FONT></TD>
560	</TR>
561	</TABLE>
562
563	<A NAME="setUser(java.lang.String)"><!-- --></A><H3>
564	setUser</H3>
565	<PRE>
566	public void <B>setUser</B>(java.lang.String user)</PRE>
567	<DL>
568	<DD>sets the user for SMTP auth; this requires JavaMail
569	<P>
570	<DD><DL>
571	<DT><B>Parameters:</B><DD><CODE>user</CODE> - <DT><B>Since:</B></DT>
572	<DD>ant 1.6</DD>
573	</DL>
574	</DD>
575	</DL>
576	<HR>
577
578	<A NAME="setPassword(java.lang.String)"><!-- --></A><H3>
579	setPassword</H3>
580	<PRE>
581	public void <B>setPassword</B>(java.lang.String password)</PRE>
582	<DL>
583	<DD>sets the password for SMTP auth; this requires JavaMail
584	<P>
585	<DD><DL>
586	<DT><B>Parameters:</B><DD><CODE>password</CODE> - <DT><B>Since:</B></DT>
587	<DD>ant 1.6</DD>
588	</DL>
589	</DD>
590	</DL>
591	<HR>
592
593	<A NAME="setSSL(boolean)"><!-- --></A><H3>
594	setSSL</H3>
595	<PRE>
596	public void <B>setSSL</B>(boolean SSL)</PRE>
597	<DL>
598	<DD>tells if the user needs to send his data over SSL
599	<P>
600	<DD><DL>
601	<DT><B>Parameters:</B><DD><CODE>SSL</CODE> - <DT><B>Since:</B></DT>
602	<DD>ant 1.6</DD>
603	</DL>
604	</DD>
605	</DL>
606	<HR>
607
608	<A NAME="setEncoding(org.apache.tools.ant.taskdefs.email.EmailTask.Encoding)"><!-- --></A><H3>
609	setEncoding</H3>
610	<PRE>
611	public void <B>setEncoding</B>(<A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailTask.Encoding.html" title="class in org.apache.tools.ant.taskdefs.email">EmailTask.Encoding</A> encoding)</PRE>
612	<DL>
613	<DD>Allows the build writer to choose the preferred encoding method
614	<P>
615	<DD><DL>
616	<DT><B>Parameters:</B><DD><CODE>encoding</CODE> - The encoding (one of AUTO,MIME,UU,PLAIN)</DL>
617	</DD>
618	</DL>
619	<HR>
620
621	<A NAME="setMailport(int)"><!-- --></A><H3>
622	setMailport</H3>
623	<PRE>
624	public void <B>setMailport</B>(int port)</PRE>
625	<DL>
626	<DD>Sets the mail server port
627	<P>
628	<DD><DL>
629	<DT><B>Parameters:</B><DD><CODE>port</CODE> - The port to use</DL>
630	</DD>
631	</DL>
632	<HR>
633
634	<A NAME="setMailhost(java.lang.String)"><!-- --></A><H3>
635	setMailhost</H3>
636	<PRE>
637	public void <B>setMailhost</B>(java.lang.String host)</PRE>
638	<DL>
639	<DD>Sets the host
640	<P>
641	<DD><DL>
642	<DT><B>Parameters:</B><DD><CODE>host</CODE> - The host to connect to</DL>
643	</DD>
644	</DL>
645	<HR>
646
647	<A NAME="setSubject(java.lang.String)"><!-- --></A><H3>
648	setSubject</H3>
649	<PRE>
650	public void <B>setSubject</B>(java.lang.String subject)</PRE>
651	<DL>
652	<DD>Sets the subject line of the email
653	<P>
654	<DD><DL>
655	<DT><B>Parameters:</B><DD><CODE>subject</CODE> - Subject of this email.</DL>
656	</DD>
657	</DL>
658	<HR>
659
660	<A NAME="setMessage(java.lang.String)"><!-- --></A><H3>
661	setMessage</H3>
662	<PRE>
663	public void <B>setMessage</B>(java.lang.String message)</PRE>
664	<DL>
665	<DD>Shorthand method to set the message
666	<P>
667	<DD><DL>
668	<DT><B>Parameters:</B><DD><CODE>message</CODE> - Message body of this email.</DL>
669	</DD>
670	</DL>
671	<HR>
672
673	<A NAME="setMessageFile(java.io.File)"><!-- --></A><H3>
674	setMessageFile</H3>
675	<PRE>
676	public void <B>setMessageFile</B>(java.io.File file)</PRE>
677	<DL>
678	<DD>Shorthand method to set the message from a file
679	<P>
680	<DD><DL>
681	<DT><B>Parameters:</B><DD><CODE>file</CODE> - The file from which to take the message</DL>
682	</DD>
683	</DL>
684	<HR>
685
686	<A NAME="setMessageMimeType(java.lang.String)"><!-- --></A><H3>
687	setMessageMimeType</H3>
688	<PRE>
689	public void <B>setMessageMimeType</B>(java.lang.String type)</PRE>
690	<DL>
691	<DD>Shorthand method to set type of the text message, text/plain by default
692	but text/html or text/xml is quite feasible.
693	<P>
694	<DD><DL>
695	<DT><B>Parameters:</B><DD><CODE>type</CODE> - The new MessageMimeType value</DL>
696	</DD>
697	</DL>
698	<HR>
699
700	<A NAME="addMessage(org.apache.tools.ant.taskdefs.email.Message)"><!-- --></A><H3>
701	addMessage</H3>
702	<PRE>
703	public void <B>addMessage</B>(<A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Message.html" title="class in org.apache.tools.ant.taskdefs.email">Message</A> message)
704	throws <A HREF="../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
705	<DL>
706	<DD>Add a message element
707	<P>
708	<DD><DL>
709	<DT><B>Parameters:</B><DD><CODE>message</CODE> - The message object
710	<DT><B>Throws:</B>
711	<DD><CODE><A HREF="../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if a message has already been added</DL>
712	</DD>
713	</DL>
714	<HR>
715
716	<A NAME="addFrom(org.apache.tools.ant.taskdefs.email.EmailAddress)"><!-- --></A><H3>
717	addFrom</H3>
718	<PRE>
719	public void <B>addFrom</B>(<A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailAddress.html" title="class in org.apache.tools.ant.taskdefs.email">EmailAddress</A> address)</PRE>
720	<DL>
721	<DD>Adds a from address element
722	<P>
723	<DD><DL>
724	<DT><B>Parameters:</B><DD><CODE>address</CODE> - The address to send from</DL>
725	</DD>
726	</DL>
727	<HR>
728
729	<A NAME="setFrom(java.lang.String)"><!-- --></A><H3>
730	setFrom</H3>
731	<PRE>
732	public void <B>setFrom</B>(java.lang.String address)</PRE>
733	<DL>
734	<DD>Shorthand to set the from address element
735	<P>
736	<DD><DL>
737	<DT><B>Parameters:</B><DD><CODE>address</CODE> - The address to send mail from</DL>
738	</DD>
739	</DL>
740	<HR>
741
742	<A NAME="addReplyTo(org.apache.tools.ant.taskdefs.email.EmailAddress)"><!-- --></A><H3>
743	addReplyTo</H3>
744	<PRE>
745	public void <B>addReplyTo</B>(<A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailAddress.html" title="class in org.apache.tools.ant.taskdefs.email">EmailAddress</A> address)</PRE>
746	<DL>
747	<DD>Adds a replyto address element
748	<P>
749	<DD><DL>
750	<DT><B>Parameters:</B><DD><CODE>address</CODE> - The address to reply to<DT><B>Since:</B></DT>
751	<DD>ant 1.6</DD>
752	</DL>
753	</DD>
754	</DL>
755	<HR>
756
757	<A NAME="setReplyTo(java.lang.String)"><!-- --></A><H3>
758	setReplyTo</H3>
759	<PRE>
760	public void <B>setReplyTo</B>(java.lang.String address)</PRE>
761	<DL>
762	<DD>Shorthand to set the replyto address element
763	<P>
764	<DD><DL>
765	<DT><B>Parameters:</B><DD><CODE>address</CODE> - The address to which replies should be directed<DT><B>Since:</B></DT>
766	<DD>ant 1.6</DD>
767	</DL>
768	</DD>
769	</DL>
770	<HR>
771
772	<A NAME="addTo(org.apache.tools.ant.taskdefs.email.EmailAddress)"><!-- --></A><H3>
773	addTo</H3>
774	<PRE>
775	public void <B>addTo</B>(<A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailAddress.html" title="class in org.apache.tools.ant.taskdefs.email">EmailAddress</A> address)</PRE>
776	<DL>
777	<DD>Adds a to address element
778	<P>
779	<DD><DL>
780	<DT><B>Parameters:</B><DD><CODE>address</CODE> - An email address</DL>
781	</DD>
782	</DL>
783	<HR>
784
785	<A NAME="setToList(java.lang.String)"><!-- --></A><H3>
786	setToList</H3>
787	<PRE>
788	public void <B>setToList</B>(java.lang.String list)</PRE>
789	<DL>
790	<DD>Adds "to" address elements
791	<P>
792	<DD><DL>
793	<DT><B>Parameters:</B><DD><CODE>list</CODE> - Comma separated list of addresses</DL>
794	</DD>
795	</DL>
796	<HR>
797
798	<A NAME="addCc(org.apache.tools.ant.taskdefs.email.EmailAddress)"><!-- --></A><H3>
799	addCc</H3>
800	<PRE>
801	public void <B>addCc</B>(<A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailAddress.html" title="class in org.apache.tools.ant.taskdefs.email">EmailAddress</A> address)</PRE>
802	<DL>
803	<DD>Adds "cc" address element
804	<P>
805	<DD><DL>
806	<DT><B>Parameters:</B><DD><CODE>address</CODE> - The email address</DL>
807	</DD>
808	</DL>
809	<HR>
810
811	<A NAME="setCcList(java.lang.String)"><!-- --></A><H3>
812	setCcList</H3>
813	<PRE>
814	public void <B>setCcList</B>(java.lang.String list)</PRE>
815	<DL>
816	<DD>Adds "cc" address elements
817	<P>
818	<DD><DL>
819	<DT><B>Parameters:</B><DD><CODE>list</CODE> - Comma separated list of addresses</DL>
820	</DD>
821	</DL>
822	<HR>
823
824	<A NAME="addBcc(org.apache.tools.ant.taskdefs.email.EmailAddress)"><!-- --></A><H3>
825	addBcc</H3>
826	<PRE>
827	public void <B>addBcc</B>(<A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailAddress.html" title="class in org.apache.tools.ant.taskdefs.email">EmailAddress</A> address)</PRE>
828	<DL>
829	<DD>Adds "bcc" address elements
830	<P>
831	<DD><DL>
832	<DT><B>Parameters:</B><DD><CODE>address</CODE> - The email address</DL>
833	</DD>
834	</DL>
835	<HR>
836
837	<A NAME="setBccList(java.lang.String)"><!-- --></A><H3>
838	setBccList</H3>
839	<PRE>
840	public void <B>setBccList</B>(java.lang.String list)</PRE>
841	<DL>
842	<DD>Adds "bcc" address elements
843	<P>
844	<DD><DL>
845	<DT><B>Parameters:</B><DD><CODE>list</CODE> - comma separated list of addresses</DL>
846	</DD>
847	</DL>
848	<HR>
849
850	<A NAME="setFailOnError(boolean)"><!-- --></A><H3>
851	setFailOnError</H3>
852	<PRE>
853	public void <B>setFailOnError</B>(boolean failOnError)</PRE>
854	<DL>
855	<DD>Indicates whether BuildExceptions should be passed back to the core
856	<P>
857	<DD><DL>
858	<DT><B>Parameters:</B><DD><CODE>failOnError</CODE> - The new FailOnError value</DL>
859	</DD>
860	</DL>
861	<HR>
862
863	<A NAME="setFiles(java.lang.String)"><!-- --></A><H3>
864	setFiles</H3>
865	<PRE>
866	public void <B>setFiles</B>(java.lang.String filenames)</PRE>
867	<DL>
868	<DD>Adds a list of files to be attached
869	<P>
870	<DD><DL>
871	<DT><B>Parameters:</B><DD><CODE>filenames</CODE> - Comma separated list of files</DL>
872	</DD>
873	</DL>
874	<HR>
875
876	<A NAME="addFileset(org.apache.tools.ant.types.FileSet)"><!-- --></A><H3>
877	addFileset</H3>
878	<PRE>
879	public void <B>addFileset</B>(<A HREF="../../../../../../org/apache/tools/ant/types/FileSet.html" title="class in org.apache.tools.ant.types">FileSet</A> fs)</PRE>
880	<DL>
881	<DD>Adds a set of files (nested fileset attribute).
882	<P>
883	<DD><DL>
884	<DT><B>Parameters:</B><DD><CODE>fs</CODE> - The fileset</DL>
885	</DD>
886	</DL>
887	<HR>
888
889	<A NAME="setIncludefilenames(boolean)"><!-- --></A><H3>
890	setIncludefilenames</H3>
891	<PRE>
892	public void <B>setIncludefilenames</B>(boolean includeFileNames)</PRE>
893	<DL>
894	<DD>Sets Includefilenames attribute
895	<P>
896	<DD><DL>
897	<DT><B>Parameters:</B><DD><CODE>includeFileNames</CODE> - Whether to include filenames in the text of the
898	message</DL>
899	</DD>
900	</DL>
901	<HR>
902
903	<A NAME="getIncludeFileNames()"><!-- --></A><H3>
904	getIncludeFileNames</H3>
905	<PRE>
906	public boolean <B>getIncludeFileNames</B>()</PRE>
907	<DL>
908	<DD>Identifies whether file names should be included
909	<P>
910	<DD><DL>
911
912	<DT><B>Returns:</B><DD>Identifies whether file names should be included</DL>
913	</DD>
914	</DL>
915	<HR>
916
917	<A NAME="execute()"><!-- --></A><H3>
918	execute</H3>
919	<PRE>
920	public void <B>execute</B>()</PRE>
921	<DL>
922	<DD>Sends an email
923	<P>
924	<DD><DL>
925	<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../org/apache/tools/ant/Task.html#execute()">execute</A></CODE> in class <CODE><A HREF="../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></CODE></DL>
926	</DD>
927	<DD><DL>
928	</DL>
929	</DD>
930	</DL>
931	<HR>
932
933	<A NAME="setCharset(java.lang.String)"><!-- --></A><H3>
934	setCharset</H3>
935	<PRE>
936	public void <B>setCharset</B>(java.lang.String charset)</PRE>
937	<DL>
938	<DD>Sets the character set of mail message.
939	Will be ignored if mimeType contains ....; Charset=... substring or
940	encoding is not a <code>mime</code>
941	<P>
942	<DD><DL>
943	<DT><B>Since:</B></DT>
944	<DD>Ant 1.6</DD>
945	</DL>
946	</DD>
947	</DL>
948	<HR>
949
950	<A NAME="getCharset()"><!-- --></A><H3>
951	getCharset</H3>
952	<PRE>
953	public java.lang.String <B>getCharset</B>()</PRE>
954	<DL>
955	<DD>Returns the character set of mail message.
956	<P>
957	<DD><DL>
958
959	<DT><B>Returns:</B><DD>Charset of mail message.<DT><B>Since:</B></DT>
960	<DD>Ant 1.6</DD>
961	</DL>
962	</DD>
963	</DL>
964	<!-- ========= END OF CLASS DATA ========= -->
965	<HR>
966
967
968	<!-- ======= START OF BOTTOM NAVBAR ====== -->
969	<A NAME="navbar_bottom"><!-- --></A>
970	<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
971	<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
972	<TR>
973	<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
974	<A NAME="navbar_bottom_firstrow"><!-- --></A>
975	<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
976	<TR ALIGN="center" VALIGN="top">
977	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
978	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
979	<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
980	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
981	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
982	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
983	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
984	</TR>
985	</TABLE>
986	</TD>
987	<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
988	</EM>
989	</TD>
990	</TR>
991
992	<TR>
993	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
994	<A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailAddress.html" title="class in org.apache.tools.ant.taskdefs.email"><B>PREV CLASS</B></A>
995	<A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailTask.Encoding.html" title="class in org.apache.tools.ant.taskdefs.email"><B>NEXT CLASS</B></A></FONT></TD>
996	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
997	<A HREF="../../../../../../index.html" target="_top"><B>FRAMES</B></A>
998	<A HREF="EmailTask.html" target="_top"><B>NO FRAMES</B></A>
999	<SCRIPT type="text/javascript">
1000	<!--
1001	if(window==top) {
1002	document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
1003	}
1004	//-->
1005	</SCRIPT>
1006	<NOSCRIPT>
1007	<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
1008	</NOSCRIPT>
1009
1010	</FONT></TD>
1011	</TR>
1012	<TR>
1013	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
1014	SUMMARY: <A HREF="#nested_class_summary">NESTED</A> \| <A HREF="#field_summary">FIELD</A> \| <A HREF="#constructor_summary">CONSTR</A> \| <A HREF="#method_summary">METHOD</A></FONT></TD>
1015	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
1016	DETAIL: <A HREF="#field_detail">FIELD</A> \| <A HREF="#constructor_detail">CONSTR</A> \| <A HREF="#method_detail">METHOD</A></FONT></TD>
1017	</TR>
1018	</TABLE>
1019	<A NAME="skip-navbar_bottom"></A>
1020	<!-- ======== END OF BOTTOM NAVBAR ======= -->
1021
1022	<HR>
1023	Copyright Â© 2000-2007 Apache Software Foundation. All Rights Reserved.
1024	</BODY>
1025	</HTML>

Note: See TracBrowser for help on using the repository browser.

Download in other formats: