summaryrefslogtreecommitdiff
path: root/alot/db
diff options
context:
space:
mode:
Diffstat (limited to 'alot/db')
-rw-r--r--alot/db/utils.py10
1 files changed, 10 insertions, 0 deletions
diff --git a/alot/db/utils.py b/alot/db/utils.py
index 0b034da0..4e8ab904 100644
--- a/alot/db/utils.py
+++ b/alot/db/utils.py
@@ -16,6 +16,16 @@ from alot.helper import string_decode
def extract_headers(mail, headers=None):
+ """
+ returns subset of this messages headers as human-readable format:
+ all header values are decoded, the resulting string has
+ one line "KEY: VALUE" for each requested header present in the mail.
+
+ :param mail: the mail to use
+ :type mail: :class:`email.Message`
+ :param headers: headers to extract
+ :type headers: list of str
+ """
headertext = u''
if headers == None:
headers = mail.keys()