summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorNick Hu <me@nickhu.co.uk>2019-04-10 11:00:38 +0100
committerPatrick Totzke <patricktotzke@gmail.com>2019-05-11 17:29:22 +0100
commit41f12577dadee35954f9e223ced0c51369d56394 (patch)
treefde9198c47660d8f4cce8771bc4d9eff7913fc93 /docs
parentd0297605c0ec1c6b65f541d0fd5b69ac5a0f4ded (diff)
expose subject and to headers to forward_prefix hook
Diffstat (limited to 'docs')
-rw-r--r--docs/source/configuration/hooks.rst8
1 files changed, 6 insertions, 2 deletions
diff --git a/docs/source/configuration/hooks.rst b/docs/source/configuration/hooks.rst
index 5d201328..be8972b3 100644
--- a/docs/source/configuration/hooks.rst
+++ b/docs/source/configuration/hooks.rst
@@ -42,7 +42,7 @@ Other Hooks
Apart from command pre- and posthooks, the following hooks will be interpreted:
-.. py:function:: reply_prefix(realname, address, timestamp[, ui= None, dbm=None])
+.. py:function:: reply_prefix(realname, address, timestamp[, message=None, ui= None, dbm=None])
Is used to reformat the first indented line in a reply message.
This defaults to 'Quoting %s (%s)\n' % (realname, timestamp)' unless this
@@ -54,9 +54,11 @@ Apart from command pre- and posthooks, the following hooks will be interpreted:
:type address: str
:param timestamp: value of the Date header of the replied message
:type timestamp: :obj:`datetime.datetime`
+ :param message: message object attached to reply
+ :type message: :obj:`email.Message`
:rtype: string
-.. py:function:: forward_prefix(realname, address, timestamp[, ui= None, dbm=None])
+.. py:function:: forward_prefix(realname, address, timestamp[, message=None, ui= None, dbm=None])
Is used to reformat the first indented line in a inline forwarded message.
This defaults to 'Forwarded message from %s (%s)\n' % (realname,
@@ -68,6 +70,8 @@ Apart from command pre- and posthooks, the following hooks will be interpreted:
:type address: str
:param timestamp: value of the Date header of the replied message
:type timestamp: :obj:`datetime.datetime`
+ :param message: message object being forwarded
+ :type message: :obj:`email.Message`
:rtype: string
.. _pre-edit-translate: