diff options
author | Mariatta Wijaya <mariatta.wijaya@gmail.com> | 2017-02-06 20:16:58 -0800 |
---|---|---|
committer | Mariatta Wijaya <mariatta.wijaya@gmail.com> | 2017-02-06 20:16:58 -0800 |
commit | da79bcf8ac7ae72218ab023e1ed54390bc1a3a27 (patch) | |
tree | 74845e2dbd9521d9748b9c32f1922f4123083bf3 /Doc/library/email.examples.rst | |
parent | e3c7e835bdfc97750eb9b7fc0ad2493108c2d438 (diff) | |
parent | 1fe806ac56f8b83694d24ab604eb695d00bc8497 (diff) | |
download | cpython-da79bcf8ac7ae72218ab023e1ed54390bc1a3a27.tar.gz |
Issue #29371: merge with 3.5
Diffstat (limited to 'Doc/library/email.examples.rst')
-rw-r--r-- | Doc/library/email.examples.rst | 67 |
1 files changed, 67 insertions, 0 deletions
diff --git a/Doc/library/email.examples.rst b/Doc/library/email.examples.rst new file mode 100644 index 0000000000..84e9aee0bc --- /dev/null +++ b/Doc/library/email.examples.rst @@ -0,0 +1,67 @@ +.. _email-examples: + +:mod:`email`: Examples +---------------------- + +Here are a few examples of how to use the :mod:`email` package to read, write, +and send simple email messages, as well as more complex MIME messages. + +First, let's see how to create and send a simple text message (both the +text content and the addresses may contain unicode characters): + +.. literalinclude:: ../includes/email-simple.py + + +Parsing RFC822 headers can easily be done by the using the classes +from the :mod:`~email.parser` module: + +.. literalinclude:: ../includes/email-headers.py + + +Here's an example of how to send a MIME message containing a bunch of family +pictures that may be residing in a directory: + +.. literalinclude:: ../includes/email-mime.py + + +Here's an example of how to send the entire contents of a directory as an email +message: [1]_ + +.. literalinclude:: ../includes/email-dir.py + + +Here's an example of how to unpack a MIME message like the one +above, into a directory of files: + +.. literalinclude:: ../includes/email-unpack.py + + +Here's an example of how to create an HTML message with an alternative plain +text version. To make things a bit more interesting, we include a related +image in the html part, and we save a copy of what we are going to send to +disk, as well as sending it. + +.. literalinclude:: ../includes/email-alternative.py + + +If we were sent the message from the last example, here is one way we could +process it: + +.. literalinclude:: ../includes/email-read-alternative.py + +Up to the prompt, the output from the above is: + +.. code-block:: none + + To: Penelope Pussycat <penelope@example.com>, Fabrette Pussycat <fabrette@example.com> + From: Pepé Le Pew <pepe@example.com> + Subject: Ayons asperges pour le déjeuner + + Salut! + + Cela ressemble à un excellent recipie[1] déjeuner. + + +.. rubric:: Footnotes + +.. [1] Thanks to Matthew Dixon Cowles for the original inspiration and examples. |