# HG changeset patch
# User Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
# Date 1478796845 -3600
# Node ID ea9342f8d46bb47b4f6570af57cb1b625b4516c8
# Parent  c25392980f91f2a68a2dbd4e63a1a73077ff89ee
docs: document X-Kallithea-Notification-Type header

diff -r c25392980f91 -r ea9342f8d46b docs/usage/email.rst
--- a/docs/usage/email.rst	Tue Oct 11 17:45:40 2016 +0200
+++ b/docs/usage/email.rst	Thu Nov 10 17:54:05 2016 +0100
@@ -48,6 +48,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
 ------------