/** * 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 settings for an email activity in a journey. This type of * activity sends an email message to participants.

See Also:

AWS * API Reference

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

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

*/ inline const JourneyEmailMessage& GetMessageConfig() const{ return m_messageConfig; } /** *

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

*/ inline bool MessageConfigHasBeenSet() const { return m_messageConfigHasBeenSet; } /** *

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

*/ inline void SetMessageConfig(const JourneyEmailMessage& value) { m_messageConfigHasBeenSet = true; m_messageConfig = value; } /** *

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

*/ inline void SetMessageConfig(JourneyEmailMessage&& value) { m_messageConfigHasBeenSet = true; m_messageConfig = std::move(value); } /** *

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

*/ inline EmailMessageActivity& WithMessageConfig(const JourneyEmailMessage& value) { SetMessageConfig(value); return *this;} /** *

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

*/ inline EmailMessageActivity& WithMessageConfig(JourneyEmailMessage&& value) { SetMessageConfig(std::move(value)); return *this;} /** *

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

*/ inline const Aws::String& GetNextActivity() const{ return m_nextActivity; } /** *

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

*/ inline bool NextActivityHasBeenSet() const { return m_nextActivityHasBeenSet; } /** *

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

*/ inline void SetNextActivity(const Aws::String& value) { m_nextActivityHasBeenSet = true; m_nextActivity = value; } /** *

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

*/ inline void SetNextActivity(Aws::String&& value) { m_nextActivityHasBeenSet = true; m_nextActivity = std::move(value); } /** *

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

*/ inline void SetNextActivity(const char* value) { m_nextActivityHasBeenSet = true; m_nextActivity.assign(value); } /** *

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

*/ inline EmailMessageActivity& WithNextActivity(const Aws::String& value) { SetNextActivity(value); return *this;} /** *

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

*/ inline EmailMessageActivity& WithNextActivity(Aws::String&& value) { SetNextActivity(std::move(value)); return *this;} /** *

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

*/ inline EmailMessageActivity& WithNextActivity(const char* value) { SetNextActivity(value); return *this;} /** *

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.

*/ inline const Aws::String& GetTemplateName() const{ return m_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.

*/ inline bool TemplateNameHasBeenSet() const { return m_templateNameHasBeenSet; } /** *

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.

*/ inline void SetTemplateName(const Aws::String& value) { m_templateNameHasBeenSet = true; m_templateName = value; } /** *

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.

*/ inline void SetTemplateName(Aws::String&& value) { m_templateNameHasBeenSet = true; m_templateName = std::move(value); } /** *

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.

*/ inline void SetTemplateName(const char* value) { m_templateNameHasBeenSet = true; m_templateName.assign(value); } /** *

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.

*/ inline EmailMessageActivity& WithTemplateName(const Aws::String& value) { SetTemplateName(value); return *this;} /** *

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.

*/ inline EmailMessageActivity& WithTemplateName(Aws::String&& value) { SetTemplateName(std::move(value)); return *this;} /** *

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.

*/ inline EmailMessageActivity& WithTemplateName(const char* value) { SetTemplateName(value); return *this;} /** *

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.

*/ inline const Aws::String& GetTemplateVersion() const{ return m_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.

*/ inline bool TemplateVersionHasBeenSet() const { return m_templateVersionHasBeenSet; } /** *

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.

*/ inline void SetTemplateVersion(const Aws::String& value) { m_templateVersionHasBeenSet = true; m_templateVersion = value; } /** *

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.

*/ inline void SetTemplateVersion(Aws::String&& value) { m_templateVersionHasBeenSet = true; m_templateVersion = std::move(value); } /** *

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.

*/ inline void SetTemplateVersion(const char* value) { m_templateVersionHasBeenSet = true; m_templateVersion.assign(value); } /** *

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.

*/ inline EmailMessageActivity& WithTemplateVersion(const Aws::String& value) { SetTemplateVersion(value); return *this;} /** *

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.

*/ inline EmailMessageActivity& WithTemplateVersion(Aws::String&& value) { SetTemplateVersion(std::move(value)); return *this;} /** *

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.

*/ inline EmailMessageActivity& WithTemplateVersion(const char* value) { SetTemplateVersion(value); return *this;} private: JourneyEmailMessage m_messageConfig; bool m_messageConfigHasBeenSet = false; Aws::String m_nextActivity; bool m_nextActivityHasBeenSet = false; Aws::String m_templateName; bool m_templateNameHasBeenSet = false; Aws::String m_templateVersion; bool m_templateVersionHasBeenSet = false; }; } // namespace Model } // namespace Pinpoint } // namespace Aws