| Benjamin Peterson | fa0d703 | 2009-06-01 22:42:33 +0000 | [diff] [blame] | 1 | .. _email-examples: | 
 | 2 |  | 
| Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 3 | :mod:`email`: Examples | 
 | 4 | ---------------------- | 
 | 5 |  | 
 | 6 | Here are a few examples of how to use the :mod:`email` package to read, write, | 
 | 7 | and send simple email messages, as well as more complex MIME messages. | 
 | 8 |  | 
 | 9 | First, let's see how to create and send a simple text message: | 
 | 10 |  | 
 | 11 | .. literalinclude:: ../includes/email-simple.py | 
 | 12 |  | 
 | 13 |  | 
| Sean Reifscheider | 78a44c5 | 2010-03-19 23:23:05 +0000 | [diff] [blame] | 14 | And parsing RFC822 headers can easily be done by the parse(filename) or | 
 | 15 | parsestr(message_as_string) methods of the Parser() class: | 
 | 16 |  | 
 | 17 | .. literalinclude:: ../includes/email-headers.py | 
 | 18 |  | 
 | 19 |  | 
| Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 20 | Here's an example of how to send a MIME message containing a bunch of family | 
 | 21 | pictures that may be residing in a directory: | 
 | 22 |  | 
 | 23 | .. literalinclude:: ../includes/email-mime.py | 
 | 24 |  | 
 | 25 |  | 
 | 26 | Here's an example of how to send the entire contents of a directory as an email | 
| Christian Heimes | 292d351 | 2008-02-03 16:51:08 +0000 | [diff] [blame] | 27 | message: [1]_ | 
| Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 28 |  | 
 | 29 | .. literalinclude:: ../includes/email-dir.py | 
 | 30 |  | 
 | 31 |  | 
| Christian Heimes | 292d351 | 2008-02-03 16:51:08 +0000 | [diff] [blame] | 32 | Here's an example of how to unpack a MIME message like the one | 
| Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 33 | above, into a directory of files: | 
 | 34 |  | 
 | 35 | .. literalinclude:: ../includes/email-unpack.py | 
 | 36 |  | 
| Christian Heimes | 292d351 | 2008-02-03 16:51:08 +0000 | [diff] [blame] | 37 | Here's an example of how to create an HTML message with an alternative plain | 
 | 38 | text version: [2]_ | 
 | 39 |  | 
 | 40 | .. literalinclude:: ../includes/email-alternative.py | 
 | 41 |  | 
| Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 42 |  | 
 | 43 | .. rubric:: Footnotes | 
 | 44 |  | 
 | 45 | .. [1] Thanks to Matthew Dixon Cowles for the original inspiration and examples. | 
| Christian Heimes | 292d351 | 2008-02-03 16:51:08 +0000 | [diff] [blame] | 46 | .. [2] Contributed by Martin Matejek. |