Safe Haskell	Safe-Inferred
Language	GHC2021

Wire.EmailSubsystem.Template

Contents

Re-exports

Synopsis

data Localised a = Localised {
- locDefault :: (Locale, a)
- locOther :: Map Locale a
}
type TemplateBranding = Text -> Text
data UserTemplates = UserTemplates {
- activationSms :: ActivationSmsTemplate
- activationCall :: ActivationCallTemplate
- verificationEmail :: VerificationEmailTemplate
- activationEmail :: ActivationEmailTemplate
- activationEmailUpdate :: ActivationEmailTemplate
- teamActivationEmail :: TeamActivationEmailTemplate
- passwordResetSms :: PasswordResetSmsTemplate
- passwordResetEmail :: PasswordResetEmailTemplate
- loginSms :: LoginSmsTemplate
- loginCall :: LoginCallTemplate
- deletionSms :: DeletionSmsTemplate
- deletionEmail :: DeletionEmailTemplate
- upgradePersonalToTeamEmail :: UpgradePersonalToTeamEmailTemplate
- newClientEmail :: NewClientEmailTemplate
- verificationLoginEmail :: SecondFactorVerificationEmailTemplate
- verificationScimTokenEmail :: SecondFactorVerificationEmailTemplate
- verificationTeamDeletionEmail :: SecondFactorVerificationEmailTemplate
}
data ActivationSmsTemplate = ActivationSmsTemplate {
- activationSmslUrl :: Template
- activationSmsText :: Template
- activationSmsSender :: Text
}
data ActivationCallTemplate = ActivationCallTemplate {
- activationCallText :: Template
}
data VerificationEmailTemplate = VerificationEmailTemplate {
- verificationEmailUrl :: Template
- verificationEmailSubject :: Template
- verificationEmailBodyText :: Template
- verificationEmailBodyHtml :: Template
- verificationEmailSender :: EmailAddress
- verificationEmailSenderName :: Text
}
data ActivationEmailTemplate = ActivationEmailTemplate {
- activationEmailUrl :: Template
- activationEmailSubject :: Template
- activationEmailBodyText :: Template
- activationEmailBodyHtml :: Template
- activationEmailSender :: EmailAddress
- activationEmailSenderName :: Text
}
data TeamActivationEmailTemplate = TeamActivationEmailTemplate {
- teamActivationEmailUrl :: Template
- teamActivationEmailSubject :: Template
- teamActivationEmailBodyText :: Template
- teamActivationEmailBodyHtml :: Template
- teamActivationEmailSender :: EmailAddress
- teamActivationEmailSenderName :: Text
}
data PasswordResetSmsTemplate = PasswordResetSmsTemplate {
- passwordResetSmsText :: Template
- passwordResetSmsSender :: Text
}
data PasswordResetEmailTemplate = PasswordResetEmailTemplate {
- passwordResetEmailUrl :: Template
- passwordResetEmailSubject :: Template
- passwordResetEmailBodyText :: Template
- passwordResetEmailBodyHtml :: Template
- passwordResetEmailSender :: EmailAddress
- passwordResetEmailSenderName :: Text
}
data LoginSmsTemplate = LoginSmsTemplate {
- loginSmsUrl :: Template
- loginSmsText :: Template
- loginSmsSender :: Text
}
data LoginCallTemplate = LoginCallTemplate {
- loginCallText :: Template
}
data DeletionSmsTemplate = DeletionSmsTemplate {
- deletionSmsUrl :: Template
- deletionSmsText :: Template
- deletionSmsSender :: Text
}
data DeletionEmailTemplate = DeletionEmailTemplate {
- deletionEmailUrl :: Template
- deletionEmailSubject :: Template
- deletionEmailBodyText :: Template
- deletionEmailBodyHtml :: Template
- deletionEmailSender :: EmailAddress
- deletionEmailSenderName :: Text
}
data UpgradePersonalToTeamEmailTemplate = UpgradePersonalToTeamEmailTemplate {
- upgradePersonalToTeamEmailSubject :: Template
- upgradePersonalToTeamEmailBodyText :: Template
- upgradePersonalToTeamEmailBodyHtml :: Template
- upgradePersonalToTeamEmailSender :: EmailAddress
- upgradePersonalToTeamEmailSenderName :: Text
}
data NewClientEmailTemplate = NewClientEmailTemplate {
- newClientEmailSubject :: Template
- newClientEmailBodyText :: Template
- newClientEmailBodyHtml :: Template
- newClientEmailSender :: EmailAddress
- newClientEmailSenderName :: Text
}
data SecondFactorVerificationEmailTemplate = SecondFactorVerificationEmailTemplate {
- sndFactorVerificationEmailSubject :: Template
- sndFactorVerificationEmailBodyText :: Template
- sndFactorVerificationEmailBodyHtml :: Template
- sndFactorVerificationEmailSender :: EmailAddress
- sndFactorVerificationEmailSenderName :: Text
}
data InvitationEmailTemplate = InvitationEmailTemplate {
- invitationEmailUrl :: !Template
- invitationEmailSubject :: !Template
- invitationEmailBodyText :: !Template
- invitationEmailBodyHtml :: !Template
- invitationEmailSender :: !EmailAddress
- invitationEmailSenderName :: !Text
}
data CreatorWelcomeEmailTemplate = CreatorWelcomeEmailTemplate {
- creatorWelcomeEmailUrl :: !Text
- creatorWelcomeEmailSubject :: !Template
- creatorWelcomeEmailBodyText :: !Template
- creatorWelcomeEmailBodyHtml :: !Template
- creatorWelcomeEmailSender :: !EmailAddress
- creatorWelcomeEmailSenderName :: !Text
}
data MemberWelcomeEmailTemplate = MemberWelcomeEmailTemplate {
- memberWelcomeEmailUrl :: !Text
- memberWelcomeEmailSubject :: !Template
- memberWelcomeEmailBodyText :: !Template
- memberWelcomeEmailBodyHtml :: !Template
- memberWelcomeEmailSender :: !EmailAddress
- memberWelcomeEmailSenderName :: !Text
}
data TeamTemplates = TeamTemplates {
- invitationEmail :: !InvitationEmailTemplate
- existingUserInvitationEmail :: !InvitationEmailTemplate
- creatorWelcomeEmail :: !CreatorWelcomeEmailTemplate
- memberWelcomeEmail :: !MemberWelcomeEmailTemplate
}
forLocale :: Maybe Locale -> Localised a -> (Locale, a)
renderTextWithBranding :: Template -> (Text -> Text) -> TemplateBranding -> Text
renderHtmlWithBranding :: Template -> (Text -> Text) -> TemplateBranding -> Text
data Template

