NotificationEmail (Gerrit Review Plugin API Documentation)

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

Direct Known Subclasses:

ChangeEmail
```
public abstract class NotificationEmail
extends OutgoingEmail
```
Common class for notifications that are related to a project and branch

Field Summary

Fields
Modifier and Type Field and Description

protected com.google.gerrit.reviewdb.client.Branch.NameKey branch

protected com.google.gerrit.reviewdb.client.Project.NameKey project
- Fields inherited from class com.google.gerrit.server.mail.OutgoingEmail
  args, fromId, messageClass, velocityContext

Fields
Modifier and Type	Field and Description
`protected com.google.gerrit.reviewdb.client.Branch.NameKey`	`branch`
`protected com.google.gerrit.reviewdb.client.Project.NameKey`	`project`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`NotificationEmail(EmailArguments ea, java.lang.String mc, com.google.gerrit.reviewdb.client.Project.NameKey project, com.google.gerrit.reviewdb.client.Branch.NameKey branch)`

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`add(RecipientType type, com.google.gerrit.server.mail.ProjectWatch.Watchers.List list)` Add users or email addresses to the TO, CC, or BCC list.
`java.lang.String`	`getListId()`
`java.lang.String`	`getSshHost()`
`protected abstract ProjectWatch.Watchers`	`getWatchers(com.google.gerrit.reviewdb.client.AccountProjectWatch.NotifyType type)` Returns all watchers that are relevant
`protected void`	`includeWatchers(com.google.gerrit.reviewdb.client.AccountProjectWatch.NotifyType type)` Include users and groups that want notification of events.
`protected void`	`init()` Setup the message headers and envelope (TO, CC, BCC).
`protected void`	`setupVelocityContext()`

Methods inherited from class com.google.gerrit.server.mail.OutgoingEmail
add, add, add, add, appendText, format, getFromLine, getGerritHost, getGerritUrl, getNameEmailFor, getNameFor, getSettingsUrl, isVisibleTo, joinStrings, joinStrings, send, setFrom, 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

project

protected com.google.gerrit.reviewdb.client.Project.NameKey project

branch

protected com.google.gerrit.reviewdb.client.Branch.NameKey branch

Constructor Detail

NotificationEmail

protected NotificationEmail(EmailArguments ea,
                 java.lang.String mc,
                 com.google.gerrit.reviewdb.client.Project.NameKey project,
                 com.google.gerrit.reviewdb.client.Branch.NameKey branch)

Method Detail

init
```
protected void init()
             throws com.google.gerrit.common.errors.EmailException
```
Description copied from class: OutgoingEmail

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

Overrides:

init in class OutgoingEmail

Throws:

com.google.gerrit.common.errors.EmailException

getListId

public java.lang.String getListId()
                           throws com.google.gerrit.common.errors.EmailException

Throws:: com.google.gerrit.common.errors.EmailException

includeWatchers

protected void includeWatchers(com.google.gerrit.reviewdb.client.AccountProjectWatch.NotifyType type)

Include users and groups that want notification of events.

getWatchers

protected abstract ProjectWatch.Watchers getWatchers(com.google.gerrit.reviewdb.client.AccountProjectWatch.NotifyType type)
                                              throws com.google.gwtorm.server.OrmException

Returns all watchers that are relevant

Throws:: com.google.gwtorm.server.OrmException

add

protected void add(RecipientType type,
       com.google.gerrit.server.mail.ProjectWatch.Watchers.List list)

Add users or email addresses to the TO, CC, or BCC list.

getSshHost
```
public java.lang.String getSshHost()
```

setupVelocityContext
```
protected void setupVelocityContext()
```
Overrides:

setupVelocityContext in class OutgoingEmail

Class NotificationEmail

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

project

branch

Constructor Detail

NotificationEmail

Method Detail

init

getListId

includeWatchers

getWatchers

add

getSshHost

setupVelocityContext