133
119
return self._client_commands
135
121
def compose(self, prompt, to, subject, attachment, mime_subtype,
136
extension, basename=None, body=None):
137
123
"""See MailClient.compose.
139
125
Writes the attachment to a temporary file, invokes _compose.
142
basename = 'attachment'
143
pathname = osutils.mkdtemp(prefix='bzr-mail-')
144
attach_path = osutils.pathjoin(pathname, basename + extension)
145
outfile = open(attach_path, 'wb')
127
fd, pathname = tempfile.mkstemp(extension, 'bzr-mail-')
147
outfile.write(attachment)
129
os.write(fd, attachment)
151
kwargs = {'body': body}
154
self._compose(prompt, to, subject, attach_path, mime_subtype,
132
self._compose(prompt, to, subject, pathname, mime_subtype, extension)
157
134
def _compose(self, prompt, to, subject, attach_path, mime_subtype,
158
extension, body=None, from_=None):
159
136
"""Invoke a mail client as a commandline process.
161
138
Overridden by MAPIClient.
224
192
if isinstance(path, unicode):
226
return path.encode(osutils.get_user_encoding())
194
return path.encode(bzrlib.user_encoding)
227
195
except UnicodeEncodeError:
228
196
raise errors.UnableEncodePath(path, kind)
232
class ExternalMailClient(BodyExternalMailClient):
233
__doc__ = """An external mail client."""
235
supports_body = False
238
class Evolution(BodyExternalMailClient):
239
__doc__ = """Evolution mail client."""
200
class Evolution(ExternalMailClient):
201
"""Evolution mail client."""
241
203
_client_commands = ['evolution']
243
def _get_compose_commandline(self, to, subject, attach_path, body=None):
205
def _get_compose_commandline(self, to, subject, attach_path):
244
206
"""See ExternalMailClient._get_compose_commandline"""
245
207
message_options = {}
246
208
if subject is not None:
247
209
message_options['subject'] = subject
248
210
if attach_path is not None:
249
211
message_options['attach'] = attach_path
251
message_options['body'] = body
252
212
options_list = ['%s=%s' % (k, urlutils.escape(v)) for (k, v) in
253
213
sorted(message_options.iteritems())]
254
214
return ['mailto:%s?%s' % (self._encode_safe(to or ''),
255
215
'&'.join(options_list))]
256
mail_client_registry.register('evolution', Evolution,
257
help=Evolution.__doc__)
260
class Mutt(BodyExternalMailClient):
261
__doc__ = """Mutt mail client."""
218
class Mutt(ExternalMailClient):
219
"""Mutt mail client."""
263
221
_client_commands = ['mutt']
265
def _get_compose_commandline(self, to, subject, attach_path, body=None):
223
def _get_compose_commandline(self, to, subject, attach_path):
266
224
"""See ExternalMailClient._get_compose_commandline"""
267
225
message_options = []
268
226
if subject is not None:
336
277
if to is not None:
337
278
message_options.extend([self._encode_safe(to)])
338
279
return message_options
339
mail_client_registry.register('kmail', KMail,
343
class Claws(ExternalMailClient):
344
__doc__ = """Claws mail client."""
348
_client_commands = ['claws-mail']
350
def _get_compose_commandline(self, to, subject, attach_path, body=None,
352
"""See ExternalMailClient._get_compose_commandline"""
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 "+".
360
'subject=' + urllib.quote(self._encode_safe(subject)))
363
'body=' + urllib.quote(self._encode_safe(body)))
364
# to must be supplied for the claws-mail --compose syntax to work.
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
376
def _compose(self, prompt, to, subject, attach_path, mime_subtype,
377
extension, body=None, from_=None):
378
"""See ExternalMailClient._compose"""
380
from_ = self.config.get_user_option('email')
381
super(Claws, self)._compose(prompt, to, subject, attach_path,
382
mime_subtype, extension, body, from_)
385
mail_client_registry.register('claws', Claws,
389
class XDGEmail(BodyExternalMailClient):
390
__doc__ = """xdg-email attempts to invoke the user's preferred mail client"""
282
class XDGEmail(ExternalMailClient):
283
"""xdg-email attempts to invoke the user's preferred mail client"""
392
285
_client_commands = ['xdg-email']
394
def _get_compose_commandline(self, to, subject, attach_path, body=None):
287
def _get_compose_commandline(self, to, subject, attach_path):
395
288
"""See ExternalMailClient._get_compose_commandline"""
397
290
raise errors.NoMailAddressSpecified()
401
294
if attach_path is not None:
402
295
commandline.extend(['--attach',
403
296
self._encode_path(attach_path, 'attachment')])
405
commandline.extend(['--body', self._encode_safe(body)])
407
mail_client_registry.register('xdg-email', XDGEmail,
408
help=XDGEmail.__doc__)
411
class EmacsMail(ExternalMailClient):
412
__doc__ = """Call emacsclient to have a mail buffer.
414
This only work for emacs >= 22.1 due to recent -e/--eval support.
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
421
Users just have to ensure that ``mail-user-agent`` is set according
425
_client_commands = ['emacsclient']
427
def __init__(self, config):
428
super(EmacsMail, self).__init__(config)
429
self.elisp_tmp_file = None
431
def _prepare_send_function(self):
432
"""Write our wrapper function into a temporary file.
434
This temporary file will be loaded at runtime in
435
_get_compose_commandline function.
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.)
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))
450
((eq agent 'sendmail-user-agent)
454
(if (functionp 'etach-attach)
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))
461
(mml-attach-file file "text/x-patch" "BZR merge" "inline")))
462
((eq agent 'mew-user-agent)
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)))
472
(message "Unhandled MUA, report it on bazaar@lists.canonical.com")))
473
(error "File %s does not exist." file))))
476
fd, temp_file = tempfile.mkstemp(prefix="emacs-bzr-send-",
481
os.close(fd) # Just close the handle but do not remove the file.
484
def _get_compose_commandline(self, to, subject, attach_path):
485
commandline = ["--eval"]
491
_to = ("\"%s\"" % self._encode_safe(to).replace('"', '\\"'))
492
if subject is not None:
493
_subject = ("\"%s\"" %
494
self._encode_safe(subject).replace('"', '\\"'))
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)
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)
517
mail_client_registry.register('emacsclient', EmacsMail,
518
help=EmacsMail.__doc__)
521
class MAPIClient(BodyExternalMailClient):
522
__doc__ = """Default Windows mail client launched using MAPI."""
300
class MAPIClient(ExternalMailClient):
301
"""Default Windows mail client launched using MAPI."""
524
303
def _compose(self, prompt, to, subject, attach_path, mime_subtype,
525
extension, body=None):
526
305
"""See ExternalMailClient._compose.
528
307
This implementation uses MAPI via the simplemapi ctypes wrapper
530
309
from bzrlib.util import simplemapi
532
simplemapi.SendMail(to or '', subject or '', body or '',
311
simplemapi.SendMail(to or '', subject or '', '', attach_path)
534
312
except simplemapi.MAPIError, e:
535
313
if e.code != simplemapi.MAPI_USER_ABORT:
536
314
raise errors.MailClientNotFound(['MAPI supported mail client'
537
315
' (error %d)' % (e.code,)])
538
mail_client_registry.register('mapi', MAPIClient,
539
help=MAPIClient.__doc__)
542
class MailApp(BodyExternalMailClient):
543
__doc__ = """Use MacOS X's Mail.app for sending email messages.
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.
552
_client_commands = ['osascript']
554
def _get_compose_commandline(self, to, subject, attach_path, body=None,
556
"""See ExternalMailClient._get_compose_commandline"""
558
fd, self.temp_file = tempfile.mkstemp(prefix="bzr-send-",
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')
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('"', '\\"'))
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
579
os.write(fd, 'set content to "%s\\n\n"\n' %
580
body.replace('"', '\\"').replace('\n', '\\n'))
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
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')
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__)
601
318
class DefaultMail(MailClient):
602
__doc__ = """Default mail handling. Tries XDGEmail (or MAPIClient on Windows),
319
"""Default mail handling. Tries XDGEmail (or MAPIClient on Windows),
603
320
falls back to Editor"""
607
322
def _mail_client(self):
608
323
"""Determine the preferred mail client for this platform"""
609
324
if osutils.supports_mapi():
612
327
return XDGEmail(self.config)
614
329
def compose(self, prompt, to, subject, attachment, mime_subtype,
615
extension, basename=None, body=None):
616
331
"""See MailClient.compose"""
618
333
return self._mail_client().compose(prompt, to, subject,
619
334
attachment, mimie_subtype,
620
extension, basename, body)
621
336
except errors.MailClientNotFound:
622
337
return Editor(self.config).compose(prompt, to, subject,
623
attachment, mimie_subtype, extension, body)
338
attachment, mimie_subtype, extension)
625
def compose_merge_request(self, to, subject, directive, basename=None,
340
def compose_merge_request(self, to, subject, directive):
627
341
"""See MailClient.compose_merge_request"""
629
343
return self._mail_client().compose_merge_request(to, subject,
630
directive, basename=basename, body=body)
631
345
except errors.MailClientNotFound:
632
346
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'