bzrlib.mail_client.BodyExternalMailClient : API documentation

Method	compose	See MailClient.compose.
Method	_get_client_commands	Provide a list of commands that may invoke the mail client
Method	_compose	Invoke a mail client as a commandline process.
Method	_get_compose_commandline	Determine the commandline to use for composing a message
Method	_encode_safe	Encode possible unicode string argument to 8-bit string
Method	_encode_path	Encode unicode path in user encoding.

Inherited from MailClient:

Method	__init__	Undocumented
Method	compose_merge_request	Compose (and possibly send) a merge request
Method	_get_merge_prompt	Generate a prompt string. Overridden by Editor.

def _get_client_commands(self):

Provide a list of commands that may invoke the mail client

def compose(self, prompt, to, subject, attachment, mime_subtype, extension, basename=None, body=None):

overrides bzrlib.mail_client.MailClient.compose

See MailClient.compose.

Writes the attachment to a temporary file, invokes _compose.

def _compose(self, prompt, to, subject, attach_path, mime_subtype, extension, body=None, from_=None):

overridden in bzrlib.mail_client.Claws, bzrlib.mail_client.MAPIClient

Invoke a mail client as a commandline process.

Overridden by MAPIClient.
:param to: The address to send the mail to
:param subject: The subject line for the mail
:param pathname: The path to the attachment
:param mime_subtype: The attachment is assumed to have a major type of
    "text", but the precise subtype can be specified here
:param extension: A file extension (including period) associated with
    the attachment type.
:param body: Optional body text.
:param from_: Optional From: header.

def _get_compose_commandline(self, to, subject, attach_path, body):

overridden in bzrlib.mail_client.Claws, bzrlib.mail_client.EmacsMail, bzrlib.mail_client.Evolution, bzrlib.mail_client.KMail, bzrlib.mail_client.MailApp, bzrlib.mail_client.Mutt, bzrlib.mail_client.Thunderbird, bzrlib.mail_client.XDGEmail

Determine the commandline to use for composing a message

Implemented by various subclasses :param to: The address to send the mail to :param subject: The subject line for the mail :param attach_path: The path to the attachment

def _encode_safe(self, u):

Encode possible unicode string argument to 8-bit string in user_encoding. Unencodable characters will be replaced with '?'.

Parameters	u	possible unicode string.
Returns	encoded string if u is unicode, u itself otherwise.

def _encode_path(self, path, kind):

Encode unicode path in user encoding.

Parameters	path	possible unicode path.
	kind	path kind ('executable' or 'attachment').
Returns	encoded path if path is unicode, path itself otherwise.
Raises	UnableEncodePath.

b.m.BodyExternalMailClient(MailClient) : class documentation