Skip to content

/AWS1/IF_SEB=>STARTARCHIVEEXPORT()

About StartArchiveExport

Initiates an export of emails from the specified archive.

Method Signature

METHODS /AWS1/IF_SEB~STARTARCHIVEEXPORT
  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/SEBEXPORTMAXRESULTS OPTIONAL
    !IO_EXPORTDESTINATIONCONF TYPE REF TO /AWS1/CL_SEBEXPORTDSTCONF OPTIONAL
    !IV_INCLUDEMETADATA TYPE /AWS1/SEBBOOLEAN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_sebstartarchiveexprsp
  RAISING
    /AWS1/CX_SEBACCESSDENIEDEX
    /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 export emails from.

iv_fromtimestamp TYPE /AWS1/SEBTIMESTAMP /AWS1/SEBTIMESTAMP

The start of the timestamp range to include emails from.

iv_totimestamp TYPE /AWS1/SEBTIMESTAMP /AWS1/SEBTIMESTAMP

The end of the timestamp range to include emails from.

io_exportdestinationconf TYPE REF TO /AWS1/CL_SEBEXPORTDSTCONF /AWS1/CL_SEBEXPORTDSTCONF

Details on where to deliver the exported email data.

Optional arguments:

io_filters TYPE REF TO /AWS1/CL_SEBARCHIVEFILTERS /AWS1/CL_SEBARCHIVEFILTERS

Criteria to filter which emails are included in the export.

iv_maxresults TYPE /AWS1/SEBEXPORTMAXRESULTS /AWS1/SEBEXPORTMAXRESULTS

The maximum number of email items to include in the export.

iv_includemetadata TYPE /AWS1/SEBBOOLEAN /AWS1/SEBBOOLEAN

Whether to include message metadata as JSON files in the export.

RETURNING

oo_output TYPE REF TO /aws1/cl_sebstartarchiveexprsp /AWS1/CL_SEBSTARTARCHIVEEXPRSP

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->startarchiveexport(
  io_exportdestinationconf = new /aws1/cl_sebexportdstconf( new /aws1/cl_sebs3exportdstconf( |string| ) )
  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_includemetadata = ABAP_TRUE
  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_exportid = lo_result->get_exportid( ).
ENDIF.