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

Last change on this file since 14982 was 14982, checked in by oranfry, 16 years ago

initial import of LiRK3
File size: 16.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:17 NZST 2007 -->
6<TITLE>
7MailLogger (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.listener.MailLogger class">
11
12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
13
14<SCRIPT type="text/javascript">
15function windowTitle()
16{
17 parent.document.title="MailLogger (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>&nbsp;</TD>
36 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
37 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</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&nbsp;<A HREF="../../../../../org/apache/tools/ant/listener/Log4jListener.html" title="class in org.apache.tools.ant.listener"><B>PREV CLASS</B></A>&nbsp;
53&nbsp;NEXT CLASS</FONT></TD>
54<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
55 <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
56&nbsp;<A HREF="MailLogger.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
57&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_org.apache.tools.ant.DefaultLogger">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
73<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
74DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<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">
84org.apache.tools.ant.listener</FONT>
85<BR>
86Class MailLogger</H2>
87<PRE>
88java.lang.Object
89 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../org/apache/tools/ant/DefaultLogger.html" title="class in org.apache.tools.ant">org.apache.tools.ant.DefaultLogger</A>
90 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.listener.MailLogger</B>
91</PRE>
92<DL>
93<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../org/apache/tools/ant/BuildListener.html" title="interface in org.apache.tools.ant">BuildListener</A>, <A HREF="../../../../../org/apache/tools/ant/BuildLogger.html" title="interface in org.apache.tools.ant">BuildLogger</A>, java.util.EventListener</DD>
94</DL>
95<HR>
96<DL>
97<DT>public class <B>MailLogger</B><DT>extends <A HREF="../../../../../org/apache/tools/ant/DefaultLogger.html" title="class in org.apache.tools.ant">DefaultLogger</A></DL>
98
99<P>
100Buffers log messages from DefaultLogger, and sends an e-mail with the
101 results. The following Project properties are used to send the mail.
102 <ul>
103 <li> MailLogger.mailhost [default: localhost] - Mail server to use</li>
104 <li> MailLogger.port [default: 25] - Default port for SMTP </li>
105 <li> MailLogger.from [required] - Mail "from" address</li>
106 <li> MailLogger.failure.notify [default: true] - Send build failure
107 e-mails?</li>
108 <li> MailLogger.success.notify [default: true] - Send build success
109 e-mails?</li>
110 <li> MailLogger.failure.to [required if failure mail to be sent] - Address
111 to send failure messages to</li>
112 <li> MailLogger.success.to [required if success mail to be sent] - Address
113 to send success messages to</li>
114 <li> MailLogger.failure.subject [default: "Build Failure"] - Subject of
115 failed build</li>
116 <li> MailLogger.success.subject [default: "Build Success"] - Subject of
117 successful build</li>
118 </ul>
119 These properties are set using standard Ant property setting mechanisms
120 (&lt;property&gt;, command-line -D, etc). Ant properties can be overridden
121 by specifying the filename of a properties file in the <i>
122 MailLogger.properties.file property</i> . Any properties defined in that
123 file will override Ant properties.
124<P>
125
126<P>
127<HR>
128
129<P>
130<!-- ======== NESTED CLASS SUMMARY ======== -->
131
132
133<!-- =========== FIELD SUMMARY =========== -->
134
135<A NAME="field_summary"><!-- --></A>
136<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
137<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
138<TD COLSPAN=2><FONT SIZE="+2">
139<B>Field Summary</B></FONT></TD>
140</TR>
141</TABLE>
142&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.DefaultLogger"><!-- --></A>
143<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
144<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
145<TD><B>Fields inherited from class org.apache.tools.ant.<A HREF="../../../../../org/apache/tools/ant/DefaultLogger.html" title="class in org.apache.tools.ant">DefaultLogger</A></B></TD>
146</TR>
147<TR BGCOLOR="white" CLASS="TableRowColor">
148<TD><CODE><A HREF="../../../../../org/apache/tools/ant/DefaultLogger.html#emacsMode">emacsMode</A>, <A HREF="../../../../../org/apache/tools/ant/DefaultLogger.html#err">err</A>, <A HREF="../../../../../org/apache/tools/ant/DefaultLogger.html#LEFT_COLUMN_SIZE">LEFT_COLUMN_SIZE</A>, <A HREF="../../../../../org/apache/tools/ant/DefaultLogger.html#lSep">lSep</A>, <A HREF="../../../../../org/apache/tools/ant/DefaultLogger.html#msgOutputLevel">msgOutputLevel</A>, <A HREF="../../../../../org/apache/tools/ant/DefaultLogger.html#out">out</A></CODE></TD>
149</TR>
150</TABLE>
151&nbsp;
152<!-- ======== CONSTRUCTOR SUMMARY ======== -->
153
154<A NAME="constructor_summary"><!-- --></A>
155<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
156<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
157<TD COLSPAN=2><FONT SIZE="+2">
158<B>Constructor Summary</B></FONT></TD>
159</TR>
160<TR BGCOLOR="white" CLASS="TableRowColor">
161<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/listener/MailLogger.html#MailLogger()">MailLogger</A></B>()</CODE>
162
163<BR>
164&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
165</TR>
166</TABLE>
167&nbsp;
168<!-- ========== METHOD SUMMARY =========== -->
169
170<A NAME="method_summary"><!-- --></A>
171<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
172<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
173<TD COLSPAN=2><FONT SIZE="+2">
174<B>Method Summary</B></FONT></TD>
175</TR>
176<TR BGCOLOR="white" CLASS="TableRowColor">
177<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
178<CODE>&nbsp;void</CODE></FONT></TD>
179<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/listener/MailLogger.html#buildFinished(org.apache.tools.ant.BuildEvent)">buildFinished</A></B>(<A HREF="../../../../../org/apache/tools/ant/BuildEvent.html" title="class in org.apache.tools.ant">BuildEvent</A>&nbsp;event)</CODE>
180
181<BR>
182&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sends an e-mail with the log results.</TD>
183</TR>
184<TR BGCOLOR="white" CLASS="TableRowColor">
185<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
186<CODE>protected &nbsp;void</CODE></FONT></TD>
187<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/listener/MailLogger.html#log(java.lang.String)">log</A></B>(java.lang.String&nbsp;message)</CODE>
188
189<BR>
190&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Receives and buffers log messages.</TD>
191</TR>
192</TABLE>
193&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.DefaultLogger"><!-- --></A>
194<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
195<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
196<TD><B>Methods inherited from class org.apache.tools.ant.<A HREF="../../../../../org/apache/tools/ant/DefaultLogger.html" title="class in org.apache.tools.ant">DefaultLogger</A></B></TD>
197</TR>
198<TR BGCOLOR="white" CLASS="TableRowColor">
199<TD><CODE><A HREF="../../../../../org/apache/tools/ant/DefaultLogger.html#buildStarted(org.apache.tools.ant.BuildEvent)">buildStarted</A>, <A HREF="../../../../../org/apache/tools/ant/DefaultLogger.html#formatTime(long)">formatTime</A>, <A HREF="../../../../../org/apache/tools/ant/DefaultLogger.html#messageLogged(org.apache.tools.ant.BuildEvent)">messageLogged</A>, <A HREF="../../../../../org/apache/tools/ant/DefaultLogger.html#printMessage(java.lang.String, java.io.PrintStream, int)">printMessage</A>, <A HREF="../../../../../org/apache/tools/ant/DefaultLogger.html#setEmacsMode(boolean)">setEmacsMode</A>, <A HREF="../../../../../org/apache/tools/ant/DefaultLogger.html#setErrorPrintStream(java.io.PrintStream)">setErrorPrintStream</A>, <A HREF="../../../../../org/apache/tools/ant/DefaultLogger.html#setMessageOutputLevel(int)">setMessageOutputLevel</A>, <A HREF="../../../../../org/apache/tools/ant/DefaultLogger.html#setOutputPrintStream(java.io.PrintStream)">setOutputPrintStream</A>, <A HREF="../../../../../org/apache/tools/ant/DefaultLogger.html#targetFinished(org.apache.tools.ant.BuildEvent)">targetFinished</A>, <A HREF="../../../../../org/apache/tools/ant/DefaultLogger.html#targetStarted(org.apache.tools.ant.BuildEvent)">targetStarted</A>, <A HREF="../../../../../org/apache/tools/ant/DefaultLogger.html#taskFinished(org.apache.tools.ant.BuildEvent)">taskFinished</A>, <A HREF="../../../../../org/apache/tools/ant/DefaultLogger.html#taskStarted(org.apache.tools.ant.BuildEvent)">taskStarted</A></CODE></TD>
200</TR>
201</TABLE>
202&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
203<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
204<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
205<TD><B>Methods inherited from class java.lang.Object</B></TD>
206</TR>
207<TR BGCOLOR="white" CLASS="TableRowColor">
208<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
209</TR>
210</TABLE>
211&nbsp;
212<P>
213
214<!-- ============ FIELD DETAIL =========== -->
215
216
217<!-- ========= CONSTRUCTOR DETAIL ======== -->
218
219<A NAME="constructor_detail"><!-- --></A>
220<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
221<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
222<TD COLSPAN=1><FONT SIZE="+2">
223<B>Constructor Detail</B></FONT></TD>
224</TR>
225</TABLE>
226
227<A NAME="MailLogger()"><!-- --></A><H3>
228MailLogger</H3>
229<PRE>
230public <B>MailLogger</B>()</PRE>
231<DL>
232</DL>
233
234<!-- ============ METHOD DETAIL ========== -->
235
236<A NAME="method_detail"><!-- --></A>
237<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
238<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
239<TD COLSPAN=1><FONT SIZE="+2">
240<B>Method Detail</B></FONT></TD>
241</TR>
242</TABLE>
243
244<A NAME="buildFinished(org.apache.tools.ant.BuildEvent)"><!-- --></A><H3>
245buildFinished</H3>
246<PRE>
247public void <B>buildFinished</B>(<A HREF="../../../../../org/apache/tools/ant/BuildEvent.html" title="class in org.apache.tools.ant">BuildEvent</A>&nbsp;event)</PRE>
248<DL>
249<DD>Sends an e-mail with the log results.
250<P>
251<DD><DL>
252<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/tools/ant/BuildListener.html#buildFinished(org.apache.tools.ant.BuildEvent)">buildFinished</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/tools/ant/BuildListener.html" title="interface in org.apache.tools.ant">BuildListener</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/tools/ant/DefaultLogger.html#buildFinished(org.apache.tools.ant.BuildEvent)">buildFinished</A></CODE> in class <CODE><A HREF="../../../../../org/apache/tools/ant/DefaultLogger.html" title="class in org.apache.tools.ant">DefaultLogger</A></CODE></DL>
253</DD>
254<DD><DL>
255<DT><B>Parameters:</B><DD><CODE>event</CODE> - the build finished event</DL>
256</DD>
257</DL>
258<HR>
259
260<A NAME="log(java.lang.String)"><!-- --></A><H3>
261log</H3>
262<PRE>
263protected void <B>log</B>(java.lang.String&nbsp;message)</PRE>
264<DL>
265<DD>Receives and buffers log messages.
266<P>
267<DD><DL>
268<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/tools/ant/DefaultLogger.html#log(java.lang.String)">log</A></CODE> in class <CODE><A HREF="../../../../../org/apache/tools/ant/DefaultLogger.html" title="class in org.apache.tools.ant">DefaultLogger</A></CODE></DL>
269</DD>
270<DD><DL>
271<DT><B>Parameters:</B><DD><CODE>message</CODE> - the message being logger</DL>
272</DD>
273</DL>
274<!-- ========= END OF CLASS DATA ========= -->
275<HR>
276
277
278<!-- ======= START OF BOTTOM NAVBAR ====== -->
279<A NAME="navbar_bottom"><!-- --></A>
280<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
281<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
282<TR>
283<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
284<A NAME="navbar_bottom_firstrow"><!-- --></A>
285<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
286 <TR ALIGN="center" VALIGN="top">
287 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
288 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
289 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
290 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
291 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
292 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
293 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
294 </TR>
295</TABLE>
296</TD>
297<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
298</EM>
299</TD>
300</TR>
301
302<TR>
303<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
304&nbsp;<A HREF="../../../../../org/apache/tools/ant/listener/Log4jListener.html" title="class in org.apache.tools.ant.listener"><B>PREV CLASS</B></A>&nbsp;
305&nbsp;NEXT CLASS</FONT></TD>
306<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
307 <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
308&nbsp;<A HREF="MailLogger.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
309&nbsp;<SCRIPT type="text/javascript">
310 <!--
311 if(window==top) {
312 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
313 }
314 //-->
315</SCRIPT>
316<NOSCRIPT>
317 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
318</NOSCRIPT>
319
320</FONT></TD>
321</TR>
322<TR>
323<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
324 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_org.apache.tools.ant.DefaultLogger">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
325<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
326DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
327</TR>
328</TABLE>
329<A NAME="skip-navbar_bottom"></A>
330<!-- ======== END OF BOTTOM NAVBAR ======= -->
331
332<HR>
333Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
334</BODY>
335</HTML>
Note: See TracBrowser for help on using the repository browser.