LISTQUEUEEMAILADDRESSES()`¶

About ListQueueEmailAddresses¶

Lists all email addresses that are currently associated with a specific queue, providing details about which "From" email addresses agents can select when handling email contacts. This helps administrators manage agent email address options and understand the available choices for different brands and business units.

Important things to know

The response includes metadata about each email address available for agent selection, including whether it's configured as the default outbound email.
Agents can select from these email addresses when replying to inbound contacts or initiating outbound contacts in this queue.
The list includes both explicitly associated email addresses and any default outbound email address configured for the queue.
Results are paginated to handle queues with many associated email addresses (up to 50 per queue).

Method Signature¶

METHODS /AWS1/IF_CNT~LISTQUEUEEMAILADDRESSES
  IMPORTING
    !IV_INSTANCEID TYPE /AWS1/CNTINSTANCEID OPTIONAL
    !IV_QUEUEID TYPE /AWS1/CNTQUEUEID OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/CNTNEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/CNTMAXRESULT100 OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cntlstqueueemailadr01
  RAISING
    /AWS1/CX_CNTACCESSDENIEDEX
    /AWS1/CX_CNTINTERNALSERVICEEX
    /AWS1/CX_CNTINVALIDPARAMETEREX
    /AWS1/CX_CNTINVALIDREQUESTEX
    /AWS1/CX_CNTRESOURCENOTFOUNDEX
    /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.

`iv_queueid` `TYPE /AWS1/CNTQUEUEID` `/AWS1/CNTQUEUEID`¶

The identifier for the queue.

Optional arguments:¶

`iv_nexttoken` `TYPE /AWS1/CNTNEXTTOKEN` `/AWS1/CNTNEXTTOKEN`¶

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

`iv_maxresults` `TYPE /AWS1/CNTMAXRESULT100` `/AWS1/CNTMAXRESULT100`¶

The maximum number of results to return per page.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_cntlstqueueemailadr01` `/AWS1/CL_CNTLSTQUEUEEMAILADR01`¶

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->listqueueemailaddresses(
  iv_instanceid = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_queueid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_nexttoken = lo_result->get_nexttoken( ).
  LOOP AT lo_result->get_emailaddressmetadatalist( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_emailaddressid = lo_row_1->get_id( ).
      lv_emailaddressarn = lo_row_1->get_arn( ).
      lv_boolean = lo_row_1->get_isdefaultoutboundemail( ).
    ENDIF.
  ENDLOOP.
  lv_timestamp = lo_result->get_lastmodifiedtime( ).
  lv_regionname = lo_result->get_lastmodifiedregion( ).
ENDIF.

/AWS1/IF_CNT=>LISTQUEUEEMAILADDRESSES()¶