/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace Pinpoint { namespace Model { /** *

Specifies the content and settings for a message template that can be used in * messages that are sent through the email channel.

*/ class EmailTemplateRequest { public: AWS_PINPOINT_API EmailTemplateRequest(); AWS_PINPOINT_API EmailTemplateRequest(Aws::Utils::Json::JsonView jsonValue); AWS_PINPOINT_API EmailTemplateRequest& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_PINPOINT_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

A JSON object that specifies the default values to use for message variables * in the message template. This object is a set of key-value pairs. Each key * defines a message variable in the template. The corresponding value defines the * default value for that variable. When you create a message that's based on the * template, you can override these defaults with message-specific and * address-specific variables and values.

*/ inline const Aws::String& GetDefaultSubstitutions() const{ return m_defaultSubstitutions; } /** *

*/ inline bool DefaultSubstitutionsHasBeenSet() const { return m_defaultSubstitutionsHasBeenSet; } /** *

*/ inline void SetDefaultSubstitutions(const Aws::String& value) { m_defaultSubstitutionsHasBeenSet = true; m_defaultSubstitutions = value; } /** *

*/ inline void SetDefaultSubstitutions(Aws::String&& value) { m_defaultSubstitutionsHasBeenSet = true; m_defaultSubstitutions = std::move(value); } /** *

*/ inline void SetDefaultSubstitutions(const char* value) { m_defaultSubstitutionsHasBeenSet = true; m_defaultSubstitutions.assign(value); } /** *

*/ inline EmailTemplateRequest& WithDefaultSubstitutions(const Aws::String& value) { SetDefaultSubstitutions(value); return *this;} /** *

*/ inline EmailTemplateRequest& WithDefaultSubstitutions(Aws::String&& value) { SetDefaultSubstitutions(std::move(value)); return *this;} /** *

*/ inline EmailTemplateRequest& WithDefaultSubstitutions(const char* value) { SetDefaultSubstitutions(value); return *this;} /** *

The message body, in HTML format, to use in email messages that are based on * the message template. We recommend using HTML format for email clients that * render HTML content. You can include links, formatted text, and more in an HTML * message.

*/ inline const Aws::String& GetHtmlPart() const{ return m_htmlPart; } /** *

*/ inline bool HtmlPartHasBeenSet() const { return m_htmlPartHasBeenSet; } /** *

*/ inline void SetHtmlPart(const Aws::String& value) { m_htmlPartHasBeenSet = true; m_htmlPart = value; } /** *

*/ inline void SetHtmlPart(Aws::String&& value) { m_htmlPartHasBeenSet = true; m_htmlPart = std::move(value); } /** *

*/ inline void SetHtmlPart(const char* value) { m_htmlPartHasBeenSet = true; m_htmlPart.assign(value); } /** *

*/ inline EmailTemplateRequest& WithHtmlPart(const Aws::String& value) { SetHtmlPart(value); return *this;} /** *

*/ inline EmailTemplateRequest& WithHtmlPart(Aws::String&& value) { SetHtmlPart(std::move(value)); return *this;} /** *

*/ inline EmailTemplateRequest& WithHtmlPart(const char* value) { SetHtmlPart(value); return *this;} /** *

The unique identifier for the recommender model to use for the message * template. Amazon Pinpoint uses this value to determine how to retrieve and * process data from a recommender model when it sends messages that use the * template, if the template contains message variables for recommendation * data.

*/ inline const Aws::String& GetRecommenderId() const{ return m_recommenderId; } /** *

*/ inline bool RecommenderIdHasBeenSet() const { return m_recommenderIdHasBeenSet; } /** *

*/ inline void SetRecommenderId(const Aws::String& value) { m_recommenderIdHasBeenSet = true; m_recommenderId = value; } /** *

*/ inline void SetRecommenderId(Aws::String&& value) { m_recommenderIdHasBeenSet = true; m_recommenderId = std::move(value); } /** *

*/ inline void SetRecommenderId(const char* value) { m_recommenderIdHasBeenSet = true; m_recommenderId.assign(value); } /** *

*/ inline EmailTemplateRequest& WithRecommenderId(const Aws::String& value) { SetRecommenderId(value); return *this;} /** *

*/ inline EmailTemplateRequest& WithRecommenderId(Aws::String&& value) { SetRecommenderId(std::move(value)); return *this;} /** *

*/ inline EmailTemplateRequest& WithRecommenderId(const char* value) { SetRecommenderId(value); return *this;} /** *

The subject line, or title, to use in email messages that are based on the * message template.

*/ inline const Aws::String& GetSubject() const{ return m_subject; } /** *

The subject line, or title, to use in email messages that are based on the * message template.

*/ inline bool SubjectHasBeenSet() const { return m_subjectHasBeenSet; } /** *

The subject line, or title, to use in email messages that are based on the * message template.

*/ inline void SetSubject(const Aws::String& value) { m_subjectHasBeenSet = true; m_subject = value; } /** *

The subject line, or title, to use in email messages that are based on the * message template.

*/ inline void SetSubject(Aws::String&& value) { m_subjectHasBeenSet = true; m_subject = std::move(value); } /** *

The subject line, or title, to use in email messages that are based on the * message template.

*/ inline void SetSubject(const char* value) { m_subjectHasBeenSet = true; m_subject.assign(value); } /** *

The subject line, or title, to use in email messages that are based on the * message template.

*/ inline EmailTemplateRequest& WithSubject(const Aws::String& value) { SetSubject(value); return *this;} /** *

The subject line, or title, to use in email messages that are based on the * message template.

*/ inline EmailTemplateRequest& WithSubject(Aws::String&& value) { SetSubject(std::move(value)); return *this;} /** *

The subject line, or title, to use in email messages that are based on the * message template.

*/ inline EmailTemplateRequest& WithSubject(const char* value) { SetSubject(value); return *this;} /** *

As of 22-05-2023 tags has been deprecated for update operations. * After this date any value in tags is not processed and an error code is not * returned. To manage tags we recommend using either Tags * in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi * commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi * in the AWS SDK.