Документация Python неофициальный перевод

email: Примерыemail: Examples

Вот несколько примеров использования пакета email для чтения, записи, и отправки простых email-сообщений, а также более сложных MIME-сообщений.

Сначала посмотрим, как создать и отправить простое текстовое сообщение (как текст, так и адреса могут содержать символы Unicode):

# Импорт smtplib для функции отправки
import smtplib

# Импортируются необходимые модули email.
from email.message import EmailMessage

# Открыть текстовый файл, имя которого находится в textfile, для чтения.
with open(textfile) as fp:
    # Создать сообщение text/plain
    msg = EmailMessage()
    msg.set_content(fp.read())

# me == адрес электронной почты отправителя
# you == адрес электронной почты получателя
msg['Subject'] = f'The contents of {textfile}'
msg['From'] = me
msg['To'] = you

# Отправить сообщение через собственный SMTP-сервер.
s = smtplib.SMTP('localhost')
s.send_message(msg)
s.quit()

Разбор заголовков RFC 822 легко выполняется с помощью классов из модуля parser:

# Импортируются необходимые модули email.
#from email.parser import BytesParser
from email.parser import Parser
from email.policy import default

# Если заголовки e-mail находятся в файле, раскомментируйте эти две строки:
# with open(messagefile, 'rb') as fp:
#     headers = BytesParser(policy=default).parse(fp)

#  Или для разбора заголовков из строки (это нечастая операция), используйте:
headers = Parser(policy=default).parsestr(
        'From: Foo Bar <user@example.com>\n'
        'To: <someone_else@example.com>\n'
        'Subject: Test message\n'
        '\n'
        'Body would go here\n')

#  Теперь к элементам заголовков можно обращаться как к словарю:
print('To: {}'.format(headers['to']))
print('From: {}'.format(headers['from']))
print('Subject: {}'.format(headers['subject']))

# Также можно обращаться к частям адресов:
print('Recipient username: {}'.format(headers['to'].addresses[0].username))
print('Sender name: {}'.format(headers['from'].addresses[0].display_name))

Вот пример отправки MIME-сообщения, содержащего много семейных фотографий, которые могут находиться в каталоге:

# Импортируем smtplib для непосредственной отправки.
import smtplib

# Вот модули пакета email, которые нам понадобятся.
from email.message import EmailMessage

# Создаём контейнерное email-сообщение.
msg = EmailMessage()
msg['Subject'] = 'Our family reunion'
# me == адрес электронной почты отправителя
# family = список адресов электронной почты всех получателей
msg['From'] = me
msg['To'] = ', '.join(family)
msg.preamble = 'You will not see this in a MIME-aware mail reader.\n'

# Откройте файлы в бинарном режиме. Можно также опустить подтип
# если хотите, чтобы MIMEImage угадал его.
for file in pngfiles:
    with open(file, 'rb') as fp:
        img_data = fp.read()
    msg.add_attachment(img_data, maintype='image',
                                 subtype='png')

# Отправляем email через собственный SMTP-сервер.
with smtplib.SMTP('localhost') as s:
    s.send_message(msg)

Вот пример отправки всего содержимого каталога в виде email- сообщения: [1]

#!/usr/bin/env python3

"""Отправляем содержимое каталога как MIME-сообщение."""

import os
import smtplib
# Для определения типа MIME по расширению имени файла
import mimetypes

from argparse import ArgumentParser

from email.message import EmailMessage
from email.policy import SMTP


