ChangeEmail (Gerrit Review Plugin API Documentation)

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

Direct Known Subclasses:

NewChangeSender, ReplyToChangeSender
```
public abstract class ChangeEmail
extends NotificationEmail
```
Sends an email to one or more interested parties.

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.Set<com.google.gerrit.reviewdb.client.Account.Id>`	`authors`
`protected com.google.gerrit.reviewdb.client.Change`	`change`
`protected ChangeData`	`changeData`
`protected com.google.gerrit.reviewdb.client.ChangeMessage`	`changeMessage`
`protected boolean`	`emailOnlyAuthors`
`protected com.google.gerrit.reviewdb.client.PatchSet`	`patchSet`
`protected com.google.gerrit.reviewdb.client.PatchSetInfo`	`patchSetInfo`
`protected ProjectState`	`projectState`

Fields inherited from class com.google.gerrit.server.mail.NotificationEmail
branch, project

Fields inherited from class com.google.gerrit.server.mail.OutgoingEmail
args, fromId, messageClass, velocityContext

Constructor Summary

Constructors
Modifier Constructor and Description

protected ChangeEmail(EmailArguments ea, com.google.gerrit.reviewdb.client.Change c, java.lang.String mc)

Constructors
Modifier	Constructor and Description
`protected`	`ChangeEmail(EmailArguments ea, com.google.gerrit.reviewdb.client.Change c, java.lang.String mc)`

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`add(RecipientType rt, com.google.gerrit.reviewdb.client.Account.Id to)` Schedule delivery of this message to the given account.
`protected void`	`bccStarredBy()` BCC any user who has starred this change.
`protected void`	`ccAllApprovals()` Any user who has published comments on this change.
`protected void`	`ccExistingReviewers()` Users who have non-zero approval codes on the change.
`protected void`	`format()` Format the message body by calling `OutgoingEmail.appendText(String)`.
`protected abstract void`	`formatChange()` Format the message body by calling `OutgoingEmail.appendText(String)`.
`protected void`	`formatChangeDetail()` Format the change message and the affected file list.
`protected void`	`formatCoverLetter()` Format the sender's "cover letter", `getCoverLetter()`.
`protected void`	`formatFooter()` Format the message footer by calling `OutgoingEmail.appendText(String)`.
`protected java.util.Set<com.google.gerrit.reviewdb.client.Account.Id>`	`getAuthors()` Find all users who are authors of any part of this change.
`java.lang.String`	`getChangeDetail()` Create the change message and the affected file list.
`java.lang.String`	`getChangeMessageThreadId()`
`java.lang.String`	`getChangeUrl()` Get a link to the change; null if the server doesn't know its own address.
`java.lang.String`	`getCoverLetter()` Get the text of the "cover letter", from `ChangeMessage`.
`boolean`	`getIncludeDiff()`
`protected PatchList`	`getPatchList()` Get the patch list corresponding to this patch set.
`protected java.util.Set<com.google.gerrit.reviewdb.client.AccountGroup.UUID>`	`getProjectOwners()` Get the groups which own the project.
`protected ProjectState`	`getProjectState()` Get the project entity the change is in; null if its been deleted.
`java.lang.String`	`getUnifiedDiff()` Show patch set as unified difference.
`protected ProjectWatch.Watchers`	`getWatchers(com.google.gerrit.reviewdb.client.AccountProjectWatch.NotifyType type)` Returns all watchers that are relevant
`protected void`	`init()` Setup the message headers and envelope (TO, CC, BCC).
`protected boolean`	`isVisibleTo(com.google.gerrit.reviewdb.client.Account.Id to)`
`protected void`	`rcptToAuthors(RecipientType rt)` TO or CC all vested parties (change owner, patch set uploader, author).
`void`	`setChangeMessage(com.google.gerrit.reviewdb.client.ChangeMessage cm)`
`void`	`setFrom(com.google.gerrit.reviewdb.client.Account.Id id)`
`void`	`setPatchSet(com.google.gerrit.reviewdb.client.PatchSet ps)`
`void`	`setPatchSet(com.google.gerrit.reviewdb.client.PatchSet ps, com.google.gerrit.reviewdb.client.PatchSetInfo psi)`
`protected void`	`setupVelocityContext()`

Methods inherited from class com.google.gerrit.server.mail.NotificationEmail
add, getListId, getSshHost, includeWatchers

Methods inherited from class com.google.gerrit.server.mail.OutgoingEmail
add, add, add, appendText, getFromLine, getGerritHost, getGerritUrl, getNameEmailFor, getNameFor, getSettingsUrl, joinStrings, joinStrings, send, setHeader, setHeader, setVHeader, shouldSendMessage, velocify, velocifyFile

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

Field Detail

change

protected final com.google.gerrit.reviewdb.client.Change change

changeData
```
protected final ChangeData changeData
```

patchSet

protected com.google.gerrit.reviewdb.client.PatchSet patchSet

patchSetInfo

protected com.google.gerrit.reviewdb.client.PatchSetInfo patchSetInfo

changeMessage

protected com.google.gerrit.reviewdb.client.ChangeMessage changeMessage

projectState
```
protected ProjectState projectState
```

authors

protected java.util.Set<com.google.gerrit.reviewdb.client.Account.Id> authors

emailOnlyAuthors
```
protected boolean emailOnlyAuthors
```

Constructor Detail

ChangeEmail

protected ChangeEmail(EmailArguments ea,
           com.google.gerrit.reviewdb.client.Change c,
           java.lang.String mc)

Method Detail
- setFrom
```
public void setFrom(com.google.gerrit.reviewdb.client.Account.Id id)
```
  Overrides:
  
  setFrom in class OutgoingEmail
- setPatchSet
```
public void setPatchSet(com.google.gerrit.reviewdb.client.PatchSet ps)
```
- setPatchSet
```
public void setPatchSet(com.google.gerrit.reviewdb.client.PatchSet ps,
               com.google.gerrit.reviewdb.client.PatchSetInfo psi)
