com.google.gerrit.server.mail

Class OutgoingEmail

java.lang.Object

com.google.gerrit.server.mail.OutgoingEmail

Direct Known Subclasses:

AddKeySender, NotificationEmail, RegisterNewEmailSender

public abstract class OutgoingEmail
extends java.lang.Object

Sends an email to one or more interested parties.

Field Summary

Fields

Modifier and Type	Field and Description
protected EmailArguments	args
protected com.google.gerrit.reviewdb.client.Account.Id	fromId
protected java.lang.String	messageClass
protected com.google.gerrit.extensions.api.changes.NotifyHandling	notify
protected org.apache.velocity.VelocityContext	velocityContext

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OutgoingEmail(EmailArguments ea, java.lang.String mc)

Method Summary

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	add(RecipientType rt, Address addr) Schedule delivery of this message to the given account.
protected void	add(RecipientType rt, java.util.Collection<com.google.gerrit.reviewdb.client.Account.Id> list) Schedule this message for delivery to the listed accounts.
protected void	add(RecipientType rt, com.google.gerrit.reviewdb.client.UserIdentity who)
protected void	appendText(java.lang.String text) Append text to the outgoing email body.
protected abstract void	format() Format the message body by calling appendText(String).
protected java.lang.String	getFromLine()
java.lang.String	getGerritHost()
java.lang.String	getGerritUrl()
java.lang.String	getNameEmailFor(com.google.gerrit.reviewdb.client.Account.Id accountId) Gets the human readable name and email for an account; if neither are available, returns the Anonymous Coward name.
protected java.lang.String	getNameFor(com.google.gerrit.reviewdb.client.Account.Id accountId) Lookup a human readable name for an account, usually the "full name".
java.lang.String	getSettingsUrl()
java.lang.String	getUserNameEmailFor(com.google.gerrit.reviewdb.client.Account.Id accountId) Gets the human readable name and email for an account; if both are unavailable, returns the username.
protected void	init() Setup the message headers and envelope (TO, CC, BCC).
protected boolean	isVisibleTo(com.google.gerrit.reviewdb.client.Account.Id to)
java.lang.String	joinStrings(java.lang.Iterable<java.lang.Object> in, java.lang.String joiner)
java.lang.String	joinStrings(java.util.Iterator<java.lang.Object> in, java.lang.String joiner)
protected void	removeUser(com.google.gerrit.reviewdb.client.Account user)
void	send() Format and enqueue the message for delivery.
void	setFrom(com.google.gerrit.reviewdb.client.Account.Id id)
protected void	setHeader(java.lang.String name, java.util.Date date)
protected void	setHeader(java.lang.String name, java.lang.String value) Set a header in the outgoing message.
void	setNotify(com.google.gerrit.extensions.api.changes.NotifyHandling notify)
protected void	setupVelocityContext()
protected void	setVHeader(java.lang.String name, java.lang.String value) Set a header in the outgoing message using a template.
protected boolean	shouldSendMessage()
protected java.lang.String	velocify(java.lang.String template)
protected java.lang.String	velocifyFile(java.lang.String name)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

messageClass

protected java.lang.String messageClass

velocityContext

protected org.apache.velocity.VelocityContext velocityContext

args

protected final EmailArguments args

fromId

protected com.google.gerrit.reviewdb.client.Account.Id fromId

notify

protected com.google.gerrit.extensions.api.changes.NotifyHandling notify

Constructor Detail

OutgoingEmail

protected OutgoingEmail(EmailArguments ea,
                        java.lang.String mc)

Method Detail

setFrom

public void setFrom(com.google.gerrit.reviewdb.client.Account.Id id)

setNotify

public void setNotify(com.google.gerrit.extensions.api.changes.NotifyHandling notify)

send

public void send()
          throws com.google.gerrit.common.errors.EmailException

Format and enqueue the message for delivery.

Throws:

com.google.gerrit.common.errors.EmailException

format

protected abstract void format()
                        throws com.google.gerrit.common.errors.EmailException

Format the message body by calling 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).

Throws:

com.google.gerrit.common.errors.EmailException - if an error occurred.

getFromLine

protected java.lang.String getFromLine()

getGerritHost

public java.lang.String getGerritHost()

getSettingsUrl

public java.lang.String getSettingsUrl()

getGerritUrl

public java.lang.String getGerritUrl()

setVHeader

protected void setVHeader(java.lang.String name,
                          java.lang.String value)
                   throws com.google.gerrit.common.errors.EmailException

Set a header in the outgoing message using a template.

Throws:

com.google.gerrit.common.errors.EmailException

setHeader

protected void setHeader(java.lang.String name,
                         java.lang.String value)

Set a header in the outgoing message.

setHeader

protected void setHeader(java.lang.String name,
                         java.util.Date date)

appendText

protected void appendText(java.lang.String text)

Append text to the outgoing email body.

getNameFor

protected java.lang.String getNameFor(com.google.gerrit.reviewdb.client.Account.Id accountId)

Lookup a human readable name for an account, usually the "full name".

getNameEmailFor

public java.lang.String getNameEmailFor(com.google.gerrit.reviewdb.client.Account.Id accountId)

Gets the human readable name and email for an account; if neither are available, returns the Anonymous Coward name.

Parameters:

accountId - user to fetch.

Returns:

name/email of account, or Anonymous Coward if unset.

getUserNameEmailFor

public java.lang.String getUserNameEmailFor(com.google.gerrit.reviewdb.client.Account.Id accountId)

Gets the human readable name and email for an account; if both are unavailable, returns the username. If no username is set, this function returns null.

Parameters:

accountId - user to fetch.

Returns:

name/email of account, username, or null if unset.

shouldSendMessage

protected boolean shouldSendMessage()

add

protected void add(RecipientType rt,
                   java.util.Collection<com.google.gerrit.reviewdb.client.Account.Id> list)

Schedule this message for delivery to the listed accounts.

add

protected void add(RecipientType rt,
                   com.google.gerrit.reviewdb.client.UserIdentity who)

add

protected void add(RecipientType rt,
                   com.google.gerrit.reviewdb.client.Account.Id to)

Schedule delivery of this message to the given account.

isVisibleTo

protected boolean isVisibleTo(com.google.gerrit.reviewdb.client.Account.Id to)
                       throws com.google.gwtorm.server.OrmException

Parameters:

to - account.

Returns:

whether this email is visible to the given account.

Throws:

com.google.gwtorm.server.OrmException

add

protected void add(RecipientType rt,
                   Address addr)

Schedule delivery of this message to the given account.

setupVelocityContext

protected void setupVelocityContext()

velocify

protected java.lang.String velocify(java.lang.String template)
                             throws com.google.gerrit.common.errors.EmailException

Throws:

com.google.gerrit.common.errors.EmailException

velocifyFile

protected java.lang.String velocifyFile(java.lang.String name)
                                 throws com.google.gerrit.common.errors.EmailException

Throws:

com.google.gerrit.common.errors.EmailException

joinStrings

public java.lang.String joinStrings(java.lang.Iterable<java.lang.Object> in,
                                    java.lang.String joiner)

joinStrings

public java.lang.String joinStrings(java.util.Iterator<java.lang.Object> in,
                                    java.lang.String joiner)

removeUser

protected void removeUser(com.google.gerrit.reviewdb.client.Account user)