1 # GNU MediaGoblin -- federated, autonomous media hosting
2 # Copyright (C) 2011 MediaGoblin contributors. See AUTHORS.
4 # This program is free software: you can redistribute it and/or modify
5 # it under the terms of the GNU Affero General Public License as published by
6 # the Free Software Foundation, either version 3 of the License, or
7 # (at your option) any later version.
9 # This program is distributed in the hope that it will be useful,
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 # GNU Affero General Public License for more details.
14 # You should have received a copy of the GNU Affero General Public License
15 # along with this program. If not, see <http://www.gnu.org/licenses/>.
18 from email
.MIMEText
import MIMEText
19 from mediagoblin
import mg_globals
20 from mediagoblin
.tools
import common
22 ### ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
23 ### Special email test stuff begins HERE
24 ### ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
26 # We have two "test inboxes" here:
30 # If you're writing test views, you'll probably want to check this.
31 # It contains a list of MIMEText messages.
33 # EMAIL_TEST_MBOX_INBOX:
34 # ----------------------
35 # This collects the messages from the FakeMhost inbox. It's reslly
36 # just here for testing the send_email method itself.
38 # Anyway this contains:
40 # - to: a list of email recipient addresses
41 # - message: not just the body, but the whole message, including
46 # Before running tests that call functions which send email, you should
47 # always call _clear_test_inboxes() to "wipe" the inboxes clean.
50 EMAIL_TEST_MBOX_INBOX
= []
52 class FakeMhost(object):
54 Just a fake mail host so we can capture and test messages
57 def login(self
, *args
, **kwargs
):
60 def sendmail(self
, from_addr
, to_addrs
, message
):
61 EMAIL_TEST_MBOX_INBOX
.append(
66 def _clear_test_inboxes():
67 global EMAIL_TEST_INBOX
68 global EMAIL_TEST_MBOX_INBOX
70 EMAIL_TEST_MBOX_INBOX
= []
72 ### ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
73 ### </Special email test stuff>
74 ### ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
76 def send_email(from_addr
, to_addrs
, subject
, message_body
):
78 Simple email sending wrapper, use this so we can capture messages
79 for unit testing purposes.
82 - from_addr: address you're sending the email from
83 - to_addrs: list of recipient email addresses
84 - subject: subject of the email
85 - message_body: email body text
87 if common
.TESTS_ENABLED
or mg_globals
.app_config
['email_debug_mode']:
89 elif not mg_globals
.app_config
['email_debug_mode']:
91 mg_globals
.app_config
['email_smtp_host'],
92 mg_globals
.app_config
['email_smtp_port'])
94 # SMTP.__init__ Issues SMTP.connect implicitly if host
95 if not mg_globals
.app_config
['email_smtp_host']: # e.g. host = ''
96 mhost
.connect() # We SMTP.connect explicitly
98 if mg_globals
.app_config
['email_smtp_user'] \
99 or mg_globals
.app_config
['email_smtp_pass']:
101 mg_globals
.app_config
['email_smtp_user'],
102 mg_globals
.app_config
['email_smtp_pass'])
104 message
= MIMEText(message_body
.encode('utf-8'), 'plain', 'utf-8')
105 message
['Subject'] = subject
106 message
['From'] = from_addr
107 message
['To'] = ', '.join(to_addrs
)
109 if common
.TESTS_ENABLED
:
110 EMAIL_TEST_INBOX
.append(message
)
112 if mg_globals
.app_config
['email_debug_mode']:
113 print u
"===== Email ====="
114 print u
"From address: %s" % message
['From']
115 print u
"To addresses: %s" % message
['To']
116 print u
"Subject: %s" % message
['Subject']
118 print message
.get_payload(decode
=True)
120 return mhost
.sendmail(from_addr
, to_addrs
, message
.as_string())