`email.utils.md`

102 строк · 12.0 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/2.7/library/email.utils.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# 18.1.9. [`email.utils`](https://python-all.ru/2.7/library/email.utils.html#module-email.utils): Разные утилиты89В модуле [`email.utils`](https://python-all.ru/2.7/library/email.utils.html#module-email.utils) предоставляется несколько полезных утилит:1011#### `email.utils.quote(str)`1213Возвращает новую строку, в которой обратная косая черта в *str* заменена двумя обратными косыми чертами, а двойные кавычки – на обратную косую черту с двойной кавычкой.1415#### `email.utils.unquote(str)`1617Возвращает новую строку, которая является *расквотированной* версией *str*. Если *str* начинается и заканчивается двойными кавычками, они удаляются. Аналогично, если *str* начинается и заканчивается угловыми скобками, они удаляются.1819#### `email.utils.parseaddr(address)`2021Разбирает адрес – который должен быть значением какого-либо поля, содержащего адрес, такого как *To* или *Cc* – на составляющие части: *realname* и *адрес электронной почты*. Возвращает кортеж с этой информацией, если только разбор не завершится ошибкой; в этом случае возвращается кортеж из двух элементов `('', '')`.2223#### `email.utils.formataddr(pair)`2425Обратная функция к [`parseaddr()`](https://python-all.ru/2.7/library/email.utils.html#email.utils.parseaddr), она принимает кортеж из двух элементов вида `(realname, email_address)` и возвращает строковое значение, подходящее для заголовка *To* или *Cc*. Если первый элемент *pair* равен false, то второй элемент возвращается без изменений.2627#### `email.utils.getaddresses(fieldvalues)`2829Этот метод возвращает список кортежей из двух элементов в том же формате, что и `parseaddr()`. *fieldvalues* – это последовательность значений полей заголовка, как она может быть возвращена функцией [`Message.get_all`](https://python-all.ru/2.7/library/email.message.html#email.message.Message.get_all). Ниже приведён простой пример, который получает всех получателей сообщения:3031```python32from email.utils import getaddresses3334tos = msg.get_all('to', [])35ccs = msg.get_all('cc', [])36resent_tos = msg.get_all('resent-to', [])37resent_ccs = msg.get_all('resent-cc', [])38all_recipients = getaddresses(tos + ccs + resent_tos + resent_ccs)39```4041#### `email.utils.parsedate(date)`4243Пытается разобрать дату в соответствии с правилами [**RFC 2822**](https://python-all.ru/2.7/library/email.utils.html). Однако некоторые почтовые программы не следуют этому формату, поэтому [`parsedate()`](https://python-all.ru/2.7/library/email.utils.html#email.utils.parsedate) пытается правильно угадать дату в таких случаях. *date* – это строка, содержащая дату в формате [**RFC 2822**](https://python-all.ru/2.7/library/email.utils.html), например, `"Mon, 20 Nov 1995 19:12:08 -0500"`. Если разбор даты успешен, [`parsedate()`](https://python-all.ru/2.7/library/email.utils.html#email.utils.parsedate) возвращает кортеж из 9 элементов, который можно напрямую передать в [`time.mktime()`](https://python-all.ru/2.7/library/time.html#time.mktime); в противном случае возвращается `None`. Обратите внимание, что индексы 6, 7 и 8 кортежа результата не пригодны для использования.4445#### `email.utils.parsedate_tz(date)`4647Выполняет ту же функцию, что и [`parsedate()`](https://python-all.ru/2.7/library/email.utils.html#email.utils.parsedate), но возвращает либо `None`, либо кортеж из 10 элементов; первые 9 элементов составляют кортеж, который можно напрямую передать в [`time.mktime()`](https://python-all.ru/2.7/library/time.html#time.mktime), а десятый – это смещение часового пояса даты относительно UTC (официальное название среднего времени по Гринвичу) [1](https://python-all.ru/2.7/library/email.utils.html#id2). Если входная строка не содержит часового пояса, последним элементом возвращаемого кортежа будет `None`. Обратите внимание, что индексы 6, 7 и 8 кортежа результата непригодны для использования.4849#### `email.utils.mktime_tz(tuple)`5051Преобразует 10-элементный кортеж, возвращаемый функцией [`parsedate_tz()`](https://python-all.ru/2.7/library/email.utils.html#email.utils.parsedate_tz), в метку времени UTC (секунды с начала эпохи). Если элемент часового пояса в кортеже равен `None`, предполагается местное время.5253#### `email.utils.formatdate([timeval[, localtime][, usegmt]])`5455Возвращает строку даты в соответствии с [**RFC 2822**](https://python-all.ru/2.7/library/email.utils.html), например:5657```python58Fri, 09 Nov 2001 01:08:47 -000059```6061Необязательный *timeval*, если задан, представляет собой вещественное значение времени, принимаемое [`time.gmtime()`](https://python-all.ru/2.7/library/time.html#time.gmtime) и [`time.localtime()`](https://python-all.ru/2.7/library/time.html#time.localtime); в противном случае используется текущее время.6263Необязательный флаг *localtime*: если `True`, интерпретирует *timeval* и возвращает дату относительно местного часового пояса вместо UTC, с учётом перехода на летнее время. По умолчанию `False`, то есть используется UTC.6465Необязательный флаг *usegmt*: если `True`, выводит строку даты с часовым поясом в виде ASCII-строки `GMT`, а не числового `-0000`. Это необходимо для некоторых протоколов (например, HTTP). Применяется только когда *localtime* равен `False`. По умолчанию `False`.6667Новое в версии 2.4.6869#### `email.utils.make_msgid([idstring])`7071Возвращает строку, подходящую для заголовка *Message-ID*, совместимого с [**RFC 2822**](https://python-all.ru/2.7/library/email.utils.html). Необязательный параметр *idstring*, если задан, используется для повышения уникальности идентификатора сообщения.7273#### `email.utils.decode_rfc2231(s)`7475Декодирует строку *s* в соответствии с [**RFC 2231**](https://python-all.ru/2.7/library/email.utils.html).7677#### `email.utils.encode_rfc2231(s[, charset[, language]])`7879Кодирует строку *s* в соответствии с [**RFC 2231**](https://python-all.ru/2.7/library/email.utils.html). Необязательные параметры *charset* и *language*, если заданы, указывают имя кодировки и язык. Если ни один не задан, *s* возвращается как есть. Если *charset* задан, а *language* нет, строка кодируется с пустой строкой для *language*.8081#### `email.utils.collapse_rfc2231_value(value[, errors[, fallback_charset]])`8283Когда параметр заголовка закодирован в формате [**RFC 2231**](https://python-all.ru/2.7/library/email.utils.html), [`Message.get_param`](https://python-all.ru/2.7/library/email.message.html#email.message.Message.get_param) может вернуть кортеж из трёх элементов, содержащий кодировку, язык и значение. [`collapse_rfc2231_value()`](https://python-all.ru/2.7/library/email.utils.html#email.utils.collapse_rfc2231_value) преобразует это в строку Unicode. Необязательный *errors* передаётся аргументу *errors* встроенной функции [`unicode()`](https://python-all.ru/2.7/library/functions.html#unicode); по умолчанию он равен `replace`. Необязательный *fallback\_charset* задаёт кодировку, которую следует использовать, если кодировка заголовка [**RFC 2231**](https://python-all.ru/2.7/library/email.utils.html) не известна Python; по умолчанию `us-ascii`.8485Для удобства, если *value*, переданное в [`collapse_rfc2231_value()`](https://python-all.ru/2.7/library/email.utils.html#email.utils.collapse_rfc2231_value), не является кортежем, оно должно быть строкой и возвращается без кавычек.8687#### `email.utils.decode_params(params)`8889Декодирует список параметров в соответствии с [**RFC 2231**](https://python-all.ru/2.7/library/email.utils.html). *params* – это последовательность 2-элементных кортежей, содержащих элементы вида `(content-type, string-value)`.9091Изменено в версии 2.4: Функция `dump_address_pair()` удалена; вместо неё используйте [`formataddr()`](https://python-all.ru/2.7/library/email.utils.html#email.utils.formataddr) .9293Изменено в версии 2.4: Функция `decode()` удалена; вместо неё используйте метод `Header.decode_header` .9495Изменено в версии 2.4: Функция `encode()` удалена; вместо неё используйте метод [`Header.encode`](https://python-all.ru/2.7/library/email.header.html#email.header.Header.encode).9697Сноски9899**[1](https://python-all.ru/2.7/library/email.utils.html#id1)**100101Обратите внимание, что знак смещения часового пояса противоположен знаку переменной `time.timezone` для того же часового пояса; последняя переменная следует стандарту POSIX, тогда как этот модуль следует [**RFC 2822**](https://python-all.ru/2.7/library/email.utils.html).102