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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-pinpoint/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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#message_configTypes::JourneyEmailMessage

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



6293
6294
6295
6296
6297
6298
6299
6300
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6293

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

#next_activityString

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

Returns:

  • (String)


6293
6294
6295
6296
6297
6298
6299
6300
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6293

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

#template_nameString

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.

Returns:

  • (String)


6293
6294
6295
6296
6297
6298
6299
6300
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6293

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

#template_versionString

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.

Returns:

  • (String)


6293
6294
6295
6296
6297
6298
6299
6300
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6293

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