Documentation

data Localised a Source #

Localised templates.

Constructors

Localised
Fields locDefault :: (Locale, a) locOther :: Map Locale a

type TemplateBranding = Text -> Text Source #

See genTemplateBranding.

data UserTemplates Source #

Constructors

UserTemplates

data ActivationSmsTemplate Source #

Constructors

ActivationSmsTemplate
Fields activationSmslUrl :: Template activationSmsText :: Template activationSmsSender :: Text

data ActivationCallTemplate Source #

Constructors

ActivationCallTemplate
Fields activationCallText :: Template

data VerificationEmailTemplate Source #

Constructors

VerificationEmailTemplate
Fields verificationEmailUrl :: Template verificationEmailSubject :: Template verificationEmailBodyText :: Template verificationEmailBodyHtml :: Template verificationEmailSender :: EmailAddress verificationEmailSenderName :: Text

data ActivationEmailTemplate Source #

Constructors

ActivationEmailTemplate
Fields activationEmailUrl :: Template activationEmailSubject :: Template activationEmailBodyText :: Template activationEmailBodyHtml :: Template activationEmailSender :: EmailAddress activationEmailSenderName :: Text

data TeamActivationEmailTemplate Source #

Constructors

TeamActivationEmailTemplate
Fields teamActivationEmailUrl :: Template teamActivationEmailSubject :: Template teamActivationEmailBodyText :: Template teamActivationEmailBodyHtml :: Template teamActivationEmailSender :: EmailAddress teamActivationEmailSenderName :: Text

data PasswordResetSmsTemplate Source #

Constructors

PasswordResetSmsTemplate
Fields passwordResetSmsText :: Template passwordResetSmsSender :: Text

data PasswordResetEmailTemplate Source #

Constructors

PasswordResetEmailTemplate
Fields passwordResetEmailUrl :: Template passwordResetEmailSubject :: Template passwordResetEmailBodyText :: Template passwordResetEmailBodyHtml :: Template passwordResetEmailSender :: EmailAddress passwordResetEmailSenderName :: Text

data LoginSmsTemplate Source #

Constructors

