Package com.google.gerrit.server.mail

Interface EmailFactories

All Known Implementing Classes:

DefaultEmailFactories

public interface EmailFactories

Set of factories for default email notifications.

To send a change related email, first ChangeEmail.ChangeEmailDecorator needs to be constructed and configured. The decorator is then passed in createChangeEmail(NameKey, Change.Id, ChangeEmailDecorator) and finally the result to createOutgoingEmail(String, EmailDecorator) to be sent.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATTENTION_SET_ADDED
static final String	ATTENTION_SET_REMOVED
static final String	CHANGE_ABANDONED
static final String	CHANGE_MERGED
static final String	CHANGE_RESTORED
static final String	CHANGE_REVERTED
static final String	COMMENTS_ADDED
static final String	INBOUND_EMAIL_REJECTED
static final String	KEY_ADDED
static final String	KEY_DELETED
static final String	NEW_EMAIL_REGISTERED
static final String	NEW_PATCHSET_ADDED
static final String	PASSWORD_UPDATED
static final String	REVIEW_REQUESTED
static final String	REVIEWER_DELETED
static final String	VOTE_DELETED

Method Summary

Modifier and Type	Method	Description
ChangeEmail.ChangeEmailDecorator	createAbandonedChangeEmail()	ChangeEmail decorator that adds information about change being abandoned to the email.
OutgoingEmail.EmailDecorator	createAddKeyEmail(IdentifiedUser user, AccountSshKey sshKey)	Email decorator for adding a key to the account.
OutgoingEmail.EmailDecorator	createAddKeyEmail(IdentifiedUser user, List<String> gpgKeys)	Email decorator for adding gpg keys to the account.
AttentionSetChangeEmailDecorator	createAttentionSetChangeEmail()	ChangeEmail decorator that adds information about attention set change to the email.
ChangeEmail	createChangeEmail(Project.NameKey project, Change.Id changeId, ChangeEmail.ChangeEmailDecorator changeEmailDecorator)	Base email decorator for change-related emails.
CommentChangeEmailDecorator	createCommentChangeEmail(Project.NameKey project, Change.Id changeId, org.eclipse.jgit.lib.ObjectId preUpdateMetaId, Map<SubmitRequirement,SubmitRequirementResult> postUpdateSubmitRequirementResults)	ChangeEmail decorator that adds information about an iteration of review to the email.
OutgoingEmail.EmailDecorator	createDeleteKeyEmail(IdentifiedUser user, AccountSshKey sshKey)	Email decorator for adding a key to the account.
OutgoingEmail.EmailDecorator	createDeleteKeyEmail(IdentifiedUser user, List<String> gpgKeys)	Email decorator for adding gpg keys to the account.
DeleteReviewerChangeEmailDecorator	createDeleteReviewerChangeEmail()	ChangeEmail decorator that adds information about deleted reviewer to the email.
ChangeEmail.ChangeEmailDecorator	createDeleteVoteChangeEmail()	ChangeEmail decorator that adds information about deleted vote to the email.
OutgoingEmail.EmailDecorator	createHttpPasswordUpdateEmail(IdentifiedUser user, String operation)	Email decorator for password modification operations.
OutgoingEmail.EmailDecorator	createInboundEmailRejectionEmail(Address to, String threadId, InboundEmailRejectionEmailDecorator.InboundEmailError reason)	Email decorator for inbound email errors.
ChangeEmail.ChangeEmailDecorator	createMergedChangeEmail(Optional<String> stickyApprovalDiff)	ChangeEmail decorator that adds information about change being merged to the email.
OutgoingEmail	createOutgoingEmail(String messageClass, OutgoingEmail.EmailDecorator emailDecorator)	Base class for any outgoing email.
RegisterNewEmailDecorator	createRegisterNewEmail(String address)	Email decorator for the "new email address added" notification.
ReplacePatchSetChangeEmailDecorator	createReplacePatchSetChangeEmail(Project.NameKey project, Change.Id changeId, ChangeKind changeKind, org.eclipse.jgit.lib.ObjectId preUpdateMetaId, Map<SubmitRequirement,SubmitRequirementResult> postUpdateSubmitRequirementResults)	ChangeEmail decorator that adds information about a new patchset added to the change.
ChangeEmail.ChangeEmailDecorator	createRestoredChangeEmail()	ChangeEmail decorator that adds information about change being restored to the email.
ChangeEmail.ChangeEmailDecorator	createRevertedChangeEmail()	ChangeEmail decorator that adds information about change being reverted to the email.
StartReviewChangeEmailDecorator	createStartReviewChangeEmail()	ChangeEmail decorator that adds information when change is uploaded or first sent to review.

Field Details

CHANGE_ABANDONED

static final String CHANGE_ABANDONED

See Also:

• Constant Field Values

ATTENTION_SET_ADDED

static final String ATTENTION_SET_ADDED

See Also:

• Constant Field Values

ATTENTION_SET_REMOVED

static final String ATTENTION_SET_REMOVED

See Also:

• Constant Field Values

COMMENTS_ADDED

static final String COMMENTS_ADDED

See Also:

• Constant Field Values

REVIEWER_DELETED

static final String REVIEWER_DELETED

See Also:

• Constant Field Values

VOTE_DELETED