def main():
    parser = ArgumentParser(description="""\
Send the contents of a directory as a MIME message.
Unless the -o option is given, the email is sent by forwarding to your local
SMTP server, which then does the normal delivery process.  Your local machine
must be running an SMTP server.
""")
    parser.add_argument('-d', '--directory',
                        help="""Mail the contents of the specified directory,
                        otherwise use the current directory.  Only the regular
                        files in the directory are sent, and we don't recurse to
                        subdirectories.""")
    parser.add_argument('-o', '--output',
                        metavar='FILE',
                        help="""Print the composed message to FILE instead of
                        sending the message to the SMTP server.""")
    parser.add_argument('-s', '--sender', required=True,
                        help='The value of the From: header (required)')
    parser.add_argument('-r', '--recipient', required=True,
                        action='append', metavar='RECIPIENT',
                        default=[], dest='recipients',
                        help='A To: header value (at least one required)')
    args = parser.parse_args()
    directory = args.directory
    if not directory:
        directory = '.'
    # Создаём сообщение
    msg = EmailMessage()
    msg['Subject'] = f'Contents of directory {os.path.abspath(directory)}'
    msg['To'] = ', '.join(args.recipients)
    msg['From'] = args.sender
    msg.preamble = 'You will not see this in a MIME-aware mail reader.\n'

    for filename in os.listdir(directory):
        path = os.path.join(directory, filename)
        if not os.path.isfile(path):
            continue
        # Определяем тип содержимого по расширению файла. Кодировка
        # будет проигнорирована, хотя стоит проверять простые вещи, такие как
        # gzip-файлы или сжатые файлы.
        ctype, encoding = mimetypes.guess_file_type(path)
        if ctype is None or encoding is not None:
            # Не удалось определить тип, или файл закодирован (сжат), поэтому
            # используем общий тип 'набор битов'.
            ctype = 'application/octet-stream'
        maintype, subtype = ctype.split('/', 1)
        with open(path, 'rb') as fp:
            msg.add_attachment(fp.read(),
                               maintype=maintype,
                               subtype=subtype,
                               filename=filename)
    # Теперь отправляем или сохраняем сообщение
    if args.output:
        with open(args.output, 'wb') as fp:
            fp.write(msg.as_bytes(policy=SMTP))
    else:
        with smtplib.SMTP('localhost') as s:
            s.send_message(msg)


if __name__ == '__main__':
    main()

Вот пример распаковки MIME-сообщения вроде показанного выше в каталог с файлами:

#!/usr/bin/env python3

"""Распаковываем MIME-сообщение в каталог файлов."""

import os
import email
import mimetypes

from email.policy import default

from argparse import ArgumentParser


def main():
    parser = ArgumentParser(description="""\
Unpack a MIME message into a directory of files.
""")
    parser.add_argument('-d', '--directory', required=True,
                        help="""Unpack the MIME message into the named
                        directory, which will be created if it doesn't already
                        exist.""")
    parser.add_argument('msgfile')
    args = parser.parse_args()

    with open(args.msgfile, 'rb') as fp:
        msg = email.message_from_binary_file(fp, policy=default)

    try:
        os.mkdir(args.directory)
    except FileExistsError:
        pass

    counter = 1
    for part in msg.walk():
        # multipart/* – это просто контейнеры
        if part.get_content_maintype() == 'multipart':
            continue
        # Приложениям следует тщательно проверять имя файла, чтобы
        # email-сообщение не могло перезаписать важные файлы
        filename = part.get_filename()
        if not filename:
            ext = mimetypes.guess_extension(part.get_content_type())
            if not ext:
                # Использовать универсальное расширение для набора битов.
                ext = '.bin'
            filename = f'part-{counter:03d}{ext}'
        counter += 1
        with open(os.path.join(args.directory, filename), 'wb') as fp:
            fp.write(part.get_payload(decode=True))


if __name__ == '__main__':
    main()

Вот пример создания HTML-сообщения с альтернативной текстовой версией. Чтобы было интереснее, мы добавляем связанное изображение в HTML-часть и сохраняем копию того, что собираемся отправить на диск, а также отправляем его.

#!/usr/bin/env python3

import smtplib

from email.message import EmailMessage
from email.headerregistry import Address
from email.utils import make_msgid

# Создаём базовое текстовое сообщение.
msg = EmailMessage()
msg['Subject'] = "Pourquoi pas des asperges pour ce midi ?"
msg['From'] = Address("Pepé Le Pew", "pepe", "example.com")
msg['To'] = (Address("Penelope Pussycat", "penelope", "example.com"),
             Address("Fabrette Pussycat", "fabrette", "example.com"))
msg.set_content("""\
Salut!

Cette recette [1] sera sûrement un très bon repas.

[1] http://www.yummly.com/recipe/Roasted-Asparagus-Epicurious-203718

--Pepé
""")

