Part of lp.code.mail.branchmergeproposal View In Hierarchy
Known subclasses: lp.code.mail.codereviewcomment.CodeReviewCommentMailer
Method | __init__ | Constructor. |
Method | sendAll | Send notifications to all recipients. |
Class Method | forCreation | Return a mailer for BranchMergeProposal creation. |
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 | _getToAddresses | Return the addresses to use for the to header. |
Method | _getHeaders | Return the mail headers to use. |
Method | _addAttachments | Attach the diff, if present and not too large. |
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:
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 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 | _getSubject | The subject template expanded with the template params. |
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 | _getFooter | Provide a footer to attach to the body, or None. |
Method | _getExpandedFooter | Provide an expanded footer for recipients who have requested it. |
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 . |
Parameters | merge_proposal | The BranchMergeProposal that was created. |
from_user | The user that the creation notification should come from. |
Parameters | merge_proposal | The BranchMergeProposal that was created. |
from_user | The user that the creation notification should come from. Optional. |
If the email is being sent directly to the recipient, their email address is returned. Otherwise, the merge proposal and requested reviewers are returned.
Parameters | ctrl | The MailController to attach the diff to. |
Email address of the recipient. |
Used to provide consistent indentation for requested reviews and related bugs.
Related bugs are provided by
IBranchMergeProposal.getRelatedBugTasks