static final String VOTE_DELETED

See Also:

• Constant Field Values

CHANGE_MERGED

static final String CHANGE_MERGED

See Also:

• Constant Field Values

NEW_PATCHSET_ADDED

static final String NEW_PATCHSET_ADDED

See Also:

• Constant Field Values

CHANGE_RESTORED

static final String CHANGE_RESTORED

See Also:

• Constant Field Values

CHANGE_REVERTED

static final String CHANGE_REVERTED

See Also:

• Constant Field Values

REVIEW_REQUESTED

static final String REVIEW_REQUESTED

See Also:

• Constant Field Values

KEY_ADDED

static final String KEY_ADDED

See Also:

• Constant Field Values

KEY_DELETED

static final String KEY_DELETED

See Also:

• Constant Field Values

PASSWORD_UPDATED

static final String PASSWORD_UPDATED

See Also:

• Constant Field Values

INBOUND_EMAIL_REJECTED

static final String INBOUND_EMAIL_REJECTED

See Also:

• Constant Field Values

NEW_EMAIL_REGISTERED

static final String NEW_EMAIL_REGISTERED

See Also:

• Constant Field Values

Method Details

createAbandonedChangeEmail

ChangeEmail.ChangeEmailDecorator createAbandonedChangeEmail()

ChangeEmail decorator that adds information about change being abandoned to the email.

createAttentionSetChangeEmail

AttentionSetChangeEmailDecorator createAttentionSetChangeEmail()

ChangeEmail decorator that adds information about attention set change to the email.

createCommentChangeEmail

CommentChangeEmailDecorator createCommentChangeEmail(Project.NameKey project,
 Change.Id changeId,
 org.eclipse.jgit.lib.ObjectId preUpdateMetaId,
 Map<SubmitRequirement,SubmitRequirementResult> postUpdateSubmitRequirementResults)

ChangeEmail decorator that adds information about an iteration of review to the email.

createDeleteReviewerChangeEmail

DeleteReviewerChangeEmailDecorator createDeleteReviewerChangeEmail()

ChangeEmail decorator that adds information about deleted reviewer to the email.

createDeleteVoteChangeEmail

ChangeEmail.ChangeEmailDecorator createDeleteVoteChangeEmail()

ChangeEmail decorator that adds information about deleted vote to the email.

createMergedChangeEmail

ChangeEmail.ChangeEmailDecorator createMergedChangeEmail(Optional<String> stickyApprovalDiff)

ChangeEmail decorator that adds information about change being merged to the email.

createReplacePatchSetChangeEmail

ReplacePatchSetChangeEmailDecorator createReplacePatchSetChangeEmail(Project.NameKey project,
 Change.Id changeId,
 ChangeKind changeKind,
 org.eclipse.jgit.lib.ObjectId preUpdateMetaId,
 Map<SubmitRequirement,SubmitRequirementResult> postUpdateSubmitRequirementResults)

ChangeEmail decorator that adds information about a new patchset added to the change.

createRestoredChangeEmail

ChangeEmail.ChangeEmailDecorator createRestoredChangeEmail()

ChangeEmail decorator that adds information about change being restored to the email.

createRevertedChangeEmail

ChangeEmail.ChangeEmailDecorator createRevertedChangeEmail()

ChangeEmail decorator that adds information about change being reverted to the email.

createStartReviewChangeEmail

StartReviewChangeEmailDecorator createStartReviewChangeEmail()

ChangeEmail decorator that adds information when change is uploaded or first sent to review.

createChangeEmail

ChangeEmail createChangeEmail(Project.NameKey project,
 Change.Id changeId,
 ChangeEmail.ChangeEmailDecorator changeEmailDecorator)

Base email decorator for change-related emails.

createAddKeyEmail

OutgoingEmail.EmailDecorator createAddKeyEmail(IdentifiedUser user,
 AccountSshKey sshKey)

Email decorator for adding a key to the account.

createAddKeyEmail

OutgoingEmail.EmailDecorator createAddKeyEmail(IdentifiedUser user,
 List<String> gpgKeys)

Email decorator for adding gpg keys to the account.

createDeleteKeyEmail

OutgoingEmail.EmailDecorator createDeleteKeyEmail(IdentifiedUser user,
 AccountSshKey sshKey)

Email decorator for adding a key to the account.

createDeleteKeyEmail

OutgoingEmail.EmailDecorator createDeleteKeyEmail(IdentifiedUser user,
 List<String> gpgKeys)

Email decorator for adding gpg keys to the account.

createHttpPasswordUpdateEmail

OutgoingEmail.EmailDecorator createHttpPasswordUpdateEmail(IdentifiedUser user,
 String operation)

Email decorator for password modification operations.

createInboundEmailRejectionEmail

OutgoingEmail.EmailDecorator createInboundEmailRejectionEmail(Address to,
 String threadId,
 InboundEmailRejectionEmailDecorator.InboundEmailError reason)

Email decorator for inbound email errors.

createRegisterNewEmail

RegisterNewEmailDecorator createRegisterNewEmail(String address)

Email decorator for the "new email address added" notification.

createOutgoingEmail

OutgoingEmail createOutgoingEmail(String messageClass,
 OutgoingEmail.EmailDecorator emailDecorator)

Base class for any outgoing email.