mail.py
233 lines
| 8.4 KiB
| text/x-python
|
PythonLexer
/ mercurial / mail.py
|
r2889 | # mail.py - mail sending bits for mercurial | ||
# | ||||
# Copyright 2006 Matt Mackall <mpm@selenic.com> | ||||
# | ||||
|
r8225 | # This software may be used and distributed according to the terms of the | ||
|
r10263 | # GNU General Public License version 2 or any later version. | ||
|
r2889 | |||
|
r3891 | from i18n import _ | ||
|
r8312 | import util, encoding | ||
|
r8332 | import os, smtplib, socket, quopri | ||
|
r7114 | import email.Header, email.MIMEText, email.Utils | ||
|
r2889 | |||
|
r11542 | _oldheaderinit = email.Header.Header.__init__ | ||
def _unifiedheaderinit(self, *args, **kw): | ||||
""" | ||||
Python2.7 introduces a backwards incompatible change | ||||
(Python issue1974, r70772) in email.Generator.Generator code: | ||||
pre-2.7 code passed "continuation_ws='\t'" to the Header | ||||
constructor, and 2.7 removed this parameter. | ||||
Default argument is continuation_ws=' ', which means that the | ||||
behaviour is different in <2.7 and 2.7 | ||||
We consider the 2.7 behaviour to be preferable, but need | ||||
to have an unified behaviour for versions 2.4 to 2.7 | ||||
""" | ||||
# override continuation_ws | ||||
kw['continuation_ws'] = ' ' | ||||
_oldheaderinit(self, *args, **kw) | ||||
email.Header.Header.__dict__['__init__'] = _unifiedheaderinit | ||||
|
r2889 | def _smtp(ui): | ||
|
r5973 | '''build an smtp connection and return a function to send mail''' | ||
|
r2889 | local_hostname = ui.config('smtp', 'local_hostname') | ||
|
r13244 | tls = ui.config('smtp', 'tls', 'none') | ||
|
r13201 | # backward compatible: when tls = true, we use starttls. | ||
starttls = tls == 'starttls' or util.parsebool(tls) | ||||
smtps = tls == 'smtps' | ||||
|
r14965 | if (starttls or smtps) and not util.safehasattr(socket, 'ssl'): | ||
|
r13201 | raise util.Abort(_("can't use TLS: Python SSL support not installed")) | ||
if smtps: | ||||
ui.note(_('(using smtps)\n')) | ||||
s = smtplib.SMTP_SSL(local_hostname=local_hostname) | ||||
else: | ||||
s = smtplib.SMTP(local_hostname=local_hostname) | ||||
|
r2889 | mailhost = ui.config('smtp', 'host') | ||
if not mailhost: | ||||
|
r12090 | raise util.Abort(_('smtp.host not configured - cannot send mail')) | ||
|
r12076 | mailport = util.getport(ui.config('smtp', 'port', 25)) | ||
|
r2964 | ui.note(_('sending mail: smtp host %s, port %s\n') % | ||
(mailhost, mailport)) | ||||
|
r2889 | s.connect(host=mailhost, port=mailport) | ||
|
r13201 | if starttls: | ||
ui.note(_('(using starttls)\n')) | ||||
|
r2889 | s.ehlo() | ||
s.starttls() | ||||
s.ehlo() | ||||
username = ui.config('smtp', 'username') | ||||
password = ui.config('smtp', 'password') | ||||
|
r5749 | if username and not password: | ||
password = ui.getpass() | ||||
|
r2889 | if username and password: | ||
ui.note(_('(authenticating to mail server as %s)\n') % | ||||
(username)) | ||||
|
r9246 | try: | ||
s.login(username, password) | ||||
except smtplib.SMTPException, inst: | ||||
raise util.Abort(inst) | ||||
|
r2889 | |||
|
r5973 | def send(sender, recipients, msg): | ||
try: | ||||
return s.sendmail(sender, recipients, msg) | ||||
except smtplib.SMTPRecipientsRefused, inst: | ||||
recipients = [r[1] for r in inst.recipients.values()] | ||||
raise util.Abort('\n' + '\n'.join(recipients)) | ||||
except smtplib.SMTPException, inst: | ||||
raise util.Abort(inst) | ||||
|
r5947 | |||
|
r5973 | return send | ||
|
r5947 | |||
|
r5973 | def _sendmail(ui, sender, recipients, msg): | ||
'''send mail using sendmail.''' | ||||
program = ui.config('email', 'method') | ||||
|
r5975 | cmdline = '%s -f %s %s' % (program, util.email(sender), | ||
' '.join(map(util.email, recipients))) | ||||
|
r5973 | ui.note(_('sending mail: %s\n') % cmdline) | ||
|
r6548 | fp = util.popen(cmdline, 'w') | ||
|
r5973 | fp.write(msg) | ||
ret = fp.close() | ||||
if ret: | ||||
raise util.Abort('%s %s' % ( | ||||
os.path.basename(program.split(None, 1)[0]), | ||||
|
r14234 | util.explainexit(ret)[0])) | ||
|
r2889 | |||
def connect(ui): | ||||
|
r5973 | '''make a mail connection. return a function to send mail. | ||
|
r2889 | call as sendmail(sender, list-of-recipients, msg).''' | ||
|
r5973 | if ui.config('email', 'method', 'smtp') == 'smtp': | ||
|
r5947 | return _smtp(ui) | ||
|
r5973 | return lambda s, r, m: _sendmail(ui, s, r, m) | ||
|
r2889 | |||
def sendmail(ui, sender, recipients, msg): | ||||
|
r5973 | send = connect(ui) | ||
return send(sender, recipients, msg) | ||||
|
r4489 | |||
def validateconfig(ui): | ||||
'''determine if we have enough config data to try sending email.''' | ||||
method = ui.config('email', 'method', 'smtp') | ||||
if method == 'smtp': | ||||
if not ui.config('smtp', 'host'): | ||||
raise util.Abort(_('smtp specified as email transport, ' | ||||
'but no smtp host configured')) | ||||
else: | ||||
|
r14271 | if not util.findexe(method): | ||
|
r4489 | raise util.Abort(_('%r specified as email transport, ' | ||
'but not in PATH') % method) | ||||
|
r7114 | |||
|
r7191 | def mimetextpatch(s, subtype='plain', display=False): | ||
'''If patch in utf-8 transfer-encode it.''' | ||||
|
r8332 | |||
enc = None | ||||
for line in s.splitlines(): | ||||
if len(line) > 950: | ||||
s = quopri.encodestring(s) | ||||
enc = "quoted-printable" | ||||
break | ||||
cs = 'us-ascii' | ||||
|
r7191 | if not display: | ||
|
r8332 | try: | ||
s.decode('us-ascii') | ||||
except UnicodeDecodeError: | ||||
|
r7191 | try: | ||
|
r8332 | s.decode('utf-8') | ||
cs = 'utf-8' | ||||
|
r7191 | except UnicodeDecodeError: | ||
|
r8332 | # We'll go with us-ascii as a fallback. | ||
|
r7191 | pass | ||
|
r8332 | |||
msg = email.MIMEText.MIMEText(s, subtype, cs) | ||||
if enc: | ||||
del msg['Content-Transfer-Encoding'] | ||||
msg['Content-Transfer-Encoding'] = enc | ||||
return msg | ||||
|
r7191 | |||
|
r7114 | def _charsets(ui): | ||
'''Obtains charsets to send mail parts not containing patches.''' | ||||
charsets = [cs.lower() for cs in ui.configlist('email', 'charsets')] | ||||
|
r7948 | fallbacks = [encoding.fallbackencoding.lower(), | ||
encoding.encoding.lower(), 'utf-8'] | ||||
|
r8343 | for cs in fallbacks: # find unique charsets while keeping order | ||
|
r7114 | if cs not in charsets: | ||
charsets.append(cs) | ||||
return [cs for cs in charsets if not cs.endswith('ascii')] | ||||
def _encode(ui, s, charsets): | ||||
'''Returns (converted) string, charset tuple. | ||||
Finds out best charset by cycling through sendcharsets in descending | ||||
|
r7948 | order. Tries both encoding and fallbackencoding for input. Only as | ||
|
r7114 | last resort send as is in fake ascii. | ||
Caveat: Do not use for mail parts containing patches!''' | ||||
try: | ||||
s.decode('ascii') | ||||
except UnicodeDecodeError: | ||||
sendcharsets = charsets or _charsets(ui) | ||||
|
r7948 | for ics in (encoding.encoding, encoding.fallbackencoding): | ||
|
r7114 | try: | ||
u = s.decode(ics) | ||||
except UnicodeDecodeError: | ||||
continue | ||||
for ocs in sendcharsets: | ||||
try: | ||||
return u.encode(ocs), ocs | ||||
except UnicodeEncodeError: | ||||
pass | ||||
except LookupError: | ||||
|
r7195 | ui.warn(_('ignoring invalid sendcharset: %s\n') % ocs) | ||
|
r7114 | # if ascii, or all conversion attempts fail, send (broken) ascii | ||
return s, 'us-ascii' | ||||
def headencode(ui, s, charsets=None, display=False): | ||||
'''Returns RFC-2047 compliant header from given string.''' | ||||
if not display: | ||||
# split into words? | ||||
s, cs = _encode(ui, s, charsets) | ||||
return str(email.Header.Header(s, cs)) | ||||
return s | ||||
|
r9948 | def _addressencode(ui, name, addr, charsets=None): | ||
|
r7114 | name = headencode(ui, name, charsets) | ||
try: | ||||
acc, dom = addr.split('@') | ||||
acc = acc.encode('ascii') | ||||
|
r9715 | dom = dom.decode(encoding.encoding).encode('idna') | ||
|
r7114 | addr = '%s@%s' % (acc, dom) | ||
except UnicodeDecodeError: | ||||
raise util.Abort(_('invalid email address: %s') % addr) | ||||
except ValueError: | ||||
try: | ||||
# too strict? | ||||
addr = addr.encode('ascii') | ||||
except UnicodeDecodeError: | ||||
raise util.Abort(_('invalid local address: %s') % addr) | ||||
return email.Utils.formataddr((name, addr)) | ||||
|
r9948 | def addressencode(ui, address, charsets=None, display=False): | ||
'''Turns address into RFC-2047 compliant header.''' | ||||
if display or not address: | ||||
return address or '' | ||||
name, addr = email.Utils.parseaddr(address) | ||||
return _addressencode(ui, name, addr, charsets) | ||||
def addrlistencode(ui, addrs, charsets=None, display=False): | ||||
'''Turns a list of addresses into a list of RFC-2047 compliant headers. | ||||
A single element of input list may contain multiple addresses, but output | ||||
always has one address per item''' | ||||
if display: | ||||
return [a.strip() for a in addrs if a.strip()] | ||||
result = [] | ||||
for name, addr in email.Utils.getaddresses(addrs): | ||||
if name or addr: | ||||
result.append(_addressencode(ui, name, addr, charsets)) | ||||
return result | ||||
|
r7114 | def mimeencode(ui, s, charsets=None, display=False): | ||
'''creates mime text object, encodes it if needed, and sets | ||||
charset and transfer-encoding accordingly.''' | ||||
cs = 'us-ascii' | ||||
if not display: | ||||
s, cs = _encode(ui, s, charsets) | ||||
return email.MIMEText.MIMEText(s, 'plain', cs) | ||||