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

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

initial import of LiRK3
File size: 12.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:35 NZST 2007 -->
6<TITLE>
7SmtpResponseReader (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.mail.SmtpResponseReader 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="SmtpResponseReader (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/mail/MailMessage.html" title="class in org.apache.tools.mail"><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="SmtpResponseReader.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="#field_summary">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;<A HREF="#field_detail">FIELD</A>&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.mail</FONT>
85<BR>
86Class SmtpResponseReader</H2>
87<PRE>
88java.lang.Object
89 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.mail.SmtpResponseReader</B>
90</PRE>
91<HR>
92<DL>
93<DT>public class <B>SmtpResponseReader</B><DT>extends java.lang.Object</DL>
94
95<P>
96A wrapper around the raw input from the SMTP server that assembles
97 multi line responses into a single String.
98
99 <p>The same rules used here would apply to FTP and other Telnet
100 based protocols as well.</p>
101<P>
102
103<P>
104<HR>
105
106<P>
107<!-- ======== NESTED CLASS SUMMARY ======== -->
108
109
110<!-- =========== FIELD SUMMARY =========== -->
111
112<A NAME="field_summary"><!-- --></A>
113<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
114<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
115<TD COLSPAN=2><FONT SIZE="+2">
116<B>Field Summary</B></FONT></TD>
117</TR>
118<TR BGCOLOR="white" CLASS="TableRowColor">
119<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
120<CODE>protected &nbsp;java.io.BufferedReader</CODE></FONT></TD>
121<TD><CODE><B><A HREF="../../../../org/apache/tools/mail/SmtpResponseReader.html#reader">reader</A></B></CODE>
122
123<BR>
124&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
125</TR>
126</TABLE>
127&nbsp;
128<!-- ======== CONSTRUCTOR SUMMARY ======== -->
129
130<A NAME="constructor_summary"><!-- --></A>
131<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
132<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
133<TD COLSPAN=2><FONT SIZE="+2">
134<B>Constructor Summary</B></FONT></TD>
135</TR>
136<TR BGCOLOR="white" CLASS="TableRowColor">
137<TD><CODE><B><A HREF="../../../../org/apache/tools/mail/SmtpResponseReader.html#SmtpResponseReader(java.io.InputStream)">SmtpResponseReader</A></B>(java.io.InputStream&nbsp;in)</CODE>
138
139<BR>
140&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Wrap this input stream.</TD>
141</TR>
142</TABLE>
143&nbsp;
144<!-- ========== METHOD SUMMARY =========== -->
145
146<A NAME="method_summary"><!-- --></A>
147<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
148<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
149<TD COLSPAN=2><FONT SIZE="+2">
150<B>Method Summary</B></FONT></TD>
151</TR>
152<TR BGCOLOR="white" CLASS="TableRowColor">
153<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
154<CODE>&nbsp;void</CODE></FONT></TD>
155<TD><CODE><B><A HREF="../../../../org/apache/tools/mail/SmtpResponseReader.html#close()">close</A></B>()</CODE>
156
157<BR>
158&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Closes the underlying stream.</TD>
159</TR>
160<TR BGCOLOR="white" CLASS="TableRowColor">
161<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
162<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
163<TD><CODE><B><A HREF="../../../../org/apache/tools/mail/SmtpResponseReader.html#getResponse()">getResponse</A></B>()</CODE>
164
165<BR>
166&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Read until the server indicates that the response is complete.</TD>
167</TR>
168<TR BGCOLOR="white" CLASS="TableRowColor">
169<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
170<CODE>protected &nbsp;boolean</CODE></FONT></TD>
171<TD><CODE><B><A HREF="../../../../org/apache/tools/mail/SmtpResponseReader.html#hasMoreLines(java.lang.String)">hasMoreLines</A></B>(java.lang.String&nbsp;line)</CODE>
172
173<BR>
174&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Should we expect more input?</TD>
175</TR>
176</TABLE>
177&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
178<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
179<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
180<TD><B>Methods inherited from class java.lang.Object</B></TD>
181</TR>
182<TR BGCOLOR="white" CLASS="TableRowColor">
183<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
184</TR>
185</TABLE>
186&nbsp;
187<P>
188
189<!-- ============ FIELD DETAIL =========== -->
190
191<A NAME="field_detail"><!-- --></A>
192<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
193<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
194<TD COLSPAN=1><FONT SIZE="+2">
195<B>Field Detail</B></FONT></TD>
196</TR>
197</TABLE>
198
199<A NAME="reader"><!-- --></A><H3>
200reader</H3>
201<PRE>
202protected java.io.BufferedReader <B>reader</B></PRE>
203<DL>
204<DL>
205</DL>
206</DL>
207
208<!-- ========= CONSTRUCTOR DETAIL ======== -->
209
210<A NAME="constructor_detail"><!-- --></A>
211<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
212<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
213<TD COLSPAN=1><FONT SIZE="+2">
214<B>Constructor Detail</B></FONT></TD>
215</TR>
216</TABLE>
217
218<A NAME="SmtpResponseReader(java.io.InputStream)"><!-- --></A><H3>
219SmtpResponseReader</H3>
220<PRE>
221public <B>SmtpResponseReader</B>(java.io.InputStream&nbsp;in)</PRE>
222<DL>
223<DD>Wrap this input stream.
224<P>
225<DT><B>Parameters:</B><DD><CODE>in</CODE> - the stream to wrap.</DL>
226
227<!-- ============ METHOD DETAIL ========== -->
228
229<A NAME="method_detail"><!-- --></A>
230<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
231<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
232<TD COLSPAN=1><FONT SIZE="+2">
233<B>Method Detail</B></FONT></TD>
234</TR>
235</TABLE>
236
237<A NAME="getResponse()"><!-- --></A><H3>
238getResponse</H3>
239<PRE>
240public java.lang.String <B>getResponse</B>()
241 throws java.io.IOException</PRE>
242<DL>
243<DD>Read until the server indicates that the response is complete.
244<P>
245<DD><DL>
246
247<DT><B>Returns:</B><DD>Responsecode (3 digits) + Blank + Text from all
248 response line concatenated (with blanks replacing the \r\n
249 sequences).
250<DT><B>Throws:</B>
251<DD><CODE>java.io.IOException</CODE> - on error.</DL>
252</DD>
253</DL>
254<HR>
255
256<A NAME="close()"><!-- --></A><H3>
257close</H3>
258<PRE>
259public void <B>close</B>()
260 throws java.io.IOException</PRE>
261<DL>
262<DD>Closes the underlying stream.
263<P>
264<DD><DL>
265
266<DT><B>Throws:</B>
267<DD><CODE>java.io.IOException</CODE> - on error.</DL>
268</DD>
269</DL>
270<HR>
271
272<A NAME="hasMoreLines(java.lang.String)"><!-- --></A><H3>
273hasMoreLines</H3>
274<PRE>
275protected boolean <B>hasMoreLines</B>(java.lang.String&nbsp;line)</PRE>
276<DL>
277<DD>Should we expect more input?
278<P>
279<DD><DL>
280<DT><B>Parameters:</B><DD><CODE>line</CODE> - the line to check.
281<DT><B>Returns:</B><DD>true if there are more lines to check.</DL>
282</DD>
283</DL>
284<!-- ========= END OF CLASS DATA ========= -->
285<HR>
286
287
288<!-- ======= START OF BOTTOM NAVBAR ====== -->
289<A NAME="navbar_bottom"><!-- --></A>
290<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
291<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
292<TR>
293<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
294<A NAME="navbar_bottom_firstrow"><!-- --></A>
295<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
296 <TR ALIGN="center" VALIGN="top">
297 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
298 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
299 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
300 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
301 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
302 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
303 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
304 </TR>
305</TABLE>
306</TD>
307<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
308</EM>
309</TD>
310</TR>
311
312<TR>
313<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
314&nbsp;<A HREF="../../../../org/apache/tools/mail/MailMessage.html" title="class in org.apache.tools.mail"><B>PREV CLASS</B></A>&nbsp;
315&nbsp;NEXT CLASS</FONT></TD>
316<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
317 <A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
318&nbsp;<A HREF="SmtpResponseReader.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
319&nbsp;<SCRIPT type="text/javascript">
320 <!--
321 if(window==top) {
322 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
323 }
324 //-->
325</SCRIPT>
326<NOSCRIPT>
327 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
328</NOSCRIPT>
329
330</FONT></TD>
331</TR>
332<TR>
333<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
334 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
335<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
336DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
337</TR>
338</TABLE>
339<A NAME="skip-navbar_bottom"></A>
340<!-- ======== END OF BOTTOM NAVBAR ======= -->
341
342<HR>
343Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
344</BODY>
345</HTML>
Note: See TracBrowser for help on using the repository browser.