<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" >
<head><meta content="text/html;charset=&quot;utf-8&quot;" http-equiv="Content-type"/><link href="faldoc.css" rel="stylesheet" type="text/css"/><title> - Class SMTP</title></head><body class="faldoc"><ul class="navi_top"><li class="top"><a href="index.html">Top: Table of contents</a></li>
<li class="up"><a href="net_smtp.html">Up: Module net.smtp</a></li>
<li class="prev"><a href="net_smtp.html">Previous: Module net.smtp</a></li>
<li class="next"><a href="parser.html">Generic line-oriented parser and r...</a></li>
<li class="clear"></li>
</ul><div id="page_body"><h1><span class="toc_number">14.1</span>Class SMTP</h1><p class="brief">Simple Mail Transfer Protocol interface. </p>
<pre class="prototype">Class SMTP( server, port )</pre>
<table class="prototype">
<tbody><tr class="param"><td class="name">server</td><td class="content"> A remote server IP or DNS. </td></tr>
<tr class="param"><td class="name">port</td><td class="content"> A port name or number, defaults to 'smtp'. </td></tr>
</tbody>
</table>
<table class="members">
<tbody><tr class="member_type"><td class="member_type" colspan="2">Properties</td></tr>
<tr><td colspan="2"><a href="#authSchemes">authSchemes</a></td></tr>
<tr><td colspan="2"><a href="#heloMsg">heloMsg</a></td></tr>
<tr><td colspan="2"><a href="#port">port</a></td></tr>
<tr><td colspan="2"><a href="#server">server</a></td></tr>
<tr><td colspan="2"><a href="#timeout">timeout</a></td></tr>
<tr><td colspan="2"><a href="#trace">trace</a></td></tr>
</tbody>
<tbody><tr class="member_type"><td class="member_type" colspan="2">Methods</td></tr>
<tr><td><a href="#auth">auth</a></td><td>Set authentication parameters. </td></tr>
<tr><td colspan="2"><a href="#connect">connect</a></td></tr>
<tr><td colspan="2"><a href="#data">data</a></td></tr>
<tr><td colspan="2"><a href="#extractMail">extractMail</a></td></tr>
<tr><td colspan="2"><a href="#helo">helo</a></td></tr>
<tr><td colspan="2"><a href="#mailFrom">mailFrom</a></td></tr>
<tr><td colspan="2"><a href="#quit">quit</a></td></tr>
<tr><td colspan="2"><a href="#rcpt">rcpt</a></td></tr>
<tr><td><a href="#send">send</a></td><td>Send a MIME part. </td></tr>
<tr><td><a href="#sendTo">sendTo</a></td><td>Send a mail data to a remote SMTP server. </td></tr>
</tbody>
</table>
<h2>Properties</h2><h3><a name="authSchemes">authSchemes</a></h3><h3><a name="heloMsg">heloMsg</a></h3><h3><a name="port">port</a></h3><h3><a name="server">server</a></h3><h3><a name="timeout">timeout</a></h3><h3><a name="trace">trace</a></h3><h2>Methods</h2><h3><a name="auth">auth</a></h3><p class="brief">Set authentication parameters. </p>
<pre class="prototype">auth( scheme, ... )</pre>
<table class="prototype">
<tbody><tr class="param"><td class="name">scheme</td><td class="content"> The authentication scheme to be used. </td></tr>
<tr class="param"><td class="name">...</td><td class="content"> Authentication data (usually, a pair of userid, password parameters). </td></tr>
<tr class="return"><td class="name">Return</td><td class="content">self </td></tr>
</tbody>
</table>
<p>Available schemes are: <ul><li>"PLAIN" </li></ul></p>
<h3><a name="connect">connect</a></h3><pre class="prototype">connect()</pre>
<h3><a name="data">data</a></h3><pre class="prototype">data( content )</pre>
<table class="prototype">
<tbody></tbody>
</table>
<h3><a name="extractMail">extractMail</a></h3><pre class="prototype">extractMail( field )</pre>
<table class="prototype">
<tbody></tbody>
</table>
<h3><a name="helo">helo</a></h3><pre class="prototype">helo()</pre>
<h3><a name="mailFrom">mailFrom</a></h3><pre class="prototype">mailFrom( sender )</pre>
<table class="prototype">
<tbody></tbody>
</table>
<h3><a name="quit">quit</a></h3><pre class="prototype">quit()</pre>
<h3><a name="rcpt">rcpt</a></h3><pre class="prototype">rcpt( target )</pre>
<table class="prototype">
<tbody></tbody>
</table>
<h3><a name="send">send</a></h3><p class="brief">Send a MIME part. </p>
<pre class="prototype">send( part )</pre>
<table class="prototype">
<tbody><tr class="param"><td class="name">part</td><td class="content"> A <b>mime.Part</b> instance. </td></tr>
<tr class="raise"><td class="name">Raise</td><td class="content"><table>
<tbody><tr><td class="name"><b>CodeError</b></td><td class="content"> if the contents of From or To fields are invalid </td></tr>
</tbody>
</table>
</td></tr>
</tbody>
</table>
<p>Sends a mail to the described recipients. The part must include the From and To headers. </p>
<p>If the Date header is not included, it will be added and set to the current date and date. </p>
<p class="see_also">See also: <b>mime</b>.</p>
<h3><a name="sendTo">sendTo</a></h3><p class="brief">Send a mail data to a remote SMTP server. </p>
<pre class="prototype">sendTo( sender, rcpt, data )</pre>
<table class="prototype">
<tbody><tr class="param"><td class="name">sender</td><td class="content"> The sender of the mail. </td></tr>
<tr class="param"><td class="name">rcpt</td><td class="content"> Single or multiple mail target recipients. </td></tr>
<tr class="param"><td class="name">data</td><td class="content"> A string containing the mail content, properly encoded. </td></tr>
</tbody>
</table>
</div><ul class="navi_bottom"><li class="top"><a href="index.html">Top: Table of contents</a></li>
<li class="up"><a href="net_smtp.html">Up: Module net.smtp</a></li>
<li class="prev"><a href="net_smtp.html">Previous: Module net.smtp</a></li>
<li class="next"><a href="parser.html">Generic line-oriented parser and r...</a></li>
<li class="clear"></li>
</ul><div class="signature">Made with <a href="faldoc 3.0">http://www.falconpl.org</a></div></body></html>
