com.google.gerrit.server.mail.send

Class ChangeEmail

java.lang.Object

com.google.gerrit.server.mail.send.OutgoingEmail

com.google.gerrit.server.mail.send.NotificationEmail

com.google.gerrit.server.mail.send.ChangeEmail

Direct Known Subclasses:

NewChangeSender, ReplyToChangeSender, SetAssigneeSender

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<Account.Id>	authors
protected Change	change
protected ChangeData	changeData
protected java.lang.String	changeMessage
protected boolean	emailOnlyAuthors
protected PatchSet	patchSet
protected PatchSetInfo	patchSetInfo
protected ProjectState	projectState
protected com.google.common.collect.ListMultimap<Account.Id,java.lang.String>	stars
protected java.sql.Timestamp	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, velocityContext

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ChangeEmail(EmailArguments ea, java.lang.String mc, ChangeData cd)

Method Summary

Modifier and Type	Method and Description
protected void	add(RecipientType rt, 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<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".
boolean	getIncludeDiff()
protected PatchList	getPatchList() Get the patch list corresponding to this patch set.
protected java.util.Set<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(WatchConfig.NotifyType type, boolean includeWatchersFromNotifyConfig) Returns all watchers that are relevant
protected void	init() Setup the message headers and envelope (TO, CC, BCC).
protected boolean	isVisibleTo(Account.Id to)
protected static ChangeData	newChangeData(EmailArguments ea, Project.NameKey project, Change.Id id)
protected void	rcptToAuthors(RecipientType rt) TO or CC all vested parties (change owner, patch set uploader, author).
protected void	removeUsersThatIgnoredTheChange()
void	setChangeMessage(ChangeMessage cm) Deprecated.
void	setChangeMessage(java.lang.String cm, java.sql.Timestamp t)
void	setFrom(Account.Id id)
void	setPatchSet(PatchSet ps)
void	setPatchSet(PatchSet ps, PatchSetInfo psi)
protected void	setupSoyContext()
protected void	setupVelocityContext()

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

add, getListId, getSshHost, includeWatchers, includeWatchers

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

add, add, add, add, add, add, add, addByEmail, addByEmail, appendHtml, appendText, getFromLine, getGerritHost, getGerritUrl, getNameEmailFor, getNameFor, getSettingsUrl, getUserNameEmailFor, removeHeader, removeUser, send, setAccountsToNotify, setHeader, setHeader, setNotify, setVHeader, shouldSendMessage, soyHtmlTemplate, soyTextTemplate, supportsHtml, textTemplate, useHtml, 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 Change change

changeData

protected final ChangeData changeData

stars

protected com.google.common.collect.ListMultimap<Account.Id,java.lang.String> stars

patchSet

protected PatchSet patchSet

patchSetInfo

protected PatchSetInfo patchSetInfo

changeMessage

protected java.lang.String changeMessage

timestamp

protected java.sql.Timestamp timestamp

projectState

protected ProjectState projectState

authors

protected java.util.Set<Account.Id> authors

emailOnlyAuthors

protected boolean emailOnlyAuthors

Constructor Detail

ChangeEmail

protected ChangeEmail(EmailArguments ea,
                      java.lang.String mc,
                      ChangeData cd)
               throws com.google.gwtorm.server.OrmException

Throws:

com.google.gwtorm.server.OrmException

Method Detail

newChangeData

protected static ChangeData newChangeData(EmailArguments ea,
                                          Project.NameKey project,
                                          Change.Id id)

setFrom

public void setFrom(Account.Id id)

Overrides:

setFrom in class OutgoingEmail

setPatchSet

public void setPatchSet(PatchSet ps)

setPatchSet

public void setPatchSet(PatchSet ps,
                        PatchSetInfo psi)

setChangeMessage

@Deprecated
public void setChangeMessage(ChangeMessage cm)

Deprecated.

setChangeMessage

public void setChangeMessage(java.lang.String cm,
                             java.sql.Timestamp t)

format

protected void format()
               throws EmailException

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

Specified by:

format in class OutgoingEmail

Throws:

EmailException

formatChange

protected abstract void formatChange()
                              throws EmailException

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

Throws:

EmailException

formatFooter

protected void formatFooter()
                     throws EmailException

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

Throws:

EmailException - if an error occurred.

init

protected void init()
             throws EmailException

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

Overrides:

init in class NotificationEmail

Throws:

EmailException - if an error occurred.

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 EmailException

Throws:

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".

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<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.

removeUsersThatIgnoredTheChange

protected void removeUsersThatIgnoredTheChange()

getWatchers

protected final ProjectWatch.Watchers getWatchers(WatchConfig.NotifyType type,
                                                  boolean includeWatchersFromNotifyConfig)
                                           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,
                   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(Account.Id to)
                       throws com.google.gwtorm.server.OrmException,
                              PermissionBackendException

Overrides:

isVisibleTo in class OutgoingEmail

Parameters:

to - account.

Returns:

whether this email is visible to the given account.

Throws:

com.google.gwtorm.server.OrmException

PermissionBackendException

getAuthors

protected java.util.Set<Account.Id> getAuthors()

Find all users who are authors of any part of this change.

setupVelocityContext

protected void setupVelocityContext()

Overrides:

setupVelocityContext in class NotificationEmail

setupSoyContext

protected void setupSoyContext()

Overrides:

setupSoyContext in class NotificationEmail

getIncludeDiff

public boolean getIncludeDiff()

getUnifiedDiff

public java.lang.String getUnifiedDiff()

Show patch set as unified difference.