From 1248dd22ea037fcab134ee835b04b532ee1bee88 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?P=C4=93teris=20Caune?= <cuu508@gmail.com>
Date: Thu, 12 Aug 2021 11:55:55 +0300
Subject: [PATCH] Add a note about keyword filtering in Docs / Email

---
 templates/docs/email.html | 6 ++++++
 templates/docs/email.md   | 8 ++++++++
 2 files changed, 14 insertions(+)

diff --git a/templates/docs/email.html b/templates/docs/email.html
index 5224d741..16923fa7 100644
--- a/templates/docs/email.html
+++ b/templates/docs/email.html
@@ -2,6 +2,12 @@
 <p>As an alternative to HTTP/HTTPS requests, you can "ping" checks by
 sending email messages to special email addresses.</p>
 <p><img alt="Email address for pinging via email" src="IMG_URL/emails.png" /></p>
+<p>By default, SITE_NAME will consider any email received at the displayed address as
+a "success" signal. You can also configure SITE_NAME to look for specific
+keywords in message's subject line to decide if the message is "success"
+or a "failure" signal. You can set up the keywords in the
+<strong>Filtering Rules</strong> dialog:</p>
+<p><img alt="Setting filtering rules" src="IMG_URL/filtering_rules.png" /></p>
 <h2>Use Case: Newsletter Delivery Monitoring</h2>
 <p>Consider a cron job that runs weekly and sends weekly newsletters
 to a list of email addresses. You have already set up a check to get alerted
diff --git a/templates/docs/email.md b/templates/docs/email.md
index 8aaa1cde..195ac5e6 100644
--- a/templates/docs/email.md
+++ b/templates/docs/email.md
@@ -5,6 +5,14 @@ sending email messages to special email addresses.
 
 ![Email address for pinging via email](IMG_URL/emails.png)
 
+By default, SITE_NAME will consider any email received at the displayed address as
+a "success" signal. You can also configure SITE_NAME to look for specific
+keywords in message's subject line to decide if the message is "success"
+or a "failure" signal. You can set up the keywords in the
+**Filtering Rules** dialog:
+
+![Setting filtering rules](IMG_URL/filtering_rules.png)
+
 ## Use Case: Newsletter Delivery Monitoring
 
 Consider a cron job that runs weekly and sends weekly newsletters