Mercurial > kallithea
changeset 6313:6b865fcfed20
docs: document X-Kallithea-Notification-Type header
author | Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> |
---|---|
date | Thu, 10 Nov 2016 17:54:05 +0100 |
parents | 51415ff90b08 |
children | 50f1a6adbefd |
files | docs/usage/email.rst |
diffstat | 1 files changed, 13 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- a/docs/usage/email.rst Thu Nov 10 16:10:41 2016 +0100 +++ b/docs/usage/email.rst Thu Nov 10 17:54:05 2016 +0100 @@ -57,6 +57,19 @@ The subject of these emails can optionally be prefixed with the value of ``email_prefix`` in the configuration file. +A Kallithea-specific header indicating the email type will be added to each +email. This header can be used for email filtering. The header is of the form: + + X-Kallithea-Notification-Type: <type> + +where ``<type>`` is one of: + +- ``pull_request``: you are invited as reviewer in a pull request +- ``pull_request_comment``: a comment was given on a pull request +- ``cs_comment``: a comment was given on a changeset +- ``registration``: a new user was registered +- ``message``: another type of email + Error emails ------------