Skip to content

/AWS1/IF_SE2=>SENDBULKEMAIL()

About SendBulkEmail

Composes an email message to multiple destinations.

Method Signature

METHODS /AWS1/IF_SE2~SENDBULKEMAIL
  IMPORTING
    !IV_FROMEMAILADDRESS TYPE /AWS1/SE2EMAILADDRESS OPTIONAL
    !IV_FROMEMAILADDRESSIDARN TYPE /AWS1/SE2AMAZONRESOURCENAME OPTIONAL
    !IT_REPLYTOADDRESSES TYPE /AWS1/CL_SE2EMAILADDRESSLIST_W=>TT_EMAILADDRESSLIST OPTIONAL
    !IV_FEEDBACKFORWARDINGEMAIL00 TYPE /AWS1/SE2EMAILADDRESS OPTIONAL
    !IV_FEEDBACKFORWARDINGEMAIL01 TYPE /AWS1/SE2AMAZONRESOURCENAME OPTIONAL
    !IT_DEFAULTEMAILTAGS TYPE /AWS1/CL_SE2MESSAGETAG=>TT_MESSAGETAGLIST OPTIONAL
    !IO_DEFAULTCONTENT TYPE REF TO /AWS1/CL_SE2BULKEMAILCONTENT OPTIONAL
    !IT_BULKEMAILENTRIES TYPE /AWS1/CL_SE2BULKEMAILENTRY=>TT_BULKEMAILENTRYLIST OPTIONAL
    !IV_CONFIGURATIONSETNAME TYPE /AWS1/SE2CONFIGURATIONSETNAME OPTIONAL
    !IV_ENDPOINTID TYPE /AWS1/SE2ENDPOINTID OPTIONAL
    !IV_TENANTNAME TYPE /AWS1/SE2TENANTNAME OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_se2sendbulkemailrsp
  RAISING
    /AWS1/CX_SE2ACCOUNTSUSPENDEDEX
    /AWS1/CX_SE2BADREQUESTEX
    /AWS1/CX_SE2LIMITEXCEEDEDEX
    /AWS1/CX_SE2MAILFRMDOMNOTVER00
    /AWS1/CX_SE2MESSAGEREJECTED
    /AWS1/CX_SE2NOTFOUNDEXCEPTION
    /AWS1/CX_SE2SENDINGPAUSEDEX
    /AWS1/CX_SE2TOOMANYREQUESTSEX
    /AWS1/CX_SE2CLIENTEXC
    /AWS1/CX_SE2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

io_defaultcontent TYPE REF TO /AWS1/CL_SE2BULKEMAILCONTENT /AWS1/CL_SE2BULKEMAILCONTENT

An object that contains the body of the message. You can specify a template message.

it_bulkemailentries TYPE /AWS1/CL_SE2BULKEMAILENTRY=>TT_BULKEMAILENTRYLIST TT_BULKEMAILENTRYLIST

The list of bulk email entry objects.

Optional arguments:

iv_fromemailaddress TYPE /AWS1/SE2EMAILADDRESS /AWS1/SE2EMAILADDRESS

The email address to use as the "From" address for the email. The address that you specify has to be verified.

iv_fromemailaddressidarn TYPE /AWS1/SE2AMAZONRESOURCENAME /AWS1/SE2AMAZONRESOURCENAME

This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the FromEmailAddress parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use sender@example.com, then you would specify the FromEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FromEmailAddress to be sender@example.com.

For more information about sending authorization, see the Amazon SES Developer Guide.

it_replytoaddresses TYPE /AWS1/CL_SE2EMAILADDRESSLIST_W=>TT_EMAILADDRESSLIST TT_EMAILADDRESSLIST

The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.

iv_feedbackforwardingemail00 TYPE /AWS1/SE2EMAILADDRESS /AWS1/SE2EMAILADDRESS

The address that you want bounce and complaint notifications to be sent to.

iv_feedbackforwardingemail01 TYPE /AWS1/SE2AMAZONRESOURCENAME /AWS1/SE2AMAZONRESOURCENAME

This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the FeedbackForwardingEmailAddress parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the FeedbackForwardingEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FeedbackForwardingEmailAddress to be feedback@example.com.

For more information about sending authorization, see the Amazon SES Developer Guide.

it_defaultemailtags TYPE /AWS1/CL_SE2MESSAGETAG=>TT_MESSAGETAGLIST TT_MESSAGETAGLIST

