Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Pinpoint.Types.EmailMessageActivity

Description

Documentation

data EmailMessageActivity Source #

Specifies the settings for an email activity in a journey. This type of activity sends an email message to participants.

See: newEmailMessageActivity smart constructor.

Constructors

EmailMessageActivity'

Fields

messageConfig :: Maybe JourneyEmailMessage
Specifies the sender address for an email message that's sent to participants in the journey.
nextActivity :: Maybe Text
The unique identifier for the next activity to perform, after the message is sent.
templateName :: Maybe Text
The name of the email message template to use for the message. If specified, this value must match the name of an existing message template.
templateVersion :: Maybe Text
The unique identifier for the version of the email template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

Instances

Instances details

FromJSON EmailMessageActivity Source #
Instance details Defined in Amazonka.Pinpoint.Types.EmailMessageActivity Methods parseJSON :: Value -> Parser EmailMessageActivity # parseJSONList :: Value -> Parser [EmailMessageActivity] #
ToJSON EmailMessageActivity Source #
Instance details Defined in Amazonka.Pinpoint.Types.EmailMessageActivity Methods toJSON :: EmailMessageActivity -> Value # toEncoding :: EmailMessageActivity -> Encoding # toJSONList :: [EmailMessageActivity] -> Value # toEncodingList :: [EmailMessageActivity] -> Encoding #
Generic EmailMessageActivity Source #
Instance details Defined in Amazonka.Pinpoint.Types.EmailMessageActivity Associated Types type Rep EmailMessageActivity :: Type -> Type # Methods from :: EmailMessageActivity -> Rep EmailMessageActivity x # to :: Rep EmailMessageActivity x -> EmailMessageActivity #
Read EmailMessageActivity Source #
Instance details Defined in Amazonka.Pinpoint.Types.EmailMessageActivity Methods readsPrec :: Int -> ReadS EmailMessageActivity # readList :: ReadS [EmailMessageActivity] # readPrec :: ReadPrec EmailMessageActivity # readListPrec :: ReadPrec [EmailMessageActivity] #
Show EmailMessageActivity Source #
Instance details Defined in Amazonka.Pinpoint.Types.EmailMessageActivity Methods showsPrec :: Int -> EmailMessageActivity -> ShowS # show :: EmailMessageActivity -> String # showList :: [EmailMessageActivity] -> ShowS #
NFData EmailMessageActivity Source #
Instance details Defined in Amazonka.Pinpoint.Types.EmailMessageActivity Methods rnf :: EmailMessageActivity -> () #
Eq EmailMessageActivity Source #
Instance details Defined in Amazonka.Pinpoint.Types.EmailMessageActivity Methods (==) :: EmailMessageActivity -> EmailMessageActivity -> Bool # (/=) :: EmailMessageActivity -> EmailMessageActivity -> Bool #
Hashable EmailMessageActivity Source #
Instance details Defined in Amazonka.Pinpoint.Types.EmailMessageActivity Methods hashWithSalt :: Int -> EmailMessageActivity -> Int # hash :: EmailMessageActivity -> Int #
type Rep EmailMessageActivity Source #
Instance details Defined in Amazonka.Pinpoint.Types.EmailMessageActivity type Rep EmailMessageActivity = D1 ('MetaData "EmailMessageActivity" "Amazonka.Pinpoint.Types.EmailMessageActivity" "amazonka-pinpoint-2.0-GBFs9S7wa7bFiDe66NqAzt" 'False) (C1 ('MetaCons "EmailMessageActivity'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "messageConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JourneyEmailMessage)) :: S1 ('MetaSel ('Just "nextActivity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "templateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "templateVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newEmailMessageActivity :: EmailMessageActivity Source #

Create a value of EmailMessageActivity with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:messageConfig:EmailMessageActivity', emailMessageActivity_messageConfig - Specifies the sender address for an email message that's sent to participants in the journey.

$sel:nextActivity:EmailMessageActivity', emailMessageActivity_nextActivity - The unique identifier for the next activity to perform, after the message is sent.

$sel:templateName:EmailMessageActivity', emailMessageActivity_templateName - The name of the email message template to use for the message. If specified, this value must match the name of an existing message template.

$sel:templateVersion:EmailMessageActivity', emailMessageActivity_templateVersion - The unique identifier for the version of the email template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.

If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

emailMessageActivity_messageConfig :: Lens' EmailMessageActivity (Maybe JourneyEmailMessage) Source #

Specifies the sender address for an email message that's sent to participants in the journey.

emailMessageActivity_nextActivity :: Lens' EmailMessageActivity (Maybe Text) Source #

The unique identifier for the next activity to perform, after the message is sent.

emailMessageActivity_templateName :: Lens' EmailMessageActivity (Maybe Text) Source #

The name of the email message template to use for the message. If specified, this value must match the name of an existing message template.

emailMessageActivity_templateVersion :: Lens' EmailMessageActivity (Maybe Text) Source #

The unique identifier for the version of the email template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.

If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.