mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-26 10:19:53 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

Lots of explicit class names for method and member descs.

Browse source
This commit is contained in:
Georg Brandl 2007-04-01 22:39:10 +00:00
parent b8e8df2e63
commit ae91afdcfb
42 changed files with 489 additions and 489 deletions
Download patch file Download diff file Expand all files Collapse all files

24
Doc/lib/libsmtplib.tex
View file

@ -126,13 +126,13 @@ A nice selection of exceptions is defined as well:
An \class{SMTP} instance has the following methods:
\begin{methoddesc}{set_debuglevel}{level}
\begin{methoddesc}[SMTP]{set_debuglevel}{level}
Set the debug output level. A true value for \var{level} results in
debug messages for connection and for all messages sent to and
received from the server.
\end{methoddesc}
\begin{methoddesc}{connect}{\optional{host\optional{, port}}}
\begin{methoddesc}[SMTP]{connect}{\optional{host\optional{, port}}}
Connect to a host on a given port. The defaults are to connect to the
local host at the standard SMTP port (25).
If the hostname ends with a colon (\character{:}) followed by a
@ -142,7 +142,7 @@ This method is automatically invoked by the constructor if a
host is specified during instantiation.
\end{methoddesc}
\begin{methoddesc}{docmd}{cmd, \optional{, argstring}}
\begin{methoddesc}[SMTP]{docmd}{cmd, \optional{, argstring}}
Send a command \var{cmd} to the server. The optional argument
\var{argstring} is simply concatenated to the command, separated by a
space.
@ -159,7 +159,7 @@ If the connection to the server is lost while waiting for the reply,
\exception{SMTPServerDisconnected} will be raised.
\end{methoddesc}
\begin{methoddesc}{helo}{\optional{hostname}}
\begin{methoddesc}[SMTP]{helo}{\optional{hostname}}
Identify yourself to the SMTP server using \samp{HELO}. The hostname
argument defaults to the fully qualified domain name of the local
host.
@ -169,7 +169,7 @@ explicitly. It will be implicitly called by the \method{sendmail()}
when necessary.
\end{methoddesc}
\begin{methoddesc}{ehlo}{\optional{hostname}}
\begin{methoddesc}[SMTP]{ehlo}{\optional{hostname}}
Identify yourself to an ESMTP server using \samp{EHLO}. The hostname
argument defaults to the fully qualified domain name of the local
host. Examine the response for ESMTP option and store them for use by
@ -180,13 +180,13 @@ mail, it should not be necessary to call this method explicitly. It
will be implicitly called by \method{sendmail()} when necessary.
\end{methoddesc}
\begin{methoddesc}{has_extn}{name}
\begin{methoddesc}[SMTP]{has_extn}{name}
Return \constant{True} if \var{name} is in the set of SMTP service
extensions returned by the server, \constant{False} otherwise.
Case is ignored.
\end{methoddesc}
\begin{methoddesc}{verify}{address}
\begin{methoddesc}[SMTP]{verify}{address}
Check the validity of an address on this server using SMTP \samp{VRFY}.
Returns a tuple consisting of code 250 and a full \rfc{822} address
(including human name) if the user address is valid. Otherwise returns
@ -195,7 +195,7 @@ an SMTP error code of 400 or greater and an error string.
\note{Many sites disable SMTP \samp{VRFY} in order to foil spammers.}
\end{methoddesc}
\begin{methoddesc}{login}{user, password}
\begin{methoddesc}[SMTP]{login}{user, password}
Log in on an SMTP server that requires authentication.
The arguments are the username and the password to authenticate with.
If there has been no previous \samp{EHLO} or \samp{HELO} command this
@ -213,7 +213,7 @@ or may raise the following exceptions:
\end{description}
\end{methoddesc}
\begin{methoddesc}{starttls}{\optional{keyfile\optional{, certfile}}}
\begin{methoddesc}[SMTP]{starttls}{\optional{keyfile\optional{, certfile}}}
Put the SMTP connection in TLS (Transport Layer Security) mode. All
SMTP commands that follow will be encrypted. You should then call
\method{ehlo()} again.
@ -222,8 +222,8 @@ If \var{keyfile} and \var{certfile} are provided, these are passed to
the \refmodule{socket} module's \function{ssl()} function.
\end{methoddesc}
\begin{methoddesc}{sendmail}{from_addr, to_addrs, msg\optional{,
mail_options, rcpt_options}}
\begin{methoddesc}[SMTP]{sendmail}{from_addr, to_addrs, msg\optional{,
mail_options, rcpt_options}}
Send mail. The required arguments are an \rfc{822} from-address
string, a list of \rfc{822} to-address strings (a bare string will be
treated as a list with 1 address), and a message string. The caller
@ -279,7 +279,7 @@ an exception is raised.
\end{methoddesc}
\begin{methoddesc}{quit}{}
\begin{methoddesc}[SMTP]{quit}{}
Terminate the SMTP session and close the connection.
\end{methoddesc}