STARTARCHIVESEARCH()`¶

About StartArchiveSearch¶

Initiates a search across emails in the specified archive.

Method Signature¶

METHODS /AWS1/IF_SEB~STARTARCHIVESEARCH
  IMPORTING
    !IV_ARCHIVEID TYPE /AWS1/SEBARCHIVEID OPTIONAL
    !IO_FILTERS TYPE REF TO /AWS1/CL_SEBARCHIVEFILTERS OPTIONAL
    !IV_FROMTIMESTAMP TYPE /AWS1/SEBTIMESTAMP OPTIONAL
    !IV_TOTIMESTAMP TYPE /AWS1/SEBTIMESTAMP OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/SEBSEARCHMAXRESULTS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_sebstrtarchivesrchrsp
  RAISING
    /AWS1/CX_SEBACCESSDENIEDEX
    /AWS1/CX_SEBCONFLICTEXCEPTION
    /AWS1/CX_SEBRESOURCENOTFOUNDEX
    /AWS1/CX_SEBSERVICEQUOTAEXCDEX
    /AWS1/CX_SEBTHROTTLINGEX
    /AWS1/CX_SEBVALIDATIONEX
    /AWS1/CX_SEBCLIENTEXC
    /AWS1/CX_SEBSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_archiveid` `TYPE /AWS1/SEBARCHIVEID` `/AWS1/SEBARCHIVEID`¶

The identifier of the archive to search emails in.

`iv_fromtimestamp` `TYPE /AWS1/SEBTIMESTAMP` `/AWS1/SEBTIMESTAMP`¶

The start timestamp of the range to search emails from.

`iv_totimestamp` `TYPE /AWS1/SEBTIMESTAMP` `/AWS1/SEBTIMESTAMP`¶

The end timestamp of the range to search emails from.

`iv_maxresults` `TYPE /AWS1/SEBSEARCHMAXRESULTS` `/AWS1/SEBSEARCHMAXRESULTS`¶

The maximum number of search results to return.

Optional arguments:¶

`io_filters` `TYPE REF TO /AWS1/CL_SEBARCHIVEFILTERS` `/AWS1/CL_SEBARCHIVEFILTERS`¶

Criteria to filter which emails are included in the search results.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_sebstrtarchivesrchrsp` `/AWS1/CL_SEBSTRTARCHIVESRCHRSP`¶

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->startarchivesearch(
  io_filters = new /aws1/cl_sebarchivefilters(
    it_include = VALUE /aws1/cl_sebarchivefiltercond=>tt_archivefilterconditions(
      (
        new /aws1/cl_sebarchivefiltercond(
          io_booleanexpression = new /aws1/cl_sebarchiveblnxprsn(
            io_evaluate = new /aws1/cl_sebarchiveblntoeval00( |string| )
            iv_operator = |string|
          )
          io_stringexpression = new /aws1/cl_sebarchivestringxprsn(
            io_evaluate = new /aws1/cl_sebarchivestrtoeval00( |string| )
            it_values = VALUE /aws1/cl_sebstringvaluelist_w=>tt_stringvaluelist(
              ( new /aws1/cl_sebstringvaluelist_w( |string| ) )
            )
            iv_operator = |string|
          )
        )
      )
    )
    it_unless = VALUE /aws1/cl_sebarchivefiltercond=>tt_archivefilterconditions(
      (
        new /aws1/cl_sebarchivefiltercond(
          io_booleanexpression = new /aws1/cl_sebarchiveblnxprsn(
            io_evaluate = new /aws1/cl_sebarchiveblntoeval00( |string| )
            iv_operator = |string|
          )
          io_stringexpression = new /aws1/cl_sebarchivestringxprsn(
            io_evaluate = new /aws1/cl_sebarchivestrtoeval00( |string| )
            it_values = VALUE /aws1/cl_sebstringvaluelist_w=>tt_stringvaluelist(
              ( new /aws1/cl_sebstringvaluelist_w( |string| ) )
            )
            iv_operator = |string|
          )
        )
      )
    )
  )
  iv_archiveid = |string|
  iv_fromtimestamp = '20150101000000.0000000'
  iv_maxresults = 123
  iv_totimestamp = '20150101000000.0000000'
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_searchid = lo_result->get_searchid( ).
ENDIF.

/AWS1/IF_SEB=>STARTARCHIVESEARCH()¶