```
- setChangeMessage
```
public void setChangeMessage(com.google.gerrit.reviewdb.client.ChangeMessage cm)
```
- format
```
protected void format()
               throws com.google.gerrit.common.errors.EmailException
```
  Format the message body by calling OutgoingEmail.appendText(String).
  
  Specified by:
  
  format in class OutgoingEmail
  
  Throws:
  
  com.google.gerrit.common.errors.EmailException
- formatChange
```
protected abstract void formatChange()
                              throws com.google.gerrit.common.errors.EmailException
```
  Format the message body by calling OutgoingEmail.appendText(String).
  
  Throws:
  
  com.google.gerrit.common.errors.EmailException
- formatFooter
```
protected void formatFooter()
                     throws com.google.gerrit.common.errors.EmailException
```
  Format the message footer by calling OutgoingEmail.appendText(String).
  
  Throws:
  
  com.google.gerrit.common.errors.EmailException
- init
```
protected void init()
             throws com.google.gerrit.common.errors.EmailException
```
  Setup the message headers and envelope (TO, CC, BCC).
  
  Overrides:
  
  init in class NotificationEmail
  
  Throws:
  
  com.google.gerrit.common.errors.EmailException
- getChangeUrl
```
public java.lang.String getChangeUrl()
```
  Get a link to the change; null if the server doesn't know its own address.
- getChangeMessageThreadId
```
public java.lang.String getChangeMessageThreadId()
                                          throws com.google.gerrit.common.errors.EmailException
