From c921814e183e1983cb0b7663410c8cd8acaac584 Mon Sep 17 00:00:00 2001
From: lasat <lasat@users.noreply.github.com>
Date: Thu, 23 Dec 2021 07:45:39 +0100
Subject: [PATCH] Update index.rst

add note to imap password to escape '%'
---
 docs/index.rst | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/docs/index.rst b/docs/index.rst
index 2e2bae1..b7351d5 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -185,6 +185,10 @@ The full set of configuration options are:
     - ``skip_certificate_verification`` - bool: Skip certificate verification (not recommended)
     - ``user`` - str: The IMAP user
     - ``password`` - str: The IMAP password
+    
+    ..note::
+      The percent symbol has a special function, so it should be escaped. Use "%%" instead of "%" and it should work fine.
+    
     - ``reports_folder`` - str: The IMAP folder where the incoming reports can be found (Default: INBOX)
     - ``archive_folder`` - str:  The IMAP folder to sort processed emails into (Default: Archive)
     - ``watch`` - bool: Use the IMAP ``IDLE`` command to process messages as they arrive