[Python-checkins] python/dist/src/Doc/lib libsmtpd.tex, NONE, 1.1 lib.tex, 1.227, 1.228

[fdrake at users.sourceforge.net]

Update of /cvsroot/python/python/dist/src/Doc/lib
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv15563/lib

Modified Files:
	lib.tex 
Added Files:
	libsmtpd.tex 
Log Message:
Added documentation for the "smtpd" module.
Closes SF bug #450803.


--- NEW FILE: libsmtpd.tex ---
\section{\module{smtpd} ---
         SMTP Server}

\declaremodule{standard}{smtpd}

\moduleauthor{Barry Warsaw}{barry at zope.com}
\sectionauthor{Moshe Zadka}{moshez at moshez.org}

\modulesynopsis{Implement a flexible SMTP server}

This module offers several classes to implement SMTP servers.  One is
a generic do-nothing implementation, which can be overridden, while
the other two offer specific mail-sending strategies.


\subsection{SMTPServer Objects}

\begin{classdesc}{SMTPServer}{localaddr, remoteaddr}
Create a new \class{SMTPServer} object, which binds to local address
\var{localaddr}.  It will treat \var{remoteaddr} as an upstream SMTP
relayer.  It inherits from \class{asyncore.dispatcher}, and so will
insert itself into \refmodule{asyncore}'s event loop on instantiation.
\end{classdesc}

\begin{methoddesc}[SMTPServer]{process_message}{peer, mailfrom, rcpttos, data}
Raise \exception{NotImplementedError} exception. Override this in
subclasses to do something useful with this message. Whatever was
passed in the constructor as \var{remoteaddr} will be available as the
\member{_remoteaddr} attribute. \var{peer} is the remote host's address,
\var{mailfrom} is the envelope originator, \var{rcpttos} are the
envelope recipients and \var{data} is a string containing the contents
of the e-mail (which should be in \rfc{2822} format).
\end{methoddesc}


\subsection{DebuggingServer Objects}

\begin{classdesc}{DebuggingServer}{localaddr, remoteaddr}
Create a new debugging server.  Arguments are as per
\class{SMTPServer}.  Messages will be discarded, and printed on
stdout.
\end{classdesc}


\subsection{PureProxy Objects}

\begin{classdesc}{PureProxy}{localaddr, remoteaddr}
Create a new pure proxy server. Arguments are as per \class{SMTPServer}.
Everything will be relayed to \var{remoteaddr}.  Note that running
this has a good chance to make you into an open relay, so please be
careful.
\end{classdesc}


\subsection{MailmanProxy Objects}

\begin{classdesc}{MailmanProxy}{localaddr, remoteaddr}
Create a new pure proxy server. Arguments are as per
\class{SMTPServer}.  Everything will be relayed to \var{remoteaddr},
unless local mailman configurations knows about an address, in which
case it will be handled via mailman.  Note that running this has a
good chance to make you into an open relay, so please be careful.
\end{classdesc}

Index: lib.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/lib.tex,v
retrieving revision 1.227
retrieving revision 1.228
diff -C2 -d -r1.227 -r1.228
*** lib.tex	5 Jul 2004 05:52:03 -0000	1.227
--- lib.tex	11 Jul 2004 16:25:25 -0000	1.228
***************
*** 229,232 ****
--- 229,233 ----
  \input{libnntplib}
  \input{libsmtplib}
+ \input{libsmtpd}
  \input{libtelnetlib}
  \input{liburlparse}