Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code | Sign in
(3)

Side by Side Diff: Doc/library/smtpd.rst

Issue 18758: Fix internal references in the documentation
Patch Set: Created 6 years, 5 months ago
Left:
Right:
Use n/p to move between diff chunks; N/P to move between comments. Please Sign in to add in-line comments.
Jump to:
View unified diff | Download patch
« no previous file with comments | « Doc/library/shelve.rst ('k') | Doc/library/socket.rst » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 :mod:`smtpd` --- SMTP Server 1 :mod:`smtpd` --- SMTP Server
2 ============================ 2 ============================
3 3
4 .. module:: smtpd 4 .. module:: smtpd
5 :synopsis: A SMTP server implementation in Python. 5 :synopsis: A SMTP server implementation in Python.
6 6
7 .. moduleauthor:: Barry Warsaw <barry@zope.com> 7 .. moduleauthor:: Barry Warsaw <barry@zope.com>
8 .. sectionauthor:: Moshe Zadka <moshez@moshez.org> 8 .. sectionauthor:: Moshe Zadka <moshez@moshez.org>
9 9
10 **Source code:** :source:`Lib/smtpd.py` 10 **Source code:** :source:`Lib/smtpd.py`
11 11
12 -------------- 12 --------------
13 13
14 This module offers several classes to implement SMTP (email) servers. 14 This module offers several classes to implement SMTP (email) servers.
15 15
16 Several server implementations are present; one is a generic 16 Several server implementations are present; one is a generic
17 do-nothing implementation, which can be overridden, while the other two offer 17 do-nothing implementation, which can be overridden, while the other two offer
18 specific mail-sending strategies. 18 specific mail-sending strategies.
19 19
20 Additionally the SMTPChannel may be extended to implement very specific 20 Additionally the SMTPChannel may be extended to implement very specific
21 interaction behaviour with SMTP clients. 21 interaction behaviour with SMTP clients.
22 22
23 The code supports :RFC:`5321`, plus the :rfc:`1870` SIZE extension. 23 The code supports :RFC:`5321`, plus the :rfc:`1870` SIZE extension.
24 24
25 25
26 SMTPServer Objects 26 SMTPServer Objects
27 ------------------ 27 ------------------
28 28
29 29
30 .. class:: SMTPServer(localaddr, remoteaddr, data_size_limit=33554432, 30 .. class:: SMTPServer(localaddr, remoteaddr, data_size_limit=33554432,\
31 map=None) 31 map=None)
32 32
33 Create a new :class:`SMTPServer` object, which binds to local address 33 Create a new :class:`SMTPServer` object, which binds to local address
34 *localaddr*. It will treat *remoteaddr* as an upstream SMTP relayer. It 34 *localaddr*. It will treat *remoteaddr* as an upstream SMTP relayer. It
35 inherits from :class:`asyncore.dispatcher`, and so will insert itself into 35 inherits from :class:`asyncore.dispatcher`, and so will insert itself into
36 :mod:`asyncore`'s event loop on instantiation. 36 :mod:`asyncore`'s event loop on instantiation.
37 37
38 *data_size_limit* specifies the maximum number of bytes that will be 38 *data_size_limit* specifies the maximum number of bytes that will be
39 accepted in a ``DATA`` command. A value of ``None`` or ``0`` means no 39 accepted in a ``DATA`` command. A value of ``None`` or ``0`` means no
40 limit. 40 limit.
(...skipping 48 matching lines...) Expand 10 before | Expand all | Expand 10 after
89 89
90 Create a new pure proxy server. Arguments are as per :class:`SMTPServer`. 90 Create a new pure proxy server. Arguments are as per :class:`SMTPServer`.
91 Everything will be relayed to *remoteaddr*, unless local mailman configuratio ns 91 Everything will be relayed to *remoteaddr*, unless local mailman configuratio ns
92 knows about an address, in which case it will be handled via mailman. Note t hat 92 knows about an address, in which case it will be handled via mailman. Note t hat
93 running this has a good chance to make you into an open relay, so please be 93 running this has a good chance to make you into an open relay, so please be
94 careful. 94 careful.
95 95
96 SMTPChannel Objects 96 SMTPChannel Objects
97 ------------------- 97 -------------------
98 98
99 .. class:: SMTPChannel(server, conn, addr, data_size_limit=33554432, 99 .. class:: SMTPChannel(server, conn, addr, data_size_limit=33554432,\
100 map=None)) 100 map=None))
101 101
102 Create a new :class:`SMTPChannel` object which manages the communication 102 Create a new :class:`SMTPChannel` object which manages the communication
103 between the server and a single SMTP client. 103 between the server and a single SMTP client.
104 104
105 *conn* and *addr* are as per the instance variables described below. 105 *conn* and *addr* are as per the instance variables described below.
106 106
107 *data_size_limit* specifies the maximum number of bytes that will be 107 *data_size_limit* specifies the maximum number of bytes that will be
108 accepted in a ``DATA`` command. A value of ``None`` or ``0`` means no 108 accepted in a ``DATA`` command. A value of ``None`` or ``0`` means no
109 limit. 109 limit.
(...skipping 81 matching lines...) Expand 10 before | Expand all | Expand 10 after
191 the :attr:`rcpttos` list. 191 the :attr:`rcpttos` list.
192 RSET Resets the :attr:`mailfrom`, :attr:`rcpttos`, and 192 RSET Resets the :attr:`mailfrom`, :attr:`rcpttos`, and
193 :attr:`received_data`, but not the greeting. 193 :attr:`received_data`, but not the greeting.
194 DATA Sets the internal state to :attr:`DATA` and stores remaining lines 194 DATA Sets the internal state to :attr:`DATA` and stores remaining lines
195 from the client in :attr:`received_data` until the terminator 195 from the client in :attr:`received_data` until the terminator
196 ``"\r\n.\r\n"`` is received. 196 ``"\r\n.\r\n"`` is received.
197 HELP Returns minimal information on command syntax 197 HELP Returns minimal information on command syntax
198 VRFY Returns code 252 (the server doesn't know if the address is valid) 198 VRFY Returns code 252 (the server doesn't know if the address is valid)
199 EXPN Reports that the command is not implemented. 199 EXPN Reports that the command is not implemented.
200 ======== =================================================================== 200 ======== ===================================================================
OLDNEW
« no previous file with comments | « Doc/library/shelve.rst ('k') | Doc/library/socket.rst » ('j') | no next file with comments »

RSS Feeds Recent Issues | This issue
This is Rietveld 894c83f36cb7+