Send Outbound Email

connect_send_outbound_email

R Documentation

Send outbound email for outbound campaigns

Description

Send outbound email for outbound campaigns. For more information about outbound campaigns, see Set up Amazon Connect outbound campaigns.

Only the Amazon Connect outbound campaigns service principal is allowed to assume a role in your account and call this API.

Usage

connect_send_outbound_email(InstanceId, FromEmailAddress,
  DestinationEmailAddress, AdditionalRecipients, EmailMessage,
  TrafficType, SourceCampaign, ClientToken)

Arguments

InstanceId

[required] The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

FromEmailAddress

[required] The email address to be used for sending email.

DestinationEmailAddress

[required] The email address to send the email to.

AdditionalRecipients

The additional recipients address of the email in CC.

EmailMessage

[required] The email message body to be sent to the newly created email.

TrafficType

[required] Denotes the class of traffic.

SourceCampaign

A Campaign object need for Campaign traffic type.

ClientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

Value

An empty list.

Request syntax

svc$send_outbound_email(
  InstanceId = "string",
  FromEmailAddress = list(
    EmailAddress = "string",
    DisplayName = "string"
  ),
  DestinationEmailAddress = list(
    EmailAddress = "string",
    DisplayName = "string"
  ),
  AdditionalRecipients = list(
    CcEmailAddresses = list(
      list(
        EmailAddress = "string",
        DisplayName = "string"
      )
    )
  ),
  EmailMessage = list(
    MessageSourceType = "TEMPLATE"|"RAW",
    TemplatedMessageConfig = list(
      KnowledgeBaseId = "string",
      MessageTemplateId = "string",
      TemplateAttributes = list(
        CustomAttributes = list(
          "string"
        ),
        CustomerProfileAttributes = "string"
      )
    ),
    RawMessage = list(
      Subject = "string",
      Body = "string",
      ContentType = "string"
    )
  ),
  TrafficType = "GENERAL"|"CAMPAIGN",
  SourceCampaign = list(
    CampaignId = "string",
    OutboundRequestId = "string"
  ),
  ClientToken = "string"
)