1 #!/usr/bin/env python 2 3 """ 4 Mail preparation support. 5 6 Copyright (C) 2014, 2015 Paul Boddie <paul@boddie.org.uk> 7 8 This program is free software; you can redistribute it and/or modify it under 9 the terms of the GNU General Public License as published by the Free Software 10 Foundation; either version 3 of the License, or (at your option) any later 11 version. 12 13 This program is distributed in the hope that it will be useful, but WITHOUT 14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 15 FOR A PARTICULAR PURPOSE. See the GNU General Public License for more 16 details. 17 18 You should have received a copy of the GNU General Public License along with 19 this program. If not, see <http://www.gnu.org/licenses/>. 20 """ 21 22 from imiptools.config import MESSAGE_SENDER, OUTGOING_PREFIX 23 from email.mime.message import MIMEMessage 24 from email.mime.multipart import MIMEMultipart 25 from email.mime.text import MIMEText 26 from smtplib import LMTP, SMTP 27 28 MESSAGE_SUBJECT = "Calendar system message" 29 30 MESSAGE_TEXT = """\ 31 This is a message from the calendar system. 32 """ 33 34 PREAMBLE_TEXT = """\ 35 This message contains several different parts, one of which will contain 36 calendar information that will only be understood by a suitable program. 37 """ 38 39 class Messenger: 40 41 "Sending of outgoing messages." 42 43 def __init__(self, lmtp_socket=None, sender=None, subject=None, body_text=None, preamble_text=None): 44 45 """ 46 Deliver to a local mail system using LMTP if 'lmtp_socket' is provided. 47 """ 48 49 self.lmtp_socket = lmtp_socket 50 self.sender = sender or MESSAGE_SENDER 51 self.subject = subject or MESSAGE_SUBJECT 52 self.body_text = body_text or MESSAGE_TEXT 53 self.preamble_text = preamble_text or PREAMBLE_TEXT 54 55 def local_delivery(self): 56 57 "Return whether local delivery is performed using this messenger." 58 59 return self.lmtp_socket is not None 60 61 def sendmail(self, recipients, data, sender=None, outgoing_bcc=None, lmtp_socket=None): 62 63 """ 64 Send a mail to the given 'recipients' consisting of the given 'data', 65 using the given 'sender' identity if indicated, indicating an 66 'outgoing_bcc' identity if indicated. 67 68 The 'outgoing_bcc' argument is required when sending on behalf of a user 69 from the calendar@domain address, since this will not be detected as a 70 valid participant and handled using the outgoing transport. 71 """ 72 73 if self.lmtp_socket: 74 smtp = LMTP(self.lmtp_socket) 75 else: 76 smtp = SMTP("localhost") 77 78 if outgoing_bcc: 79 recipients = list(recipients) + ["%s+%s" % (OUTGOING_PREFIX, outgoing_bcc)] 80 81 smtp.sendmail(sender or self.sender, recipients, data) 82 smtp.quit() 83 84 def make_outgoing_message(self, parts, recipients, sender=None, outgoing_bcc=None): 85 86 """ 87 Make a message from the given 'parts' for the given 'recipients', using 88 the given 'sender' identity if indicated, indicating an 'outgoing_bcc' 89 identity if indicated. 90 """ 91 92 message = self._make_summary_for_parts(parts) 93 94 message["From"] = sender or self.sender 95 for recipient in recipients: 96 message["To"] = recipient 97 if outgoing_bcc: 98 message["Bcc"] = "%s+%s" % (OUTGOING_PREFIX, outgoing_bcc) 99 message["Subject"] = self.subject 100 101 return message 102 103 def make_summary_message(self, msg, parts): 104 105 """ 106 Return a simple summary using details from 'msg' and the given 'parts'. 107 """ 108 109 message = self._make_summary_for_parts(parts) 110 self._copy_headers(message, msg) 111 return message 112 113 def wrap_message(self, msg, parts): 114 115 "Wrap 'msg' and provide the given 'parts' as the primary content." 116 117 message = self._make_container_for_parts(parts) 118 payload = message.get_payload() 119 payload.append(MIMEMessage(msg)) 120 self._copy_headers(message, msg) 121 return message 122 123 def _make_summary_for_parts(self, parts): 124 125 "Return a simple summary for the given 'parts'." 126 127 if len(parts) == 1: 128 return parts[0] 129 else: 130 return self._make_container_for_parts(parts) 131 132 def _make_container_for_parts(self, parts): 133 134 "Return a container for the given 'parts'." 135 136 message = MIMEMultipart("mixed", _subparts=parts) 137 message.preamble = self.preamble_text 138 return message 139 140 def _copy_headers(self, message, msg): 141 message["From"] = msg["From"] 142 message["To"] = msg["To"] 143 message["Subject"] = msg["Subject"] 144 145 # vim: tabstop=4 expandtab shiftwidth=4