API for Amazon WorkMail Message Flow¶
| ABAP Package | /AWS1/API_WMM |
|---|---|
| ABAP SDK "TLA" | WMM |
| ABAP Interface | /AWS1/IF_WMM |
The "TLA" is a Three Letter Abbreviation that appears in ABAP class names, data dictionary
objects and other ABAP objects throughout the AWS SDK for SAP ABAP. The TLA for Amazon WorkMail Message Flow is WMM.
This TLA helps squeeze ABAP objects into the 30-character length limit of the ABAP data dictionary.
Installation¶
To install the AWS SDK for SAP ABAP, import the Core transport, along with the transport for the WorkMailMessageFlow module and other API modules you are interested in. A few modules are included in the Core transport itself. For more information, see the Developer Guide guide.
About The Service¶
The WorkMail Message Flow API provides access to email messages as they are being sent and received by a WorkMail organization.
Using the SDK¶
In your code, create a client using the SDK module for Amazon WorkMail Message Flow, which is created with
factory method /AWS1/CL_WMM_FACTORY=>create().
In this example we will assume you have configured
an SDK profile in transaction /AWS1/IMG called ZFINANCE.
DATA(go_session) = /aws1/cl_rt_session_aws=>create( 'ZFINANCE' ).
DATA(go_wmm) = /aws1/cl_wmm_factory=>create( go_session ).
Your variable go_wmm is an instance of /AWS1/IF_WMM,
and all of the operations
in the Amazon WorkMail Message Flow service are accessed by calling methods in /AWS1/IF_WMM.
API Operations¶
For an overview of ABAP method calls corresponding to API operations in Amazon WorkMail Message Flow, see the Operation List.
Factory Method¶
/AWS1/CL_WMM_FACTORY=>create( )¶
Creates an object of type /AWS1/IF_WMM.
IMPORTING¶
Optional arguments:¶
iv_protocol TYPE /aws1/rt_protocol /AWS1/RT_PROTOCOL¶
Domain /AWS1/RT_ACCOUNT_ID Primitive Type NUMC
io_session TYPE REF TO /aws1/cl_rt_session_base /AWS1/CL_RT_SESSION_BASE¶
Domain /AWS1/RT_ACCOUNT_ID Primitive Type NUMC
iv_region TYPE /aws1/rt_region_id /AWS1/RT_REGION_ID¶
Domain /AWS1/RT_ACCOUNT_ID Primitive Type NUMC
iv_custom_endpoint TYPE /aws1/rt_endpoint /AWS1/RT_ENDPOINT¶
Domain /AWS1/RT_ACCOUNT_ID Primitive Type NUMC
RETURNING¶
oo_client TYPE REF TO /aws1/if_wmm /AWS1/IF_WMM¶
/AWS1/IF_WMMrepresents the ABAP client for the WorkMailMessageFlow service, representing each operation as a method call. For more information see the API Page page.
Configuring Programmatically¶
DATA(lo_config) = DATA(go_wmm)->get_config( ).
lo_config is a variable of type /AWS1/CL_WMM_CONFIG. See the documentation for /AWS1/CL_WMM_CONFIG for
details on the settings that can be configured.