com.google.gerrit.server.mail.send

Class OutgoingEmail

java.lang.Object

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

Direct Known Subclasses:

AddKeySender, DeleteKeySender, HttpPasswordUpdateSender, InboundEmailRejectionSender, 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 java.util.List<java.lang.String>	footers
protected Account.Id	fromId
protected java.lang.String	messageClass
protected NotifyHandling	notify
protected java.util.Map<java.lang.String,java.lang.Object>	soyContext
protected java.util.Map<java.lang.String,java.lang.Object>	soyContextEmailData

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, Account.Id to) Schedule delivery of this message to the given account.
protected void	add(RecipientType rt, Account.Id to, boolean override)
protected void	add(RecipientType rt, com.google.gerrit.mail.Address addr) Schedule delivery of this message to the given account.
protected void	add(RecipientType rt, com.google.gerrit.mail.Address addr, boolean override)
protected void	add(RecipientType rt, java.util.Collection<Account.Id> list) Schedule this message for delivery to the listed accounts.
protected void	add(RecipientType rt, java.util.Collection<Account.Id> list, boolean override) Schedule this message for delivery to the listed accounts.
protected void	add(RecipientType rt, UserIdentity who)
protected void	add(RecipientType rt, UserIdentity who, boolean override)
protected void	addByEmail(RecipientType rt, java.util.Collection<com.google.gerrit.mail.Address> list) Schedule this message for delivery to the listed address.
protected void	addByEmail(RecipientType rt, java.util.Collection<com.google.gerrit.mail.Address> list, boolean override) Schedule this message for delivery to the listed address.
protected void	appendHtml(java.lang.String html) Append html to the outgoing email body.
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()
protected java.lang.String	getNameEmailFor(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(Account.Id accountId) Lookup a human readable name for an account, usually the "full name".
java.lang.String	getSettingsUrl()
protected java.lang.String	getUserNameEmailFor(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(Account.Id to)
protected void	removeHeader(java.lang.String name) Remove a header from the outgoing message.
protected void	removeUser(Account user)
void	send() Format and enqueue the message for delivery.
void	setAccountsToNotify(com.google.common.collect.ListMultimap<RecipientType,Account.Id> accountsToNotify)
void	setFrom(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(NotifyHandling notify)
protected void	setupSoyContext()
protected boolean	shouldSendMessage()
protected java.lang.String	soyHtmlTemplate(java.lang.String name)
protected boolean	supportsHtml() Override this method to enable HTML in a subclass.
protected java.lang.String	textTemplate(java.lang.String name)
protected boolean	useHtml()

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

soyContext

protected java.util.Map<java.lang.String,java.lang.Object> soyContext

soyContextEmailData

protected java.util.Map<java.lang.String,java.lang.Object> soyContextEmailData

footers

protected java.util.List<java.lang.String> footers

args

protected final EmailArguments args

fromId

protected Account.Id fromId

notify

protected NotifyHandling notify

Constructor Detail

OutgoingEmail

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

Method Detail

setFrom

public void setFrom(Account.Id id)

setNotify

public void setNotify(NotifyHandling notify)

setAccountsToNotify

public void setAccountsToNotify(com.google.common.collect.ListMultimap<RecipientType,Account.Id> accountsToNotify)

send

public void send()
          throws EmailException

Format and enqueue the message for delivery.

Throws:

EmailException

format

protected abstract void format()
                        throws EmailException

Format the message body by calling appendText(String).

Throws:

EmailException

init

protected void init()
             throws EmailException

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

Throws:

EmailException - if an error occurred.

getFromLine

protected java.lang.String getFromLine()

getGerritHost

public java.lang.String getGerritHost()

getSettingsUrl

public java.lang.String getSettingsUrl()

setHeader

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

Set a header in the outgoing message.

removeHeader

protected void removeHeader(java.lang.String name)

Remove a header from 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.

appendHtml

protected void appendHtml(java.lang.String html)

Append html to the outgoing email body.

getNameFor

protected java.lang.String getNameFor(Account.Id accountId)

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

getNameEmailFor

protected java.lang.String getNameEmailFor(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

protected java.lang.String getUserNameEmailFor(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 or the accountId is null.

shouldSendMessage

protected boolean shouldSendMessage()

add

protected void add(RecipientType rt,
                   java.util.Collection<Account.Id> list)

Schedule this message for delivery to the listed accounts.

add

protected void add(RecipientType rt,
                   java.util.Collection<Account.Id> list,
                   boolean override)

Schedule this message for delivery to the listed accounts.

addByEmail

protected void addByEmail(RecipientType rt,
                          java.util.Collection<com.google.gerrit.mail.Address> list)

Schedule this message for delivery to the listed address.

addByEmail

protected void addByEmail(RecipientType rt,
                          java.util.Collection<com.google.gerrit.mail.Address> list,
                          boolean override)

Schedule this message for delivery to the listed address.

add

protected void add(RecipientType rt,
                   UserIdentity who)

add

protected void add(RecipientType rt,
                   UserIdentity who,
                   boolean override)

add

protected void add(RecipientType rt,
                   Account.Id to)

Schedule delivery of this message to the given account.

add

protected void add(RecipientType rt,
                   Account.Id to,
                   boolean override)

isVisibleTo

protected boolean isVisibleTo(Account.Id to)
                       throws PermissionBackendException

Parameters:

to - account.

Returns:

whether this email is visible to the given account.

Throws:

PermissionBackendException

add

protected void add(RecipientType rt,
                   com.google.gerrit.mail.Address addr)

Schedule delivery of this message to the given account.

add

protected void add(RecipientType rt,
                   com.google.gerrit.mail.Address addr,
                   boolean override)

setupSoyContext

protected void setupSoyContext()

textTemplate

protected java.lang.String textTemplate(java.lang.String name)

soyHtmlTemplate

protected java.lang.String soyHtmlTemplate(java.lang.String name)

removeUser

protected void removeUser(Account user)

useHtml

protected final boolean useHtml()

supportsHtml

protected boolean supportsHtml()

Override this method to enable HTML in a subclass.