debian/notmuch
1
0
Fork 0
mirror of https://git.notmuchmail.org/git/notmuch synced 2024-12-22 17:34:54 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

python: fix docstring of Message.get_header()

Browse source 
Update the docstring from notmuch.h.

Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
This commit is contained in:
Justus Winter 2011-09-30 03:05:04 +02:00 committed by Sebastian Spaeth
parent f63d605835
commit a378a91ba2
1 changed files with 7 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
bindings/python/notmuch/message.py
View file

@ -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)