Package com.atlassian.bitbucket.mail

Class SoyMailMessageRequest

java.lang.Object

com.atlassian.bitbucket.mail.SoyMailMessageRequest

public class SoyMailMessageRequest
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SoyMailMessageRequest.Builder

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getContext()
String	getCssModuleKey()
Function<MailMessage.Builder,MailMessage.Builder>	getMessageEffector()	Can be passed that will be given the opportunity to add to the MailMessage.Builder, returning a new Builder to use for the MailMessage.
Iterable<ApplicationUser>	getRecipients()
String	getSoyTemplateModuleKey()
String	getSoyTemplateName()
I18nKey	getSubjectKey()

Methods inherited from class java.lang.Object

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

Method Details

getContext

@Nonnull
public Map<String,Object> getContext()

getCssModuleKey

@Nonnull
public String getCssModuleKey()

Returns:

the key of the css module to inline into the mail message

getRecipients

@Nonnull
public Iterable<ApplicationUser> getRecipients()

Returns:

the list of users to be sent the mail

getSoyTemplateModuleKey

@Nonnull
public String getSoyTemplateModuleKey()

Returns:

the key of the module containing the soy template

getSoyTemplateName

@Nonnull
public String getSoyTemplateName()

Returns:

the name of the soy template to render

getSubjectKey

@Nullable
public I18nKey getSubjectKey()

Returns:

the i18n key of the mail subject line

getMessageEffector

@Nonnull
public Function<MailMessage.Builder,MailMessage.Builder> getMessageEffector()

Can be passed that will be given the opportunity to add to the MailMessage.Builder, returning a new Builder to use for the MailMessage. The SoyMailer will set the text, to, subject etc, so these can be over-ridden or used to set headers.

Returns:

a MailMessage.Builder