diff options
| author | Patrick Totzke <patricktotzke@gmail.com> | 2019-08-10 18:13:14 +0100 |
|---|---|---|
| committer | Patrick Totzke <patricktotzke@gmail.com> | 2019-08-15 11:33:04 +0100 |
| commit | 0c5d569f67404cf5006ccf2d7f8eac090be8388f (patch) | |
| tree | a25d24d819866ce3948e7860d910b38161fe72c5 /alot | |
| parent | 562cfe62bc93e05bf1b299dbec074adacd7c7c42 (diff) | |
update docstrings
Diffstat (limited to 'alot')
| -rw-r--r-- | alot/db/message.py | 2 | ||||
| -rw-r--r-- | alot/db/utils.py | 6 |
2 files changed, 4 insertions, 4 deletions
diff --git a/alot/db/message.py b/alot/db/message.py index 8b93f1ce..720276dd 100644 --- a/alot/db/message.py +++ b/alot/db/message.py @@ -99,7 +99,7 @@ class Message: return NotImplemented def get_email(self): - """returns :class:`email.Message` for this message""" + """returns :class:`email.email.EmailMessage` for this message""" path = self.get_filename() warning = "Subject: Caution!\n"\ "Message file is no longer accessible:\n%s" % path diff --git a/alot/db/utils.py b/alot/db/utils.py index da8f3df7..3de39d3a 100644 --- a/alot/db/utils.py +++ b/alot/db/utils.py @@ -314,7 +314,7 @@ def extract_headers(mail, headers=None): one line "KEY: VALUE" for each requested header present in the mail. :param mail: the mail to use - :type mail: :class:`email.Message` + :type mail: :class:`email.message.EmailMessage` :param headers: headers to extract :type headers: list of str """ @@ -394,7 +394,7 @@ def remove_cte(part, as_string=False): ..Note:: All this may be depricated in favour of `email.contentmanager.raw_data_manager` (v3.6+) - :param email.Message part: The part to decode + :param email.message.EmailMessage part: The part to decode :param bool as_string: If true return a str, otherwise return bytes :returns: The mail with any Content-Transfer-Encoding removed :rtype: Union[str, bytes] @@ -466,7 +466,7 @@ def extract_body(mail): part. :param mail: the mail to use - :type mail: :class:`email.Message` + :type mail: :class:`email.message.EmailMessage` :returns: The combined text of any parts to be used :rtype: str """ |