```
  Throws:
  
  com.google.gerrit.common.errors.EmailException
- formatCoverLetter
```
protected void formatCoverLetter()
```
  Format the sender's "cover letter", getCoverLetter().
- getCoverLetter
```
public java.lang.String getCoverLetter()
```
  Get the text of the "cover letter", from ChangeMessage.
- formatChangeDetail
```
protected void formatChangeDetail()
```
  Format the change message and the affected file list.
- getChangeDetail
```
public java.lang.String getChangeDetail()
```
  Create the change message and the affected file list.
- getPatchList
```
protected PatchList getPatchList()
                          throws PatchListNotAvailableException
```
  Get the patch list corresponding to this patch set.
  
  Throws:
  
  PatchListNotAvailableException
- getProjectState
```
protected ProjectState getProjectState()
```
  Get the project entity the change is in; null if its been deleted.
- getProjectOwners
```
protected java.util.Set<com.google.gerrit.reviewdb.client.AccountGroup.UUID> getProjectOwners()
```
  Get the groups which own the project.
- rcptToAuthors
```
protected void rcptToAuthors(RecipientType rt)
```
  TO or CC all vested parties (change owner, patch set uploader, author).
- bccStarredBy
```
protected void bccStarredBy()
```
  BCC any user who has starred this change.
- getWatchers
```
protected final ProjectWatch.Watchers getWatchers(com.google.gerrit.reviewdb.client.AccountProjectWatch.NotifyType type)
                                           throws com.google.gwtorm.server.OrmException
```
  Description copied from class: NotificationEmail
  
  Returns all watchers that are relevant
  
  Specified by:
  
  getWatchers in class NotificationEmail
  
  Throws:
  
  com.google.gwtorm.server.OrmException
- ccAllApprovals
```
protected void ccAllApprovals()
```
  Any user who has published comments on this change.
- ccExistingReviewers
```
protected void ccExistingReviewers()
```
  Users who have non-zero approval codes on the change.
- add
```
protected void add(RecipientType rt,
       com.google.gerrit.reviewdb.client.Account.Id to)
```
  Description copied from class: OutgoingEmail
  
  Schedule delivery of this message to the given account.
  
  Overrides:
  
  add in class OutgoingEmail
- isVisibleTo
```
protected boolean isVisibleTo(com.google.gerrit.reviewdb.client.Account.Id to)
                       throws com.google.gwtorm.server.OrmException
```
  Overrides:
  
  isVisibleTo in class OutgoingEmail
  
  Throws:
  
  com.google.gwtorm.server.OrmException
- getAuthors
```
protected java.util.Set<com.google.gerrit.reviewdb.client.Account.Id> getAuthors()
```
  Find all users who are authors of any part of this change.
- setupVelocityContext
```
protected void setupVelocityContext()
```
  Overrides:
  
  setupVelocityContext in class NotificationEmail
- getIncludeDiff
```
public boolean getIncludeDiff()
```
- getUnifiedDiff
```
public java.lang.String getUnifiedDiff()
```
  Show patch set as unified difference.

Class ChangeEmail

Field Summary

Fields inherited from class com.google.gerrit.server.mail.NotificationEmail

Fields inherited from class com.google.gerrit.server.mail.OutgoingEmail

Constructor Summary

Method Summary

Methods inherited from class com.google.gerrit.server.mail.NotificationEmail

Methods inherited from class com.google.gerrit.server.mail.OutgoingEmail

Methods inherited from class java.lang.Object

Field Detail

change

changeData

patchSet

patchSetInfo

changeMessage

projectState

authors

emailOnlyAuthors

Constructor Detail

ChangeEmail

Method Detail

setFrom

setPatchSet

setPatchSet

setChangeMessage

format

formatChange

formatFooter

init

getChangeUrl

getChangeMessageThreadId

formatCoverLetter

getCoverLetter

formatChangeDetail

getChangeDetail

getPatchList

getProjectState

getProjectOwners

rcptToAuthors

bccStarredBy

getWatchers

ccAllApprovals

ccExistingReviewers

add

isVisibleTo

getAuthors

setupVelocityContext

getIncludeDiff

getUnifiedDiff