AddKeySender (Gerrit Review Plugin API Documentation)

java.lang.Object
- com.google.gerrit.server.mail.send.OutgoingEmail
- - com.google.gerrit.server.mail.send.AddKeySender

public class AddKeySender
extends OutgoingEmail

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface AddKeySender.Factory

Field Summary
- Fields inherited from class com.google.gerrit.server.mail.send.OutgoingEmail
  args, footers, fromId, messageClass, notify, soyContext, soyContextEmailData

Constructor Summary

Constructors
Constructor	Description
`AddKeySender(EmailArguments ea, IdentifiedUser user, AccountSshKey sshKey)`
`AddKeySender(EmailArguments ea, IdentifiedUser user, List<String> gpgKeys)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`format()`	Format the message body by calling `OutgoingEmail.appendText(String)`.
`String`	`getEmail()`
`String`	`getGpgKeys()`
`String`	`getKeyType()`
`String`	`getSshKey()`
`String`	`getUserNameEmail()`
`protected void`	`init()`	Setup the message headers and envelope (TO, CC, BCC).
`protected void`	`setupSoyContext()`
`protected boolean`	`shouldSendMessage()`
`protected boolean`	`supportsHtml()`	Override this method to enable HTML in a subclass.

Methods inherited from class com.google.gerrit.server.mail.send.OutgoingEmail
add, add, add, add, add, add, add, add, addByEmail, addByEmail, appendHtml, appendText, getFromLine, getGerritHost, getNameEmailFor, getNameFor, getSettingsUrl, getUserNameEmailFor, isVisibleTo, removeHeader, removeUser, send, setFrom, setHeader, setHeader, setNotify, soyHtmlTemplate, textTemplate, useHtml

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AddKeySender

public AddKeySender(EmailArguments ea,
                    IdentifiedUser user,
                    AccountSshKey sshKey)

AddKeySender

public AddKeySender(EmailArguments ea,
                    IdentifiedUser user,
                    List<String> gpgKeys)

Method Detail
- init
```
protected void init()
             throws com.google.gerrit.exceptions.EmailException
```
  Description copied from class: OutgoingEmail
  
  Setup the message headers and envelope (TO, CC, BCC).
  
  Overrides:
  
  init in class OutgoingEmail
  
  Throws:
  
  com.google.gerrit.exceptions.EmailException - if an error occurred.
- shouldSendMessage
```
protected boolean shouldSendMessage()
```
  Overrides:
  
  shouldSendMessage in class OutgoingEmail
- format
```
protected void format()
               throws com.google.gerrit.exceptions.EmailException
```
  Description copied from class: OutgoingEmail
  
  Format the message body by calling OutgoingEmail.appendText(String).
  
  Specified by:
  
  format in class OutgoingEmail
  
  Throws:
  
  com.google.gerrit.exceptions.EmailException
- getEmail
```
public String getEmail()
```
- getUserNameEmail
```
public String getUserNameEmail()
```
- getKeyType
```
public String getKeyType()
```
- getSshKey
```
public String getSshKey()
```
- getGpgKeys
```
public String getGpgKeys()
```
- setupSoyContext
```
protected void setupSoyContext()
```
  Overrides:
  
  setupSoyContext in class OutgoingEmail
- supportsHtml
```
protected boolean supportsHtml()
```
  Description copied from class: OutgoingEmail
  
  Override this method to enable HTML in a subclass.
  
  Overrides:
  
  supportsHtml in class OutgoingEmail