/AWS1/IF_CNT=>SENDOUTBOUNDEMAIL()

About SendOutboundEmail

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.

Method Signature

METHODS /AWS1/IF_CNT~SENDOUTBOUNDEMAIL
  IMPORTING
    !IV_INSTANCEID TYPE /AWS1/CNTINSTANCEID OPTIONAL
    !IO_FROMEMAILADDRESS TYPE REF TO /AWS1/CL_CNTEMAILADDRESSINFO OPTIONAL
    !IO_DESTINATIONEMAILADDRESS TYPE REF TO /AWS1/CL_CNTEMAILADDRESSINFO OPTIONAL
    !IO_ADDITIONALRECIPIENTS TYPE REF TO /AWS1/CL_CNTOUTBOUNDADDLRECI00 OPTIONAL
    !IO_EMAILMESSAGE TYPE REF TO /AWS1/CL_CNTOUTBOUNDEMAILCONT OPTIONAL
    !IV_TRAFFICTYPE TYPE /AWS1/CNTTRAFFICTYPE OPTIONAL
    !IO_SOURCECAMPAIGN TYPE REF TO /AWS1/CL_CNTSOURCECAMPAIGN OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/CNTCLIENTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cntsendoutboundemai01
  RAISING
    /AWS1/CX_CNTACCESSDENIEDEX
    /AWS1/CX_CNTIDEMPOTENCYEX
    /AWS1/CX_CNTINTERNALSERVICEEX
    /AWS1/CX_CNTINVALIDREQUESTEX
    /AWS1/CX_CNTRESOURCENOTFOUNDEX
    /AWS1/CX_CNTSERVICEQUOTAEXCDEX
    /AWS1/CX_CNTTHROTTLINGEX
    /AWS1/CX_CNTCLIENTEXC
    /AWS1/CX_CNTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_instanceid TYPE /AWS1/CNTINSTANCEID /AWS1/CNTINSTANCEID

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

io_fromemailaddress TYPE REF TO /AWS1/CL_CNTEMAILADDRESSINFO /AWS1/CL_CNTEMAILADDRESSINFO

The email address to be used for sending email.

io_destinationemailaddress TYPE REF TO /AWS1/CL_CNTEMAILADDRESSINFO /AWS1/CL_CNTEMAILADDRESSINFO

The email address to send the email to.

io_emailmessage TYPE REF TO /AWS1/CL_CNTOUTBOUNDEMAILCONT /AWS1/CL_CNTOUTBOUNDEMAILCONT

The email message body to be sent to the newly created email.

iv_traffictype TYPE /AWS1/CNTTRAFFICTYPE /AWS1/CNTTRAFFICTYPE

Denotes the class of traffic.

Only the CAMPAIGN traffic type is supported.

Optional arguments:

io_additionalrecipients TYPE REF TO /AWS1/CL_CNTOUTBOUNDADDLRECI00 /AWS1/CL_CNTOUTBOUNDADDLRECI00

The additional recipients address of the email in CC.

io_sourcecampaign TYPE REF TO /AWS1/CL_CNTSOURCECAMPAIGN /AWS1/CL_CNTSOURCECAMPAIGN

A Campaign object need for Campaign traffic type.

iv_clienttoken TYPE /AWS1/CNTCLIENTTOKEN /AWS1/CNTCLIENTTOKEN

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.

RETURNING

oo_output TYPE REF TO /aws1/cl_cntsendoutboundemai01 /AWS1/CL_CNTSENDOUTBOUNDEMAI01

Domain	/AWS1/RT_ACCOUNT_ID
Primitive Type	NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->sendoutboundemail(
  io_additionalrecipients = new /aws1/cl_cntoutboundaddlreci00(
    it_ccemailaddresses = VALUE /aws1/cl_cntemailaddressinfo=>tt_emailaddressrecipientlist(
      (
        new /aws1/cl_cntemailaddressinfo(
          iv_displayname = |string|
          iv_emailaddress = |string|
        )
      )
    )
  )
  io_destinationemailaddress = new /aws1/cl_cntemailaddressinfo(
    iv_displayname = |string|
    iv_emailaddress = |string|
  )
  io_emailmessage = new /aws1/cl_cntoutboundemailcont(
    io_rawmessage = new /aws1/cl_cntoutboundrawmessage(
      iv_body = |string|
      iv_contenttype = |string|
      iv_subject = |string|
    )
    io_templatedmessageconfig = new /aws1/cl_cnttmpldmessageconfig(
      io_templateattributes = new /aws1/cl_cnttemplateattributes(
        it_customattributes = VALUE /aws1/cl_cntattributes_w=>tt_attributes(
          (
            VALUE /aws1/cl_cntattributes_w=>ts_attributes_maprow(
              value = new /aws1/cl_cntattributes_w( |string| )
              key = |string|
            )
          )
        )
        iv_customerprofileattributes = |string|
      )
      iv_knowledgebaseid = |string|
      iv_messagetemplateid = |string|
    )
    iv_messagesourcetype = |string|
  )
  io_fromemailaddress = new /aws1/cl_cntemailaddressinfo(
    iv_displayname = |string|
    iv_emailaddress = |string|
  )
  io_sourcecampaign = new /aws1/cl_cntsourcecampaign(
    iv_campaignid = |string|
    iv_outboundrequestid = |string|
  )
  iv_clienttoken = |string|
  iv_instanceid = |string|
  iv_traffictype = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
ENDIF.