# Добавляем HTML-версию. Это преобразует сообщение в multipart/alternative.
# контейнер, где исходное текстовое сообщение – первая часть, а новое html
# сообщение – вторая часть.
asparagus_cid = make_msgid()
msg.add_alternative("""\
<html>
  <head></head>
  <body>
    <p>Salut!</p>
    <p>Cette
        <a href="http://www.yummly.com/recipe/Roasted-Asparagus-Epicurious-203718">
            recette
        </a> sera sûrement un très bon repas.
    </p>
    <img src="cid:{asparagus_cid}">
  </body>
</html>
""".format(asparagus_cid=asparagus_cid[1:-1]), subtype='html')
# Обратите внимание: для использования в html потребовалось снять угловые скобки с msgid.

# Теперь добавьте связанное изображение в html-часть.
with open("roasted-asparagus.jpg", 'rb') as img:
    msg.get_payload()[1].add_related(img.read(), 'image', 'jpeg',
                                     cid=asparagus_cid)

# Создается локальная копия отправляемых данных.
with open('outgoing.msg', 'wb') as f:
    f.write(bytes(msg))

# Отправка сообщения через локальный SMTP-сервер.
with smtplib.SMTP('localhost') as s:
    s.send_message(msg)

Если бы нам отправили сообщение из предыдущего примера, вот один из способов, как его можно обработать:

import os
import sys
import tempfile
import mimetypes
import webbrowser

# Импортируются необходимые модули email.
from email import policy
from email.parser import BytesParser


def magic_html_parser(html_text, partfiles):
    """Возвращает безопасно очищенный html, связанный с файлами частей.

    Атрибуты href="cid:...." перезаписываются, чтобы указывать на имена файлов из partfiles.
    Хотя это и нетривиально, возможно реализовать с помощью html.parser.
    """
    raise NotImplementedError("Add the magic needed")


# В реальной программе имя файла получается из аргументов.
with open('outgoing.msg', 'rb') as fp:
    msg = BytesParser(policy=policy.default).parse(fp)

# Теперь к элементам заголовка можно обращаться как к словарю, и любые не-ASCII символы будут
# преобразованы в Unicode:
print('To:', msg['to'])
print('From:', msg['from'])
print('Subject:', msg['subject'])

# Если нужно вывести предварительный просмотр содержимого сообщения, можно извлечь
# наименее отформатированную полезную нагрузку и вывести первые три строки. Конечно,
# если сообщение не содержит части в обычном тексте, вывод первых трех строк html
# вероятно, бесполезен, но это всего лишь концептуальный пример.
simplest = msg.get_body(preferencelist=('plain', 'html'))
print()
print(''.join(simplest.get_content().splitlines(keepends=True)[:3]))

ans = input("View full message?")
if ans.lower()[0] == 'n':
    sys.exit()

# Можно извлечь наиболее полную альтернативу для отображения:
richest = msg.get_body()
partfiles = {}
if richest['content-type'].maintype == 'text':
    if richest['content-type'].subtype == 'plain':
        for line in richest.get_content().splitlines():
            print(line)
        sys.exit()
    elif richest['content-type'].subtype == 'html':
        body = richest
    else:
        print("Don't know how to display {}".format(richest.get_content_type()))
        sys.exit()
elif richest['content-type'].content_type == 'multipart/related':
    body = richest.get_body(preferencelist=('html'))
    for part in richest.iter_attachments():
        fn = part.get_filename()
        if fn:
            extension = os.path.splitext(part.get_filename())[1]
        else:
            extension = mimetypes.guess_extension(part.get_content_type())
        with tempfile.NamedTemporaryFile(suffix=extension, delete=False) as f:
            f.write(part.get_content())
            # снова удалите угловые скобки, чтобы перейти от формы cid в email к форме в html.
            partfiles[part['content-id'][1:-1]] = f.name
else:
    print("Don't know how to display {}".format(richest.get_content_type()))
    sys.exit()
with tempfile.NamedTemporaryFile(mode='w', delete=False) as f:
    f.write(magic_html_parser(body.get_content(), partfiles))
webbrowser.open(f.name)
os.remove(f.name)
for fn in partfiles.values():
    os.remove(fn)

# Конечно, есть много email-сообщений, которые могут нарушить эту простую
# программу, но она справится с наиболее распространенными.

До приглашения вывод из примера выше:

To: Penelope Pussycat <penelope@example.com>, Fabrette Pussycat <fabrette@example.com>
From: Pepé Le Pew <pepe@example.com>
Subject: Pourquoi pas des asperges pour ce midi ?

Salut!

Cette recette [1] sera sûrement un très bon repas.

Сноски