twisted.protocols.smtp.IMessageDelivery.html [plain text]
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>twisted.protocols.smtp.IMessageDelivery</title>
<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="twisted.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<font size="-1"><b class="breadcrumbs">
<a href="twisted.html">Package twisted</a> ::
<a href="twisted.protocols.html">Package protocols</a> ::
<a href="twisted.protocols.smtp.html">Module smtp</a> ::
Class IMessageDelivery
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="twisted.protocols.smtp.IMessageDelivery.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class IMessageDelivery</h2>
<pre class="base-tree">
<a href="twisted.python.components.Interface.html"><code>Interface</code></a> --+
|
<b>IMessageDelivery</b>
</pre><br />
<hr/>
<!-- =========== START OF METHOD SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Method Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>str</code>
</font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.smtp.IMessageDelivery.html#receivedHeader" class="summary-sig-name"><code>receivedHeader</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>helo</span>,
<span class=summary-sig-arg>origin</span>,
<span class=summary-sig-arg>recipients</span>)</span></code>
<br />
Generate the Received header for a message</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>Deferred</code> or <code>Address</code>
</font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.smtp.IMessageDelivery.html#validateFrom" class="summary-sig-name"><code>validateFrom</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>helo</span>,
<span class=summary-sig-arg>origin</span>)</span></code>
<br />
Validate the address from which the message originates.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> no-argument callable
</font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.smtp.IMessageDelivery.html#validateTo" class="summary-sig-name"><code>validateTo</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>user</span>)</span></code>
<br />
Validate the address for which the message is destined.</td></tr>
</table><br />
<!-- =========== START OF METHOD DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Method Details</th></tr>
</table>
<a name="receivedHeader"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">receivedHeader</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>helo</span>,
<span class=sig-arg>origin</span>,
<span class=sig-arg>recipients</span>)</span>
</h3>
Generate the Received header for a message
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>helo</b></code> -
The argument to the HELO command and the client's IP
address.
<br /><i>
(type=<code>(str, str)</code>)</i>
<dd><code><b>origin</b></code> -
The address the message is from
<br /><i>
(type=<code>Address</code>)</i>
<dd><code><b>recipients</b></code> -
A list of the addresses for which this message is bound.
<br /><i>
(type=<code>list</code> of <code>str</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
The full "Received" header string.
<br /><i>
(type=<code>str</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="validateFrom"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">validateFrom</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>helo</span>,
<span class=sig-arg>origin</span>)</span>
</h3>
Validate the address from which the message originates.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>helo</b></code> -
The argument to the HELO command and the client's IP
address.
<br /><i>
(type=<code>(str, str)</code>)</i>
<dd><code><b>origin</b></code> -
The address the message is from
<br /><i>
(type=<code>Address</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
<code>origin</code> or a <code>Deferred</code> whose callback
will be passed <code>origin</code>.
<br /><i>
(type=<code>Deferred</code> or <code>Address</code>)</i>
</dd>
</dl>
<dl><dt><b>Raises:</b></dt>
<dd><code><b>SMTPBadSender</b></code> -
Raised of messages from this address are not to be
accepted.
</dl>
</dd></dl>
</td></tr></table>
<a name="validateTo"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">validateTo</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>user</span>)</span>
</h3>
Validate the address for which the message is destined.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>user</b></code> -
The address to validate.
<br /><i>
(type=<code>User</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
A <code>Deferred</code> which becomes, or a callable which
takes no arguments and returns an object implementing
<code>IMessage</code>. This will be called and the returned
object used to deliver the message when it arrives.
<br /><i>
(type=no-argument callable)</i>
</dd>
</dl>
<dl><dt><b>Raises:</b></dt>
<dd><code><b>SMTPBadRcpt</b></code> -
Raised if messages to the address are not to be accepted.
</dl>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="twisted.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left"><font size="-2">Generated by Epydoc 2.0 on Sat May 15 20:08:18 2004</font></td>
<td align="right"><a href="http://epydoc.sourceforge.net"
><font size="-2">http://epydoc.sf.net</font></a></td>
</tr>
</table>
</body>
</html>