l.c.m.s.SourcePackageRecipeBuildMailer(BaseMailer) : class documentation

Part of lp.code.mail.sourcepackagerecipebuild View In Hierarchy

No class docstring
Class Method forStatus Create a mailer for notifying about 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 build status.
ParametersbuildThe build to notify about the state of.
def __init__(self, subject, body_template, recipients, from_address, build):
Constructor.
ParameterssubjectA Python dict-replacement template for the subject line of the email.
templateName of the template to use for the message body.
recipientsA dict of recipient to Subscription.
from_addressThe from_address to use on emails.
deltaA Delta object with members "delta_values", "interface" and "new_values", such as BranchMergeProposalDelta.
message_idThe Message-Id to use for generated emails. If not supplied, random message-ids will be used.
mail_controller_classThe class of the mail controller to use to send the mails. Defaults to MailController.
requestAn optional IErrorReportRequest to use when logging OOPSes.
wrapWrap body text using MailWrapper.
force_wrapSee MailWrapper.format.
def _getHeaders(self, email, recipient):
See BaseMailer
def _getTemplateParams(self, email, recipient):
See BaseMailer
def _getFooter(self, email, recipient, params):
See BaseMailer
API Documentation for Launchpad, generated by pydoctor at 2022-06-16 00:00:12.