l.c.m.c.CodeReviewCommentMailer(BMPMailer) : class documentation

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

Send email about creation of a CodeReviewComment.
Method __init__ Constructor.
Class Method forCreation Return a mailer for CodeReviewComment creation.
Method _getSubject Don't do any string template insertions on subjects.
Method _generateBodyBits Pre-generate the bits of the body email that don't change.
Method _getBody Return the complete body to use for this email.
Method _getHeaders Return the mail headers to use.
Method _getToAddresses Provide to addresses as if this were a mailing list.
Method _addAttachments Add the attachments from the original message.

Inherited from BMPMailer:

Method sendAll Send notifications to all recipients.
Class Method forModification Return a mailer for BranchMergeProposal creation.
Class Method forReviewRequest Return a mailer for a request to review a BranchMergeProposal.
Method _getReplyToAddress Return the address to use for the reply-to header.
Method _generateTemplateParams For template params that don't change, calculate just once.
Method _formatExtraInformation Consistently indent the chunks with the heading.
Method _getCommitMessage Return a string describing the commit message, if any.
Method _getRequestedReviews Return a string describing the requested reviews, if any.
Method _getRelatedBugTasks Return a string describing related bug tasks, if any.
Method _getTemplateParams Return a dict of values to use in the body and subject.

Inherited from BranchMailer (via BMPMailer):

Class Method forBranchModified Construct a BranchMailer for mail about a branch modification.
Class Method forRevision Construct a BranchMailer for mail about branch revisions.
Method _includeDiff Determine whether to include a diff, and explanation.
Method _explainNotPresentDiff Provide an explanation why the diff is not being included.

Inherited from BaseMailer (via BMPMailer, BranchMailer):

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 _getFromAddress Undocumented
Method _getTemplateName Return the name of the template to use for this email body.
Method _getFooter Provide a footer to attach to the body, or None.
Method _getExpandedFooter Provide an expanded footer for recipients who have requested it.
def __init__(self, code_review_comment, recipients, message_id=None):
Constructor.
@classmethod
def forCreation(klass, code_review_comment):
Return a mailer for CodeReviewComment creation.
def _getSubject(self, email, recipient):
Don't do any string template insertions on subjects.
def _generateBodyBits(self):
Pre-generate the bits of the body email that don't change.
def _getBody(self, email, recipient):
Return the complete body to use for this email.

If there was a vote, we prefix "Review: " to the message. We always append information about why this message was sent. If there is an existing footer, we append it to that. Otherwise, we we insert a new footer.

def _getHeaders(self, email, recipient):
Return the mail headers to use.
def _getToAddresses(self, email, recipient):
Provide to addresses as if this were a mailing list.

CodeReviewComments which are not replies shall list the merge proposer as their to address. CodeReviewComments which are replies shall list the parent comment's author as their to address.

def _addAttachments(self, ctrl, email):
Add the attachments from the original message.
API Documentation for Launchpad, generated by pydoctor at 2019-09-18 00:00:08.