NewChangeSender (Gerrit Review Plugin API Documentation)

java.lang.Object
- com.google.gerrit.server.mail.send.OutgoingEmail
- - com.google.gerrit.server.mail.send.NotificationEmail
  - - com.google.gerrit.server.mail.send.ChangeEmail
    - - com.google.gerrit.server.mail.send.NewChangeSender

Direct Known Subclasses:

CreateChangeSender, ModifyReviewerSender
```
public abstract class NewChangeSender
extends ChangeEmail
```
Sends an email alerting a user to a new change for them to review.

Field Summary
- Fields inherited from class com.google.gerrit.server.mail.send.ChangeEmail
  authors, change, changeData, changeMessage, emailOnlyAttentionSetIfEnabled, emailOnlyAuthors, patchSet, patchSetInfo, projectState, stars, timestamp
- Fields inherited from class com.google.gerrit.server.mail.send.NotificationEmail
  branch
- Fields inherited from class com.google.gerrit.server.mail.send.OutgoingEmail
  args, footers, fromId, messageClass, notify, soyContext, soyContextEmailData

Constructor Summary

Constructors
Modifier Constructor Description

protected NewChangeSender(EmailArguments args, ChangeData changeData)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addExtraCC(Collection<Account.Id> cc)`
`void`	`addExtraCCByEmail(Collection<Address> cc)`
`void`	`addRemovedByEmailReviewers(Collection<Address> removed)`
`void`	`addRemovedReviewers(Collection<Account.Id> removed)`
`void`	`addReviewers(Collection<Account.Id> cc)`
`void`	`addReviewersByEmail(Collection<Address> cc)`
`protected void`	`formatChange()`	Format the message body by calling `OutgoingEmail.appendText(String)`.
`List<String>`	`getRemovedReviewerNames()`
`List<String>`	`getReviewerNames()`
`protected void`	`init()`	Setup the message headers and envelope (TO, CC, BCC).
`protected void`	`setupSoyContext()`

Methods inherited from class com.google.gerrit.server.mail.send.ChangeEmail
add, addWatcher, bccStarredBy, ccAllApprovals, ccExistingReviewers, format, formatFooter, getAuthors, getChangeDetail, getChangeMessageThreadId, getChangeUrl, getCoverLetter, getDiffTemplateData, getIncludeDiff, getProjectState, getUnifiedDiff, getWatchers, isVisibleTo, listModifiedFiles, listModifiedFiles, newChangeData, newChangeData, rcptToAuthors, setChangeMessage, setFrom, setPatchSet, setPatchSet

Methods inherited from class com.google.gerrit.server.mail.send.NotificationEmail
add, getInstanceAndProjectName, getShortProjectName, getSshHost, includeWatchers, includeWatchers

Methods inherited from class com.google.gerrit.server.mail.send.OutgoingEmail
add, add, add, addByEmail, addByEmail, appendHtml, appendText, getFromLine, getGerritHost, getNameEmailFor, getNameFor, getSettingsUrl, getUserNameEmailFor, removeHeader, removeUser, send, setHeader, setHeader, setMessageId, setNotify, shouldSendMessage, soyHtmlTemplate, textTemplate, useHtml

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NewChangeSender

protected NewChangeSender(EmailArguments args,
                          ChangeData changeData)

Method Detail

addReviewers

public void addReviewers(Collection<Account.Id> cc)

addReviewersByEmail

public void addReviewersByEmail(Collection<Address> cc)

addExtraCC

public void addExtraCC(Collection<Account.Id> cc)

addExtraCCByEmail

public void addExtraCCByEmail(Collection<Address> cc)

addRemovedReviewers

public void addRemovedReviewers(Collection<Account.Id> removed)

addRemovedByEmailReviewers

public void addRemovedByEmailReviewers(Collection<Address> removed)

init
```
protected void init()
             throws com.google.gerrit.exceptions.EmailException
```
Description copied from class: ChangeEmail

Setup the message headers and envelope (TO, CC, BCC).

Overrides:

init in class ChangeEmail

Throws:

com.google.gerrit.exceptions.EmailException - if an error occurred.

formatChange
```
protected void formatChange()
                     throws com.google.gerrit.exceptions.EmailException
```
Description copied from class: ChangeEmail

Format the message body by calling OutgoingEmail.appendText(String).

Specified by:

formatChange in class ChangeEmail

Throws:

com.google.gerrit.exceptions.EmailException

getReviewerNames

public List<String> getReviewerNames()

getRemovedReviewerNames

public List<String> getRemovedReviewerNames()

setupSoyContext
```
protected void setupSoyContext()
```
Overrides:

setupSoyContext in class ChangeEmail