Skip to content

/AWS1/IF_WML=>REGISTERTOWORKMAIL()

About RegisterToWorkMail

Registers an existing and disabled user, group, or resource for WorkMail use by associating a mailbox and calendaring capabilities. It performs no change if the user, group, or resource is enabled and fails if the user, group, or resource is deleted. This operation results in the accumulation of costs. For more information, see Pricing. The equivalent console functionality for this operation is Enable.

Users can either be created by calling the CreateUser API operation or they can be synchronized from your directory. For more information, see DeregisterFromWorkMail.

Method Signature

METHODS /AWS1/IF_WML~REGISTERTOWORKMAIL
  IMPORTING
    !IV_ORGANIZATIONID TYPE /AWS1/WMLORGANIZATIONID OPTIONAL
    !IV_ENTITYID TYPE /AWS1/WMLENTITYIDENTIFIER OPTIONAL
    !IV_EMAIL TYPE /AWS1/WMLEMAILADDRESS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_wmlregtoworkmailrsp
  RAISING
    /AWS1/CX_WMLDIRECTORYSVCAUTH00
    /AWS1/CX_WMLDIRECTORYUNAVAILEX
    /AWS1/CX_WMLEMAILADDRESSINUS00
    /AWS1/CX_WMLENTITYALRDYREGEDEX
    /AWS1/CX_WMLENTITYNOTFOUNDEX
    /AWS1/CX_WMLENTITYSTATEEX
    /AWS1/CX_WMLINVALIDPARAMETEREX
    /AWS1/CX_WMLMAILDOMNOTFOUNDEX
    /AWS1/CX_WMLMAILDOMAINSTATEEX
    /AWS1/CX_WMLORGNOTFOUNDEX
    /AWS1/CX_WMLORGSTATEEXCEPTION
    /AWS1/CX_WMLUNSUPPORTEDOPEX
    /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 user, group, or resource exists.

iv_entityid TYPE /AWS1/WMLENTITYIDENTIFIER /AWS1/WMLENTITYIDENTIFIER

The identifier for the user, group, or resource to be updated.

The identifier can accept UserId, ResourceId, or GroupId, or Username, Resourcename, or Groupname. The following identity formats are available:

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

  • Entity name: entity

iv_email TYPE /AWS1/WMLEMAILADDRESS /AWS1/WMLEMAILADDRESS

The email for the user, group, or resource to be updated.

RETURNING

oo_output TYPE REF TO /aws1/cl_wmlregtoworkmailrsp /AWS1/CL_WMLREGTOWORKMAILRSP

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->registertoworkmail(
  iv_email = |string|
  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.