Class: Aws::Pinpoint::Types::EmailMessageActivity

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-pinpoint/types.rb

Overview

Note:

When making an API call, you may pass EmailMessageActivity data as a hash:

{
  message_config: {
    from_address: "__string",
  },
  next_activity: "__string",
  template_name: "__string",
  template_version: "__string",
}

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

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#message_config ⇒ Types::JourneyEmailMessage

The “From” address to use for the message.

Returns:



5850
5851
5852
5853
5854
5855
5856
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 5850

class EmailMessageActivity < Struct.new(
  :message_config,
  :next_activity,
  :template_name,
  :template_version)
  include Aws::Structure
end

#next_activity ⇒ String

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

Returns:

  • (String) 


5850
5851
5852
5853
5854
5855
5856
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 5850

class EmailMessageActivity < Struct.new(
  :message_config,
  :next_activity,
  :template_name,
  :template_version)
  include Aws::Structure
end

#template_name ⇒ String

The name of the email template to use for the message.

Returns:

  • (String) 


5850
5851
5852
5853
5854
5855
5856
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 5850

class EmailMessageActivity < Struct.new(
  :message_config,
  :next_activity,
  :template_name,
  :template_version)
  include Aws::Structure
end

#template_version ⇒ String

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 <link linkend=“templates-template-name-template-type-versions” />

Template Versions</link> 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.

Returns:

  • (String) 


5850
5851
5852
5853
5854
5855
5856
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 5850

class EmailMessageActivity < Struct.new(
  :message_config,
  :next_activity,
  :template_name,
  :template_version)
  include Aws::Structure
end