434 lines
12 KiB
HTML
434 lines
12 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
|
<!--NewPage-->
|
|
<HTML>
|
|
<HEAD>
|
|
<TITLE>
|
|
jala.Test.SmtpServer
|
|
</TITLE>
|
|
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
|
</HEAD>
|
|
<SCRIPT>
|
|
function asd()
|
|
{
|
|
parent.document.title="jala.Test.SmtpServer";
|
|
}
|
|
</SCRIPT>
|
|
<BODY BGCOLOR="white" onload="asd();">
|
|
|
|
<!-- ========== START OF NAVBAR ========== -->
|
|
<A NAME="navbar_bottom"><!-- --></A>
|
|
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
|
|
<TR>
|
|
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
|
<A NAME="navbar_bottom_firstrow"><!-- --></A>
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
|
|
<TR ALIGN="center" VALIGN="top">
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-summary-Global_jala.Test.js.html"><FONT CLASS="NavBarFont1"><B>File</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
|
<!--TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"--> <!--A HREF="deprecated-list.html"--><!--FONT CLASS="NavBarFont1">Deprecated</FONT--><!--/A--><!-- </TD-->
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="index-all.html"--><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
|
</TR>
|
|
</TABLE>
|
|
</TD>
|
|
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
<B>Jala Test</B>
|
|
</EM>
|
|
</TD
|
|
</TR>
|
|
|
|
<TR>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="jala.Test.HttpClient.html"><B>PREV CLASS</B></A><!--
|
|
NEXT CLASS
|
|
-->
|
|
<A HREF="jala.Test.SmtpServer.Message.html"><B>NEXT CLASS</B></A></FONT></TD>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="index.html" TARGET="_top"><B>FRAMES</B></A>
|
|
<A HREF="jala.Test.SmtpServer.html" TARGET="_top"><B>NO FRAMES</B></A>
|
|
|
|
<SCRIPT>
|
|
<!--
|
|
if(window==top) {
|
|
document.writeln('<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
|
|
}
|
|
//-->
|
|
</SCRIPT>
|
|
<NOSCRIPT>
|
|
<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
|
|
</NOSCRIPT>
|
|
</FONT></TD>
|
|
</TR>
|
|
<TR>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
SUMMARY: <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
<!-- =========== END OF NAVBAR =========== -->
|
|
<HR>
|
|
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<H2>Class jala.Test.SmtpServer</H2>
|
|
<PRE>Object
|
|
|
|
|
+--<b>jala.Test.SmtpServer</b>
|
|
</PRE>
|
|
|
|
|
|
<HR>
|
|
<DL>
|
|
<!-- Class definition -->
|
|
<DT>class
|
|
<B>jala.Test.SmtpServer</B>
|
|
|
|
|
|
</DL>
|
|
|
|
<P>
|
|
<BR/>Instances of this class represent an SMTP server listening on
|
|
localhost. By default jala.Test will create a global variable called
|
|
"smtpServer" that contains an instance of this class. To use the server call
|
|
<a href="#start">start()</a> in a test method (eg. in the basic setup method) and
|
|
<a href="#stop">stop()</a> in the cleanup method.
|
|
<BR/><I>Defined in <a href='overview-summary-Global_jala.Test.js.html'>Global/jala.Test.js</a></I><BR/><BR/>
|
|
</P>
|
|
|
|
<HR>
|
|
|
|
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
|
|
|
<A NAME="inner_classes"><!-- --></A>
|
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TD COLSPAN=2><FONT SIZE="+2">
|
|
<B>Nested Class Summary</B></FONT></TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE><static class></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="jala.Test.SmtpServer.Message.html">jala.Test.SmtpServer.Message</A></B></CODE></TD>
|
|
</TR>
|
|
|
|
</TABLE>
|
|
|
|
|
|
<!-- ======== END NESTED CLASS SUMMARY ======== -->
|
|
|
|
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
|
|
|
|
|
|
|
|
|
<!-- =========== END FIELD SUMMARY =========== -->
|
|
|
|
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
|
|
<A NAME="constructor_summary"><!-- --></A>
|
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TD COLSPAN=2><FONT SIZE="+2">
|
|
<B>Constructor Summary</B></FONT></TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="jala.Test.SmtpServer.html#jala.Test.SmtpServer()">jala.Test.SmtpServer</A>
|
|
</B>
|
|
(<Number> port)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Creates a new SmtpServer instance
|
|
</TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<!-- ======== END CONSTRUCTOR SUMMARY ======== -->
|
|
|
|
|
|
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
|
|
<A NAME="method_summary"><!-- --></A>
|
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TD COLSPAN=2><FONT SIZE="+2">
|
|
<B>Method Summary</B></FONT></TD>
|
|
</TR>
|
|
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> Array</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#getMessages">getMessages</A></B>()
|
|
</CODE>
|
|
<BR>
|
|
|
|
Returns an array containing all mails received by the server,
|
|
where each one is an instance of <a href="jala.Test.SmtpServer.Message.html#">jala.Test.SmtpServer.Message</a>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#start">start</A></B>()
|
|
</CODE>
|
|
<BR>
|
|
|
|
Starts the SMTP server.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#stop">stop</A></B>()
|
|
</CODE>
|
|
<BR>
|
|
|
|
Stops the SMTP server and switches the "smtp" property of the tested
|
|
application back to the value defined in app or server.properties
|
|
</TD>
|
|
</TR>
|
|
|
|
|
|
</TABLE>
|
|
|
|
|
|
|
|
<P>
|
|
<!-- ========== END METHOD SUMMARY =========== -->
|
|
|
|
|
|
<!-- ============ FIELD DETAIL START =========== -->
|
|
|
|
|
|
<!-- ============ FIELD DETAIL END =========== -->
|
|
|
|
<!-- ========= CONSTRUCTOR DETAIL START ======== -->
|
|
|
|
<A NAME="constructor_detail"><!-- --></A>
|
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TD COLSPAN=1>
|
|
<FONT SIZE="+2"><B>Constructor Detail</B></FONT>
|
|
</TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<A NAME="jala.Test.SmtpServer()"><!-- --></A><H3>
|
|
jala.Test.SmtpServer</H3>
|
|
<PRE><B>jala.Test.SmtpServer</B>(<Number> port)</PRE>
|
|
|
|
|
|
<UL>
|
|
Creates a new SmtpServer instance
|
|
</UL>
|
|
|
|
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>port</CODE> - Optional port to listen on (defaults to 25)
|
|
</UL>
|
|
|
|
|
|
</UL>
|
|
|
|
|
|
<!-- Constructor return value(s) -->
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
A newly created SmtpServer instance
|
|
</UL>
|
|
</UL>
|
|
|
|
<!-- End constructor return value(s) -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES -->
|
|
|
|
<HR/>
|
|
<!-- END ADDITIONAL ATTRIBUTES -->
|
|
|
|
<!-- ========= CONSTRUCTOR DETAIL END ======== -->
|
|
|
|
|
|
<!-- ============ METHOD DETAIL START ========== -->
|
|
|
|
<A NAME="method_detail"><!-- --></A>
|
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TD COLSPAN=1><FONT SIZE="+2">
|
|
<B>Method Detail</B></FONT>
|
|
</TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<!-- One single method detail entry -->
|
|
|
|
<A NAME="getMessages"><!-- --></A>
|
|
<H3>getMessages</H3>
|
|
<PRE>Array <B>getMessages</B>()</PRE>
|
|
|
|
<UL>Returns an array containing all mails received by the server,
|
|
where each one is an instance of <a href="jala.Test.SmtpServer.Message.html#">jala.Test.SmtpServer.Message</a></UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
An array with all messages
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="start"><!-- --></A>
|
|
<H3>start</H3>
|
|
<PRE>void <B>start</B>()</PRE>
|
|
|
|
<UL>Starts the SMTP server. Note that this method switches the SMTP server as
|
|
defined in app.properties of the tested application or server.properties
|
|
to "localhost" to ensure that all mails sent during tests are received
|
|
by this server. The SMTP server definition is switched back to the
|
|
original when <a href="#stop">stop()</a> is called.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="stop"><!-- --></A>
|
|
<H3>stop</H3>
|
|
<PRE>void <B>stop</B>()</PRE>
|
|
|
|
<UL>Stops the SMTP server and switches the "smtp" property of the tested
|
|
application back to the value defined in app or server.properties</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
|
|
|
|
<!-- ============ METHOD DETAIL END ========== -->
|
|
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
|
|
<!-- ========== START OF NAVBAR ========== -->
|
|
<A NAME="navbar_bottom"><!-- --></A>
|
|
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
|
|
<TR>
|
|
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
|
<A NAME="navbar_bottom_firstrow"><!-- --></A>
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
|
|
<TR ALIGN="center" VALIGN="top">
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-summary-Global_jala.Test.js.html"><FONT CLASS="NavBarFont1"><B>File</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-tree.html"><FONT CLASS="NavBarFont1"><b>Tree</b></FONT></A> </TD>
|
|
<!--TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"--> <!--A HREF="deprecated-list.html"--><!--FONT CLASS="NavBarFont1">Deprecated</FONT--><!--/A--><!-- </TD-->
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
|
</TR>
|
|
</TABLE>
|
|
</TD>
|
|
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
<B>Jala Test</B>
|
|
</EM>
|
|
</TD
|
|
</TR>
|
|
|
|
<TR>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="jala.Test.HttpClient.html"><B>PREV CLASS</B></A><!--
|
|
NEXT CLASS
|
|
-->
|
|
<A HREF="jala.Test.SmtpServer.Message.html"><B>NEXT CLASS</B></A></FONT></TD>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="index.html" TARGET="_top"><B>FRAMES</B></A>
|
|
<A HREF="jala.Test.SmtpServer.html" TARGET="_top"><B>NO FRAMES</B></A>
|
|
|
|
<SCRIPT>
|
|
<!--
|
|
if(window==top) {
|
|
document.writeln('<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
|
|
}
|
|
//-->
|
|
</SCRIPT>
|
|
<NOSCRIPT>
|
|
<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
|
|
</NOSCRIPT>
|
|
</FONT></TD>
|
|
</TR>
|
|
<TR>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
SUMMARY: <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<!-- =========== END OF NAVBAR =========== -->
|
|
|
|
<HR>
|
|
<FONT SIZE="-1">
|
|
|
|
</FONT>
|
|
<div class="jsdoc_ctime">Documentation generated by <a href="http://jsdoc.sourceforge.net/" target="_parent">JSDoc</a> on Tue Jan 8 15:50:17 2008</div>
|
|
</BODY>
|
|
</HTML>
|