setIdentityHeadersInNotificationsEnabled method

Future<void> setIdentityHeadersInNotificationsEnabled({
  1. required bool enabled,
  2. required String identity,
  3. required NotificationType notificationType,
})

Given an identity (an email address or a domain), sets whether Amazon SES includes the original email headers in the Amazon Simple Notification Service (Amazon SNS) notifications of a specified type.

You can execute this operation no more than once per second.

For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide.

Parameter enabled : Sets whether Amazon SES includes the original email headers in Amazon SNS notifications of the specified notification type. A value of true specifies that Amazon SES will include headers in notifications, and a value of false specifies that Amazon SES will not include headers in notifications.

This value can only be set when NotificationType is already set to use a particular Amazon SNS topic.

Parameter identity : The identity for which to enable or disable headers in notifications. Examples: user@example.com, example.com.

Parameter notificationType : The notification type for which to enable or disable headers in notifications.

Implementation

Future<void> setIdentityHeadersInNotificationsEnabled({
  required bool enabled,
  required String identity,
  required NotificationType notificationType,
}) async {
  ArgumentError.checkNotNull(enabled, 'enabled');
  ArgumentError.checkNotNull(identity, 'identity');
  ArgumentError.checkNotNull(notificationType, 'notificationType');
  final $request = <String, dynamic>{};
  $request['Enabled'] = enabled;
  $request['Identity'] = identity;
  $request['NotificationType'] = notificationType.toValue();
  await _protocol.send(
    $request,
    action: 'SetIdentityHeadersInNotificationsEnabled',
    version: '2010-12-01',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['SetIdentityHeadersInNotificationsEnabledRequest'],
    shapes: shapes,
    resultWrapper: 'SetIdentityHeadersInNotificationsEnabledResult',
  );
}