kallithea Changeset - ea9342f8d46b

Changeset - ea9342f8d46b

Parent rev.

Child rev.

[Not reviewed]

stable

0 1 0

Thomas De Schampheleire - 9 years ago 2016-11-10 17:54:05
thomas.de.schampheleire@gmail.com

Grafted from: 6b865fcfed20

docs: document X-Kallithea-Notification-Type header

1 file changed with 13 insertions and 0 deletions:

docs/usage/email.rst

0 comments (0 inline, 0 general)

docs/usage/email.rst

➞

Show inline comments

@@ @@ -39,24 +39,37 @@ Recipients will see these emails origina @@
 ``app_email_from`` setting in the configuration file. This setting can either
 contain only an email address, like `kallithea-noreply@example.com`, or both
 a name and an address in the following format: `Kallithea
 <kallithea-noreply@example.com>`. However, if the email is sent due to an
 action of a particular user, for example when a comment is given or a pull
 request created, the name of that user will be combined with the email address
 specified in ``app_email_from`` to form the sender (and any name part in that
 configuration setting disregarded).
 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
 ------------
 When an exception occurs in Kallithea -- and unless interactive debugging is
 enabled using ``set debug = true`` in the ``[app:main]`` section of the
 configuration file -- an email with exception details is sent by WebError_'s
 ``ErrorMiddleware`` to the addresses specified in ``email_to`` in the
 configuration file.
 Recipients will see these emails originating from the sender specified in the
 ``error_email_from`` setting in the configuration file. This setting can either

0 comments (0 inline, 0 general)