Field Detail

• messageClass

  protected 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,
               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 String getFromLine()

• getGerritHost

  public String getGerritHost()

• getSettingsUrl

  public String getSettingsUrl()

• getGerritUrl

  public String getGerritUrl()

• setVHeader

  protected void setVHeader(String name,
                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(String name,
               String value)

  Set a header in the outgoing message.

• setHeader

  protected void setHeader(String name,
               Date date)

• appendText

  protected void appendText(String text)

  Append text to the outgoing email body.

• getNameFor

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

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

• getNameEmailFor

  public 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 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,
         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 String velocify(String template)
                     throws com.google.gerrit.common.errors.EmailException

  Throws:

  com.google.gerrit.common.errors.EmailException

• velocifyFile

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

  Throws:

  com.google.gerrit.common.errors.EmailException

• joinStrings

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

• joinStrings

  public String joinStrings(Iterator<Object> in,
                   String joiner)

• removeUser

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