Context Navigation

← Previous Revision
Latest Revision
Next Revision →
Blame
Revision Log

source: release-kits/lirk3/resources/gs3-release-maker/ant/docs/manual/api/org/apache/tools/ant/taskdefs/email/Mailer.html@ 14982

Last change on this file since 14982 was 14982, checked in by oranfry, 16 years ago
initial import of LiRK3
File size: 30.4 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	Mailer (Apache Ant API)
8	</TITLE>
9
10	<META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.email.Mailer 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="Mailer (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/EmailTask.Encoding.html" title="class in org.apache.tools.ant.taskdefs.email"><B>PREV CLASS</B></A>
53	<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>
54	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
55	<A HREF="../../../../../../index.html" target="_top"><B>FRAMES</B></A>
56	<A HREF="Mailer.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: NESTED \| <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 Mailer</H2>
87	<PRE>
88	java.lang.Object
89	<IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.taskdefs.email.Mailer</B>
90	</PRE>
91	<DL>
92	<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>
93	</DL>
94	<HR>
95	<DL>
96	<DT>public abstract class <B>Mailer</B><DT>extends java.lang.Object</DL>
97
98	<P>
99	Base class for the various emailing implementations.
100	<P>
101
102	<P>
103	<DL>
104	<DT><B>Since:</B></DT>
105	<DD>Ant 1.5</DD>
106	</DL>
107	<HR>
108
109	<P>
110	<!-- ======== NESTED CLASS SUMMARY ======== -->
111
112
113	<!-- =========== FIELD SUMMARY =========== -->
114
115	<A NAME="field_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>Field 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>protected  java.util.Vector</CODE></FONT></TD>
124	<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Mailer.html#bccList">bccList</A></B></CODE>
125
126	<BR>
127	</TD>
128	</TR>
129	<TR BGCOLOR="white" CLASS="TableRowColor">
130	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
131	<CODE>protected  java.util.Vector</CODE></FONT></TD>
132	<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Mailer.html#ccList">ccList</A></B></CODE>
133
134	<BR>
135	</TD>
136	</TR>
137	<TR BGCOLOR="white" CLASS="TableRowColor">
138	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
139	<CODE>protected  java.util.Vector</CODE></FONT></TD>
140	<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Mailer.html#files">files</A></B></CODE>
141
142	<BR>
143	</TD>
144	</TR>
145	<TR BGCOLOR="white" CLASS="TableRowColor">
146	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
147	<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>
148	<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Mailer.html#from">from</A></B></CODE>
149
150	<BR>
151	</TD>
152	</TR>
153	<TR BGCOLOR="white" CLASS="TableRowColor">
154	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
155	<CODE>protected  java.lang.String</CODE></FONT></TD>
156	<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Mailer.html#host">host</A></B></CODE>
157
158	<BR>
159	</TD>
160	</TR>
161	<TR BGCOLOR="white" CLASS="TableRowColor">
162	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
163	<CODE>protected  boolean</CODE></FONT></TD>
164	<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Mailer.html#includeFileNames">includeFileNames</A></B></CODE>
165
166	<BR>
167	</TD>
168	</TR>
169	<TR BGCOLOR="white" CLASS="TableRowColor">
170	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
171	<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>
172	<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Mailer.html#message">message</A></B></CODE>
173
174	<BR>
175	</TD>
176	</TR>
177	<TR BGCOLOR="white" CLASS="TableRowColor">
178	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
179	<CODE>protected  java.lang.String</CODE></FONT></TD>
180	<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Mailer.html#password">password</A></B></CODE>
181
182	<BR>
183	</TD>
184	</TR>
185	<TR BGCOLOR="white" CLASS="TableRowColor">
186	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
187	<CODE>protected  int</CODE></FONT></TD>
188	<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Mailer.html#port">port</A></B></CODE>
189
190	<BR>
191	</TD>
192	</TR>
193	<TR BGCOLOR="white" CLASS="TableRowColor">
194	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
195	<CODE>protected  java.util.Vector</CODE></FONT></TD>
196	<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Mailer.html#replyToList">replyToList</A></B></CODE>
197
198	<BR>
199	</TD>
200	</TR>
201	<TR BGCOLOR="white" CLASS="TableRowColor">
202	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
203	<CODE>protected  boolean</CODE></FONT></TD>
204	<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Mailer.html#SSL">SSL</A></B></CODE>
205
206	<BR>
207	</TD>
208	</TR>
209	<TR BGCOLOR="white" CLASS="TableRowColor">
210	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
211	<CODE>protected  java.lang.String</CODE></FONT></TD>
212	<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Mailer.html#subject">subject</A></B></CODE>
213
214	<BR>
215	</TD>
216	</TR>
217	<TR BGCOLOR="white" CLASS="TableRowColor">
218	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
219	<CODE>protected  <A HREF="../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></CODE></FONT></TD>
220	<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Mailer.html#task">task</A></B></CODE>
221
222	<BR>
223	</TD>
224	</TR>
225	<TR BGCOLOR="white" CLASS="TableRowColor">
226	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
227	<CODE>protected  java.util.Vector</CODE></FONT></TD>
228	<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Mailer.html#toList">toList</A></B></CODE>
229
230	<BR>
231	</TD>
232	</TR>
233	<TR BGCOLOR="white" CLASS="TableRowColor">
234	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
235	<CODE>protected  java.lang.String</CODE></FONT></TD>
236	<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Mailer.html#user">user</A></B></CODE>
237
238	<BR>
239	</TD>
240	</TR>
241	</TABLE>
242
243	<!-- ======== CONSTRUCTOR SUMMARY ======== -->
244
245	<A NAME="constructor_summary"><!-- --></A>
246	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
247	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
248	<TD COLSPAN=2><FONT SIZE="+2">
249	<B>Constructor Summary</B></FONT></TD>
250	</TR>
251	<TR BGCOLOR="white" CLASS="TableRowColor">
252	<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Mailer.html#Mailer()">Mailer</A></B>()</CODE>
253
254	<BR>
255	</TD>
256	</TR>
257	</TABLE>
258
259	<!-- ========== METHOD SUMMARY =========== -->
260
261	<A NAME="method_summary"><!-- --></A>
262	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
263	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
264	<TD COLSPAN=2><FONT SIZE="+2">
265	<B>Method Summary</B></FONT></TD>
266	</TR>
267	<TR BGCOLOR="white" CLASS="TableRowColor">
268	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
269	<CODE>protected  java.lang.String</CODE></FONT></TD>
270	<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Mailer.html#getDate()">getDate</A></B>()</CODE>
271
272	<BR>
273	Returns the current Date in a format suitable for a SMTP date
274	header.</TD>
275	</TR>
276	<TR BGCOLOR="white" CLASS="TableRowColor">
277	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
278	<CODE>abstract  void</CODE></FONT></TD>
279	<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Mailer.html#send()">send</A></B>()</CODE>
280
281	<BR>
282	This method should send the email</TD>
283	</TR>
284	<TR BGCOLOR="white" CLASS="TableRowColor">
285	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
286	<CODE> void</CODE></FONT></TD>
287	<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>
288
289	<BR>
290	Sets the bcc addresses</TD>
291	</TR>
292	<TR BGCOLOR="white" CLASS="TableRowColor">
293	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
294	<CODE> void</CODE></FONT></TD>
295	<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>
296
297	<BR>
298	Sets the cc addresses</TD>
299	</TR>
300	<TR BGCOLOR="white" CLASS="TableRowColor">
301	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
302	<CODE> void</CODE></FONT></TD>
303	<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>
304
305	<BR>
306	Sets the files to attach</TD>
307	</TR>
308	<TR BGCOLOR="white" CLASS="TableRowColor">
309	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
310	<CODE> void</CODE></FONT></TD>
311	<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>
312
313	<BR>
314	Sets the address to send from</TD>
315	</TR>
316	<TR BGCOLOR="white" CLASS="TableRowColor">
317	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
318	<CODE> void</CODE></FONT></TD>
319	<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>
320
321	<BR>
322	Sets the mail server</TD>
323	</TR>
324	<TR BGCOLOR="white" CLASS="TableRowColor">
325	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
326	<CODE> void</CODE></FONT></TD>
327	<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Mailer.html#setIncludeFileNames(boolean)">setIncludeFileNames</A></B>(boolean b)</CODE>
328
329	<BR>
330	Indicates whether filenames should be listed in the body</TD>
331	</TR>
332	<TR BGCOLOR="white" CLASS="TableRowColor">
333	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
334	<CODE> void</CODE></FONT></TD>
335	<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>
336
337	<BR>
338	Sets the message</TD>
339	</TR>
340	<TR BGCOLOR="white" CLASS="TableRowColor">
341	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
342	<CODE> void</CODE></FONT></TD>
343	<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>
344
345	<BR>
346	Sets the password for smtp auth</TD>
347	</TR>
348	<TR BGCOLOR="white" CLASS="TableRowColor">
349	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
350	<CODE> void</CODE></FONT></TD>
351	<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Mailer.html#setPort(int)">setPort</A></B>(int port)</CODE>
352
353	<BR>
354	Sets the smtp port</TD>
355	</TR>
356	<TR BGCOLOR="white" CLASS="TableRowColor">
357	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
358	<CODE> void</CODE></FONT></TD>
359	<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>
360
361	<BR>
362	Sets the replyto addresses</TD>
363	</TR>
364	<TR BGCOLOR="white" CLASS="TableRowColor">
365	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
366	<CODE> void</CODE></FONT></TD>
367	<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/Mailer.html#setSSL(boolean)">setSSL</A></B>(boolean SSL)</CODE>
368
369	<BR>
370	Sets whether the user wants to send the mail through SSL</TD>
371	</TR>
372	<TR BGCOLOR="white" CLASS="TableRowColor">
373	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
374	<CODE> void</CODE></FONT></TD>
375	<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>
376
377	<BR>
378	Sets the subject</TD>
379	</TR>
380	<TR BGCOLOR="white" CLASS="TableRowColor">
381	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
382	<CODE> void</CODE></FONT></TD>
383	<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>
384
385	<BR>
386	Sets the owning task</TD>
387	</TR>
388	<TR BGCOLOR="white" CLASS="TableRowColor">
389	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
390	<CODE> void</CODE></FONT></TD>
391	<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>
392
393	<BR>
394	Set the to addresses</TD>
395	</TR>
396	<TR BGCOLOR="white" CLASS="TableRowColor">
397	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
398	<CODE> void</CODE></FONT></TD>
399	<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>
400
401	<BR>
402	Sets the user for smtp auth</TD>
403	</TR>
404	</TABLE>
405	<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
406	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
407	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
408	<TD><B>Methods inherited from class java.lang.Object</B></TD>
409	</TR>
410	<TR BGCOLOR="white" CLASS="TableRowColor">
411	<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
412	</TR>
413	</TABLE>
414
415	<P>
416
417	<!-- ============ FIELD DETAIL =========== -->
418
419	<A NAME="field_detail"><!-- --></A>
420	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
421	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
422	<TD COLSPAN=1><FONT SIZE="+2">
423	<B>Field Detail</B></FONT></TD>
424	</TR>
425	</TABLE>
426
427	<A NAME="host"><!-- --></A><H3>
428	host</H3>
429	<PRE>
430	protected java.lang.String <B>host</B></PRE>
431	<DL>
432	<DL>
433	</DL>
434	</DL>
435	<HR>
436
437	<A NAME="port"><!-- --></A><H3>
438	port</H3>
439	<PRE>
440	protected int <B>port</B></PRE>
441	<DL>
442	<DL>
443	</DL>
444	</DL>
445	<HR>
446
447	<A NAME="user"><!-- --></A><H3>
448	user</H3>
449	<PRE>
450	protected java.lang.String <B>user</B></PRE>
451	<DL>
452	<DL>
453	</DL>
454	</DL>
455	<HR>
456
457	<A NAME="password"><!-- --></A><H3>
458	password</H3>
459	<PRE>
460	protected java.lang.String <B>password</B></PRE>
461	<DL>
462	<DL>
463	</DL>
464	</DL>
465	<HR>
466
467	<A NAME="SSL"><!-- --></A><H3>
468	SSL</H3>
469	<PRE>
470	protected boolean <B>SSL</B></PRE>
471	<DL>
472	<DL>
473	</DL>
474	</DL>
475	<HR>
476
477	<A NAME="message"><!-- --></A><H3>
478	message</H3>
479	<PRE>
480	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>
481	<DL>
482	<DL>
483	</DL>
484	</DL>
485	<HR>
486
487	<A NAME="from"><!-- --></A><H3>
488	from</H3>
489	<PRE>
490	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>
491	<DL>
492	<DL>
493	</DL>
494	</DL>
495	<HR>
496
497	<A NAME="replyToList"><!-- --></A><H3>
498	replyToList</H3>
499	<PRE>
500	protected java.util.Vector <B>replyToList</B></PRE>
501	<DL>
502	<DL>
503	</DL>
504	</DL>
505	<HR>
506
507	<A NAME="toList"><!-- --></A><H3>
508	toList</H3>
509	<PRE>
510	protected java.util.Vector <B>toList</B></PRE>
511	<DL>
512	<DL>
513	</DL>
514	</DL>
515	<HR>
516
517	<A NAME="ccList"><!-- --></A><H3>
518	ccList</H3>
519	<PRE>
520	protected java.util.Vector <B>ccList</B></PRE>
521	<DL>
522	<DL>
523	</DL>
524	</DL>
525	<HR>
526
527	<A NAME="bccList"><!-- --></A><H3>
528	bccList</H3>
529	<PRE>
530	protected java.util.Vector <B>bccList</B></PRE>
531	<DL>
532	<DL>
533	</DL>
534	</DL>
535	<HR>
536
537	<A NAME="files"><!-- --></A><H3>
538	files</H3>
539	<PRE>
540	protected java.util.Vector <B>files</B></PRE>
541	<DL>
542	<DL>
543	</DL>
544	</DL>
545	<HR>
546
547	<A NAME="subject"><!-- --></A><H3>
548	subject</H3>
549	<PRE>
550	protected java.lang.String <B>subject</B></PRE>
551	<DL>
552	<DL>
553	</DL>
554	</DL>
555	<HR>
556
557	<A NAME="task"><!-- --></A><H3>
558	task</H3>
559	<PRE>
560	protected <A HREF="../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A> <B>task</B></PRE>
561	<DL>
562	<DL>
563	</DL>
564	</DL>
565	<HR>
566
567	<A NAME="includeFileNames"><!-- --></A><H3>
568	includeFileNames</H3>
569	<PRE>
570	protected boolean <B>includeFileNames</B></PRE>
571	<DL>
572	<DL>
573	</DL>
574	</DL>
575
576	<!-- ========= CONSTRUCTOR DETAIL ======== -->
577
578	<A NAME="constructor_detail"><!-- --></A>
579	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
580	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
581	<TD COLSPAN=1><FONT SIZE="+2">
582	<B>Constructor Detail</B></FONT></TD>
583	</TR>
584	</TABLE>
585
586	<A NAME="Mailer()"><!-- --></A><H3>
587	Mailer</H3>
588	<PRE>
589	public <B>Mailer</B>()</PRE>
590	<DL>
591	</DL>
592
593	<!-- ============ METHOD DETAIL ========== -->
594
595	<A NAME="method_detail"><!-- --></A>
596	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
597	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
598	<TD COLSPAN=1><FONT SIZE="+2">
599	<B>Method Detail</B></FONT></TD>
600	</TR>
601	</TABLE>
602
603	<A NAME="setHost(java.lang.String)"><!-- --></A><H3>
604	setHost</H3>
605	<PRE>
606	public void <B>setHost</B>(java.lang.String host)</PRE>
607	<DL>
608	<DD>Sets the mail server
609	<P>
610	<DD><DL>
611	<DT><B>Parameters:</B><DD><CODE>host</CODE> - the mail server name</DL>
612	</DD>
613	</DL>
614	<HR>
615
616	<A NAME="setPort(int)"><!-- --></A><H3>
617	setPort</H3>
618	<PRE>
619	public void <B>setPort</B>(int port)</PRE>
620	<DL>
621	<DD>Sets the smtp port
622	<P>
623	<DD><DL>
624	<DT><B>Parameters:</B><DD><CODE>port</CODE> - the SMTP port</DL>
625	</DD>
626	</DL>
627	<HR>
628
629	<A NAME="setUser(java.lang.String)"><!-- --></A><H3>
630	setUser</H3>
631	<PRE>
632	public void <B>setUser</B>(java.lang.String user)</PRE>
633	<DL>
634	<DD>Sets the user for smtp auth
635	<P>
636	<DD><DL>
637	<DT><B>Parameters:</B><DD><CODE>user</CODE> - the username<DT><B>Since:</B></DT>
638	<DD>ant 1.6</DD>
639	</DL>
640	</DD>
641	</DL>
642	<HR>
643
644	<A NAME="setPassword(java.lang.String)"><!-- --></A><H3>
645	setPassword</H3>
646	<PRE>
647	public void <B>setPassword</B>(java.lang.String password)</PRE>
648	<DL>
649	<DD>Sets the password for smtp auth
650	<P>
651	<DD><DL>
652	<DT><B>Parameters:</B><DD><CODE>password</CODE> - the authentication password<DT><B>Since:</B></DT>
653	<DD>ant 1.6</DD>
654	</DL>
655	</DD>
656	</DL>
657	<HR>
658
659	<A NAME="setSSL(boolean)"><!-- --></A><H3>
660	setSSL</H3>
661	<PRE>
662	public void <B>setSSL</B>(boolean SSL)</PRE>
663	<DL>
664	<DD>Sets whether the user wants to send the mail through SSL
665	<P>
666	<DD><DL>
667	<DT><B>Parameters:</B><DD><CODE>SSL</CODE> - if true use SSL transport<DT><B>Since:</B></DT>
668	<DD>ant 1.6</DD>
669	</DL>
670	</DD>
671	</DL>
672	<HR>
673
674	<A NAME="setMessage(org.apache.tools.ant.taskdefs.email.Message)"><!-- --></A><H3>
675	setMessage</H3>
676	<PRE>
677	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>
678	<DL>
679	<DD>Sets the message
680	<P>
681	<DD><DL>
682	<DT><B>Parameters:</B><DD><CODE>m</CODE> - the message content</DL>
683	</DD>
684	</DL>
685	<HR>
686
687	<A NAME="setFrom(org.apache.tools.ant.taskdefs.email.EmailAddress)"><!-- --></A><H3>
688	setFrom</H3>
689	<PRE>
690	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>
691	<DL>
692	<DD>Sets the address to send from
693	<P>
694	<DD><DL>
695	<DT><B>Parameters:</B><DD><CODE>from</CODE> - the sender</DL>
696	</DD>
697	</DL>
698	<HR>
699
700	<A NAME="setReplyToList(java.util.Vector)"><!-- --></A><H3>
701	setReplyToList</H3>
702	<PRE>
703	public void <B>setReplyToList</B>(java.util.Vector list)</PRE>
704	<DL>
705	<DD>Sets the replyto addresses
706	<P>
707	<DD><DL>
708	<DT><B>Parameters:</B><DD><CODE>list</CODE> - a vector of reployTo addresses<DT><B>Since:</B></DT>
709	<DD>ant 1.6</DD>
710	</DL>
711	</DD>
712	</DL>
713	<HR>
714
715	<A NAME="setToList(java.util.Vector)"><!-- --></A><H3>
716	setToList</H3>
717	<PRE>
718	public void <B>setToList</B>(java.util.Vector list)</PRE>
719	<DL>
720	<DD>Set the to addresses
721	<P>
722	<DD><DL>
723	<DT><B>Parameters:</B><DD><CODE>list</CODE> - a vector of recipient addresses</DL>
724	</DD>
725	</DL>
726	<HR>
727
728	<A NAME="setCcList(java.util.Vector)"><!-- --></A><H3>
729	setCcList</H3>
730	<PRE>
731	public void <B>setCcList</B>(java.util.Vector list)</PRE>
732	<DL>
733	<DD>Sets the cc addresses
734	<P>
735	<DD><DL>
736	<DT><B>Parameters:</B><DD><CODE>list</CODE> - a vector of cc addresses</DL>
737	</DD>
738	</DL>
739	<HR>
740
741	<A NAME="setBccList(java.util.Vector)"><!-- --></A><H3>
742	setBccList</H3>
743	<PRE>
744	public void <B>setBccList</B>(java.util.Vector list)</PRE>
745	<DL>
746	<DD>Sets the bcc addresses
747	<P>
748	<DD><DL>
749	<DT><B>Parameters:</B><DD><CODE>list</CODE> - a vector of the bcc addresses</DL>
750	</DD>
751	</DL>
752	<HR>
753
754	<A NAME="setFiles(java.util.Vector)"><!-- --></A><H3>
755	setFiles</H3>
756	<PRE>
757	public void <B>setFiles</B>(java.util.Vector files)</PRE>
758	<DL>
759	<DD>Sets the files to attach
760	<P>
761	<DD><DL>
762	<DT><B>Parameters:</B><DD><CODE>files</CODE> - list of files to attach to the email.</DL>
763	</DD>
764	</DL>
765	<HR>
766
767	<A NAME="setSubject(java.lang.String)"><!-- --></A><H3>
768	setSubject</H3>
769	<PRE>
770	public void <B>setSubject</B>(java.lang.String subject)</PRE>
771	<DL>
772	<DD>Sets the subject
773	<P>
774	<DD><DL>
775	<DT><B>Parameters:</B><DD><CODE>subject</CODE> - the subject line</DL>
776	</DD>
777	</DL>
778	<HR>
779
780	<A NAME="setTask(org.apache.tools.ant.Task)"><!-- --></A><H3>
781	setTask</H3>
782	<PRE>
783	public void <B>setTask</B>(<A HREF="../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A> task)</PRE>
784	<DL>
785	<DD>Sets the owning task
786	<P>
787	<DD><DL>
788	<DT><B>Parameters:</B><DD><CODE>task</CODE> - the owning task instance</DL>
789	</DD>
790	</DL>
791	<HR>
792
793	<A NAME="setIncludeFileNames(boolean)"><!-- --></A><H3>
794	setIncludeFileNames</H3>
795	<PRE>
796	public void <B>setIncludeFileNames</B>(boolean b)</PRE>
797	<DL>
798	<DD>Indicates whether filenames should be listed in the body
799	<P>
800	<DD><DL>
801	<DT><B>Parameters:</B><DD><CODE>b</CODE> - if true list attached file names in the body content.</DL>
802	</DD>
803	</DL>
804	<HR>
805
806	<A NAME="send()"><!-- --></A><H3>
807	send</H3>
808	<PRE>
809	public abstract void <B>send</B>()
810	throws <A HREF="../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
811	<DL>
812	<DD>This method should send the email
813	<P>
814	<DD><DL>
815
816	<DT><B>Throws:</B>
817	<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>
818	</DD>
819	</DL>
820	<HR>
821
822	<A NAME="getDate()"><!-- --></A><H3>
823	getDate</H3>
824	<PRE>
825	protected final java.lang.String <B>getDate</B>()</PRE>
826	<DL>
827	<DD>Returns the current Date in a format suitable for a SMTP date
828	header.
829	<P>
830	<DD><DL>
831
832	<DT><B>Returns:</B><DD>the current date in SMTP suitable format.<DT><B>Since:</B></DT>
833	<DD>Ant 1.5</DD>
834	</DL>
835	</DD>
836	</DL>
837	<!-- ========= END OF CLASS DATA ========= -->
838	<HR>
839
840
841	<!-- ======= START OF BOTTOM NAVBAR ====== -->
842	<A NAME="navbar_bottom"><!-- --></A>
843	<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
844	<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
845	<TR>
846	<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
847	<A NAME="navbar_bottom_firstrow"><!-- --></A>
848	<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
849	<TR ALIGN="center" VALIGN="top">
850	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
851	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
852	<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
853	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
854	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
855	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
856	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
857	</TR>
858	</TABLE>
859	</TD>
860	<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
861	</EM>
862	</TD>
863	</TR>
864
865	<TR>
866	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
867	<A HREF="../../../../../../org/apache/tools/ant/taskdefs/email/EmailTask.Encoding.html" title="class in org.apache.tools.ant.taskdefs.email"><B>PREV CLASS</B></A>
868	<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>
869	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
870	<A HREF="../../../../../../index.html" target="_top"><B>FRAMES</B></A>
871	<A HREF="Mailer.html" target="_top"><B>NO FRAMES</B></A>
872	<SCRIPT type="text/javascript">
873	<!--
874	if(window==top) {
875	document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
876	}
877	//-->
878	</SCRIPT>
879	<NOSCRIPT>
880	<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
881	</NOSCRIPT>
882
883	</FONT></TD>
884	</TR>
885	<TR>
886	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
887	SUMMARY: NESTED \| <A HREF="#field_summary">FIELD</A> \| <A HREF="#constructor_summary">CONSTR</A> \| <A HREF="#method_summary">METHOD</A></FONT></TD>
888	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
889	DETAIL: <A HREF="#field_detail">FIELD</A> \| <A HREF="#constructor_detail">CONSTR</A> \| <A HREF="#method_detail">METHOD</A></FONT></TD>
890	</TR>
891	</TABLE>
892	<A NAME="skip-navbar_bottom"></A>
893	<!-- ======== END OF BOTTOM NAVBAR ======= -->
894
895	<HR>
896	Copyright Â© 2000-2007 Apache Software Foundation. All Rights Reserved.
897	</BODY>
898	</HTML>

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

Download in other formats: