/AWS1/IF_SE2=>PUTEMAILIDDKIMSIGNINGATTRS()¶
About PutEmailIdentityDkimSigningAttributes¶
Used to configure or change the DKIM authentication settings for an email domain identity. You can use this operation to do any of the following:
-
Update the signing attributes for an identity that uses Bring Your Own DKIM (BYODKIM).
-
Update the key length that should be used for Easy DKIM.
-
Change from using no DKIM authentication to using Easy DKIM.
-
Change from using no DKIM authentication to using BYODKIM.
-
Change from using Easy DKIM to using BYODKIM.
-
Change from using BYODKIM to using Easy DKIM.
Method Signature¶
METHODS /AWS1/IF_SE2~PUTEMAILIDDKIMSIGNINGATTRS
IMPORTING
!IV_EMAILIDENTITY TYPE /AWS1/SE2IDENTITY OPTIONAL
!IV_SIGNINGATTRIBUTESORIGIN TYPE /AWS1/SE2DKIMSIGNINGATTRSORI00 OPTIONAL
!IO_SIGNINGATTRIBUTES TYPE REF TO /AWS1/CL_SE2DKIMSIGNINGATTRS OPTIONAL
RETURNING
VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_se2putemailiddkimsi01
RAISING
/AWS1/CX_SE2BADREQUESTEX
/AWS1/CX_SE2NOTFOUNDEXCEPTION
/AWS1/CX_SE2TOOMANYREQUESTSEX
/AWS1/CX_SE2CLIENTEXC
/AWS1/CX_SE2SERVEREXC
/AWS1/CX_RT_TECHNICAL_GENERIC
/AWS1/CX_RT_SERVICE_GENERIC.
IMPORTING¶
Required arguments:¶
iv_emailidentity TYPE /AWS1/SE2IDENTITY /AWS1/SE2IDENTITY¶
The email identity.
iv_signingattributesorigin TYPE /AWS1/SE2DKIMSIGNINGATTRSORI00 /AWS1/SE2DKIMSIGNINGATTRSORI00¶
The method to use to configure DKIM for the identity. There are the following possible values:
AWS_SES– Configure DKIM for the identity by using Easy DKIM.
EXTERNAL– Configure DKIM for the identity by using Bring Your Own DKIM (BYODKIM).
Optional arguments:¶
io_signingattributes TYPE REF TO /AWS1/CL_SE2DKIMSIGNINGATTRS /AWS1/CL_SE2DKIMSIGNINGATTRS¶
An object that contains information about the private key and selector that you want to use to configure DKIM for the identity for Bring Your Own DKIM (BYODKIM) for the identity, or, configures the key length to be used for Easy DKIM.
RETURNING¶
oo_output TYPE REF TO /aws1/cl_se2putemailiddkimsi01 /AWS1/CL_SE2PUTEMAILIDDKIMSI01¶
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->putemailiddkimsigningattrs(
io_signingattributes = new /aws1/cl_se2dkimsigningattrs(
iv_domainsigningattrsorigin = |string|
iv_domainsigningprivatekey = |string|
iv_domainsigningselector = |string|
iv_nextsigningkeylength = |string|
)
iv_emailidentity = |string|
iv_signingattributesorigin = |string|
).
This is an example of reading all possible response values
lo_result = lo_result.
IF lo_result IS NOT INITIAL.
lv_dkimstatus = lo_result->get_dkimstatus( ).
LOOP AT lo_result->get_dkimtokens( ) into lo_row.
lo_row_1 = lo_row.
IF lo_row_1 IS NOT INITIAL.
lv_dnstoken = lo_row_1->get_value( ).
ENDIF.
ENDLOOP.
lv_hostedzone = lo_result->get_signinghostedzone( ).
ENDIF.