aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorChristopher Allan Webber <cwebber@dustycloud.org>2011-05-04 08:11:37 -0500
committerChristopher Allan Webber <cwebber@dustycloud.org>2011-05-04 08:11:37 -0500
commit61ec968b0d1a3681bbc049d651f67100b64e1f6d (patch)
tree483812bde9ca98e8bf0f4d56adf31e16cfccbebf
parent4d4f6050d84125f4fd3845e42965fd21d07a5176 (diff)
downloadmediagoblin-61ec968b0d1a3681bbc049d651f67100b64e1f6d.tar.lz
mediagoblin-61ec968b0d1a3681bbc049d651f67100b64e1f6d.tar.xz
mediagoblin-61ec968b0d1a3681bbc049d651f67100b64e1f6d.zip
A simple, maybe obvious, docstring for util.send_email()
-rw-r--r--mediagoblin/util.py10
1 files changed, 10 insertions, 0 deletions
diff --git a/mediagoblin/util.py b/mediagoblin/util.py
index 5b578a00..d24b59b6 100644
--- a/mediagoblin/util.py
+++ b/mediagoblin/util.py
@@ -142,6 +142,16 @@ def _clear_test_inboxes():
### ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
def send_email(from_addr, to_addrs, subject, message_body):
+ """
+ Simple email sending wrapper, use this so we can capture messages
+ for unit testing purposes.
+
+ Args:
+ - from_addr: address you're sending the email from
+ - to_addrs: list of recipient email addresses
+ - subject: subject of the email
+ - message_body: email body text
+ """
# TODO: make a mock mhost if testing is enabled
if TESTS_ENABLED:
mhost = FakeMhost()