diff options
author | Patrick Totzke <patricktotzke@gmail.com> | 2012-02-03 12:37:09 +0000 |
---|---|---|
committer | Patrick Totzke <patricktotzke@gmail.com> | 2012-02-03 12:37:09 +0000 |
commit | ce0341e984a98bc4b15a309f631d3f513c7b773a (patch) | |
tree | b87336ff09c404c1d4e277379e5d90fc126ba1c1 /alot/account.py | |
parent | f12be511bcfa28d9a4bcaa659d30d6f9896b48b6 (diff) |
adjust docstring for Account.send_mail
mention the returned Deferred
Diffstat (limited to 'alot/account.py')
-rw-r--r-- | alot/account.py | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/alot/account.py b/alot/account.py index c644abe1..7a46b64a 100644 --- a/alot/account.py +++ b/alot/account.py @@ -161,7 +161,8 @@ class Account(object): :param mail: the mail to send :type mail: :class:`email.message.Message` or string - :raises: :class:`alot.account.SendingMailFailed` if an error occured + :returns: a `Deferred` that errs back with a class:`SendingMailFailed`, + containing a reason string if an error occured. """ return 'not implemented' |