public final class VerifyEmailAccountConfig extends Object implements StageConfig
Modifier and Type | Field and Description |
---|---|
static String |
NAME
Name of the stage configuration.
|
Constructor and Description |
---|
VerifyEmailAccountConfig() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object o) |
Map<String,String> |
getEmailServiceParameters()
Gets additional parameters for the email service.
|
String |
getEmailServiceUrl()
Gets the URL for the email service.
|
String |
getFrom()
Gets the from part for the verification email.
|
String |
getIdentityEmailField()
Gets the field name for the identity email address.
|
Map<Locale,String> |
getMessageTranslations()
Gets the message map for the verification email.
|
String |
getMimeType()
Gets the mime-type of the email message.
|
String |
getName()
Gets the name of the stage configuration.
|
String |
getProgressStageClassName()
Gets the class name of the consuming progress stage.
|
Map<Locale,String> |
getSubjectTranslations()
Gets the subject map for the verification email.
|
String |
getVerificationLink()
Gets the verification URL to be passed into the email body.
|
String |
getVerificationLinkToken()
Gets the string token representing where the verification URL should be substituted.
|
int |
hashCode() |
VerifyEmailAccountConfig |
setEmailServiceParameters(Map<String,String> emailServiceParameters)
Sets any parameters for the email service.
|
VerifyEmailAccountConfig |
setEmailServiceUrl(String emailServiceUrl)
Sets the URL for the email service.
|
VerifyEmailAccountConfig |
setFrom(String from)
Sets the from part for the verification email.
|
VerifyEmailAccountConfig |
setIdentityEmailField(String identityEmailField)
Sets the field name for the identity email address.
|
VerifyEmailAccountConfig |
setMessageTranslations(Map<Locale,String> messageTranslations)
Sets the message map for the verification email.
|
VerifyEmailAccountConfig |
setMimeType(String mimeType)
Sets the message mime-type.
|
VerifyEmailAccountConfig |
setSubjectTranslations(Map<Locale,String> subjectTranslations)
Sets the subject map for the verification email.
|
VerifyEmailAccountConfig |
setVerificationLink(String verificationLink)
Sets the verification URL to be passed into the email body.
|
VerifyEmailAccountConfig |
setVerificationLinkToken(String verificationLinkToken)
Sets the string token representing where the verification URL should be substituted.
|
public static final String NAME
public String getEmailServiceUrl()
public VerifyEmailAccountConfig setEmailServiceUrl(String emailServiceUrl)
emailServiceUrl
- the email service URLpublic Map<String,String> getEmailServiceParameters()
public VerifyEmailAccountConfig setEmailServiceParameters(Map<String,String> emailServiceParameters)
emailServiceParameters
- the email service Parameterspublic Map<Locale,String> getSubjectTranslations()
public VerifyEmailAccountConfig setSubjectTranslations(Map<Locale,String> subjectTranslations)
subjectTranslations
- the email subject map (locale to string)public Map<Locale,String> getMessageTranslations()
public VerifyEmailAccountConfig setMessageTranslations(Map<Locale,String> messageTranslations)
messageTranslations
- the email message map (locale to string)public String getMimeType()
public VerifyEmailAccountConfig setMimeType(String mimeType)
mimeType
- the message mime-typepublic String getFrom()
public VerifyEmailAccountConfig setFrom(String from)
from
- the email from fieldpublic String getVerificationLinkToken()
public VerifyEmailAccountConfig setVerificationLinkToken(String verificationLinkToken)
verificationLinkToken
- the verification URL string tokenpublic String getVerificationLink()
public VerifyEmailAccountConfig setVerificationLink(String verificationLink)
verificationLink
- the verification URLpublic String getIdentityEmailField()
public VerifyEmailAccountConfig setIdentityEmailField(String identityEmailField)
identityEmailField
- the identity email address field namepublic String getName()
StageConfig
getName
in interface StageConfig
public String getProgressStageClassName()
StageConfig
getProgressStageClassName
in interface StageConfig
Copyright © 2010-2020, ForgeRock All Rights Reserved.