l.s.m.l.LiveFSBuildMailer(BaseMailer) : class documentation

Part of lp.soyuz.mail.livefsbuild View In Hierarchy

No class docstring

Class Method	forStatus	Create a mailer for notifying about live filesystem build status.
Method	__init__	Constructor.
Method	_getHeaders	See `BaseMailer`.
Method	_getTemplateParams	See `BaseMailer`.
Method	_getFooter	See `BaseMailer`.

Inherited from BaseMailer:

Method	generateEmail	Generate the email for this recipient.
Method	textDelta	Return a textual version of the class delta.
Method	sendOne	Send notification to one recipient.
Method	sendAll	Send notifications to all recipients.
Method	_getFromAddress	Undocumented
Method	_getToAddresses	Undocumented
Method	_getSubject	The subject template expanded with the template params.
Method	_getReplyToAddress	Return the address to use for the reply-to header.
Method	_addAttachments	Add any appropriate attachments to a MailController.
Method	_getTemplateName	Return the name of the template to use for this email body.
Method	_getBody	Return the complete body to use for this email.
Method	_getExpandedFooter	Provide an expanded footer for recipients who have requested it.

@classmethod
def forStatus(cls, build):

Create a mailer for notifying about live filesystem build status.

Parameters build The relevant build.

def __init__(self, subject, template_name, recipients, from_address, build):

overrides lp.services.mail.basemailer.BaseMailer.__init__

Constructor.

Parameters	subject	A Python dict-replacement template for the subject line of the email.
	template	Name of the template to use for the message body.
	recipients	A dict of recipient to Subscription.
	from_address	The from_address to use on emails.
	delta	A Delta object with members "delta_values", "interface" and "new_values", such as BranchMergeProposalDelta.
	message_id	The Message-Id to use for generated emails. If not supplied, random message-ids will be used.
	mail_controller_class	The class of the mail controller to use to send the mails. Defaults to `MailController`.
	request	An optional `IErrorReportRequest` to use when logging OOPSes.
	wrap	Wrap body text using `MailWrapper`.
	force_wrap	See `MailWrapper.format`.

def _getHeaders(self, email, recipient):

overrides lp.services.mail.basemailer.BaseMailer._getHeaders

See BaseMailer.

def _getTemplateParams(self, email, recipient):

overrides lp.services.mail.basemailer.BaseMailer._getTemplateParams

See BaseMailer.

def _getFooter(self, email, recipient, params):

overrides lp.services.mail.basemailer.BaseMailer._getFooter

See BaseMailer.

API Documentation for Launchpad, generated by pydoctor at 2022-06-16 00:00:12.