/usr/lib/python3/dist-packages/cement/ext/ext_smtp.py is in python3-cement 2.10.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 | """
The SMTP Extension provides the ability for applications to send email based
on the `smtplib <http://docs.python.org/dev/library/smtplib.html>`_ standard
library.
Requirements
------------
* No external depencies
Configuration
-------------
This extension honors the following configuration settings:
* **to** - Default ``to`` addresses (list, or comma separated depending
on the ConfigHandler in use)
* **from_addr** - Default ``from_addr`` address
* **cc** - Default ``cc`` addresses (list, or comma separated depending
on the ConfigHandler in use)
* **bcc** - Default ``bcc`` addresses (list, or comma separated depending
on the ConfigHandler in use)
* **subject** - Default ``subject``
* **subject_prefix** - Additional string to prepend to the ``subject``
* **host** - The SMTP host server
* **port** - The SMTP host server port
* **timeout** - The timeout in seconds before terminating a connection
* **ssl** - Whether to initiate SSL or not
* **tls** - Whether to use TLS or not (requires SSL)
* **auth** - Whether or not to initiate SMTP authentication
* **username** - SMTP authentication username
* **password** - SMTP authentication password
You can add these to any application configuration file under a
``[mail.smtp]`` section, for example:
**~/.myapp.conf**
.. code-block:: text
[myapp]
# set the mail handler to use
mail_handler = smtp
[mail.smtp]
# default to addresses (comma separated list)
to = me@example.com
# default from address
from = someone_else@example.com
# default cc addresses (comma separated list)
cc = jane@example.com, rita@example.com
# default bcc addresses (comma separated list)
bcc = blackhole@example.com, someone_else@example.com
# default subject
subject = This is The Default Subject
# additional prefix to prepend to the subject
subject_prefix = MY PREFIX >
# smtp host server
host = localhost
# smtp host port
port = 465
# timeout in seconds
timeout = 30
# whether or not to establish an ssl connection
ssl = 1
# whether or not to use start tls
tls = 1
# whether or not to initiate smtp auth
auth = 1
# smtp auth username
username = john.doe
# smtp auth password
password = oober_secure_password
Usage
-----
.. code-block:: python
class MyApp(CementApp):
class Meta:
label = 'myapp'
mail_handler = 'smtp'
with MyApp() as app:
app.mail.send('This is my fake message',
subject='This is my subject',
to=['john@example.com', 'rita@example.com'],
from_addr='me@example.com',
)
"""
import sys
import smtplib
from email.header import Header
from email.mime.multipart import MIMEMultipart
from email.mime.text import MIMEText
from ..core import mail
from ..utils.misc import minimal_logger, is_true
LOG = minimal_logger(__name__)
class SMTPMailHandler(mail.CementMailHandler):
"""
This class implements the :ref:`IMail <cement.core.mail>`
interface, and is based on the `smtplib
<http://docs.python.org/dev/library/smtplib.html>`_ standard library.
"""
class Meta:
"""Handler meta-data."""
#: Unique identifier for this handler
label = 'smtp'
#: Configuration default values
config_defaults = {
'to': [],
'from_addr': 'noreply@localhost',
'cc': [],
'bcc': [],
'subject': None,
'subject_prefix': None,
'host': 'localhost',
'port': '25',
'timeout': 30,
'ssl': False,
'tls': False,
'auth': False,
'username': None,
'password': None,
}
def _get_params(self, **kw):
params = dict()
# some keyword args override configuration defaults
for item in ['to', 'from_addr', 'cc', 'bcc', 'subject']:
config_item = self.app.config.get(self._meta.config_section, item)
params[item] = kw.get(item, config_item)
# others don't
other_params = ['ssl', 'tls', 'host', 'port', 'auth', 'username',
'password', 'timeout']
for item in other_params:
params[item] = self.app.config.get(self._meta.config_section,
item)
# also grab the subject_prefix
params['subject_prefix'] = self.app.config.get(
self._meta.config_section,
'subject_prefix'
)
return params
def send(self, body, **kw):
"""
Send an email message via SMTP. Keyword arguments override
configuration defaults (cc, bcc, etc).
:param body: The message body to send
:type body: ``multiline string``
:keyword to: List of recipients (generally email addresses)
:type to: ``list``
:keyword from_addr: Address (generally email) of the sender
:type from_addr: ``str``
:keyword cc: List of CC Recipients
:type cc: ``list``
:keyword bcc: List of BCC Recipients
:type bcc: ``list``
:keyword subject: Message subject line
:type subject: ``str``
:returns: Boolean (``True`` if message is sent successfully, ``False``
otherwise)
**Usage**
.. code-block:: python
# Using all configuration defaults
app.mail.send('This is my message body')
# Overriding configuration defaults
app.mail.send('My message body'
from_addr='me@example.com',
to=['john@example.com'],
cc=['jane@example.com', 'rita@example.com'],
subject='This is my subject',
)
"""
params = self._get_params(**kw)
if is_true(params['ssl']):
server = smtplib.SMTP_SSL(params['host'], params['port'],
params['timeout'])
LOG.debug("%s : initiating ssl" % self._meta.label)
if is_true(params['tls']):
LOG.debug("%s : initiating tls" % self._meta.label)
server.starttls()
else:
server = smtplib.SMTP(params['host'], params['port'],
params['timeout'])
if is_true(params['auth']):
server.login(params['username'], params['password'])
if self.app.debug is True:
server.set_debuglevel(9)
if int(sys.version[0]) >= 3:
self._send_message(server, body, **params)
else: # pragma: nocover
self._send_message_py2(server, body, **params)
server.quit()
def _send_message(self, server, body, **params):
msg = MIMEMultipart('alternative')
msg.set_charset('utf-8')
msg['From'] = params['from_addr']
msg['To'] = ', '.join(params['to'])
msg['Cc'] = ', '.join(params['cc'])
msg['Bcc'] = ', '.join(params['bcc'])
if params['subject_prefix'] not in [None, '']:
subject = '%s %s' % (params['subject_prefix'],
params['subject'])
else:
subject = params['subject']
msg['Subject'] = Header(subject)
part = MIMEText(body)
msg.attach(part)
server.send_message(msg)
def _send_message_py2(self, server, body, **params): # pragma: nocover
msg = ""
msg += "From: %s\r\nTo: %s\r\n" % (params['from_addr'],
', '.join(params['to']))
msg += "Cc: %s\r\n" % ', '.join(params['cc'])
msg += "Bcc: %s\r\n" % ', '.join(params['bcc'])
if params['subject_prefix'] not in [None, '']:
msg += "Subject: %s %s\r\n\r\n" % (params['subject_prefix'],
params['subject'])
else:
msg += "Subject: %s\r\n\r\n" % params['subject']
msg += body + "\n"
server.sendmail(params['from_addr'],
params['to'] + params['cc'] + params['bcc'],
msg)
def load(app):
app.handler.register(SMTPMailHandler)
|