heckyel/mediagoblin
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

A simple, maybe obvious, docstring for util.send_email()

Browse Source
This commit is contained in:
Christopher Allan Webber 2011-05-04 08:11:37 -05:00
parent 4d4f6050d8
commit 61ec968b0d
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
mediagoblin/util.py
View File

@ -142,6 +142,16 @@ def _clear_test_inboxes():
### ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ### ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
def send_email(from_addr, to_addrs, subject, message_body): 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 # TODO: make a mock mhost if testing is enabled
if TESTS_ENABLED: if TESTS_ENABLED:
mhost = FakeMhost() mhost = FakeMhost()