From ae7c644d9194b3c347b970ac0f79071fc9ab6909 Mon Sep 17 00:00:00 2001
From: dandds <dan-ctr@friends.dds.mil>
Date: Fri, 12 Oct 2018 09:15:56 -0400
Subject: [PATCH] update README, adjust email config function name

---
 README.md   | 16 ++++++++++++++++
 atst/app.py |  4 ++--
 2 files changed, 18 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index a0c82d63..f8c5429a 100644
--- a/README.md
+++ b/README.md
@@ -111,6 +111,22 @@ projects for all of the test users:
 
 `pipenv run python script/seed_sample.py`
 
+### Email Notifications
+
+To send email, the following configuration values must be set:
+
+```
+MAIL_SERVER = <SMTP server URL>
+MAIL_PORT = <SMTP server port>
+MAIL_SENDER = <Login name for the email account and sender address>
+MAIL_PASSWORD = <login password for the email account>
+MAIL_TLS = <Boolean, whether TLS should be enabled for outgoing email. Defaults to false.>
+```
+
+When the `DEBUG` environment variable is enabled and the app environment is not
+set to production, sent email messages are available at the `/messages` endpoint.
+Emails are not sent in development and test modes.
+
 ## Testing
 
 Tests require a test database:
diff --git a/atst/app.py b/atst/app.py
index d709fb5e..68ebd331 100644
--- a/atst/app.py
+++ b/atst/app.py
@@ -172,7 +172,7 @@ def make_upload_storage(app):
     app.uploader = uploader
 
 
-def _map_config(config):
+def _map_email_config(config):
     return {
         "server": config.get("MAIL_SERVER"),
         "port": config.get("MAIL_PORT"),
@@ -183,7 +183,7 @@ def _map_config(config):
 
 
 def make_mailer(app):
-    config = _map_config(app.config)
+    config = _map_email_config(app.config)
     if app.config["DEBUG"]:
         mailer = RedisMailer(redis=app.redis, **config)
     else: