← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/mail_client.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2007-08-28 08:23:40 UTC
  • mfrom: (2757.1.1 ianc-integration)
  • Revision ID: pqm@pqm.ubuntu.com-20070828082340-2byilw23kzl3cjx4
(Daniel Watkins) Better explanation of -r in uncommit help

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/mail_client.py
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
import errno
18
18
import os
19
19
import subprocess
20
20
import sys
21
21
import tempfile
22
 
import urllib
23
22
 
24
 
import bzrlib
25
23
from bzrlib import (
26
24
    email_message,
27
25
    errors,
28
26
    msgeditor,
29
27
    osutils,
30
28
    urlutils,
31
 
    registry
32
29
    )
33
30
 
34
 
mail_client_registry = registry.Registry()
35
 
 
36
31
 
37
32
class MailClient(object):
38
33
    """A mail client that can send messages with attachements."""
41
36
        self.config = config
42
37
 
43
38
    def compose(self, prompt, to, subject, attachment, mime_subtype,
44
 
                extension, basename=None, body=None):
 
39
                extension):
45
40
        """Compose (and possibly send) an email message
46
41
 
47
42
        Must be implemented by subclasses.
56
51
            "plain", "x-patch", etc.
57
52
        :param extension: The file extension associated with the attachment
58
53
            type, e.g. ".patch"
59
 
        :param basename: The name to use for the attachment, e.g.
60
 
            "send-nick-3252"
61
54
        """
62
55
        raise NotImplementedError
63
56
 
64
 
    def compose_merge_request(self, to, subject, directive, basename=None,
65
 
                              body=None):
 
57
    def compose_merge_request(self, to, subject, directive):
66
58
        """Compose (and possibly send) a merge request
67
59
 
68
60
        :param to: The address to send the request to
69
61
        :param subject: The subject line to use for the request
70
62
        :param directive: A merge directive representing the merge request, as
71
63
            a bytestring.
72
 
        :param basename: The name to use for the attachment, e.g.
73
 
            "send-nick-3252"
74
64
        """
75
65
        prompt = self._get_merge_prompt("Please describe these changes:", to,
76
66
                                        subject, directive)
77
67
        self.compose(prompt, to, subject, directive,
78
 
            'x-patch', '.patch', basename, body)
 
68
            'x-patch', '.patch')
79
69
 
80
70
    def _get_merge_prompt(self, prompt, to, subject, attachment):
81
71
        """Generate a prompt string.  Overridden by Editor.
91
81
class Editor(MailClient):
92
82
    """DIY mail client that uses commit message editor"""
93
83
 
94
 
    supports_body = True
95
 
 
96
84
    def _get_merge_prompt(self, prompt, to, subject, attachment):
97
85
        """See MailClient._get_merge_prompt"""
98
86
        return (u"%s\n\n"
102
90
                         attachment.decode('utf-8', 'replace')))
103
91
 
104
92
    def compose(self, prompt, to, subject, attachment, mime_subtype,
105
 
                extension, basename=None, body=None):
 
93
                extension):
106
94
        """See MailClient.compose"""
107
 
        if not to:
108
 
            raise errors.NoMailAddressSpecified()
109
 
        body = msgeditor.edit_commit_message(prompt, start_message=body)
 
95
        body = msgeditor.edit_commit_message(prompt)
110
96
        if body == '':
111
97
            raise errors.NoMessageSupplied()
112
98
        email_message.EmailMessage.send(self.config,
116
102
                                        body,
117
103
                                        attachment,
118
104
                                        attachment_mime_subtype=mime_subtype)
119
 
mail_client_registry.register('editor', Editor,
120
 
                              help=Editor.__doc__)
121
 
 
122
 
 
123
 
class BodyExternalMailClient(MailClient):
124
 
 
125
 
    supports_body = True
 
105
 
 
106
 
 
107
class ExternalMailClient(MailClient):
 
108
    """An external mail client."""
126
109
 
127
110
    def _get_client_commands(self):
128
111
        """Provide a list of commands that may invoke the mail client"""
133
116
            return self._client_commands
134
117
 
135
118
    def compose(self, prompt, to, subject, attachment, mime_subtype,
136
 
                extension, basename=None, body=None):
 
119
                extension):
137
120
        """See MailClient.compose.
138
121
 
139
122
        Writes the attachment to a temporary file, invokes _compose.
140
123
        """
141
 
        if basename is None:
142
 
            basename = 'attachment'
143
 
        pathname = osutils.mkdtemp(prefix='bzr-mail-')
144
 
        attach_path = osutils.pathjoin(pathname, basename + extension)
145
 
        outfile = open(attach_path, 'wb')
 
124
        fd, pathname = tempfile.mkstemp(extension, 'bzr-mail-')
146
125
        try:
147
 
            outfile.write(attachment)
 
126
            os.write(fd, attachment)
148
127
        finally:
149
 
            outfile.close()
150
 
        if body is not None:
151
 
            kwargs = {'body': body}
152
 
        else:
153
 
            kwargs = {}
154
 
        self._compose(prompt, to, subject, attach_path, mime_subtype,
155
 
                      extension, **kwargs)
 
128
            os.close(fd)
 
129
        self._compose(prompt, to, subject, pathname, mime_subtype, extension)
156
130
 
157
131
    def _compose(self, prompt, to, subject, attach_path, mime_subtype,
158
 
                 extension, body=None, from_=None):
 
132
                extension):
159
133
        """Invoke a mail client as a commandline process.
160
134
 
161
135
        Overridden by MAPIClient.
166
140
            "text", but the precise subtype can be specified here
167
141
        :param extension: A file extension (including period) associated with
168
142
            the attachment type.
169
 
        :param body: Optional body text.
170
 
        :param from_: Optional From: header.
171
143
        """
172
144
        for name in self._get_client_commands():
173
 
            cmdline = [self._encode_path(name, 'executable')]
174
 
            if body is not None:
175
 
                kwargs = {'body': body}
176
 
            else:
177
 
                kwargs = {}
178
 
            if from_ is not None:
179
 
                kwargs['from_'] = from_
 
145
            cmdline = [name]
180
146
            cmdline.extend(self._get_compose_commandline(to, subject,
181
 
                                                         attach_path,
182
 
                                                         **kwargs))
 
147
                                                         attach_path))
183
148
            try:
184
149
                subprocess.call(cmdline)
185
150
            except OSError, e:
190
155
        else:
191
156
            raise errors.MailClientNotFound(self._client_commands)
192
157
 
193
 
    def _get_compose_commandline(self, to, subject, attach_path, body):
 
158
    def _get_compose_commandline(self, to, subject, attach_path):
194
159
        """Determine the commandline to use for composing a message
195
160
 
196
161
        Implemented by various subclasses
200
165
        """
201
166
        raise NotImplementedError
202
167
 
203
 
    def _encode_safe(self, u):
204
 
        """Encode possible unicode string argument to 8-bit string
205
 
        in user_encoding. Unencodable characters will be replaced
206
 
        with '?'.
207
 
 
208
 
        :param  u:  possible unicode string.
209
 
        :return:    encoded string if u is unicode, u itself otherwise.
210
 
        """
211
 
        if isinstance(u, unicode):
212
 
            return u.encode(osutils.get_user_encoding(), 'replace')
213
 
        return u
214
 
 
215
 
    def _encode_path(self, path, kind):
216
 
        """Encode unicode path in user encoding.
217
 
 
218
 
        :param  path:   possible unicode path.
219
 
        :param  kind:   path kind ('executable' or 'attachment').
220
 
        :return:        encoded path if path is unicode,
221
 
                        path itself otherwise.
222
 
        :raise:         UnableEncodePath.
223
 
        """
224
 
        if isinstance(path, unicode):
225
 
            try:
226
 
                return path.encode(osutils.get_user_encoding())
227
 
            except UnicodeEncodeError:
228
 
                raise errors.UnableEncodePath(path, kind)
229
 
        return path
230
 
 
231
 
 
232
 
class ExternalMailClient(BodyExternalMailClient):
233
 
    """An external mail client."""
234
 
 
235
 
    supports_body = False
236
 
 
237
 
 
238
 
class Evolution(BodyExternalMailClient):
 
168
 
 
169
class Evolution(ExternalMailClient):
239
170
    """Evolution mail client."""
240
171
 
241
172
    _client_commands = ['evolution']
242
173
 
243
 
    def _get_compose_commandline(self, to, subject, attach_path, body=None):
 
174
    def _get_compose_commandline(self, to, subject, attach_path):
244
175
        """See ExternalMailClient._get_compose_commandline"""
245
176
        message_options = {}
246
177
        if subject is not None:
247
178
            message_options['subject'] = subject
248
179
        if attach_path is not None:
249
180
            message_options['attach'] = attach_path
250
 
        if body is not None:
251
 
            message_options['body'] = body
252
181
        options_list = ['%s=%s' % (k, urlutils.escape(v)) for (k, v) in
253
 
                        sorted(message_options.iteritems())]
254
 
        return ['mailto:%s?%s' % (self._encode_safe(to or ''),
255
 
            '&'.join(options_list))]
256
 
mail_client_registry.register('evolution', Evolution,
257
 
                              help=Evolution.__doc__)
258
 
 
259
 
 
260
 
class Mutt(BodyExternalMailClient):
261
 
    """Mutt mail client."""
262
 
 
263
 
    _client_commands = ['mutt']
264
 
 
265
 
    def _get_compose_commandline(self, to, subject, attach_path, body=None):
266
 
        """See ExternalMailClient._get_compose_commandline"""
267
 
        message_options = []
268
 
        if subject is not None:
269
 
            message_options.extend(['-s', self._encode_safe(subject)])
270
 
        if attach_path is not None:
271
 
            message_options.extend(['-a',
272
 
                self._encode_path(attach_path, 'attachment')])
273
 
        if body is not None:
274
 
            # Store the temp file object in self, so that it does not get
275
 
            # garbage collected and delete the file before mutt can read it.
276
 
            self._temp_file = tempfile.NamedTemporaryFile(
277
 
                prefix="mutt-body-", suffix=".txt")
278
 
            self._temp_file.write(body)
279
 
            self._temp_file.flush()
280
 
            message_options.extend(['-i', self._temp_file.name])
281
 
        if to is not None:
282
 
            message_options.extend(['--', self._encode_safe(to)])
283
 
        return message_options
284
 
mail_client_registry.register('mutt', Mutt,
285
 
                              help=Mutt.__doc__)
286
 
 
287
 
 
288
 
class Thunderbird(BodyExternalMailClient):
 
182
                        message_options.iteritems()]
 
183
        return ['mailto:%s?%s' % (to or '', '&'.join(options_list))]
 
184
 
 
185
 
 
186
class Thunderbird(ExternalMailClient):
289
187
    """Mozilla Thunderbird (or Icedove)
290
188
 
291
189
    Note that Thunderbird 1.5 is buggy and does not support setting
296
194
    """
297
195
 
298
196
    _client_commands = ['thunderbird', 'mozilla-thunderbird', 'icedove',
299
 
        '/Applications/Mozilla/Thunderbird.app/Contents/MacOS/thunderbird-bin',
300
 
        '/Applications/Thunderbird.app/Contents/MacOS/thunderbird-bin']
 
197
        '/Applications/Mozilla/Thunderbird.app/Contents/MacOS/thunderbird-bin']
301
198
 
302
 
    def _get_compose_commandline(self, to, subject, attach_path, body=None):
 
199
    def _get_compose_commandline(self, to, subject, attach_path):
303
200
        """See ExternalMailClient._get_compose_commandline"""
304
201
        message_options = {}
305
202
        if to is not None:
306
 
            message_options['to'] = self._encode_safe(to)
 
203
            message_options['to'] = to
307
204
        if subject is not None:
308
 
            message_options['subject'] = self._encode_safe(subject)
 
205
            message_options['subject'] = subject
309
206
        if attach_path is not None:
310
207
            message_options['attachment'] = urlutils.local_path_to_url(
311
208
                attach_path)
312
 
        if body is not None:
313
 
            options_list = ['body=%s' % urllib.quote(self._encode_safe(body))]
314
 
        else:
315
 
            options_list = []
316
 
        options_list.extend(["%s='%s'" % (k, v) for k, v in
317
 
                        sorted(message_options.iteritems())])
 
209
        options_list = ["%s='%s'" % (k, v) for k, v in
 
210
                        sorted(message_options.iteritems())]
318
211
        return ['-compose', ','.join(options_list)]
319
 
mail_client_registry.register('thunderbird', Thunderbird,
320
 
                              help=Thunderbird.__doc__)
321
212
 
322
213
 
323
214
class KMail(ExternalMailClient):
329
220
        """See ExternalMailClient._get_compose_commandline"""
330
221
        message_options = []
331
222
        if subject is not None:
332
 
            message_options.extend(['-s', self._encode_safe(subject)])
 
223
            message_options.extend( ['-s', subject ] )
333
224
        if attach_path is not None:
334
 
            message_options.extend(['--attach',
335
 
                self._encode_path(attach_path, 'attachment')])
 
225
            message_options.extend( ['--attach', attach_path] )
336
226
        if to is not None:
337
 
            message_options.extend([self._encode_safe(to)])
338
 
        return message_options
339
 
mail_client_registry.register('kmail', KMail,
340
 
                              help=KMail.__doc__)
341
 
 
342
 
 
343
 
class Claws(ExternalMailClient):
344
 
    """Claws mail client."""
345
 
 
346
 
    supports_body = True
347
 
 
348
 
    _client_commands = ['claws-mail']
349
 
 
350
 
    def _get_compose_commandline(self, to, subject, attach_path, body=None,
351
 
                                 from_=None):
352
 
        """See ExternalMailClient._get_compose_commandline"""
353
 
        compose_url = []
354
 
        if from_ is not None:
355
 
            compose_url.append('from=' + urllib.quote(from_))
356
 
        if subject is not None:
357
 
            # Don't use urllib.quote_plus because Claws doesn't seem
358
 
            # to recognise spaces encoded as "+".
359
 
            compose_url.append(
360
 
                'subject=' + urllib.quote(self._encode_safe(subject)))
361
 
        if body is not None:
362
 
            compose_url.append(
363
 
                'body=' + urllib.quote(self._encode_safe(body)))
364
 
        # to must be supplied for the claws-mail --compose syntax to work.
365
 
        if to is None:
366
 
            raise errors.NoMailAddressSpecified()
367
 
        compose_url = 'mailto:%s?%s' % (
368
 
            self._encode_safe(to), '&'.join(compose_url))
369
 
        # Collect command-line options.
370
 
        message_options = ['--compose', compose_url]
371
 
        if attach_path is not None:
372
 
            message_options.extend(
373
 
                ['--attach', self._encode_path(attach_path, 'attachment')])
374
 
        return message_options
375
 
 
376
 
    def _compose(self, prompt, to, subject, attach_path, mime_subtype,
377
 
                 extension, body=None, from_=None):
378
 
        """See ExternalMailClient._compose"""
379
 
        if from_ is None:
380
 
            from_ = self.config.get_user_option('email')
381
 
        super(Claws, self)._compose(prompt, to, subject, attach_path,
382
 
                                    mime_subtype, extension, body, from_)
383
 
 
384
 
 
385
 
mail_client_registry.register('claws', Claws,
386
 
                              help=Claws.__doc__)
387
 
 
388
 
 
389
 
class XDGEmail(BodyExternalMailClient):
 
227
            message_options.extend( [ to ] )
 
228
 
 
229
        return message_options
 
230
 
 
231
 
 
232
class XDGEmail(ExternalMailClient):
390
233
    """xdg-email attempts to invoke the user's preferred mail client"""
391
234
 
392
235
    _client_commands = ['xdg-email']
393
236
 
394
 
    def _get_compose_commandline(self, to, subject, attach_path, body=None):
 
237
    def _get_compose_commandline(self, to, subject, attach_path):
395
238
        """See ExternalMailClient._get_compose_commandline"""
396
 
        if not to:
397
 
            raise errors.NoMailAddressSpecified()
398
 
        commandline = [self._encode_safe(to)]
399
 
        if subject is not None:
400
 
            commandline.extend(['--subject', self._encode_safe(subject)])
401
 
        if attach_path is not None:
402
 
            commandline.extend(['--attach',
403
 
                self._encode_path(attach_path, 'attachment')])
404
 
        if body is not None:
405
 
            commandline.extend(['--body', self._encode_safe(body)])
406
 
        return commandline
407
 
mail_client_registry.register('xdg-email', XDGEmail,
408
 
                              help=XDGEmail.__doc__)
409
 
 
410
 
 
411
 
class EmacsMail(ExternalMailClient):
412
 
    """Call emacsclient to have a mail buffer.
413
 
 
414
 
    This only work for emacs >= 22.1 due to recent -e/--eval support.
415
 
 
416
 
    The good news is that this implementation will work with all mail
417
 
    agents registered against ``mail-user-agent``. So there is no need
418
 
    to instantiate ExternalMailClient for each and every GNU Emacs
419
 
    MUA.
420
 
 
421
 
    Users just have to ensure that ``mail-user-agent`` is set according
422
 
    to their tastes.
423
 
    """
424
 
 
425
 
    _client_commands = ['emacsclient']
426
 
 
427
 
    def __init__(self, config):
428
 
        super(EmacsMail, self).__init__(config)
429
 
        self.elisp_tmp_file = None
430
 
 
431
 
    def _prepare_send_function(self):
432
 
        """Write our wrapper function into a temporary file.
433
 
 
434
 
        This temporary file will be loaded at runtime in
435
 
        _get_compose_commandline function.
436
 
 
437
 
        This function does not remove the file.  That's a wanted
438
 
        behaviour since _get_compose_commandline won't run the send
439
 
        mail function directly but return the eligible command line.
440
 
        Removing our temporary file here would prevent our sendmail
441
 
        function to work.  (The file is deleted by some elisp code
442
 
        after being read by Emacs.)
443
 
        """
444
 
 
445
 
        _defun = r"""(defun bzr-add-mime-att (file)
446
 
  "Attach FILE to a mail buffer as a MIME attachment."
447
 
  (let ((agent mail-user-agent))
448
 
    (if (and file (file-exists-p file))
449
 
        (cond
450
 
         ((eq agent 'sendmail-user-agent)
451
 
          (progn
452
 
            (mail-text)
453
 
            (newline)
454
 
            (if (functionp 'etach-attach)
455
 
              (etach-attach file)
456
 
              (mail-attach-file file))))
457
 
         ((or (eq agent 'message-user-agent)
458
 
              (eq agent 'gnus-user-agent)
459
 
              (eq agent 'mh-e-user-agent))
460
 
          (progn
461
 
            (mml-attach-file file "text/x-patch" "BZR merge" "inline")))
462
 
         ((eq agent 'mew-user-agent)
463
 
          (progn
464
 
            (mew-draft-prepare-attachments)
465
 
            (mew-attach-link file (file-name-nondirectory file))
466
 
            (let* ((nums (mew-syntax-nums))
467
 
                   (syntax (mew-syntax-get-entry mew-encode-syntax nums)))
468
 
              (mew-syntax-set-cd syntax "BZR merge")
469
 
              (mew-encode-syntax-print mew-encode-syntax))
470
 
            (mew-header-goto-body)))
471
 
         (t
472
 
          (message "Unhandled MUA, report it on bazaar@lists.canonical.com")))
473
 
      (error "File %s does not exist." file))))
474
 
"""
475
 
 
476
 
        fd, temp_file = tempfile.mkstemp(prefix="emacs-bzr-send-",
477
 
                                         suffix=".el")
478
 
        try:
479
 
            os.write(fd, _defun)
480
 
        finally:
481
 
            os.close(fd) # Just close the handle but do not remove the file.
482
 
        return temp_file
483
 
 
484
 
    def _get_compose_commandline(self, to, subject, attach_path):
485
 
        commandline = ["--eval"]
486
 
 
487
 
        _to = "nil"
488
 
        _subject = "nil"
489
 
 
490
 
        if to is not None:
491
 
            _to = ("\"%s\"" % self._encode_safe(to).replace('"', '\\"'))
492
 
        if subject is not None:
493
 
            _subject = ("\"%s\"" %
494
 
                        self._encode_safe(subject).replace('"', '\\"'))
495
 
 
496
 
        # Funcall the default mail composition function
497
 
        # This will work with any mail mode including default mail-mode
498
 
        # User must tweak mail-user-agent variable to tell what function
499
 
        # will be called inside compose-mail.
500
 
        mail_cmd = "(compose-mail %s %s)" % (_to, _subject)
501
 
        commandline.append(mail_cmd)
502
 
 
503
 
        # Try to attach a MIME attachment using our wrapper function
504
 
        if attach_path is not None:
505
 
            # Do not create a file if there is no attachment
506
 
            elisp = self._prepare_send_function()
507
 
            self.elisp_tmp_file = elisp
508
 
            lmmform = '(load "%s")' % elisp
509
 
            mmform  = '(bzr-add-mime-att "%s")' % \
510
 
                self._encode_path(attach_path, 'attachment')
511
 
            rmform = '(delete-file "%s")' % elisp
512
 
            commandline.append(lmmform)
513
 
            commandline.append(mmform)
514
 
            commandline.append(rmform)
515
 
 
516
 
        return commandline
517
 
mail_client_registry.register('emacsclient', EmacsMail,
518
 
                              help=EmacsMail.__doc__)
519
 
 
520
 
 
521
 
class MAPIClient(BodyExternalMailClient):
 
239
        commandline = [to]
 
240
        if subject is not None:
 
241
            commandline.extend(['--subject', subject])
 
242
        if attach_path is not None:
 
243
            commandline.extend(['--attach', attach_path])
 
244
        return commandline
 
245
 
 
246
 
 
247
class MAPIClient(ExternalMailClient):
522
248
    """Default Windows mail client launched using MAPI."""
523
249
 
524
250
    def _compose(self, prompt, to, subject, attach_path, mime_subtype,
525
 
                 extension, body=None):
 
251
                 extension):
526
252
        """See ExternalMailClient._compose.
527
253
 
528
254
        This implementation uses MAPI via the simplemapi ctypes wrapper
529
255
        """
530
256
        from bzrlib.util import simplemapi
531
257
        try:
532
 
            simplemapi.SendMail(to or '', subject or '', body or '',
533
 
                                attach_path)
 
258
            simplemapi.SendMail(to or '', subject or '', '', attach_path)
534
259
        except simplemapi.MAPIError, e:
535
260
            if e.code != simplemapi.MAPI_USER_ABORT:
536
261
                raise errors.MailClientNotFound(['MAPI supported mail client'
537
262
                                                 ' (error %d)' % (e.code,)])
538
 
mail_client_registry.register('mapi', MAPIClient,
539
 
                              help=MAPIClient.__doc__)
540
 
 
541
 
 
542
 
class MailApp(BodyExternalMailClient):
543
 
    """Use MacOS X's Mail.app for sending email messages.
544
 
 
545
 
    Although it would be nice to use appscript, it's not installed
546
 
    with the shipped Python installations.  We instead build an
547
 
    AppleScript and invoke the script using osascript(1).  We don't
548
 
    use the _encode_safe() routines as it's not clear what encoding
549
 
    osascript expects the script to be in.
550
 
    """
551
 
 
552
 
    _client_commands = ['osascript']
553
 
 
554
 
    def _get_compose_commandline(self, to, subject, attach_path, body=None,
555
 
                                from_=None):
556
 
       """See ExternalMailClient._get_compose_commandline"""