LoginSmsTemplate
Fields loginSmsUrl :: Template loginSmsText :: Template loginSmsSender :: Text

data LoginCallTemplate Source #

Constructors

LoginCallTemplate
Fields loginCallText :: Template

data DeletionSmsTemplate Source #

Constructors

DeletionSmsTemplate
Fields deletionSmsUrl :: Template deletionSmsText :: Template deletionSmsSender :: Text

data DeletionEmailTemplate Source #

Constructors

DeletionEmailTemplate
Fields deletionEmailUrl :: Template deletionEmailSubject :: Template deletionEmailBodyText :: Template deletionEmailBodyHtml :: Template deletionEmailSender :: EmailAddress deletionEmailSenderName :: Text

data UpgradePersonalToTeamEmailTemplate Source #

Constructors

UpgradePersonalToTeamEmailTemplate
Fields upgradePersonalToTeamEmailSubject :: Template upgradePersonalToTeamEmailBodyText :: Template upgradePersonalToTeamEmailBodyHtml :: Template upgradePersonalToTeamEmailSender :: EmailAddress upgradePersonalToTeamEmailSenderName :: Text

data NewClientEmailTemplate Source #

Constructors

NewClientEmailTemplate
Fields newClientEmailSubject :: Template newClientEmailBodyText :: Template newClientEmailBodyHtml :: Template newClientEmailSender :: EmailAddress newClientEmailSenderName :: Text

data SecondFactorVerificationEmailTemplate Source #

Constructors

SecondFactorVerificationEmailTemplate
Fields sndFactorVerificationEmailSubject :: Template sndFactorVerificationEmailBodyText :: Template sndFactorVerificationEmailBodyHtml :: Template sndFactorVerificationEmailSender :: EmailAddress sndFactorVerificationEmailSenderName :: Text

data InvitationEmailTemplate Source #

Constructors

InvitationEmailTemplate
Fields invitationEmailUrl :: !Template invitationEmailSubject :: !Template invitationEmailBodyText :: !Template invitationEmailBodyHtml :: !Template invitationEmailSender :: !EmailAddress invitationEmailSenderName :: !Text

data CreatorWelcomeEmailTemplate Source #

Constructors

CreatorWelcomeEmailTemplate
Fields creatorWelcomeEmailUrl :: !Text creatorWelcomeEmailSubject :: !Template creatorWelcomeEmailBodyText :: !Template creatorWelcomeEmailBodyHtml :: !Template creatorWelcomeEmailSender :: !EmailAddress creatorWelcomeEmailSenderName :: !Text

data MemberWelcomeEmailTemplate Source #

Constructors

MemberWelcomeEmailTemplate
Fields memberWelcomeEmailUrl :: !Text memberWelcomeEmailSubject :: !Template memberWelcomeEmailBodyText :: !Template memberWelcomeEmailBodyHtml :: !Template memberWelcomeEmailSender :: !EmailAddress memberWelcomeEmailSenderName :: !Text

data TeamTemplates Source #

Constructors

TeamTemplates
Fields invitationEmail :: !InvitationEmailTemplate existingUserInvitationEmail :: !InvitationEmailTemplate creatorWelcomeEmail :: !CreatorWelcomeEmailTemplate memberWelcomeEmail :: !MemberWelcomeEmailTemplate

forLocale Source #

Arguments

:: Maybe Locale	`Just` the preferred locale or `Nothing` for the default locale.
-> Localised a	The `Localised` structure.
-> (Locale, a)	Pair of the effectively chosen locale and the associated value.

Lookup a localised item from a Localised structure.

renderTextWithBranding :: Template -> (Text -> Text) -> TemplateBranding -> Text Source #

Uses a replace and a branding function, to replaces all placeholders from the given template to produce a Text. To be used on plain text templates

renderHtmlWithBranding :: Template -> (Text -> Text) -> TemplateBranding -> Text Source #

Uses a replace and a branding function to replace all placeholders from the given template to produce a Text. To be used on HTML templates

Re-exports

data Template Source #

A representation of a Text template, supporting efficient rendering.

Instances

Instances details

Show Template
Instance details Defined in Data.Text.Template Methods showsPrec :: Int -> Template -> ShowS # show :: Template -> String # showList :: [Template] -> ShowS #
Eq Template
Instance details Defined in Data.Text.Template Methods (==) :: Template -> Template -> Bool # (/=) :: Template -> Template -> Bool #