diff options
| author | R David Murray <rdmurray@bitdance.com> | 2015-05-16 14:16:33 -0400 |
|---|---|---|
| committer | R David Murray <rdmurray@bitdance.com> | 2015-05-16 14:16:33 -0400 |
| commit | 311376588388647477db55092b61c1c61ecd3f85 (patch) | |
| tree | 944cf8e6af5c54f5f4fb95c6cd65009b40b2c3ba /Doc/library/smtpd.rst | |
| parent | cee7cf60263210ca34f8221fc7dabd360c825533 (diff) | |
| download | cpython-git-311376588388647477db55092b61c1c61ecd3f85.tar.gz | |
#19662: Make requirement to support arbitrary keywords explicit.
When not using decode_data=True, smtpd may provide keyword arguments to the
process_message user-implemented method. This doc update is intended to make
it clear that arbitrary keywords must be supported, so that we can add
additional features in the future by just adding keywords to the
process_message call.
Diffstat (limited to 'Doc/library/smtpd.rst')
| -rw-r--r-- | Doc/library/smtpd.rst | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/Doc/library/smtpd.rst b/Doc/library/smtpd.rst index 575dcec994..2682ee0c57 100644 --- a/Doc/library/smtpd.rst +++ b/Doc/library/smtpd.rst @@ -89,6 +89,10 @@ SMTPServer Objects Currently no ``RCPT TO`` options are supported, so for now this will always be an empty list. + Implementations of ``process_message`` should use the ``**kwargs`` + signature to accept arbitrary keword arguments, since future feature + enhancements may add keys to the kwargs dictionary. + Return ``None`` to request a normal ``250 Ok`` response; otherwise return the desired response string in :RFC:`5321` format. |