diff options
| author | R. David Murray <rdmurray@bitdance.com> | 2010-12-02 21:47:19 (GMT) |
|---|---|---|
| committer | R. David Murray <rdmurray@bitdance.com> | 2010-12-02 21:47:19 (GMT) |
| commit | a0b44b5adb05e96e68297adcba39985b8f4dee61 (patch) | |
| tree | 1015b86932a3a58250e2833d8fec977671eddf04 /Doc | |
| parent | 52173d4959a1c1e961efab2522e4ba8a22a3c7c6 (diff) | |
| download | cpython-a0b44b5adb05e96e68297adcba39985b8f4dee61.zip cpython-a0b44b5adb05e96e68297adcba39985b8f4dee61.tar.gz cpython-a0b44b5adb05e96e68297adcba39985b8f4dee61.tar.bz2 | |
#8989: add 'domain' keyword to make_msgid.
Patch by Adrian von Bidder.
Diffstat (limited to 'Doc')
| -rw-r--r-- | Doc/library/email.util.rst | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/Doc/library/email.util.rst b/Doc/library/email.util.rst index a1ce301..f7b777a 100644 --- a/Doc/library/email.util.rst +++ b/Doc/library/email.util.rst @@ -105,11 +105,17 @@ There are several useful utilities provided in the :mod:`email.utils` module: ``False``. The default is ``False``. -.. function:: make_msgid(idstring=None) +.. function:: make_msgid(idstring=None, domain=None) Returns a string suitable for an :rfc:`2822`\ -compliant :mailheader:`Message-ID` header. Optional *idstring* if given, is a string - used to strengthen the uniqueness of the message id. + used to strengthen the uniqueness of the message id. Optional *domain* if + given provides the portion of the msgid after the '@'. The default is the + local hostname. It is not normally necessary to override this default, but + may be useful certain cases, such as a constructing distributed system that + uses a consistent domain name across multiple hosts. + + .. versionchanged:: 3.2 domain keyword added .. function:: decode_rfc2231(s) |