summaryrefslogtreecommitdiff
path: root/sandbox/py-rest-doc/sphinx/web/mail.py
blob: 631ead6728a9f9e496e4df1f80d643d4bd7ae1bb (plain)
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
# -*- coding: utf-8 -*-
"""
    sphinx.web.mail
    ~~~~~~~~~~~~~~~

    A simple module for sending e-mails, based on simplemail.py.

    :copyright: 2004-2007 by Gerold Penz.
                2007 by Georg Brandl.
    :license: Python license.
"""

import os.path
import sys
import time
import smtplib
import mimetypes

from email import Encoders
from email.Header import Header
from email.MIMEText import MIMEText
from email.MIMEMultipart import MIMEMultipart
from email.Utils import formataddr
from email.Utils import formatdate
from email.Message import Message
from email.MIMEAudio import MIMEAudio
from email.MIMEBase import MIMEBase
from email.MIMEImage import MIMEImage



# Exceptions
#----------------------------------------------------------------------
class SimpleMail_Exception(Exception):
    def __str__(self):
        return self.__doc__

class NoFromAddress_Exception(SimpleMail_Exception):
    pass

class NoToAddress_Exception(SimpleMail_Exception):
    pass

class NoSubject_Exception(SimpleMail_Exception):
    pass

class AttachmentNotFound_Exception(SimpleMail_Exception):
    pass


class Attachments(object):
    def __init__(self):
        self._attachments = []

    def add_filename(self, filename = ''):
        self._attachments.append(('file', filename))

    def add_string(self, filename, text, mimetype):
        self._attachments.append(('string', (filename, text, mimetype)))

    def count(self):
        return len(self._attachments)

    def get_list(self):
        return self._attachments


class Recipients(object):
    def __init__(self):
        self._recipients = []

    def add(self, address, caption = ''):
        self._recipients.append(formataddr((caption, address)))

    def count(self):
        return len(self._recipients)

    def __repr__(self):
        return str(self._recipients)

    def get_list(self):
        return self._recipients


class CCRecipients(Recipients):
    pass


class BCCRecipients(Recipients):
    pass


class Email(object):

    def __init__(
        self,
        from_address = "",
        from_caption = "",
        to_address = "",
        to_caption = "",
        subject = "",
        message = "",
        smtp_server = "localhost",
        smtp_user = "",
        smtp_password = "",
        user_agent = "",
        reply_to_address = "",
        reply_to_caption = "",
        use_tls = False,
    ):
        """
        Initialize the email object
            from_address     = the email address of the sender
            from_caption     = the caption (name) of the sender
            to_address       = the email address of the recipient
            to_caption       = the caption (name) of the recipient
            subject          = the subject of the email message
            message          = the body text of the email message
            smtp_server      = the ip-address or the name of the SMTP-server
            smtp_user        = (optional) Login name for the SMTP-Server
            smtp_password    = (optional) Password for the SMTP-Server
            user_agent       = (optional) program identification
            reply_to_address = (optional) Reply-to email address
            reply_to_caption = (optional) Reply-to caption (name)
            use_tls          = (optional) True, if the connection should use TLS
                               to encrypt.
        """

        self.from_address = from_address
        self.from_caption = from_caption
        self.recipients = Recipients()
        self.cc_recipients = CCRecipients()
        self.bcc_recipients = BCCRecipients()
        if to_address:
            self.recipients.add(to_address, to_caption)
        self.subject = subject
        self.message = message
        self.smtp_server = smtp_server
        self.smtp_user = smtp_user
        self.smtp_password = smtp_password
        self.attachments = Attachments()
        self.content_subtype = "plain"
        self.content_charset = "iso-8859-1"
        self.header_charset = "us-ascii"
        self.statusdict = None
        self.user_agent = user_agent
        self.reply_to_address = reply_to_address
        self.reply_to_caption = reply_to_caption
        self.use_tls = use_tls


    def send(self):
        """
        Send the mail. Returns True if successfully sent to at least one
        recipient.
        """

        # validation
        if len(self.from_address.strip()) == 0:
            raise NoFromAddress_Exception
        if self.recipients.count() == 0:
            if (
                (self.cc_recipients.count() == 0) and
                (self.bcc_recipients.count() == 0)
            ):
                raise NoToAddress_Exception
        if len(self.subject.strip()) == 0:
            raise NoSubject_Exception

        # assemble
        if self.attachments.count() == 0:
            msg = MIMEText(
                _text = self.message,
                _subtype = self.content_subtype,
                _charset = self.content_charset
            )
        else:
            msg = MIMEMultipart()
            if self.message:
                att = MIMEText(
                    _text = self.message,
                    _subtype = self.content_subtype,
                    _charset = self.content_charset
                )
                msg.attach(att)

        # add headers
        from_str = formataddr((self.from_caption, self.from_address))
        msg["From"] = from_str
        if self.reply_to_address:
            reply_to_str = formataddr((self.reply_to_caption, self.reply_to_address))
            msg["Reply-To"] = reply_to_str
        if self.recipients.count() > 0:
            msg["To"] = ", ".join(self.recipients.get_list())
        if self.cc_recipients.count() > 0:
            msg["Cc"] = ", ".join(self.cc_recipients.get_list())
        msg["Date"] = formatdate(time.time())
        msg["User-Agent"] = self.user_agent
        try:
            msg["Subject"] = Header(
                self.subject, self.header_charset
            )
        except(UnicodeDecodeError):
            msg["Subject"] = Header(
                self.subject, self.content_charset
            )
        msg.preamble = "You will not see this in a MIME-aware mail reader.\n"
        msg.epilogue = ""

        # assemble multipart
        if self.attachments.count() > 0:
            for typ, info in self.attachments.get_list():
                if typ == 'file':
                    filename = info
                    if not os.path.isfile(filename):
                        raise AttachmentNotFound_Exception, filename
                    mimetype, encoding = mimetypes.guess_type(filename)
                    if mimetype is None or encoding is not None:
                        mimetype = 'application/octet-stream'
                    if mimetype.startswith('text/'):
                        fp = file(filename)
                    else:
                        fp = file(filename, 'rb')
                    text = fp.read()
                    fp.close()
                else:
                    filename, text, mimetype = info
                maintype, subtype = mimetype.split('/', 1)
                if maintype == 'text':
                    # Note: we should handle calculating the charset
                    att = MIMEText(text, _subtype=subtype)
                elif maintype == 'image':
                    att = MIMEImage(text, _subtype=subtype)
                elif maintype == 'audio':
                    att = MIMEAudio(text, _subtype=subtype)
                else:
                    att = MIMEBase(maintype, subtype)
                    att.set_payload(text)
                    # Encode the payload using Base64
                    Encoders.encode_base64(att)
                # Set the filename parameter
                att.add_header(
                    'Content-Disposition',
                    'attachment',
                    filename = os.path.basename(filename).strip()
                )
                msg.attach(att)

        # connect to server
        smtp = smtplib.SMTP()
        if self.smtp_server:
            smtp.connect(self.smtp_server)
        else:
            smtp.connect()

        # TLS?
        if self.use_tls:
            smtp.ehlo()
            smtp.starttls()
            smtp.ehlo()

        # authenticate
        if self.smtp_user:
            smtp.login(user = self.smtp_user, password = self.smtp_password)

        # send
        self.statusdict = smtp.sendmail(
            from_str,
            (
                self.recipients.get_list() +
                self.cc_recipients.get_list() +
                self.bcc_recipients.get_list()
            ),
            msg.as_string()
        )
        smtp.close()

        return True