Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.PinpointEmail.Types.EmailContent

Description

Synopsis

data EmailContent = EmailContent' {
- raw :: Maybe RawMessage
- simple :: Maybe Message
- template :: Maybe Template
}
newEmailContent :: EmailContent
emailContent_raw :: Lens' EmailContent (Maybe RawMessage)
emailContent_simple :: Lens' EmailContent (Maybe Message)
emailContent_template :: Lens' EmailContent (Maybe Template)

Documentation

data EmailContent Source #

An object that defines the entire content of the email, including the message headers and the body content. You can create a simple email message, in which you specify the subject and the text and HTML versions of the message body. You can also create raw messages, in which you specify a complete MIME-formatted message. Raw messages can include attachments and custom headers.

See: newEmailContent smart constructor.

Constructors

EmailContent'

Fields

raw :: Maybe RawMessage
The raw email message. The message has to meet the following criteria:
- The message has to contain a header and a body, separated by one blank line.
- All of the required header fields must be present in the message.
- Each part of a multipart MIME message must be formatted properly.
- If you include attachments, they must be in a file format that Amazon Pinpoint supports.
- The entire message must be Base64 encoded.
- If any of the MIME parts in your message contain content that is outside of the 7-bit ASCII character range, you should encode that content to ensure that recipients' email clients render the message properly.
- The length of any single line of text in the message can't exceed 1,000 characters. This restriction is defined in RFC 5321.
simple :: Maybe Message
The simple email message. The message consists of a subject and a message body.
template :: Maybe Template
The template to use for the email message.

Instances

Instances details

Eq EmailContent Source #
Instance details Defined in Amazonka.PinpointEmail.Types.EmailContent Methods (==) :: EmailContent -> EmailContent -> Bool # (/=) :: EmailContent -> EmailContent -> Bool #
Read EmailContent Source #
Instance details Defined in Amazonka.PinpointEmail.Types.EmailContent Methods readsPrec :: Int -> ReadS EmailContent # readList :: ReadS [EmailContent] # readPrec :: ReadPrec EmailContent # readListPrec :: ReadPrec [EmailContent] #
Show EmailContent Source #
Instance details Defined in Amazonka.PinpointEmail.Types.EmailContent Methods showsPrec :: Int -> EmailContent -> ShowS # show :: EmailContent -> String # showList :: [EmailContent] -> ShowS #
Generic EmailContent Source #
Instance details Defined in Amazonka.PinpointEmail.Types.EmailContent Associated Types type Rep EmailContent :: Type -> Type # Methods from :: EmailContent -> Rep EmailContent x # to :: Rep EmailContent x -> EmailContent #
NFData EmailContent Source #
Instance details Defined in Amazonka.PinpointEmail.Types.EmailContent Methods rnf :: EmailContent -> () #
Hashable EmailContent Source #
Instance details Defined in Amazonka.PinpointEmail.Types.EmailContent Methods hashWithSalt :: Int -> EmailContent -> Int # hash :: EmailContent -> Int #
ToJSON EmailContent Source #
Instance details Defined in Amazonka.PinpointEmail.Types.EmailContent Methods toJSON :: EmailContent -> Value # toEncoding :: EmailContent -> Encoding # toJSONList :: [EmailContent] -> Value # toEncodingList :: [EmailContent] -> Encoding #
type Rep EmailContent Source #
Instance details Defined in Amazonka.PinpointEmail.Types.EmailContent type Rep EmailContent = D1 ('MetaData "EmailContent" "Amazonka.PinpointEmail.Types.EmailContent" "libZSservicesZSamazonka-pinpoint-emailZSamazonka-pinpoint-email" 'False) (C1 ('MetaCons "EmailContent'" 'PrefixI 'True) (S1 ('MetaSel ('Just "raw") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RawMessage)) :: (S1 ('MetaSel ('Just "simple") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Message)) :: S1 ('MetaSel ('Just "template") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Template)))))

newEmailContent :: EmailContent Source #

Create a value of EmailContent 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:raw:EmailContent', emailContent_raw - The raw email message. The message has to meet the following criteria:

The message has to contain a header and a body, separated by one blank line.
All of the required header fields must be present in the message.
Each part of a multipart MIME message must be formatted properly.
If you include attachments, they must be in a file format that Amazon Pinpoint supports.
The entire message must be Base64 encoded.
If any of the MIME parts in your message contain content that is outside of the 7-bit ASCII character range, you should encode that content to ensure that recipients' email clients render the message properly.
The length of any single line of text in the message can't exceed 1,000 characters. This restriction is defined in RFC 5321.

$sel:simple:EmailContent', emailContent_simple - The simple email message. The message consists of a subject and a message body.

$sel:template:EmailContent', emailContent_template - The template to use for the email message.

emailContent_raw :: Lens' EmailContent (Maybe RawMessage) Source #

The raw email message. The message has to meet the following criteria:

The message has to contain a header and a body, separated by one blank line.
All of the required header fields must be present in the message.
Each part of a multipart MIME message must be formatted properly.
If you include attachments, they must be in a file format that Amazon Pinpoint supports.
The entire message must be Base64 encoded.
If any of the MIME parts in your message contain content that is outside of the 7-bit ASCII character range, you should encode that content to ensure that recipients' email clients render the message properly.
The length of any single line of text in the message can't exceed 1,000 characters. This restriction is defined in RFC 5321.

emailContent_simple :: Lens' EmailContent (Maybe Message) Source #

The simple email message. The message consists of a subject and a message body.

emailContent_template :: Lens' EmailContent (Maybe Template) Source #

The template to use for the email message.