557
 
 
558
 
       fd, self.temp_file = tempfile.mkstemp(prefix="bzr-send-",
559
 
                                         suffix=".scpt")
560
 
       try:
561
 
           os.write(fd, 'tell application "Mail"\n')
562
 
           os.write(fd, 'set newMessage to make new outgoing message\n')
563
 
           os.write(fd, 'tell newMessage\n')
564
 
           if to is not None:
565
 
               os.write(fd, 'make new to recipient with properties'
566
 
                   ' {address:"%s"}\n' % to)
567
 
           if from_ is not None:
568
 
               # though from_ doesn't actually seem to be used
569
 
               os.write(fd, 'set sender to "%s"\n'
570
 
                   % sender.replace('"', '\\"'))
571
 
           if subject is not None:
572
 
               os.write(fd, 'set subject to "%s"\n'
573
 
                   % subject.replace('"', '\\"'))
574
 
           if body is not None:
575
 
               # FIXME: would be nice to prepend the body to the
576
 
               # existing content (e.g., preserve signature), but
577
 
               # can't seem to figure out the right applescript
578
 
               # incantation.
579
 
               os.write(fd, 'set content to "%s\\n\n"\n' %
580
 
                   body.replace('"', '\\"').replace('\n', '\\n'))
581
 
 
582
 
           if attach_path is not None:
583
 
               # FIXME: would be nice to first append a newline to
584
 
               # ensure the attachment is on a new paragraph, but
585
 
               # can't seem to figure out the right applescript
586
 
               # incantation.
587
 
               os.write(fd, 'tell content to make new attachment'
588
 
                   ' with properties {file name:"%s"}'
589
 
                   ' at after the last paragraph\n'
590
 
                   % self._encode_path(attach_path, 'attachment'))
591
 
           os.write(fd, 'set visible to true\n')
592
 
           os.write(fd, 'end tell\n')
593
 
           os.write(fd, 'end tell\n')
594
 
       finally:
595
 
           os.close(fd) # Just close the handle but do not remove the file.
596
 
       return [self.temp_file]
597
 
mail_client_registry.register('mail.app', MailApp,
598
 
                              help=MailApp.__doc__)
599
263
 
600
264
 
601
265
class DefaultMail(MailClient):
602
266
    """Default mail handling.  Tries XDGEmail (or MAPIClient on Windows),
603
267
    falls back to Editor"""
604
268
 
605
 
    supports_body = True
606
 
 
607
269
    def _mail_client(self):
608
270
        """Determine the preferred mail client for this platform"""
609
271
        if osutils.supports_mapi():
612
274
            return XDGEmail(self.config)
613
275
 
614
276
    def compose(self, prompt, to, subject, attachment, mime_subtype,
615
 
                extension, basename=None, body=None):
 
277
                extension):
616
278
        """See MailClient.compose"""
617
279
        try:
618
280
            return self._mail_client().compose(prompt, to, subject,
619
281
                                               attachment, mimie_subtype,
620
 
                                               extension, basename, body)
 
282
                                               extension)
621
283
        except errors.MailClientNotFound:
622
284
            return Editor(self.config).compose(prompt, to, subject,
623
 
                          attachment, mimie_subtype, extension, body)
 
285
                          attachment, mimie_subtype, extension)
624
286
 
625
 
    def compose_merge_request(self, to, subject, directive, basename=None,
626
 
                              body=None):
 
287
    def compose_merge_request(self, to, subject, directive):
627
288
        """See MailClient.compose_merge_request"""
628
289
        try:
629
290
            return self._mail_client().compose_merge_request(to, subject,
630
 
                    directive, basename=basename, body=body)
 
291
                                                             directive)
631
292
        except errors.MailClientNotFound:
632
293
            return Editor(self.config).compose_merge_request(to, subject,
633
 
                          directive, basename=basename, body=body)
634
 
mail_client_registry.register('default', DefaultMail,
635
 
                              help=DefaultMail.__doc__)
636
 
mail_client_registry.default_key = 'default'
637
 
 
638
 
 
 
294
                          directive)