LISTACTORMESSAGES()`¶

About ListActorMessages¶

Returns a paginated list of the email MFA messages received for an actor at its server-generated email address, most recent first.

Method Signature¶

METHODS /AWS1/IF_SAG~LISTACTORMESSAGES
  IMPORTING
    !IV_MAXRESULTS TYPE /AWS1/SAGMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/SAGNEXTTOKEN OPTIONAL
    !IV_AGENTSPACEID TYPE /AWS1/SAGSTRING OPTIONAL
    !IV_PENTESTID TYPE /AWS1/SAGSTRING OPTIONAL
    !IV_ACTORIDENTIFIER TYPE /AWS1/SAGSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_saglistactormsgsout
  RAISING
    /AWS1/CX_SAGCLIENTEXC
    /AWS1/CX_SAGSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_agentspaceid` `TYPE /AWS1/SAGSTRING` `/AWS1/SAGSTRING`¶

The unique identifier of the agent space that owns the pentest.

`iv_pentestid` `TYPE /AWS1/SAGSTRING` `/AWS1/SAGSTRING`¶

The unique identifier of the pentest that the actor belongs to.

`iv_actoridentifier` `TYPE /AWS1/SAGSTRING` `/AWS1/SAGSTRING`¶

The identifier of the actor whose messages to list. The identifier is case-insensitive.

Optional arguments:¶

`iv_maxresults` `TYPE /AWS1/SAGMAXRESULTS` `/AWS1/SAGMAXRESULTS`¶

The maximum number of results to return in a single call.

`iv_nexttoken` `TYPE /AWS1/SAGNEXTTOKEN` `/AWS1/SAGNEXTTOKEN`¶

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_saglistactormsgsout` `/AWS1/CL_SAGLISTACTORMSGSOUT`¶

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->listactormessages(
  iv_actoridentifier = |string|
  iv_agentspaceid = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_pentestid = |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_messages( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_sensitivemessagesender = lo_row_1->get_sender( ).
      lv_sensitivemessagesubject = lo_row_1->get_subject( ).
      lv_sensitivemessagebody = lo_row_1->get_body( ).
      lv_timestamp = lo_row_1->get_receivedat( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_SAG=>LISTACTORMESSAGES()¶