Skip to content

/AWS1/IF_WML=>DEREGISTERFROMWORKMAIL()

About DeregisterFromWorkMail

Mark a user, group, or resource as no longer used in WorkMail. This action disassociates the mailbox and schedules it for clean-up. WorkMail keeps mailboxes for 30 days before they are permanently removed. The functionality in the console is Disable.

Method Signature

METHODS /AWS1/IF_WML~DEREGISTERFROMWORKMAIL
  IMPORTING
    !IV_ORGANIZATIONID TYPE /AWS1/WMLORGANIZATIONID OPTIONAL
    !IV_ENTITYID TYPE /AWS1/WMLENTITYIDENTIFIER OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_wmlderegfrmworkmail01
  RAISING
    /AWS1/CX_WMLENTITYNOTFOUNDEX
    /AWS1/CX_WMLENTITYSTATEEX
    /AWS1/CX_WMLINVALIDPARAMETEREX
    /AWS1/CX_WMLORGNOTFOUNDEX
    /AWS1/CX_WMLORGSTATEEXCEPTION
    /AWS1/CX_WMLCLIENTEXC
    /AWS1/CX_WMLSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_organizationid TYPE /AWS1/WMLORGANIZATIONID /AWS1/WMLORGANIZATIONID

The identifier for the organization under which the WorkMail entity exists.

iv_entityid TYPE /AWS1/WMLENTITYIDENTIFIER /AWS1/WMLENTITYIDENTIFIER

The identifier for the member to be updated.

The identifier can be UserId, ResourceId, or Group Id, Username, Resourcename, or Groupname, or email.

  • Entity ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789, or S-1-1-12-1234567890-123456789-123456789-1234

  • Email address: entity@domain.tld

  • Entity name: entity

RETURNING

oo_output TYPE REF TO /aws1/cl_wmlderegfrmworkmail01 /AWS1/CL_WMLDEREGFRMWORKMAIL01

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->deregisterfromworkmail(
  iv_entityid = |string|
  iv_organizationid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
ENDIF.