diff options
author | Justus Winter <4winter@informatik.uni-hamburg.de> | 2011-09-30 03:05:04 +0200 |
---|---|---|
committer | Sebastian Spaeth <Sebastian@SSpaeth.de> | 2011-09-30 11:08:51 +0200 |
commit | a378a91ba2db58608640cd58373565d653a7c4e6 (patch) | |
tree | 199bd607c2b1a76b04f38d677f80be8523e1c585 /bindings/python/notmuch/message.py | |
parent | f63d605835bf7a5f05f6cf0f201f1e14e051179c (diff) |
python: fix docstring of Message.get_header()
Update the docstring from notmuch.h.
Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
Diffstat (limited to 'bindings/python/notmuch/message.py')
-rw-r--r-- | bindings/python/notmuch/message.py | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/bindings/python/notmuch/message.py b/bindings/python/notmuch/message.py index 0c3365b5..4bf90c22 100644 --- a/bindings/python/notmuch/message.py +++ b/bindings/python/notmuch/message.py @@ -369,22 +369,23 @@ class Message(object): return Message._get_date(self._msg) def get_header(self, header): - """Returns a message header + """Get the value of the specified header. - This returns any message header that is stored in the notmuch database. - This is only a selected subset of headers, which is currently: + The value will be read from the actual message file, not from + the notmuch database. The header name is case insensitive. - TODO: add stored headers + Returns an empty string ("") if the message does not contain a + header line matching 'header'. :param header: The name of the header to be retrieved. - It is not case-sensitive (TODO: confirm). + It is not case-sensitive. :type header: str :returns: The header value as string :exception: :exc:`NotmuchError` * STATUS.NOT_INITIALIZED if the message is not initialized. - * STATUS.NULL_POINTER, if no header was found + * STATUS.NULL_POINTER if any error occured. """ if self._msg is None: raise NotmuchError(STATUS.NOT_INITIALIZED) |