A list of tags, in the form of name/value pairs, to apply to an email that you send using the SendEmail operation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

iv_configurationsetname TYPE /AWS1/SE2CONFIGURATIONSETNAME /AWS1/SE2CONFIGURATIONSETNAME

The name of the configuration set to use when sending the email.

iv_endpointid TYPE /AWS1/SE2ENDPOINTID /AWS1/SE2ENDPOINTID

The ID of the multi-region endpoint (global-endpoint).

iv_tenantname TYPE /AWS1/SE2TENANTNAME /AWS1/SE2TENANTNAME

The name of the tenant through which this bulk email will be sent.

The email sending operation will only succeed if all referenced resources (identities, configuration sets, and templates) are associated with this tenant.

RETURNING

oo_output TYPE REF TO /aws1/cl_se2sendbulkemailrsp /AWS1/CL_SE2SENDBULKEMAILRSP

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->sendbulkemail(
  io_defaultcontent = new /aws1/cl_se2bulkemailcontent(
    io_template = new /aws1/cl_se2template(
      io_templatecontent = new /aws1/cl_se2emailtmplcontent(
        iv_html = |string|
        iv_subject = |string|
        iv_text = |string|
      )
      it_attachments = VALUE /aws1/cl_se2attachment=>tt_attachmentlist(
        (
          new /aws1/cl_se2attachment(
            iv_contentdescription = |string|
            iv_contentdisposition = |string|
            iv_contentid = |string|
            iv_contenttransferencoding = |string|
            iv_contenttype = |string|
            iv_filename = |string|
            iv_rawcontent = '5347567362473873563239796247513D'
          )
        )
      )
      it_headers = VALUE /aws1/cl_se2messageheader=>tt_messageheaderlist(
        (
          new /aws1/cl_se2messageheader(
            iv_name = |string|
            iv_value = |string|
          )
        )
      )
      iv_templatearn = |string|
      iv_templatedata = |string|
      iv_templatename = |string|
    )
  )
  it_bulkemailentries = VALUE /aws1/cl_se2bulkemailentry=>tt_bulkemailentrylist(
    (
      new /aws1/cl_se2bulkemailentry(
        io_destination = new /aws1/cl_se2destination(
          it_bccaddresses = VALUE /aws1/cl_se2emailaddresslist_w=>tt_emailaddresslist(
            ( new /aws1/cl_se2emailaddresslist_w( |string| ) )
          )
          it_ccaddresses = VALUE /aws1/cl_se2emailaddresslist_w=>tt_emailaddresslist(
            ( new /aws1/cl_se2emailaddresslist_w( |string| ) )
          )
          it_toaddresses = VALUE /aws1/cl_se2emailaddresslist_w=>tt_emailaddresslist(
            ( new /aws1/cl_se2emailaddresslist_w( |string| ) )
          )
        )
        io_replacementemailcontent = new /aws1/cl_se2replcmtemailcont( new /aws1/cl_se2replcmttemplate( |string| ) )
        it_replacementheaders = VALUE /aws1/cl_se2messageheader=>tt_messageheaderlist(
          (
            new /aws1/cl_se2messageheader(
              iv_name = |string|
              iv_value = |string|
            )
          )
        )
        it_replacementtags = VALUE /aws1/cl_se2messagetag=>tt_messagetaglist(
          (
            new /aws1/cl_se2messagetag(
              iv_name = |string|
              iv_value = |string|
            )
          )
        )
      )
    )
  )
  it_defaultemailtags = VALUE /aws1/cl_se2messagetag=>tt_messagetaglist(
    (
      new /aws1/cl_se2messagetag(
        iv_name = |string|
        iv_value = |string|
      )
    )
  )
  it_replytoaddresses = VALUE /aws1/cl_se2emailaddresslist_w=>tt_emailaddresslist(
    ( new /aws1/cl_se2emailaddresslist_w( |string| ) )
  )
  iv_configurationsetname = |string|
  iv_endpointid = |string|
  iv_feedbackforwardingemail00 = |string|
  iv_feedbackforwardingemail01 = |string|
  iv_fromemailaddress = |string|
  iv_fromemailaddressidarn = |string|
  iv_tenantname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_bulkemailentryresults( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_bulkemailstatus = lo_row_1->get_status( ).
      lv_errormessage = lo_row_1->get_error( ).
      lv_outboundmessageid = lo_row_1->get_messageid( ).
    ENDIF.
  ENDLOOP.
ENDIF.