aws-sdk-ses 1.54.0 → 1.55.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-ses/client.rb +380 -382
- data/lib/aws-sdk-ses/endpoint_provider.rb +27 -24
- data/lib/aws-sdk-ses/types.rb +580 -527
- data/lib/aws-sdk-ses.rb +1 -1
- metadata +2 -2
data/lib/aws-sdk-ses/types.rb
CHANGED
@@ -28,17 +28,18 @@ module Aws::SES
|
|
28
28
|
#
|
29
29
|
#
|
30
30
|
#
|
31
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
31
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-add-header.html
|
32
32
|
#
|
33
33
|
# @!attribute [rw] header_name
|
34
|
-
# The name of the header to add
|
35
|
-
#
|
36
|
-
# and dashes
|
34
|
+
# The name of the header to add to the incoming message. The name must
|
35
|
+
# contain at least one character, and can contain up to 50 characters.
|
36
|
+
# It consists of alphanumeric (a–z, A–Z, 0–9) characters and dashes.
|
37
37
|
# @return [String]
|
38
38
|
#
|
39
39
|
# @!attribute [rw] header_value
|
40
|
-
#
|
41
|
-
# characters (
|
40
|
+
# The content to include in the header. This value can contain up to
|
41
|
+
# 2048 characters. It can't contain newline (`\n`) or carriage return
|
42
|
+
# (`\r`) characters.
|
42
43
|
# @return [String]
|
43
44
|
#
|
44
45
|
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/AddHeaderAction AWS API Documentation
|
@@ -101,18 +102,20 @@ module Aws::SES
|
|
101
102
|
#
|
102
103
|
#
|
103
104
|
#
|
104
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
105
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-bounce.html
|
105
106
|
#
|
106
107
|
# @!attribute [rw] topic_arn
|
107
108
|
# The Amazon Resource Name (ARN) of the Amazon SNS topic to notify
|
108
|
-
# when the bounce action is taken.
|
109
|
-
#
|
110
|
-
#
|
111
|
-
#
|
109
|
+
# when the bounce action is taken. You can find the ARN of a topic by
|
110
|
+
# using the [ListTopics][1] operation in Amazon SNS.
|
111
|
+
#
|
112
|
+
# For more information about Amazon SNS topics, see the [Amazon SNS
|
113
|
+
# Developer Guide][2].
|
112
114
|
#
|
113
115
|
#
|
114
116
|
#
|
115
|
-
# [1]: https://docs.aws.amazon.com/sns/latest/
|
117
|
+
# [1]: https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html
|
118
|
+
# [2]: https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html
|
116
119
|
# @return [String]
|
117
120
|
#
|
118
121
|
# @!attribute [rw] smtp_reply_code
|
@@ -137,7 +140,7 @@ module Aws::SES
|
|
137
140
|
#
|
138
141
|
# @!attribute [rw] sender
|
139
142
|
# The email address of the sender of the bounced email. This is the
|
140
|
-
# address from which the bounce message
|
143
|
+
# address from which the bounce message is sent.
|
141
144
|
# @return [String]
|
142
145
|
#
|
143
146
|
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/BounceAction AWS API Documentation
|
@@ -161,7 +164,7 @@ module Aws::SES
|
|
161
164
|
#
|
162
165
|
#
|
163
166
|
#
|
164
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
167
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email.html
|
165
168
|
#
|
166
169
|
# @!attribute [rw] recipient
|
167
170
|
# The email address of the recipient of the bounced email.
|
@@ -176,7 +179,7 @@ module Aws::SES
|
|
176
179
|
#
|
177
180
|
#
|
178
181
|
#
|
179
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
182
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html
|
180
183
|
# @return [String]
|
181
184
|
#
|
182
185
|
# @!attribute [rw] bounce_type
|
@@ -209,20 +212,24 @@ module Aws::SES
|
|
209
212
|
# and BCC: fields.
|
210
213
|
#
|
211
214
|
# <note markdown="1"> Amazon SES does not support the SMTPUTF8 extension, as described in
|
212
|
-
# [RFC6531][1]. For this reason, the
|
213
|
-
#
|
214
|
-
#
|
215
|
-
#
|
216
|
-
#
|
217
|
-
#
|
215
|
+
# [RFC6531][1]. For this reason, the email address string must be
|
216
|
+
# 7-bit ASCII. If you want to send to or from email addresses that
|
217
|
+
# contain Unicode characters in the domain part of an address, you
|
218
|
+
# must encode the domain using Punycode. Punycode is not permitted in
|
219
|
+
# the local part of the email address (the part before the @ sign) nor
|
220
|
+
# in the "friendly from" name. If you want to use Unicode characters
|
221
|
+
# in the "friendly from" name, you must encode the "friendly from"
|
222
|
+
# name using MIME encoded-word syntax, as described in [Sending raw
|
223
|
+
# email using the Amazon SES API][2]. For more information about
|
224
|
+
# Punycode, see [RFC 3492][3].
|
218
225
|
#
|
219
226
|
# </note>
|
220
227
|
#
|
221
228
|
#
|
222
229
|
#
|
223
230
|
# [1]: https://tools.ietf.org/html/rfc6531
|
224
|
-
# [2]: https://
|
225
|
-
# [3]:
|
231
|
+
# [2]: https://docs.aws.amazon.com/ses/latest/dg/send-email-raw.html
|
232
|
+
# [3]: http://tools.ietf.org/html/rfc3492
|
226
233
|
# @return [Types::Destination]
|
227
234
|
#
|
228
235
|
# @!attribute [rw] replacement_tags
|
@@ -258,7 +265,7 @@ module Aws::SES
|
|
258
265
|
#
|
259
266
|
# Possible values for this parameter include:
|
260
267
|
#
|
261
|
-
# * `Success`: Amazon SES accepted the message, and
|
268
|
+
# * `Success`: Amazon SES accepted the message, and attempts to
|
262
269
|
# deliver it to the recipients.
|
263
270
|
#
|
264
271
|
# * `MessageRejected`: The message was rejected because it contained a
|
@@ -345,17 +352,18 @@ module Aws::SES
|
|
345
352
|
#
|
346
353
|
#
|
347
354
|
#
|
348
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
355
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html
|
349
356
|
#
|
350
357
|
# @!attribute [rw] rule_set_name
|
351
|
-
# The name of the rule set to create. The name must
|
358
|
+
# The name of the rule set to create. The name must meet the following
|
359
|
+
# requirements:
|
352
360
|
#
|
353
|
-
# *
|
354
|
-
# (
|
361
|
+
# * Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores
|
362
|
+
# (\_), or dashes (-).
|
355
363
|
#
|
356
364
|
# * Start and end with a letter or number.
|
357
365
|
#
|
358
|
-
# * Contain
|
366
|
+
# * Contain 64 characters or fewer.
|
359
367
|
# @return [String]
|
360
368
|
#
|
361
369
|
# @!attribute [rw] original_rule_set_name
|
@@ -387,7 +395,7 @@ module Aws::SES
|
|
387
395
|
#
|
388
396
|
#
|
389
397
|
#
|
390
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
398
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html
|
391
399
|
#
|
392
400
|
# @!attribute [rw] dimension_configurations
|
393
401
|
# A list of dimensions upon which to categorize your emails when you
|
@@ -410,35 +418,37 @@ module Aws::SES
|
|
410
418
|
#
|
411
419
|
#
|
412
420
|
#
|
413
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
421
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html
|
414
422
|
#
|
415
423
|
# @!attribute [rw] dimension_name
|
416
424
|
# The name of an Amazon CloudWatch dimension associated with an email
|
417
|
-
# sending metric. The name must:
|
425
|
+
# sending metric. The name must meet the following requirements:
|
418
426
|
#
|
419
|
-
# *
|
420
|
-
# (
|
427
|
+
# * Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores
|
428
|
+
# (\_), dashes (-), or colons (:).
|
421
429
|
#
|
422
|
-
# * Contain
|
430
|
+
# * Contain 256 characters or fewer.
|
423
431
|
# @return [String]
|
424
432
|
#
|
425
433
|
# @!attribute [rw] dimension_value_source
|
426
434
|
# The place where Amazon SES finds the value of a dimension to publish
|
427
|
-
# to Amazon CloudWatch.
|
428
|
-
#
|
429
|
-
#
|
430
|
-
#
|
435
|
+
# to Amazon CloudWatch. To use the message tags that you specify using
|
436
|
+
# an `X-SES-MESSAGE-TAGS` header or a parameter to the
|
437
|
+
# `SendEmail`/`SendRawEmail` API, specify `messageTag`. To use your
|
438
|
+
# own email headers, specify `emailHeader`. To put a custom tag on any
|
439
|
+
# link included in your email, specify `linkTag`.
|
431
440
|
# @return [String]
|
432
441
|
#
|
433
442
|
# @!attribute [rw] default_dimension_value
|
434
443
|
# The default value of the dimension that is published to Amazon
|
435
444
|
# CloudWatch if you do not provide the value of the dimension when you
|
436
|
-
# send an email. The default value must
|
445
|
+
# send an email. The default value must meet the following
|
446
|
+
# requirements:
|
437
447
|
#
|
438
|
-
# *
|
439
|
-
# (
|
448
|
+
# * Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores
|
449
|
+
# (\_), dashes (-), at signs (@), or periods (.).
|
440
450
|
#
|
441
|
-
# * Contain
|
451
|
+
# * Contain 256 characters or fewer.
|
442
452
|
# @return [String]
|
443
453
|
#
|
444
454
|
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/CloudWatchDimensionConfiguration AWS API Documentation
|
@@ -460,8 +470,8 @@ module Aws::SES
|
|
460
470
|
#
|
461
471
|
#
|
462
472
|
#
|
463
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
464
|
-
# [2]: https://docs.aws.amazon.com/ses/latest/
|
473
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/using-configuration-sets.html
|
474
|
+
# [2]: https://docs.aws.amazon.com/ses/latest/dg/
|
465
475
|
#
|
466
476
|
# @!attribute [rw] name
|
467
477
|
# The name of the configuration set. The name must meet the following
|
@@ -554,14 +564,14 @@ module Aws::SES
|
|
554
564
|
|
555
565
|
# Represents a request to create a configuration set event destination.
|
556
566
|
# A configuration set event destination, which can be either Amazon
|
557
|
-
# CloudWatch or Amazon Kinesis Firehose, describes an
|
558
|
-
# which Amazon SES publishes the email sending
|
559
|
-
# configuration set. For information about
|
560
|
-
# the [Amazon SES Developer Guide][1].
|
567
|
+
# CloudWatch or Amazon Kinesis Firehose, describes an Amazon Web
|
568
|
+
# Services service in which Amazon SES publishes the email sending
|
569
|
+
# events associated with a configuration set. For information about
|
570
|
+
# using configuration sets, see the [Amazon SES Developer Guide][1].
|
561
571
|
#
|
562
572
|
#
|
563
573
|
#
|
564
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
574
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html
|
565
575
|
#
|
566
576
|
# @!attribute [rw] configuration_set_name
|
567
577
|
# The name of the configuration set that the event destination should
|
@@ -569,8 +579,8 @@ module Aws::SES
|
|
569
579
|
# @return [String]
|
570
580
|
#
|
571
581
|
# @!attribute [rw] event_destination
|
572
|
-
# An object that describes the
|
573
|
-
# information
|
582
|
+
# An object that describes the Amazon Web Services service that email
|
583
|
+
# sending event where information is published.
|
574
584
|
# @return [Types::EventDestination]
|
575
585
|
#
|
576
586
|
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/CreateConfigurationSetEventDestinationRequest AWS API Documentation
|
@@ -594,7 +604,7 @@ module Aws::SES
|
|
594
604
|
#
|
595
605
|
#
|
596
606
|
#
|
597
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
607
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html
|
598
608
|
#
|
599
609
|
# @!attribute [rw] configuration_set
|
600
610
|
# A data structure that contains the name of the configuration set.
|
@@ -632,7 +642,7 @@ module Aws::SES
|
|
632
642
|
#
|
633
643
|
#
|
634
644
|
#
|
635
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
645
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/configure-custom-open-click-domains.html
|
636
646
|
# @return [Types::TrackingOptions]
|
637
647
|
#
|
638
648
|
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/CreateConfigurationSetTrackingOptionsRequest AWS API Documentation
|
@@ -673,7 +683,7 @@ module Aws::SES
|
|
673
683
|
#
|
674
684
|
#
|
675
685
|
#
|
676
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
686
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom
|
677
687
|
# @return [String]
|
678
688
|
#
|
679
689
|
# @!attribute [rw] success_redirection_url
|
@@ -705,7 +715,7 @@ module Aws::SES
|
|
705
715
|
#
|
706
716
|
#
|
707
717
|
#
|
708
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
718
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html
|
709
719
|
#
|
710
720
|
# @!attribute [rw] filter
|
711
721
|
# A data structure that describes the IP address filter to create,
|
@@ -733,16 +743,16 @@ module Aws::SES
|
|
733
743
|
#
|
734
744
|
#
|
735
745
|
#
|
736
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
746
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html
|
737
747
|
#
|
738
748
|
# @!attribute [rw] rule_set_name
|
739
|
-
# The name of the rule set
|
749
|
+
# The name of the rule set where the receipt rule is added.
|
740
750
|
# @return [String]
|
741
751
|
#
|
742
752
|
# @!attribute [rw] after
|
743
|
-
# The name of an existing rule after which the new rule
|
744
|
-
#
|
745
|
-
# the
|
753
|
+
# The name of an existing rule after which the new rule is placed. If
|
754
|
+
# this parameter is null, the new rule is inserted at the beginning of
|
755
|
+
# the rule list.
|
746
756
|
# @return [String]
|
747
757
|
#
|
748
758
|
# @!attribute [rw] rule
|
@@ -772,17 +782,18 @@ module Aws::SES
|
|
772
782
|
#
|
773
783
|
#
|
774
784
|
#
|
775
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
785
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html
|
776
786
|
#
|
777
787
|
# @!attribute [rw] rule_set_name
|
778
|
-
# The name of the rule set to create. The name must
|
788
|
+
# The name of the rule set to create. The name must meet the following
|
789
|
+
# requirements:
|
779
790
|
#
|
780
|
-
# *
|
781
|
-
# (
|
791
|
+
# * Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores
|
792
|
+
# (\_), or dashes (-).
|
782
793
|
#
|
783
794
|
# * Start and end with a letter or number.
|
784
795
|
#
|
785
|
-
# * Contain
|
796
|
+
# * Contain 64 characters or fewer.
|
786
797
|
# @return [String]
|
787
798
|
#
|
788
799
|
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/CreateReceiptRuleSetRequest AWS API Documentation
|
@@ -804,11 +815,11 @@ module Aws::SES
|
|
804
815
|
#
|
805
816
|
#
|
806
817
|
#
|
807
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
818
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/send-personalized-email-api.html
|
808
819
|
#
|
809
820
|
# @!attribute [rw] template
|
810
|
-
# The content of the email, composed of a subject line
|
811
|
-
#
|
821
|
+
# The content of the email, composed of a subject line and either an
|
822
|
+
# HTML part or a text-only part.
|
812
823
|
# @return [Types::Template]
|
813
824
|
#
|
814
825
|
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/CreateTemplateRequest AWS API Documentation
|
@@ -906,7 +917,7 @@ module Aws::SES
|
|
906
917
|
#
|
907
918
|
#
|
908
919
|
#
|
909
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
920
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html
|
910
921
|
#
|
911
922
|
# @!attribute [rw] configuration_set_name
|
912
923
|
# The name of the configuration set from which to delete the event
|
@@ -938,7 +949,7 @@ module Aws::SES
|
|
938
949
|
#
|
939
950
|
#
|
940
951
|
#
|
941
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
952
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html
|
942
953
|
#
|
943
954
|
# @!attribute [rw] configuration_set_name
|
944
955
|
# The name of the configuration set to delete.
|
@@ -962,8 +973,7 @@ module Aws::SES
|
|
962
973
|
# configuration set.
|
963
974
|
#
|
964
975
|
# @!attribute [rw] configuration_set_name
|
965
|
-
# The name of the configuration set
|
966
|
-
# tracking options.
|
976
|
+
# The name of the configuration set.
|
967
977
|
# @return [String]
|
968
978
|
#
|
969
979
|
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/DeleteConfigurationSetTrackingOptionsRequest AWS API Documentation
|
@@ -984,8 +994,7 @@ module Aws::SES
|
|
984
994
|
# template.
|
985
995
|
#
|
986
996
|
# @!attribute [rw] template_name
|
987
|
-
# The name of the custom verification email template
|
988
|
-
# delete.
|
997
|
+
# The name of the custom verification email template to delete.
|
989
998
|
# @return [String]
|
990
999
|
#
|
991
1000
|
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/DeleteCustomVerificationEmailTemplateRequest AWS API Documentation
|
@@ -1003,16 +1012,15 @@ module Aws::SES
|
|
1003
1012
|
#
|
1004
1013
|
#
|
1005
1014
|
#
|
1006
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
1015
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html
|
1007
1016
|
#
|
1008
1017
|
# @!attribute [rw] identity
|
1009
|
-
# The identity that is associated with the policy
|
1010
|
-
#
|
1011
|
-
#
|
1012
|
-
# `example.com`,
|
1018
|
+
# The identity that is associated with the policy to delete. You can
|
1019
|
+
# specify the identity by using its name or by using its Amazon
|
1020
|
+
# Resource Name (ARN). Examples: `user@example.com`, `example.com`,
|
1013
1021
|
# `arn:aws:ses:us-east-1:123456789012:identity/example.com`.
|
1014
1022
|
#
|
1015
|
-
# To successfully call this
|
1023
|
+
# To successfully call this operation, you must own the identity.
|
1016
1024
|
# @return [String]
|
1017
1025
|
#
|
1018
1026
|
# @!attribute [rw] policy_name
|
@@ -1038,8 +1046,8 @@ module Aws::SES
|
|
1038
1046
|
# email address or domain).
|
1039
1047
|
#
|
1040
1048
|
# @!attribute [rw] identity
|
1041
|
-
# The identity to be removed from the list of identities for the
|
1042
|
-
#
|
1049
|
+
# The identity to be removed from the list of identities for the
|
1050
|
+
# Amazon Web Services account.
|
1043
1051
|
# @return [String]
|
1044
1052
|
#
|
1045
1053
|
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/DeleteIdentityRequest AWS API Documentation
|
@@ -1062,7 +1070,7 @@ module Aws::SES
|
|
1062
1070
|
#
|
1063
1071
|
#
|
1064
1072
|
#
|
1065
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
1073
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html
|
1066
1074
|
#
|
1067
1075
|
# @!attribute [rw] filter_name
|
1068
1076
|
# The name of the IP address filter to delete.
|
@@ -1088,7 +1096,7 @@ module Aws::SES
|
|
1088
1096
|
#
|
1089
1097
|
#
|
1090
1098
|
#
|
1091
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
1099
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html
|
1092
1100
|
#
|
1093
1101
|
# @!attribute [rw] rule_set_name
|
1094
1102
|
# The name of the receipt rule set that contains the receipt rule to
|
@@ -1121,7 +1129,7 @@ module Aws::SES
|
|
1121
1129
|
#
|
1122
1130
|
#
|
1123
1131
|
#
|
1124
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
1132
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html
|
1125
1133
|
#
|
1126
1134
|
# @!attribute [rw] rule_set_name
|
1127
1135
|
# The name of the receipt rule set to delete.
|
@@ -1146,7 +1154,7 @@ module Aws::SES
|
|
1146
1154
|
#
|
1147
1155
|
#
|
1148
1156
|
#
|
1149
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
1157
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/send-personalized-email-api.html
|
1150
1158
|
#
|
1151
1159
|
# @!attribute [rw] template_name
|
1152
1160
|
# The name of the template to be deleted.
|
@@ -1165,7 +1173,8 @@ module Aws::SES
|
|
1165
1173
|
class DeleteTemplateResponse < Aws::EmptyStructure; end
|
1166
1174
|
|
1167
1175
|
# Represents a request to delete an email address from the list of email
|
1168
|
-
# addresses you have attempted to verify under your
|
1176
|
+
# addresses you have attempted to verify under your Amazon Web Services
|
1177
|
+
# account.
|
1169
1178
|
#
|
1170
1179
|
# @!attribute [rw] email_address
|
1171
1180
|
# An email address to be removed from the list of verified addresses.
|
@@ -1205,7 +1214,7 @@ module Aws::SES
|
|
1205
1214
|
#
|
1206
1215
|
#
|
1207
1216
|
#
|
1208
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
1217
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html
|
1209
1218
|
#
|
1210
1219
|
# @api private
|
1211
1220
|
#
|
@@ -1242,7 +1251,7 @@ module Aws::SES
|
|
1242
1251
|
#
|
1243
1252
|
#
|
1244
1253
|
#
|
1245
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
1254
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html
|
1246
1255
|
#
|
1247
1256
|
# @!attribute [rw] configuration_set_name
|
1248
1257
|
# The name of the configuration set to describe.
|
@@ -1267,7 +1276,7 @@ module Aws::SES
|
|
1267
1276
|
#
|
1268
1277
|
#
|
1269
1278
|
#
|
1270
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
1279
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html
|
1271
1280
|
#
|
1272
1281
|
# @!attribute [rw] configuration_set
|
1273
1282
|
# The configuration set object associated with the specified
|
@@ -1311,7 +1320,7 @@ module Aws::SES
|
|
1311
1320
|
#
|
1312
1321
|
#
|
1313
1322
|
#
|
1314
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
1323
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html
|
1315
1324
|
#
|
1316
1325
|
# @!attribute [rw] rule_set_name
|
1317
1326
|
# The name of the receipt rule set that the receipt rule belongs to.
|
@@ -1352,7 +1361,7 @@ module Aws::SES
|
|
1352
1361
|
#
|
1353
1362
|
#
|
1354
1363
|
#
|
1355
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
1364
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html
|
1356
1365
|
#
|
1357
1366
|
# @!attribute [rw] rule_set_name
|
1358
1367
|
# The name of the receipt rule set to describe.
|
@@ -1391,19 +1400,24 @@ module Aws::SES
|
|
1391
1400
|
# BCC: fields.
|
1392
1401
|
#
|
1393
1402
|
# <note markdown="1"> Amazon SES does not support the SMTPUTF8 extension, as described in
|
1394
|
-
# [RFC6531][1]. For this reason, the
|
1395
|
-
#
|
1396
|
-
#
|
1397
|
-
#
|
1398
|
-
#
|
1403
|
+
# [RFC6531][1]. For this reason, the email address string must be 7-bit
|
1404
|
+
# ASCII. If you want to send to or from email addresses that contain
|
1405
|
+
# Unicode characters in the domain part of an address, you must encode
|
1406
|
+
# the domain using Punycode. Punycode is not permitted in the local part
|
1407
|
+
# of the email address (the part before the @ sign) nor in the
|
1408
|
+
# "friendly from" name. If you want to use Unicode characters in the
|
1409
|
+
# "friendly from" name, you must encode the "friendly from" name
|
1410
|
+
# using MIME encoded-word syntax, as described in [Sending raw email
|
1411
|
+
# using the Amazon SES API][2]. For more information about Punycode, see
|
1412
|
+
# [RFC 3492][3].
|
1399
1413
|
#
|
1400
1414
|
# </note>
|
1401
1415
|
#
|
1402
1416
|
#
|
1403
1417
|
#
|
1404
1418
|
# [1]: https://tools.ietf.org/html/rfc6531
|
1405
|
-
# [2]: https://
|
1406
|
-
# [3]:
|
1419
|
+
# [2]: https://docs.aws.amazon.com/ses/latest/dg/send-email-raw.html
|
1420
|
+
# [3]: http://tools.ietf.org/html/rfc3492
|
1407
1421
|
#
|
1408
1422
|
# @!attribute [rw] to_addresses
|
1409
1423
|
# The recipients to place on the To: line of the message.
|
@@ -1427,8 +1441,7 @@ module Aws::SES
|
|
1427
1441
|
include Aws::Structure
|
1428
1442
|
end
|
1429
1443
|
|
1430
|
-
# Contains information about
|
1431
|
-
# email sending events will be published to.
|
1444
|
+
# Contains information about an event destination.
|
1432
1445
|
#
|
1433
1446
|
# <note markdown="1"> When you create or update an event destination, you must provide one,
|
1434
1447
|
# and only one, destination. The destination can be Amazon CloudWatch,
|
@@ -1445,15 +1458,16 @@ module Aws::SES
|
|
1445
1458
|
#
|
1446
1459
|
#
|
1447
1460
|
#
|
1448
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
1461
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html
|
1449
1462
|
#
|
1450
1463
|
# @!attribute [rw] name
|
1451
|
-
# The name of the event destination. The name must
|
1464
|
+
# The name of the event destination. The name must meet the following
|
1465
|
+
# requirements:
|
1452
1466
|
#
|
1453
|
-
# *
|
1454
|
-
# (
|
1467
|
+
# * Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores
|
1468
|
+
# (\_), or dashes (-).
|
1455
1469
|
#
|
1456
|
-
# * Contain
|
1470
|
+
# * Contain 64 characters or fewer.
|
1457
1471
|
# @return [String]
|
1458
1472
|
#
|
1459
1473
|
# @!attribute [rw] enabled
|
@@ -1467,6 +1481,28 @@ module Aws::SES
|
|
1467
1481
|
# @!attribute [rw] matching_event_types
|
1468
1482
|
# The type of email sending events to publish to the event
|
1469
1483
|
# destination.
|
1484
|
+
#
|
1485
|
+
# * `send` - The call was successful and Amazon SES is attempting to
|
1486
|
+
# deliver the email.
|
1487
|
+
#
|
1488
|
+
# * `reject` - Amazon SES determined that the email contained a virus
|
1489
|
+
# and rejected it.
|
1490
|
+
#
|
1491
|
+
# * `bounce` - The recipient's mail server permanently rejected the
|
1492
|
+
# email. This corresponds to a hard bounce.
|
1493
|
+
#
|
1494
|
+
# * `complaint` - The recipient marked the email as spam.
|
1495
|
+
#
|
1496
|
+
# * `delivery` - Amazon SES successfully delivered the email to the
|
1497
|
+
# recipient's mail server.
|
1498
|
+
#
|
1499
|
+
# * `open` - The recipient received the email and opened it in their
|
1500
|
+
# email client.
|
1501
|
+
#
|
1502
|
+
# * `click` - The recipient clicked one or more links in the email.
|
1503
|
+
#
|
1504
|
+
# * `renderingFailure` - Amazon SES did not send the email because of
|
1505
|
+
# a template rendering issue.
|
1470
1506
|
# @return [Array<String>]
|
1471
1507
|
#
|
1472
1508
|
# @!attribute [rw] kinesis_firehose_destination
|
@@ -1545,7 +1581,7 @@ module Aws::SES
|
|
1545
1581
|
#
|
1546
1582
|
#
|
1547
1583
|
#
|
1548
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
1584
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email.html
|
1549
1585
|
#
|
1550
1586
|
# @!attribute [rw] name
|
1551
1587
|
# The name of the header to add. Must be between 1 and 50 characters,
|
@@ -1554,8 +1590,8 @@ module Aws::SES
|
|
1554
1590
|
# @return [String]
|
1555
1591
|
#
|
1556
1592
|
# @!attribute [rw] value
|
1557
|
-
# The value of the header to add. Must
|
1558
|
-
# and must not contain newline characters ("\\r" or "\\n").
|
1593
|
+
# The value of the header to add. Must contain 2048 characters or
|
1594
|
+
# fewer, and must not contain newline characters ("\\r" or "\\n").
|
1559
1595
|
# @return [String]
|
1560
1596
|
#
|
1561
1597
|
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/ExtensionField AWS API Documentation
|
@@ -1585,11 +1621,11 @@ module Aws::SES
|
|
1585
1621
|
end
|
1586
1622
|
|
1587
1623
|
# Represents a request to return the email sending status for your
|
1588
|
-
# Amazon SES account in the current
|
1624
|
+
# Amazon SES account in the current Amazon Web Services Region.
|
1589
1625
|
#
|
1590
1626
|
# @!attribute [rw] enabled
|
1591
1627
|
# Describes whether email sending is enabled or disabled for your
|
1592
|
-
# Amazon SES account in the current
|
1628
|
+
# Amazon SES account in the current Amazon Web Services Region.
|
1593
1629
|
# @return [Boolean]
|
1594
1630
|
#
|
1595
1631
|
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/GetAccountSendingEnabledResponse AWS API Documentation
|
@@ -1604,8 +1640,7 @@ module Aws::SES
|
|
1604
1640
|
# template.
|
1605
1641
|
#
|
1606
1642
|
# @!attribute [rw] template_name
|
1607
|
-
# The name of the custom verification email template
|
1608
|
-
# retrieve.
|
1643
|
+
# The name of the custom verification email template to retrieve.
|
1609
1644
|
# @return [String]
|
1610
1645
|
#
|
1611
1646
|
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/GetCustomVerificationEmailTemplateRequest AWS API Documentation
|
@@ -1666,7 +1701,7 @@ module Aws::SES
|
|
1666
1701
|
#
|
1667
1702
|
#
|
1668
1703
|
#
|
1669
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
1704
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/send-email-authentication-dkim-easy.html
|
1670
1705
|
#
|
1671
1706
|
# @!attribute [rw] identities
|
1672
1707
|
# A list of one or more verified identities - email addresses,
|
@@ -1704,7 +1739,7 @@ module Aws::SES
|
|
1704
1739
|
#
|
1705
1740
|
#
|
1706
1741
|
#
|
1707
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
1742
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/mail-from.html
|
1708
1743
|
#
|
1709
1744
|
# @!attribute [rw] identities
|
1710
1745
|
# A list of one or more identities.
|
@@ -1738,7 +1773,7 @@ module Aws::SES
|
|
1738
1773
|
#
|
1739
1774
|
#
|
1740
1775
|
#
|
1741
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
1776
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity-using-notifications.html
|
1742
1777
|
#
|
1743
1778
|
# @!attribute [rw] identities
|
1744
1779
|
# A list of one or more identities. You can specify an identity by
|
@@ -1776,15 +1811,15 @@ module Aws::SES
|
|
1776
1811
|
#
|
1777
1812
|
#
|
1778
1813
|
#
|
1779
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
1814
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html
|
1780
1815
|
#
|
1781
1816
|
# @!attribute [rw] identity
|
1782
|
-
# The identity for which the policies
|
1783
|
-
#
|
1784
|
-
#
|
1817
|
+
# The identity for which the policies are retrieved. You can specify
|
1818
|
+
# an identity by using its name or by using its Amazon Resource Name
|
1819
|
+
# (ARN). Examples: `user@example.com`, `example.com`,
|
1785
1820
|
# `arn:aws:ses:us-east-1:123456789012:identity/example.com`.
|
1786
1821
|
#
|
1787
|
-
# To successfully call this
|
1822
|
+
# To successfully call this operation, you must own the identity.
|
1788
1823
|
# @return [String]
|
1789
1824
|
#
|
1790
1825
|
# @!attribute [rw] policy_names
|
@@ -1824,7 +1859,7 @@ module Aws::SES
|
|
1824
1859
|
#
|
1825
1860
|
#
|
1826
1861
|
#
|
1827
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
1862
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html
|
1828
1863
|
#
|
1829
1864
|
# @!attribute [rw] identities
|
1830
1865
|
# A list of identities.
|
@@ -1902,7 +1937,7 @@ module Aws::SES
|
|
1902
1937
|
end
|
1903
1938
|
|
1904
1939
|
# @!attribute [rw] template_name
|
1905
|
-
# The name of the template
|
1940
|
+
# The name of the template to retrieve.
|
1906
1941
|
# @return [String]
|
1907
1942
|
#
|
1908
1943
|
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/GetTemplateRequest AWS API Documentation
|
@@ -1914,8 +1949,8 @@ module Aws::SES
|
|
1914
1949
|
end
|
1915
1950
|
|
1916
1951
|
# @!attribute [rw] template
|
1917
|
-
# The content of the email, composed of a subject line
|
1918
|
-
#
|
1952
|
+
# The content of the email, composed of a subject line and either an
|
1953
|
+
# HTML part or a text-only part.
|
1919
1954
|
# @return [Types::Template]
|
1920
1955
|
#
|
1921
1956
|
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/GetTemplateResponse AWS API Documentation
|
@@ -1955,7 +1990,7 @@ module Aws::SES
|
|
1955
1990
|
#
|
1956
1991
|
#
|
1957
1992
|
#
|
1958
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
1993
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/send-email-authentication-dkim-easy.html
|
1959
1994
|
# @return [Array<String>]
|
1960
1995
|
#
|
1961
1996
|
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/IdentityDkimAttributes AWS API Documentation
|
@@ -2015,48 +2050,48 @@ module Aws::SES
|
|
2015
2050
|
#
|
2016
2051
|
# @!attribute [rw] bounce_topic
|
2017
2052
|
# The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon
|
2018
|
-
# SES
|
2053
|
+
# SES publishes bounce notifications.
|
2019
2054
|
# @return [String]
|
2020
2055
|
#
|
2021
2056
|
# @!attribute [rw] complaint_topic
|
2022
2057
|
# The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon
|
2023
|
-
# SES
|
2058
|
+
# SES publishes complaint notifications.
|
2024
2059
|
# @return [String]
|
2025
2060
|
#
|
2026
2061
|
# @!attribute [rw] delivery_topic
|
2027
2062
|
# The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon
|
2028
|
-
# SES
|
2063
|
+
# SES publishes delivery notifications.
|
2029
2064
|
# @return [String]
|
2030
2065
|
#
|
2031
2066
|
# @!attribute [rw] forwarding_enabled
|
2032
|
-
# Describes whether Amazon SES
|
2033
|
-
# notifications as email. `true` indicates that Amazon SES
|
2034
|
-
#
|
2035
|
-
#
|
2036
|
-
#
|
2067
|
+
# Describes whether Amazon SES forwards bounce and complaint
|
2068
|
+
# notifications as email. `true` indicates that Amazon SES forwards
|
2069
|
+
# bounce and complaint notifications as email, while `false` indicates
|
2070
|
+
# that bounce and complaint notifications are published only to the
|
2071
|
+
# specified bounce and complaint Amazon SNS topics.
|
2037
2072
|
# @return [Boolean]
|
2038
2073
|
#
|
2039
2074
|
# @!attribute [rw] headers_in_bounce_notifications_enabled
|
2040
2075
|
# Describes whether Amazon SES includes the original email headers in
|
2041
2076
|
# Amazon SNS notifications of type `Bounce`. A value of `true`
|
2042
|
-
# specifies that Amazon SES
|
2043
|
-
#
|
2044
|
-
#
|
2077
|
+
# specifies that Amazon SES includes headers in bounce notifications,
|
2078
|
+
# and a value of `false` specifies that Amazon SES does not include
|
2079
|
+
# headers in bounce notifications.
|
2045
2080
|
# @return [Boolean]
|
2046
2081
|
#
|
2047
2082
|
# @!attribute [rw] headers_in_complaint_notifications_enabled
|
2048
2083
|
# Describes whether Amazon SES includes the original email headers in
|
2049
2084
|
# Amazon SNS notifications of type `Complaint`. A value of `true`
|
2050
|
-
# specifies that Amazon SES
|
2051
|
-
# notifications, and a value of `false` specifies that Amazon SES
|
2085
|
+
# specifies that Amazon SES includes headers in complaint
|
2086
|
+
# notifications, and a value of `false` specifies that Amazon SES does
|
2052
2087
|
# not include headers in complaint notifications.
|
2053
2088
|
# @return [Boolean]
|
2054
2089
|
#
|
2055
2090
|
# @!attribute [rw] headers_in_delivery_notifications_enabled
|
2056
2091
|
# Describes whether Amazon SES includes the original email headers in
|
2057
2092
|
# Amazon SNS notifications of type `Delivery`. A value of `true`
|
2058
|
-
# specifies that Amazon SES
|
2059
|
-
# notifications, and a value of `false` specifies that Amazon SES
|
2093
|
+
# specifies that Amazon SES includes headers in delivery
|
2094
|
+
# notifications, and a value of `false` specifies that Amazon SES does
|
2060
2095
|
# not include headers in delivery notifications.
|
2061
2096
|
# @return [Boolean]
|
2062
2097
|
#
|
@@ -2148,10 +2183,10 @@ module Aws::SES
|
|
2148
2183
|
include Aws::Structure
|
2149
2184
|
end
|
2150
2185
|
|
2151
|
-
# Indicates that the provided
|
2152
|
-
# Amazon SES could not execute the provided function,
|
2153
|
-
# permissions issues. For information about giving
|
2154
|
-
# [Amazon SES Developer Guide][1].
|
2186
|
+
# Indicates that the provided Amazon Web Services Lambda function is
|
2187
|
+
# invalid, or that Amazon SES could not execute the provided function,
|
2188
|
+
# possibly due to permissions issues. For information about giving
|
2189
|
+
# permissions, see the [Amazon SES Developer Guide][1].
|
2155
2190
|
#
|
2156
2191
|
#
|
2157
2192
|
#
|
@@ -2191,10 +2226,10 @@ module Aws::SES
|
|
2191
2226
|
include Aws::Structure
|
2192
2227
|
end
|
2193
2228
|
|
2194
|
-
# Indicates that the provided Amazon S3 bucket or
|
2195
|
-
# is invalid, or that Amazon SES could not publish to
|
2196
|
-
# possibly due to permissions issues. For information about
|
2197
|
-
# permissions, see the [Amazon SES Developer Guide][1].
|
2229
|
+
# Indicates that the provided Amazon S3 bucket or Amazon Web Services
|
2230
|
+
# KMS encryption key is invalid, or that Amazon SES could not publish to
|
2231
|
+
# the bucket, possibly due to permissions issues. For information about
|
2232
|
+
# giving permissions, see the [Amazon SES Developer Guide][1].
|
2198
2233
|
#
|
2199
2234
|
#
|
2200
2235
|
#
|
@@ -2292,7 +2327,7 @@ module Aws::SES
|
|
2292
2327
|
#
|
2293
2328
|
#
|
2294
2329
|
#
|
2295
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
2330
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html
|
2296
2331
|
#
|
2297
2332
|
# @!attribute [rw] iam_role_arn
|
2298
2333
|
# The ARN of the IAM role under which Amazon SES publishes email
|
@@ -2313,41 +2348,43 @@ module Aws::SES
|
|
2313
2348
|
include Aws::Structure
|
2314
2349
|
end
|
2315
2350
|
|
2316
|
-
# When included in a receipt rule, this action calls an
|
2317
|
-
# function and, optionally, publishes a notification to
|
2318
|
-
# Notification Service (Amazon SNS).
|
2351
|
+
# When included in a receipt rule, this action calls an Amazon Web
|
2352
|
+
# Services Lambda function and, optionally, publishes a notification to
|
2353
|
+
# Amazon Simple Notification Service (Amazon SNS).
|
2319
2354
|
#
|
2320
|
-
# To enable Amazon SES to call your
|
2321
|
-
# an Amazon SNS topic of another account, Amazon SES
|
2322
|
-
# permission to access those resources. For information about
|
2323
|
-
# permissions, see the [Amazon SES Developer Guide][1].
|
2355
|
+
# To enable Amazon SES to call your Amazon Web Services Lambda function
|
2356
|
+
# or to publish to an Amazon SNS topic of another account, Amazon SES
|
2357
|
+
# must have permission to access those resources. For information about
|
2358
|
+
# giving permissions, see the [Amazon SES Developer Guide][1].
|
2324
2359
|
#
|
2325
|
-
# For information about using
|
2326
|
-
# the [Amazon SES Developer Guide][2].
|
2360
|
+
# For information about using Amazon Web Services Lambda actions in
|
2361
|
+
# receipt rules, see the [Amazon SES Developer Guide][2].
|
2327
2362
|
#
|
2328
2363
|
#
|
2329
2364
|
#
|
2330
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
2331
|
-
# [2]: https://docs.aws.amazon.com/ses/latest/
|
2365
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-permissions.html
|
2366
|
+
# [2]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-lambda.html
|
2332
2367
|
#
|
2333
2368
|
# @!attribute [rw] topic_arn
|
2334
2369
|
# The Amazon Resource Name (ARN) of the Amazon SNS topic to notify
|
2335
|
-
# when the Lambda action is
|
2336
|
-
#
|
2337
|
-
#
|
2338
|
-
#
|
2370
|
+
# when the Lambda action is executed. You can find the ARN of a topic
|
2371
|
+
# by using the [ListTopics][1] operation in Amazon SNS.
|
2372
|
+
#
|
2373
|
+
# For more information about Amazon SNS topics, see the [Amazon SNS
|
2374
|
+
# Developer Guide][2].
|
2339
2375
|
#
|
2340
2376
|
#
|
2341
2377
|
#
|
2342
|
-
# [1]: https://docs.aws.amazon.com/sns/latest/
|
2378
|
+
# [1]: https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html
|
2379
|
+
# [2]: https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html
|
2343
2380
|
# @return [String]
|
2344
2381
|
#
|
2345
2382
|
# @!attribute [rw] function_arn
|
2346
|
-
# The Amazon Resource Name (ARN) of the
|
2347
|
-
# example of an
|
2348
|
-
# `arn:aws:lambda:us-west-2:account-id:function:MyFunction`. For
|
2349
|
-
# information about
|
2350
|
-
# Guide][1].
|
2383
|
+
# The Amazon Resource Name (ARN) of the Amazon Web Services Lambda
|
2384
|
+
# function. An example of an Amazon Web Services Lambda function ARN
|
2385
|
+
# is `arn:aws:lambda:us-west-2:account-id:function:MyFunction`. For
|
2386
|
+
# more information about Amazon Web Services Lambda, see the [Amazon
|
2387
|
+
# Web Services Lambda Developer Guide][1].
|
2351
2388
|
#
|
2352
2389
|
#
|
2353
2390
|
#
|
@@ -2355,17 +2392,18 @@ module Aws::SES
|
|
2355
2392
|
# @return [String]
|
2356
2393
|
#
|
2357
2394
|
# @!attribute [rw] invocation_type
|
2358
|
-
# The invocation type of the
|
2359
|
-
# of `RequestResponse` means that the execution of the
|
2360
|
-
# immediately
|
2361
|
-
# the function
|
2362
|
-
# `Event`. For information about
|
2363
|
-
# [
|
2395
|
+
# The invocation type of the Amazon Web Services Lambda function. An
|
2396
|
+
# invocation type of `RequestResponse` means that the execution of the
|
2397
|
+
# function immediately results in a response, and a value of `Event`
|
2398
|
+
# means that the function is invoked asynchronously. The default value
|
2399
|
+
# is `Event`. For information about Amazon Web Services Lambda
|
2400
|
+
# invocation types, see the [Amazon Web Services Lambda Developer
|
2401
|
+
# Guide][1].
|
2364
2402
|
#
|
2365
2403
|
# There is a 30-second timeout on `RequestResponse` invocations. You
|
2366
2404
|
# should use `Event` invocation in most cases. Use `RequestResponse`
|
2367
|
-
# only
|
2368
|
-
#
|
2405
|
+
# only to make a mail flow decision, such as whether to stop the
|
2406
|
+
# receipt rule or the receipt rule set.
|
2369
2407
|
#
|
2370
2408
|
#
|
2371
2409
|
#
|
@@ -2395,13 +2433,13 @@ module Aws::SES
|
|
2395
2433
|
class LimitExceededException < Aws::EmptyStructure; end
|
2396
2434
|
|
2397
2435
|
# Represents a request to list the configuration sets associated with
|
2398
|
-
# your
|
2399
|
-
# sending events. For information about using
|
2400
|
-
# the [Amazon SES Developer Guide][1].
|
2436
|
+
# your Amazon Web Services account. Configuration sets enable you to
|
2437
|
+
# publish email sending events. For information about using
|
2438
|
+
# configuration sets, see the [Amazon SES Developer Guide][1].
|
2401
2439
|
#
|
2402
2440
|
#
|
2403
2441
|
#
|
2404
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
2442
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html
|
2405
2443
|
#
|
2406
2444
|
# @!attribute [rw] next_token
|
2407
2445
|
# A token returned from a previous call to `ListConfigurationSets` to
|
@@ -2422,14 +2460,14 @@ module Aws::SES
|
|
2422
2460
|
include Aws::Structure
|
2423
2461
|
end
|
2424
2462
|
|
2425
|
-
# A list of configuration sets associated with your
|
2426
|
-
# Configuration sets enable you to publish email sending
|
2427
|
-
# information about using configuration sets, see the
|
2428
|
-
# Developer Guide][1].
|
2463
|
+
# A list of configuration sets associated with your Amazon Web Services
|
2464
|
+
# account. Configuration sets enable you to publish email sending
|
2465
|
+
# events. For information about using configuration sets, see the
|
2466
|
+
# [Amazon SES Developer Guide][1].
|
2429
2467
|
#
|
2430
2468
|
#
|
2431
2469
|
#
|
2432
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
2470
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html
|
2433
2471
|
#
|
2434
2472
|
# @!attribute [rw] configuration_sets
|
2435
2473
|
# A list of configuration sets.
|
@@ -2459,7 +2497,7 @@ module Aws::SES
|
|
2459
2497
|
#
|
2460
2498
|
#
|
2461
2499
|
#
|
2462
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
2500
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom
|
2463
2501
|
#
|
2464
2502
|
# @!attribute [rw] next_token
|
2465
2503
|
# An array the contains the name and creation time stamp for each
|
@@ -2470,7 +2508,7 @@ module Aws::SES
|
|
2470
2508
|
# The maximum number of custom verification email templates to return.
|
2471
2509
|
# This value must be at least 1 and less than or equal to 50. If you
|
2472
2510
|
# do not specify a value, or if you specify a value less than 1 or
|
2473
|
-
# greater than 50, the operation
|
2511
|
+
# greater than 50, the operation returns up to 50 results.
|
2474
2512
|
# @return [Integer]
|
2475
2513
|
#
|
2476
2514
|
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/ListCustomVerificationEmailTemplatesRequest AWS API Documentation
|
@@ -2507,12 +2545,12 @@ module Aws::SES
|
|
2507
2545
|
|
2508
2546
|
# Represents a request to return a list of all identities (email
|
2509
2547
|
# addresses and domains) that you have attempted to verify under your
|
2510
|
-
#
|
2548
|
+
# Amazon Web Services account, regardless of verification status.
|
2511
2549
|
#
|
2512
2550
|
# @!attribute [rw] identity_type
|
2513
2551
|
# The type of the identities to list. Possible values are
|
2514
2552
|
# "EmailAddress" and "Domain". If this parameter is omitted, then
|
2515
|
-
# all identities
|
2553
|
+
# all identities are listed.
|
2516
2554
|
# @return [String]
|
2517
2555
|
#
|
2518
2556
|
# @!attribute [rw] next_token
|
@@ -2535,7 +2573,7 @@ module Aws::SES
|
|
2535
2573
|
end
|
2536
2574
|
|
2537
2575
|
# A list of all identities that you have attempted to verify under your
|
2538
|
-
#
|
2576
|
+
# Amazon Web Services account, regardless of verification status.
|
2539
2577
|
#
|
2540
2578
|
# @!attribute [rw] identities
|
2541
2579
|
# A list of identities.
|
@@ -2562,16 +2600,16 @@ module Aws::SES
|
|
2562
2600
|
#
|
2563
2601
|
#
|
2564
2602
|
#
|
2565
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
2603
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html
|
2566
2604
|
#
|
2567
2605
|
# @!attribute [rw] identity
|
2568
2606
|
# The identity that is associated with the policy for which the
|
2569
|
-
# policies
|
2570
|
-
#
|
2607
|
+
# policies are listed. You can specify an identity by using its name
|
2608
|
+
# or by using its Amazon Resource Name (ARN). Examples:
|
2571
2609
|
# `user@example.com`, `example.com`,
|
2572
2610
|
# `arn:aws:ses:us-east-1:123456789012:identity/example.com`.
|
2573
2611
|
#
|
2574
|
-
# To successfully call this
|
2612
|
+
# To successfully call this operation, you must own the identity.
|
2575
2613
|
# @return [String]
|
2576
2614
|
#
|
2577
2615
|
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/ListIdentityPoliciesRequest AWS API Documentation
|
@@ -2598,13 +2636,13 @@ module Aws::SES
|
|
2598
2636
|
end
|
2599
2637
|
|
2600
2638
|
# Represents a request to list the IP address filters that exist under
|
2601
|
-
# your
|
2602
|
-
# with Amazon SES. For more information, see the [Amazon
|
2603
|
-
# Guide][1].
|
2639
|
+
# your Amazon Web Services account. You use IP address filters when you
|
2640
|
+
# receive email with Amazon SES. For more information, see the [Amazon
|
2641
|
+
# SES Developer Guide][1].
|
2604
2642
|
#
|
2605
2643
|
#
|
2606
2644
|
#
|
2607
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
2645
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html
|
2608
2646
|
#
|
2609
2647
|
# @api private
|
2610
2648
|
#
|
@@ -2612,7 +2650,8 @@ module Aws::SES
|
|
2612
2650
|
#
|
2613
2651
|
class ListReceiptFiltersRequest < Aws::EmptyStructure; end
|
2614
2652
|
|
2615
|
-
# A list of IP address filters that exist under your
|
2653
|
+
# A list of IP address filters that exist under your Amazon Web Services
|
2654
|
+
# account.
|
2616
2655
|
#
|
2617
2656
|
# @!attribute [rw] filters
|
2618
2657
|
# A list of IP address filter data structures, which each consist of a
|
@@ -2629,13 +2668,13 @@ module Aws::SES
|
|
2629
2668
|
end
|
2630
2669
|
|
2631
2670
|
# Represents a request to list the receipt rule sets that exist under
|
2632
|
-
# your
|
2633
|
-
# Amazon SES. For more information, see the [Amazon SES
|
2634
|
-
# Guide][1].
|
2671
|
+
# your Amazon Web Services account. You use receipt rule sets to receive
|
2672
|
+
# email with Amazon SES. For more information, see the [Amazon SES
|
2673
|
+
# Developer Guide][1].
|
2635
2674
|
#
|
2636
2675
|
#
|
2637
2676
|
#
|
2638
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
2677
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html
|
2639
2678
|
#
|
2640
2679
|
# @!attribute [rw] next_token
|
2641
2680
|
# A token returned from a previous call to `ListReceiptRuleSets` to
|
@@ -2650,7 +2689,8 @@ module Aws::SES
|
|
2650
2689
|
include Aws::Structure
|
2651
2690
|
end
|
2652
2691
|
|
2653
|
-
# A list of receipt rule sets that exist under your
|
2692
|
+
# A list of receipt rule sets that exist under your Amazon Web Services
|
2693
|
+
# account.
|
2654
2694
|
#
|
2655
2695
|
# @!attribute [rw] rule_sets
|
2656
2696
|
# The metadata for the currently active receipt rule set. The metadata
|
@@ -2681,9 +2721,9 @@ module Aws::SES
|
|
2681
2721
|
#
|
2682
2722
|
# @!attribute [rw] max_items
|
2683
2723
|
# The maximum number of templates to return. This value must be at
|
2684
|
-
# least 1 and less than or equal to
|
2685
|
-
#
|
2686
|
-
#
|
2724
|
+
# least 1 and less than or equal to 100. If more than 100 items are
|
2725
|
+
# requested, the page size will automatically set to 100. If you do
|
2726
|
+
# not specify a value, 10 is the default page size.
|
2687
2727
|
# @return [Integer]
|
2688
2728
|
#
|
2689
2729
|
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/ListTemplatesRequest AWS API Documentation
|
@@ -2703,7 +2743,8 @@ module Aws::SES
|
|
2703
2743
|
# @!attribute [rw] next_token
|
2704
2744
|
# A token indicating that there are additional email templates
|
2705
2745
|
# available to be listed. Pass this token to a subsequent call to
|
2706
|
-
# `ListTemplates` to retrieve the next
|
2746
|
+
# `ListTemplates` to retrieve the next set of email templates within
|
2747
|
+
# your page size.
|
2707
2748
|
# @return [String]
|
2708
2749
|
#
|
2709
2750
|
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/ListTemplatesResponse AWS API Documentation
|
@@ -2716,7 +2757,7 @@ module Aws::SES
|
|
2716
2757
|
end
|
2717
2758
|
|
2718
2759
|
# A list of email addresses that you have verified with Amazon SES under
|
2719
|
-
# your
|
2760
|
+
# your Amazon Web Services account.
|
2720
2761
|
#
|
2721
2762
|
# @!attribute [rw] verified_email_addresses
|
2722
2763
|
# A list of email addresses that have been verified.
|
@@ -2747,7 +2788,7 @@ module Aws::SES
|
|
2747
2788
|
#
|
2748
2789
|
# @!attribute [rw] subject
|
2749
2790
|
# The subject of the message: A short summary of the content, which
|
2750
|
-
#
|
2791
|
+
# appears in the recipient's inbox.
|
2751
2792
|
# @return [Types::Content]
|
2752
2793
|
#
|
2753
2794
|
# @!attribute [rw] body
|
@@ -2772,7 +2813,7 @@ module Aws::SES
|
|
2772
2813
|
#
|
2773
2814
|
#
|
2774
2815
|
#
|
2775
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
2816
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email.html
|
2776
2817
|
#
|
2777
2818
|
# @!attribute [rw] reporting_mta
|
2778
2819
|
# The reporting MTA that attempted to deliver the message, formatted
|
@@ -2824,24 +2865,25 @@ module Aws::SES
|
|
2824
2865
|
#
|
2825
2866
|
#
|
2826
2867
|
#
|
2827
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
2868
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html
|
2828
2869
|
#
|
2829
2870
|
# @!attribute [rw] name
|
2830
|
-
# The name of the tag. The name must:
|
2871
|
+
# The name of the tag. The name must meet the following requirements:
|
2831
2872
|
#
|
2832
|
-
# *
|
2833
|
-
# (
|
2873
|
+
# * Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores
|
2874
|
+
# (\_), or dashes (-).
|
2834
2875
|
#
|
2835
|
-
# * Contain
|
2876
|
+
# * Contain 256 characters or fewer.
|
2836
2877
|
# @return [String]
|
2837
2878
|
#
|
2838
2879
|
# @!attribute [rw] value
|
2839
|
-
# The value of the tag. The value must
|
2880
|
+
# The value of the tag. The value must meet the following
|
2881
|
+
# requirements:
|
2840
2882
|
#
|
2841
|
-
# *
|
2842
|
-
# (
|
2883
|
+
# * Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores
|
2884
|
+
# (\_), or dashes (-).
|
2843
2885
|
#
|
2844
|
-
# * Contain
|
2886
|
+
# * Contain 256 characters or fewer.
|
2845
2887
|
# @return [String]
|
2846
2888
|
#
|
2847
2889
|
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/MessageTag AWS API Documentation
|
@@ -2878,8 +2920,7 @@ module Aws::SES
|
|
2878
2920
|
# A request to modify the delivery options for a configuration set.
|
2879
2921
|
#
|
2880
2922
|
# @!attribute [rw] configuration_set_name
|
2881
|
-
# The name of the configuration set
|
2882
|
-
# delivery options for.
|
2923
|
+
# The name of the configuration set.
|
2883
2924
|
# @return [String]
|
2884
2925
|
#
|
2885
2926
|
# @!attribute [rw] delivery_options
|
@@ -2910,15 +2951,15 @@ module Aws::SES
|
|
2910
2951
|
#
|
2911
2952
|
#
|
2912
2953
|
#
|
2913
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
2954
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html
|
2914
2955
|
#
|
2915
2956
|
# @!attribute [rw] identity
|
2916
|
-
# The identity that the policy
|
2957
|
+
# The identity to which that the policy applies. You can specify an
|
2917
2958
|
# identity by using its name or by using its Amazon Resource Name
|
2918
2959
|
# (ARN). Examples: `user@example.com`, `example.com`,
|
2919
2960
|
# `arn:aws:ses:us-east-1:123456789012:identity/example.com`.
|
2920
2961
|
#
|
2921
|
-
# To successfully call this
|
2962
|
+
# To successfully call this operation, you must own the identity.
|
2922
2963
|
# @return [String]
|
2923
2964
|
#
|
2924
2965
|
# @!attribute [rw] policy_name
|
@@ -2937,7 +2978,7 @@ module Aws::SES
|
|
2937
2978
|
#
|
2938
2979
|
#
|
2939
2980
|
#
|
2940
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
2981
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/sending-authorization-policies.html
|
2941
2982
|
# @return [String]
|
2942
2983
|
#
|
2943
2984
|
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/PutIdentityPolicyRequest AWS API Documentation
|
@@ -2961,11 +3002,11 @@ module Aws::SES
|
|
2961
3002
|
# @!attribute [rw] data
|
2962
3003
|
# The raw data of the message. This data needs to base64-encoded if
|
2963
3004
|
# you are accessing Amazon SES directly through the HTTPS interface.
|
2964
|
-
# If you are accessing Amazon SES using an
|
2965
|
-
# of the base 64-encoding for you. In all cases,
|
2966
|
-
# ensure that the message format complies with
|
2967
|
-
# standards regarding email header fields, MIME types,
|
2968
|
-
# encoding.
|
3005
|
+
# If you are accessing Amazon SES using an Amazon Web Services SDK,
|
3006
|
+
# the SDK takes care of the base 64-encoding for you. In all cases,
|
3007
|
+
# the client must ensure that the message format complies with
|
3008
|
+
# Internet email standards regarding email header fields, MIME types,
|
3009
|
+
# and MIME encoding.
|
2969
3010
|
#
|
2970
3011
|
# The To:, CC:, and BCC: headers in the raw message can contain a
|
2971
3012
|
# group list.
|
@@ -2982,7 +3023,7 @@ module Aws::SES
|
|
2982
3023
|
#
|
2983
3024
|
#
|
2984
3025
|
#
|
2985
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
3026
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/send-email-raw.html
|
2986
3027
|
# @return [String]
|
2987
3028
|
#
|
2988
3029
|
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/RawMessage AWS API Documentation
|
@@ -3002,7 +3043,7 @@ module Aws::SES
|
|
3002
3043
|
#
|
3003
3044
|
#
|
3004
3045
|
#
|
3005
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
3046
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-receipt-rules-console-walkthrough.html
|
3006
3047
|
#
|
3007
3048
|
# @!attribute [rw] s3_action
|
3008
3049
|
# Saves the received message to an Amazon Simple Storage Service
|
@@ -3022,8 +3063,8 @@ module Aws::SES
|
|
3022
3063
|
# @return [Types::WorkmailAction]
|
3023
3064
|
#
|
3024
3065
|
# @!attribute [rw] lambda_action
|
3025
|
-
# Calls an
|
3026
|
-
# notification to Amazon SNS.
|
3066
|
+
# Calls an Amazon Web Services Lambda function, and optionally,
|
3067
|
+
# publishes a notification to Amazon SNS.
|
3027
3068
|
# @return [Types::LambdaAction]
|
3028
3069
|
#
|
3029
3070
|
# @!attribute [rw] stop_action
|
@@ -3062,17 +3103,18 @@ module Aws::SES
|
|
3062
3103
|
#
|
3063
3104
|
#
|
3064
3105
|
#
|
3065
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
3106
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-ip-filtering-console-walkthrough.html
|
3066
3107
|
#
|
3067
3108
|
# @!attribute [rw] name
|
3068
|
-
# The name of the IP address filter. The name must
|
3109
|
+
# The name of the IP address filter. The name must meet the following
|
3110
|
+
# requirements:
|
3069
3111
|
#
|
3070
|
-
# *
|
3071
|
-
# (
|
3112
|
+
# * Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores
|
3113
|
+
# (\_), or dashes (-).
|
3072
3114
|
#
|
3073
3115
|
# * Start and end with a letter or number.
|
3074
3116
|
#
|
3075
|
-
# * Contain
|
3117
|
+
# * Contain 64 characters or fewer.
|
3076
3118
|
# @return [String]
|
3077
3119
|
#
|
3078
3120
|
# @!attribute [rw] ip_filter
|
@@ -3098,7 +3140,7 @@ module Aws::SES
|
|
3098
3140
|
#
|
3099
3141
|
#
|
3100
3142
|
#
|
3101
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
3143
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-ip-filtering-console-walkthrough.html
|
3102
3144
|
#
|
3103
3145
|
# @!attribute [rw] policy
|
3104
3146
|
# Indicates whether to block or allow incoming mail from the specified
|
@@ -3106,11 +3148,11 @@ module Aws::SES
|
|
3106
3148
|
# @return [String]
|
3107
3149
|
#
|
3108
3150
|
# @!attribute [rw] cidr
|
3109
|
-
# A single IP address or a range of IP addresses
|
3110
|
-
#
|
3111
|
-
#
|
3112
|
-
#
|
3113
|
-
#
|
3151
|
+
# A single IP address or a range of IP addresses to block or allow,
|
3152
|
+
# specified in Classless Inter-Domain Routing (CIDR) notation. An
|
3153
|
+
# example of a single email address is 10.0.0.1. An example of a range
|
3154
|
+
# of IP addresses is 10.0.0.1/24. For more information about CIDR
|
3155
|
+
# notation, see [RFC 2317][1].
|
3114
3156
|
#
|
3115
3157
|
#
|
3116
3158
|
#
|
@@ -3140,17 +3182,18 @@ module Aws::SES
|
|
3140
3182
|
#
|
3141
3183
|
#
|
3142
3184
|
#
|
3143
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
3185
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-receipt-rules-console-walkthrough.html
|
3144
3186
|
#
|
3145
3187
|
# @!attribute [rw] name
|
3146
|
-
# The name of the receipt rule. The name must
|
3188
|
+
# The name of the receipt rule. The name must meet the following
|
3189
|
+
# requirements:
|
3147
3190
|
#
|
3148
|
-
# *
|
3149
|
-
# (
|
3191
|
+
# * Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores
|
3192
|
+
# (\_), dashes (-), or periods (.).
|
3150
3193
|
#
|
3151
3194
|
# * Start and end with a letter or number.
|
3152
3195
|
#
|
3153
|
-
# * Contain
|
3196
|
+
# * Contain 64 characters or fewer.
|
3154
3197
|
# @return [String]
|
3155
3198
|
#
|
3156
3199
|
# @!attribute [rw] enabled
|
@@ -3160,14 +3203,14 @@ module Aws::SES
|
|
3160
3203
|
# @!attribute [rw] tls_policy
|
3161
3204
|
# Specifies whether Amazon SES should require that incoming email is
|
3162
3205
|
# delivered over a connection encrypted with Transport Layer Security
|
3163
|
-
# (TLS). If this parameter is set to `Require`, Amazon SES
|
3206
|
+
# (TLS). If this parameter is set to `Require`, Amazon SES bounces
|
3164
3207
|
# emails that are not received over TLS. The default is `Optional`.
|
3165
3208
|
# @return [String]
|
3166
3209
|
#
|
3167
3210
|
# @!attribute [rw] recipients
|
3168
3211
|
# The recipient domains and email addresses that the receipt rule
|
3169
|
-
# applies to. If this field is not specified, this rule
|
3170
|
-
# recipients
|
3212
|
+
# applies to. If this field is not specified, this rule matches all
|
3213
|
+
# recipients on all verified domains.
|
3171
3214
|
# @return [Array<String>]
|
3172
3215
|
#
|
3173
3216
|
# @!attribute [rw] actions
|
@@ -3205,17 +3248,18 @@ module Aws::SES
|
|
3205
3248
|
#
|
3206
3249
|
#
|
3207
3250
|
#
|
3208
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
3251
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html#receiving-email-concepts-rules
|
3209
3252
|
#
|
3210
3253
|
# @!attribute [rw] name
|
3211
|
-
# The name of the receipt rule set. The name must
|
3254
|
+
# The name of the receipt rule set. The name must meet the following
|
3255
|
+
# requirements:
|
3212
3256
|
#
|
3213
|
-
# *
|
3214
|
-
# (
|
3257
|
+
# * Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores
|
3258
|
+
# (\_), or dashes (-).
|
3215
3259
|
#
|
3216
3260
|
# * Start and end with a letter or number.
|
3217
3261
|
#
|
3218
|
-
# * Contain
|
3262
|
+
# * Contain 64 characters or fewer.
|
3219
3263
|
# @return [String]
|
3220
3264
|
#
|
3221
3265
|
# @!attribute [rw] created_timestamp
|
@@ -3240,12 +3284,12 @@ module Aws::SES
|
|
3240
3284
|
#
|
3241
3285
|
#
|
3242
3286
|
#
|
3243
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
3287
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email.html
|
3244
3288
|
#
|
3245
3289
|
# @!attribute [rw] final_recipient
|
3246
3290
|
# The email address that the message was ultimately delivered to. This
|
3247
3291
|
# corresponds to the `Final-Recipient` in the DSN. If not specified,
|
3248
|
-
# `FinalRecipient`
|
3292
|
+
# `FinalRecipient` is set to the `Recipient` specified in the
|
3249
3293
|
# `BouncedRecipientInfo` structure. Either `FinalRecipient` or the
|
3250
3294
|
# recipient in `BouncedRecipientInfo` must be a recipient of the
|
3251
3295
|
# original bounced message.
|
@@ -3333,15 +3377,14 @@ module Aws::SES
|
|
3333
3377
|
#
|
3334
3378
|
#
|
3335
3379
|
#
|
3336
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
3380
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html
|
3337
3381
|
#
|
3338
3382
|
# @!attribute [rw] rule_set_name
|
3339
3383
|
# The name of the receipt rule set to reorder.
|
3340
3384
|
# @return [String]
|
3341
3385
|
#
|
3342
3386
|
# @!attribute [rw] rule_names
|
3343
|
-
#
|
3344
|
-
# order that you want to put them.
|
3387
|
+
# The specified receipt rule set's receipt rules, in order.
|
3345
3388
|
# @return [Array<String>]
|
3346
3389
|
#
|
3347
3390
|
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/ReorderReceiptRuleSetRequest AWS API Documentation
|
@@ -3364,9 +3407,9 @@ module Aws::SES
|
|
3364
3407
|
#
|
3365
3408
|
# @!attribute [rw] sending_enabled
|
3366
3409
|
# Describes whether email sending is enabled or disabled for the
|
3367
|
-
# configuration set. If the value is `true`, then Amazon SES
|
3410
|
+
# configuration set. If the value is `true`, then Amazon SES sends
|
3368
3411
|
# emails that use the configuration set. If the value is `false`,
|
3369
|
-
# Amazon SES
|
3412
|
+
# Amazon SES does not send emails that use the configuration set. The
|
3370
3413
|
# default value is `true`. You can change this setting using
|
3371
3414
|
# UpdateConfigurationSetSendingEnabled.
|
3372
3415
|
# @return [Boolean]
|
@@ -3439,14 +3482,13 @@ module Aws::SES
|
|
3439
3482
|
# Service (Amazon SNS).
|
3440
3483
|
#
|
3441
3484
|
# To enable Amazon SES to write emails to your Amazon S3 bucket, use an
|
3442
|
-
#
|
3443
|
-
# of another account, Amazon SES must have permission
|
3444
|
-
# resources. For information about
|
3445
|
-
# SES Developer Guide][1].
|
3485
|
+
# Amazon Web Services KMS key to encrypt your emails, or publish to an
|
3486
|
+
# Amazon SNS topic of another account, Amazon SES must have permission
|
3487
|
+
# to access those resources. For information about granting permissions,
|
3488
|
+
# see the [Amazon SES Developer Guide][1].
|
3446
3489
|
#
|
3447
3490
|
# <note markdown="1"> When you save your emails to an Amazon S3 bucket, the maximum email
|
3448
|
-
# size (including headers) is
|
3449
|
-
# bounce.
|
3491
|
+
# size (including headers) is 40 MB. Emails larger than that bounces.
|
3450
3492
|
#
|
3451
3493
|
# </note>
|
3452
3494
|
#
|
@@ -3455,23 +3497,25 @@ module Aws::SES
|
|
3455
3497
|
#
|
3456
3498
|
#
|
3457
3499
|
#
|
3458
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
3459
|
-
# [2]: https://docs.aws.amazon.com/ses/latest/
|
3500
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-permissions.html
|
3501
|
+
# [2]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-s3.html
|
3460
3502
|
#
|
3461
3503
|
# @!attribute [rw] topic_arn
|
3462
3504
|
# The ARN of the Amazon SNS topic to notify when the message is saved
|
3463
|
-
# to the Amazon S3 bucket.
|
3464
|
-
#
|
3465
|
-
#
|
3505
|
+
# to the Amazon S3 bucket. You can find the ARN of a topic by using
|
3506
|
+
# the [ListTopics][1] operation in Amazon SNS.
|
3507
|
+
#
|
3508
|
+
# For more information about Amazon SNS topics, see the [Amazon SNS
|
3509
|
+
# Developer Guide][2].
|
3466
3510
|
#
|
3467
3511
|
#
|
3468
3512
|
#
|
3469
|
-
# [1]: https://docs.aws.amazon.com/sns/latest/
|
3513
|
+
# [1]: https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html
|
3514
|
+
# [2]: https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html
|
3470
3515
|
# @return [String]
|
3471
3516
|
#
|
3472
3517
|
# @!attribute [rw] bucket_name
|
3473
|
-
# The name of the Amazon S3 bucket
|
3474
|
-
# to.
|
3518
|
+
# The name of the Amazon S3 bucket for incoming email.
|
3475
3519
|
# @return [String]
|
3476
3520
|
#
|
3477
3521
|
# @!attribute [rw] object_key_prefix
|
@@ -3483,42 +3527,43 @@ module Aws::SES
|
|
3483
3527
|
# @!attribute [rw] kms_key_arn
|
3484
3528
|
# The customer master key that Amazon SES should use to encrypt your
|
3485
3529
|
# emails before saving them to the Amazon S3 bucket. You can use the
|
3486
|
-
# default master key or a custom master key you created in
|
3487
|
-
# follows:
|
3530
|
+
# default master key or a custom master key that you created in Amazon
|
3531
|
+
# Web Services KMS as follows:
|
3488
3532
|
#
|
3489
3533
|
# * To use the default master key, provide an ARN in the form of
|
3490
3534
|
# `arn:aws:kms:REGION:ACCOUNT-ID-WITHOUT-HYPHENS:alias/aws/ses`. For
|
3491
|
-
# example, if your
|
3492
|
-
# use the default master key in the US West (Oregon)
|
3493
|
-
# of the default master key would be
|
3535
|
+
# example, if your Amazon Web Services account ID is 123456789012
|
3536
|
+
# and you want to use the default master key in the US West (Oregon)
|
3537
|
+
# Region, the ARN of the default master key would be
|
3494
3538
|
# `arn:aws:kms:us-west-2:123456789012:alias/aws/ses`. If you use the
|
3495
3539
|
# default master key, you don't need to perform any extra steps to
|
3496
3540
|
# give Amazon SES permission to use the key.
|
3497
3541
|
#
|
3498
|
-
# * To use a custom master key you created in
|
3499
|
-
# of the master key and ensure that you add a
|
3500
|
-
# key's policy to give Amazon SES permission to
|
3501
|
-
# information about giving permissions, see the
|
3502
|
-
# Developer Guide][1].
|
3542
|
+
# * To use a custom master key that you created in Amazon Web Services
|
3543
|
+
# KMS, provide the ARN of the master key and ensure that you add a
|
3544
|
+
# statement to your key's policy to give Amazon SES permission to
|
3545
|
+
# use it. For more information about giving permissions, see the
|
3546
|
+
# [Amazon SES Developer Guide][1].
|
3503
3547
|
#
|
3504
|
-
# For more information about key policies, see the [
|
3505
|
-
# Guide][2]. If you do not specify a master
|
3506
|
-
# encrypt your emails.
|
3548
|
+
# For more information about key policies, see the [Amazon Web
|
3549
|
+
# Services KMS Developer Guide][2]. If you do not specify a master
|
3550
|
+
# key, Amazon SES does not encrypt your emails.
|
3507
3551
|
#
|
3508
3552
|
# Your mail is encrypted by Amazon SES using the Amazon S3 encryption
|
3509
3553
|
# client before the mail is submitted to Amazon S3 for storage. It is
|
3510
3554
|
# not encrypted using Amazon S3 server-side encryption. This means
|
3511
3555
|
# that you must use the Amazon S3 encryption client to decrypt the
|
3512
3556
|
# email after retrieving it from Amazon S3, as the service has no
|
3513
|
-
# access to use your
|
3514
|
-
# client is currently available with the [
|
3515
|
-
#
|
3516
|
-
#
|
3557
|
+
# access to use your Amazon Web Services KMS keys for decryption. This
|
3558
|
+
# encryption client is currently available with the [Amazon Web
|
3559
|
+
# Services SDK for Java][3] and [Amazon Web Services SDK for Ruby][4]
|
3560
|
+
# only. For more information about client-side encryption using Amazon
|
3561
|
+
# Web Services KMS master keys, see the [Amazon S3 Developer
|
3517
3562
|
# Guide][5].
|
3518
3563
|
#
|
3519
3564
|
#
|
3520
3565
|
#
|
3521
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
3566
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-permissions.html
|
3522
3567
|
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html
|
3523
3568
|
# [3]: http://aws.amazon.com/sdk-for-java/
|
3524
3569
|
# [4]: http://aws.amazon.com/sdk-for-ruby/
|
@@ -3550,26 +3595,29 @@ module Aws::SES
|
|
3550
3595
|
# about giving permissions, see the [Amazon SES Developer Guide][1].
|
3551
3596
|
#
|
3552
3597
|
# You can only publish emails that are 150 KB or less (including the
|
3553
|
-
# header) to Amazon SNS. Larger emails
|
3554
|
-
#
|
3598
|
+
# header) to Amazon SNS. Larger emails bounce. If you anticipate emails
|
3599
|
+
# larger than 150 KB, use the S3 action instead.
|
3555
3600
|
#
|
3556
3601
|
# For information about using a receipt rule to publish an Amazon SNS
|
3557
3602
|
# notification, see the [Amazon SES Developer Guide][2].
|
3558
3603
|
#
|
3559
3604
|
#
|
3560
3605
|
#
|
3561
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
3562
|
-
# [2]: https://docs.aws.amazon.com/ses/latest/
|
3606
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-permissions.html
|
3607
|
+
# [2]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-sns.html
|
3563
3608
|
#
|
3564
3609
|
# @!attribute [rw] topic_arn
|
3565
|
-
# The Amazon Resource Name (ARN) of the Amazon SNS topic to notify.
|
3566
|
-
#
|
3567
|
-
#
|
3568
|
-
#
|
3610
|
+
# The Amazon Resource Name (ARN) of the Amazon SNS topic to notify.
|
3611
|
+
# You can find the ARN of a topic by using the [ListTopics][1]
|
3612
|
+
# operation in Amazon SNS.
|
3613
|
+
#
|
3614
|
+
# For more information about Amazon SNS topics, see the [Amazon SNS
|
3615
|
+
# Developer Guide][2].
|
3569
3616
|
#
|
3570
3617
|
#
|
3571
3618
|
#
|
3572
|
-
# [1]: https://docs.aws.amazon.com/sns/latest/
|
3619
|
+
# [1]: https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html
|
3620
|
+
# [2]: https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html
|
3573
3621
|
# @return [String]
|
3574
3622
|
#
|
3575
3623
|
# @!attribute [rw] encoding
|
@@ -3599,17 +3647,20 @@ module Aws::SES
|
|
3599
3647
|
#
|
3600
3648
|
#
|
3601
3649
|
#
|
3602
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
3650
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html
|
3603
3651
|
#
|
3604
3652
|
# @!attribute [rw] topic_arn
|
3605
|
-
# The ARN of the Amazon SNS topic
|
3606
|
-
#
|
3607
|
-
#
|
3608
|
-
# about Amazon SNS topics, see the [Amazon SNS Developer Guide][1].
|
3653
|
+
# The ARN of the Amazon SNS topic for email sending events. You can
|
3654
|
+
# find the ARN of a topic by using the [ListTopics][1] Amazon SNS
|
3655
|
+
# operation.
|
3609
3656
|
#
|
3657
|
+
# For more information about Amazon SNS topics, see the [Amazon SNS
|
3658
|
+
# Developer Guide][2].
|
3610
3659
|
#
|
3611
3660
|
#
|
3612
|
-
#
|
3661
|
+
#
|
3662
|
+
# [1]: https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html
|
3663
|
+
# [2]: https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html
|
3613
3664
|
# @return [String]
|
3614
3665
|
#
|
3615
3666
|
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/SNSDestination AWS API Documentation
|
@@ -3634,13 +3685,13 @@ module Aws::SES
|
|
3634
3685
|
#
|
3635
3686
|
# @!attribute [rw] explanation
|
3636
3687
|
# Human-readable text for the bounce message to explain the failure.
|
3637
|
-
# If not specified, the text
|
3638
|
-
#
|
3688
|
+
# If not specified, the text is auto-generated based on the bounced
|
3689
|
+
# recipient information.
|
3639
3690
|
# @return [String]
|
3640
3691
|
#
|
3641
3692
|
# @!attribute [rw] message_dsn
|
3642
|
-
# Message-related DSN fields. If not specified, Amazon SES
|
3643
|
-
#
|
3693
|
+
# Message-related DSN fields. If not specified, Amazon SES chooses the
|
3694
|
+
# values.
|
3644
3695
|
# @return [Types::MessageDsn]
|
3645
3696
|
#
|
3646
3697
|
# @!attribute [rw] bounced_recipient_info_list
|
@@ -3659,7 +3710,7 @@ module Aws::SES
|
|
3659
3710
|
#
|
3660
3711
|
#
|
3661
3712
|
#
|
3662
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
3713
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html
|
3663
3714
|
# @return [String]
|
3664
3715
|
#
|
3665
3716
|
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/SendBounceRequest AWS API Documentation
|
@@ -3695,7 +3746,7 @@ module Aws::SES
|
|
3695
3746
|
#
|
3696
3747
|
#
|
3697
3748
|
#
|
3698
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
3749
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/send-personalized-email-api.html
|
3699
3750
|
#
|
3700
3751
|
# @!attribute [rw] source
|
3701
3752
|
# The email address that is sending the email. This email address must
|
@@ -3709,27 +3760,26 @@ module Aws::SES
|
|
3709
3760
|
# sending authorization, see the [Amazon SES Developer Guide][2].
|
3710
3761
|
#
|
3711
3762
|
# <note markdown="1"> Amazon SES does not support the SMTPUTF8 extension, as described in
|
3712
|
-
# [RFC6531][3]. For this reason, the
|
3713
|
-
#
|
3714
|
-
#
|
3715
|
-
#
|
3716
|
-
#
|
3717
|
-
#
|
3718
|
-
#
|
3719
|
-
# encoded-word syntax, as described in [
|
3720
|
-
#
|
3721
|
-
#
|
3763
|
+
# [RFC6531][3]. For this reason, the email address string must be
|
3764
|
+
# 7-bit ASCII. If you want to send to or from email addresses that
|
3765
|
+
# contain Unicode characters in the domain part of an address, you
|
3766
|
+
# must encode the domain using Punycode. Punycode is not permitted in
|
3767
|
+
# the local part of the email address (the part before the @ sign) nor
|
3768
|
+
# in the "friendly from" name. If you want to use Unicode characters
|
3769
|
+
# in the "friendly from" name, you must encode the "friendly from"
|
3770
|
+
# name using MIME encoded-word syntax, as described in [Sending raw
|
3771
|
+
# email using the Amazon SES API][4]. For more information about
|
3772
|
+
# Punycode, see [RFC 3492][5].
|
3722
3773
|
#
|
3723
3774
|
# </note>
|
3724
3775
|
#
|
3725
3776
|
#
|
3726
3777
|
#
|
3727
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
3728
|
-
# [2]: https://docs.aws.amazon.com/ses/latest/
|
3778
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html
|
3779
|
+
# [2]: https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html
|
3729
3780
|
# [3]: https://tools.ietf.org/html/rfc6531
|
3730
|
-
# [4]: https://
|
3731
|
-
# [5]:
|
3732
|
-
# [6]: https://tools.ietf.org/html/rfc2047
|
3781
|
+
# [4]: https://docs.aws.amazon.com/ses/latest/dg/send-email-raw.html
|
3782
|
+
# [5]: http://tools.ietf.org/html/rfc3492
|
3733
3783
|
# @return [String]
|
3734
3784
|
#
|
3735
3785
|
# @!attribute [rw] source_arn
|
@@ -3750,24 +3800,23 @@ module Aws::SES
|
|
3750
3800
|
#
|
3751
3801
|
#
|
3752
3802
|
#
|
3753
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
3803
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html
|
3754
3804
|
# @return [String]
|
3755
3805
|
#
|
3756
3806
|
# @!attribute [rw] reply_to_addresses
|
3757
3807
|
# The reply-to email address(es) for the message. If the recipient
|
3758
|
-
# replies to the message, each reply-to address
|
3759
|
-
# reply.
|
3808
|
+
# replies to the message, each reply-to address receives the reply.
|
3760
3809
|
# @return [Array<String>]
|
3761
3810
|
#
|
3762
3811
|
# @!attribute [rw] return_path
|
3763
|
-
# The email address that bounces and complaints
|
3764
|
-
#
|
3765
|
-
#
|
3766
|
-
#
|
3767
|
-
#
|
3768
|
-
#
|
3769
|
-
#
|
3770
|
-
#
|
3812
|
+
# The email address that bounces and complaints are forwarded to when
|
3813
|
+
# feedback forwarding is enabled. If the message cannot be delivered
|
3814
|
+
# to the recipient, then an error message is returned from the
|
3815
|
+
# recipient's ISP; this message is forwarded to the email address
|
3816
|
+
# specified by the `ReturnPath` parameter. The `ReturnPath` parameter
|
3817
|
+
# is never overwritten. This email address must be either individually
|
3818
|
+
# verified with Amazon SES, or from a domain that has been verified
|
3819
|
+
# with Amazon SES.
|
3771
3820
|
# @return [String]
|
3772
3821
|
#
|
3773
3822
|
# @!attribute [rw] return_path_arn
|
@@ -3788,7 +3837,7 @@ module Aws::SES
|
|
3788
3837
|
#
|
3789
3838
|
#
|
3790
3839
|
#
|
3791
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
3840
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html
|
3792
3841
|
# @return [String]
|
3793
3842
|
#
|
3794
3843
|
# @!attribute [rw] configuration_set_name
|
@@ -3822,9 +3871,8 @@ module Aws::SES
|
|
3822
3871
|
#
|
3823
3872
|
# @!attribute [rw] destinations
|
3824
3873
|
# One or more `Destination` objects. All of the recipients in a
|
3825
|
-
# `Destination`
|
3826
|
-
#
|
3827
|
-
# array.
|
3874
|
+
# `Destination` receive the same version of the email. You can specify
|
3875
|
+
# up to 50 `Destination` objects within a `Destinations` array.
|
3828
3876
|
# @return [Array<Types::BulkEmailDestination>]
|
3829
3877
|
#
|
3830
3878
|
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/SendBulkTemplatedEmailRequest AWS API Documentation
|
@@ -3846,8 +3894,10 @@ module Aws::SES
|
|
3846
3894
|
end
|
3847
3895
|
|
3848
3896
|
# @!attribute [rw] status
|
3849
|
-
#
|
3850
|
-
#
|
3897
|
+
# One object per intended recipient. Check each response object and
|
3898
|
+
# retry any messages with a failure status. (Note that order of
|
3899
|
+
# responses will be respective to order of destinations in the
|
3900
|
+
# request.)Receipt rules enable you to specify which actions
|
3851
3901
|
# @return [Array<Types::BulkEmailDestinationStatus>]
|
3852
3902
|
#
|
3853
3903
|
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/SendBulkTemplatedEmailResponse AWS API Documentation
|
@@ -3941,7 +3991,7 @@ module Aws::SES
|
|
3941
3991
|
#
|
3942
3992
|
#
|
3943
3993
|
#
|
3944
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
3994
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/send-email-formatted.html
|
3945
3995
|
#
|
3946
3996
|
# @!attribute [rw] source
|
3947
3997
|
# The email address that is sending the email. This email address must
|
@@ -3955,27 +4005,26 @@ module Aws::SES
|
|
3955
4005
|
# sending authorization, see the [Amazon SES Developer Guide][2].
|
3956
4006
|
#
|
3957
4007
|
# <note markdown="1"> Amazon SES does not support the SMTPUTF8 extension, as described in
|
3958
|
-
# [RFC6531][3]. For this reason, the
|
3959
|
-
#
|
3960
|
-
#
|
3961
|
-
#
|
3962
|
-
#
|
3963
|
-
#
|
3964
|
-
#
|
3965
|
-
# encoded-word syntax, as described in [
|
3966
|
-
#
|
3967
|
-
#
|
4008
|
+
# [RFC6531][3]. For this reason, the email address string must be
|
4009
|
+
# 7-bit ASCII. If you want to send to or from email addresses that
|
4010
|
+
# contain Unicode characters in the domain part of an address, you
|
4011
|
+
# must encode the domain using Punycode. Punycode is not permitted in
|
4012
|
+
# the local part of the email address (the part before the @ sign) nor
|
4013
|
+
# in the "friendly from" name. If you want to use Unicode characters
|
4014
|
+
# in the "friendly from" name, you must encode the "friendly from"
|
4015
|
+
# name using MIME encoded-word syntax, as described in [Sending raw
|
4016
|
+
# email using the Amazon SES API][4]. For more information about
|
4017
|
+
# Punycode, see [RFC 3492][5].
|
3968
4018
|
#
|
3969
4019
|
# </note>
|
3970
4020
|
#
|
3971
4021
|
#
|
3972
4022
|
#
|
3973
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
3974
|
-
# [2]: https://docs.aws.amazon.com/ses/latest/
|
4023
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html
|
4024
|
+
# [2]: https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html
|
3975
4025
|
# [3]: https://tools.ietf.org/html/rfc6531
|
3976
|
-
# [4]: https://
|
3977
|
-
# [5]:
|
3978
|
-
# [6]: https://tools.ietf.org/html/rfc2047
|
4026
|
+
# [4]: https://docs.aws.amazon.com/ses/latest/dg/send-email-raw.html
|
4027
|
+
# [5]: http://tools.ietf.org/html/rfc3492
|
3979
4028
|
# @return [String]
|
3980
4029
|
#
|
3981
4030
|
# @!attribute [rw] destination
|
@@ -3989,19 +4038,18 @@ module Aws::SES
|
|
3989
4038
|
#
|
3990
4039
|
# @!attribute [rw] reply_to_addresses
|
3991
4040
|
# The reply-to email address(es) for the message. If the recipient
|
3992
|
-
# replies to the message, each reply-to address
|
3993
|
-
# reply.
|
4041
|
+
# replies to the message, each reply-to address receives the reply.
|
3994
4042
|
# @return [Array<String>]
|
3995
4043
|
#
|
3996
4044
|
# @!attribute [rw] return_path
|
3997
|
-
# The email address that bounces and complaints
|
3998
|
-
#
|
3999
|
-
#
|
4000
|
-
#
|
4001
|
-
#
|
4002
|
-
#
|
4003
|
-
#
|
4004
|
-
#
|
4045
|
+
# The email address that bounces and complaints are forwarded to when
|
4046
|
+
# feedback forwarding is enabled. If the message cannot be delivered
|
4047
|
+
# to the recipient, then an error message is returned from the
|
4048
|
+
# recipient's ISP; this message is forwarded to the email address
|
4049
|
+
# specified by the `ReturnPath` parameter. The `ReturnPath` parameter
|
4050
|
+
# is never overwritten. This email address must be either individually
|
4051
|
+
# verified with Amazon SES, or from a domain that has been verified
|
4052
|
+
# with Amazon SES.
|
4005
4053
|
# @return [String]
|
4006
4054
|
#
|
4007
4055
|
# @!attribute [rw] source_arn
|
@@ -4022,7 +4070,7 @@ module Aws::SES
|
|
4022
4070
|
#
|
4023
4071
|
#
|
4024
4072
|
#
|
4025
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
4073
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html
|
4026
4074
|
# @return [String]
|
4027
4075
|
#
|
4028
4076
|
# @!attribute [rw] return_path_arn
|
@@ -4043,7 +4091,7 @@ module Aws::SES
|
|
4043
4091
|
#
|
4044
4092
|
#
|
4045
4093
|
#
|
4046
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
4094
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html
|
4047
4095
|
# @return [String]
|
4048
4096
|
#
|
4049
4097
|
# @!attribute [rw] tags
|
@@ -4093,7 +4141,7 @@ module Aws::SES
|
|
4093
4141
|
#
|
4094
4142
|
#
|
4095
4143
|
#
|
4096
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
4144
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/send-email-raw.html
|
4097
4145
|
#
|
4098
4146
|
# @!attribute [rw] source
|
4099
4147
|
# The identity's email address. If you do not provide a value for
|
@@ -4101,30 +4149,29 @@ module Aws::SES
|
|
4101
4149
|
# of the message. (You can also specify both.)
|
4102
4150
|
#
|
4103
4151
|
# <note markdown="1"> Amazon SES does not support the SMTPUTF8 extension, as described
|
4104
|
-
# in[RFC6531][1]. For this reason, the
|
4105
|
-
#
|
4106
|
-
#
|
4107
|
-
#
|
4108
|
-
#
|
4109
|
-
#
|
4110
|
-
#
|
4111
|
-
# encoded-word syntax, as described in [
|
4112
|
-
#
|
4113
|
-
#
|
4152
|
+
# in[RFC6531][1]. For this reason, the email address string must be
|
4153
|
+
# 7-bit ASCII. If you want to send to or from email addresses that
|
4154
|
+
# contain Unicode characters in the domain part of an address, you
|
4155
|
+
# must encode the domain using Punycode. Punycode is not permitted in
|
4156
|
+
# the local part of the email address (the part before the @ sign) nor
|
4157
|
+
# in the "friendly from" name. If you want to use Unicode characters
|
4158
|
+
# in the "friendly from" name, you must encode the "friendly from"
|
4159
|
+
# name using MIME encoded-word syntax, as described in [Sending raw
|
4160
|
+
# email using the Amazon SES API][2]. For more information about
|
4161
|
+
# Punycode, see [RFC 3492][3].
|
4114
4162
|
#
|
4115
4163
|
# </note>
|
4116
4164
|
#
|
4117
4165
|
# If you specify the `Source` parameter and have feedback forwarding
|
4118
|
-
# enabled, then bounces and complaints
|
4119
|
-
#
|
4120
|
-
#
|
4166
|
+
# enabled, then bounces and complaints are sent to this email address.
|
4167
|
+
# This takes precedence over any Return-Path header that you might
|
4168
|
+
# include in the raw text of the message.
|
4121
4169
|
#
|
4122
4170
|
#
|
4123
4171
|
#
|
4124
4172
|
# [1]: https://tools.ietf.org/html/rfc6531
|
4125
|
-
# [2]: https://
|
4126
|
-
# [3]:
|
4127
|
-
# [4]: https://tools.ietf.org/html/rfc2047
|
4173
|
+
# [2]: https://docs.aws.amazon.com/ses/latest/dg/send-email-raw.html
|
4174
|
+
# [3]: http://tools.ietf.org/html/rfc3492
|
4128
4175
|
# @return [String]
|
4129
4176
|
#
|
4130
4177
|
# @!attribute [rw] destinations
|
@@ -4159,8 +4206,8 @@ module Aws::SES
|
|
4159
4206
|
#
|
4160
4207
|
#
|
4161
4208
|
#
|
4162
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
4163
|
-
# [2]: https://docs.aws.amazon.com/ses/latest/
|
4209
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/mime-types.html
|
4210
|
+
# [2]: https://docs.aws.amazon.com/ses/latest/dg/send-email-raw.html
|
4164
4211
|
# [3]: https://tools.ietf.org/html/rfc5321#section-4.5.3.1.6
|
4165
4212
|
# @return [Types::RawMessage]
|
4166
4213
|
#
|
@@ -4183,7 +4230,7 @@ module Aws::SES
|
|
4183
4230
|
#
|
4184
4231
|
#
|
4185
4232
|
#
|
4186
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
4233
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/sending-authorization-delegate-sender-tasks-email.html
|
4187
4234
|
# @return [String]
|
4188
4235
|
#
|
4189
4236
|
# @!attribute [rw] source_arn
|
@@ -4212,7 +4259,7 @@ module Aws::SES
|
|
4212
4259
|
#
|
4213
4260
|
#
|
4214
4261
|
#
|
4215
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
4262
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/sending-authorization-delegate-sender-tasks-email.html
|
4216
4263
|
# @return [String]
|
4217
4264
|
#
|
4218
4265
|
# @!attribute [rw] return_path_arn
|
@@ -4241,7 +4288,7 @@ module Aws::SES
|
|
4241
4288
|
#
|
4242
4289
|
#
|
4243
4290
|
#
|
4244
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
4291
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/sending-authorization-delegate-sender-tasks-email.html
|
4245
4292
|
# @return [String]
|
4246
4293
|
#
|
4247
4294
|
# @!attribute [rw] tags
|
@@ -4291,7 +4338,7 @@ module Aws::SES
|
|
4291
4338
|
#
|
4292
4339
|
#
|
4293
4340
|
#
|
4294
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
4341
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/send-personalized-email-api.html
|
4295
4342
|
#
|
4296
4343
|
# @!attribute [rw] source
|
4297
4344
|
# The email address that is sending the email. This email address must
|
@@ -4305,26 +4352,26 @@ module Aws::SES
|
|
4305
4352
|
# sending authorization, see the [Amazon SES Developer Guide][2].
|
4306
4353
|
#
|
4307
4354
|
# <note markdown="1"> Amazon SES does not support the SMTPUTF8 extension, as described in
|
4308
|
-
# [RFC6531][3].
|
4309
|
-
#
|
4310
|
-
#
|
4311
|
-
#
|
4312
|
-
#
|
4313
|
-
#
|
4314
|
-
#
|
4315
|
-
# encoded-word syntax, as described in
|
4316
|
-
#
|
4355
|
+
# [RFC6531][3]. for this reason, The email address string must be
|
4356
|
+
# 7-bit ASCII. If you want to send to or from email addresses that
|
4357
|
+
# contain Unicode characters in the domain part of an address, you
|
4358
|
+
# must encode the domain using Punycode. Punycode is not permitted in
|
4359
|
+
# the local part of the email address (the part before the @ sign) nor
|
4360
|
+
# in the "friendly from" name. If you want to use Unicode characters
|
4361
|
+
# in the "friendly from" name, you must encode the "friendly from"
|
4362
|
+
# name using MIME encoded-word syntax, as described in [Sending raw
|
4363
|
+
# email using the Amazon SES API][4]. For more information about
|
4364
|
+
# Punycode, see [RFC 3492][5].
|
4317
4365
|
#
|
4318
4366
|
# </note>
|
4319
4367
|
#
|
4320
4368
|
#
|
4321
4369
|
#
|
4322
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
4323
|
-
# [2]: https://docs.aws.amazon.com/ses/latest/
|
4370
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html
|
4371
|
+
# [2]: https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html
|
4324
4372
|
# [3]: https://tools.ietf.org/html/rfc6531
|
4325
|
-
# [4]: https://
|
4326
|
-
# [5]:
|
4327
|
-
# [6]: https://tools.ietf.org/html/rfc2047
|
4373
|
+
# [4]: https://docs.aws.amazon.com/ses/latest/dg/send-email-raw.html
|
4374
|
+
# [5]: http://tools.ietf.org/html/rfc3492
|
4328
4375
|
# @return [String]
|
4329
4376
|
#
|
4330
4377
|
# @!attribute [rw] destination
|
@@ -4335,19 +4382,18 @@ module Aws::SES
|
|
4335
4382
|
#
|
4336
4383
|
# @!attribute [rw] reply_to_addresses
|
4337
4384
|
# The reply-to email address(es) for the message. If the recipient
|
4338
|
-
# replies to the message, each reply-to address
|
4339
|
-
# reply.
|
4385
|
+
# replies to the message, each reply-to address receives the reply.
|
4340
4386
|
# @return [Array<String>]
|
4341
4387
|
#
|
4342
4388
|
# @!attribute [rw] return_path
|
4343
|
-
# The email address that bounces and complaints
|
4344
|
-
#
|
4345
|
-
#
|
4346
|
-
#
|
4347
|
-
#
|
4348
|
-
#
|
4349
|
-
#
|
4350
|
-
#
|
4389
|
+
# The email address that bounces and complaints are forwarded to when
|
4390
|
+
# feedback forwarding is enabled. If the message cannot be delivered
|
4391
|
+
# to the recipient, then an error message is returned from the
|
4392
|
+
# recipient's ISP; this message is forwarded to the email address
|
4393
|
+
# specified by the `ReturnPath` parameter. The `ReturnPath` parameter
|
4394
|
+
# is never overwritten. This email address must be either individually
|
4395
|
+
# verified with Amazon SES, or from a domain that has been verified
|
4396
|
+
# with Amazon SES.
|
4351
4397
|
# @return [String]
|
4352
4398
|
#
|
4353
4399
|
# @!attribute [rw] source_arn
|
@@ -4368,7 +4414,7 @@ module Aws::SES
|
|
4368
4414
|
#
|
4369
4415
|
#
|
4370
4416
|
#
|
4371
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
4417
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html
|
4372
4418
|
# @return [String]
|
4373
4419
|
#
|
4374
4420
|
# @!attribute [rw] return_path_arn
|
@@ -4389,7 +4435,7 @@ module Aws::SES
|
|
4389
4435
|
#
|
4390
4436
|
#
|
4391
4437
|
#
|
4392
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
4438
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html
|
4393
4439
|
# @return [String]
|
4394
4440
|
#
|
4395
4441
|
# @!attribute [rw] tags
|
@@ -4456,7 +4502,7 @@ module Aws::SES
|
|
4456
4502
|
#
|
4457
4503
|
#
|
4458
4504
|
#
|
4459
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
4505
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html
|
4460
4506
|
#
|
4461
4507
|
# @!attribute [rw] rule_set_name
|
4462
4508
|
# The name of the receipt rule set to make active. Setting this value
|
@@ -4483,7 +4529,7 @@ module Aws::SES
|
|
4483
4529
|
#
|
4484
4530
|
#
|
4485
4531
|
#
|
4486
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
4532
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/send-email-authentication-dkim-easy.html
|
4487
4533
|
#
|
4488
4534
|
# @!attribute [rw] identity
|
4489
4535
|
# The identity for which DKIM signing should be enabled or disabled.
|
@@ -4516,7 +4562,7 @@ module Aws::SES
|
|
4516
4562
|
#
|
4517
4563
|
#
|
4518
4564
|
#
|
4519
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
4565
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity-using-notifications-email.html
|
4520
4566
|
#
|
4521
4567
|
# @!attribute [rw] identity
|
4522
4568
|
# The identity for which to set bounce and complaint notification
|
@@ -4524,14 +4570,13 @@ module Aws::SES
|
|
4524
4570
|
# @return [String]
|
4525
4571
|
#
|
4526
4572
|
# @!attribute [rw] forwarding_enabled
|
4527
|
-
# Sets whether Amazon SES
|
4528
|
-
#
|
4529
|
-
#
|
4530
|
-
#
|
4531
|
-
#
|
4532
|
-
#
|
4533
|
-
#
|
4534
|
-
# `Complaint` notification types.
|
4573
|
+
# Sets whether Amazon SES forwards bounce and complaint notifications
|
4574
|
+
# as email. `true` specifies that Amazon SES forwards bounce and
|
4575
|
+
# complaint notifications as email, in addition to any Amazon SNS
|
4576
|
+
# topic publishing otherwise specified. `false` specifies that Amazon
|
4577
|
+
# SES publishes bounce and complaint notifications only through Amazon
|
4578
|
+
# SNS. This value can only be set to `false` when Amazon SNS topics
|
4579
|
+
# are set for both `Bounce` and `Complaint` notification types.
|
4535
4580
|
# @return [Boolean]
|
4536
4581
|
#
|
4537
4582
|
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/SetIdentityFeedbackForwardingEnabledRequest AWS API Documentation
|
@@ -4556,7 +4601,7 @@ module Aws::SES
|
|
4556
4601
|
#
|
4557
4602
|
#
|
4558
4603
|
#
|
4559
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
4604
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity-using-notifications-sns.html
|
4560
4605
|
#
|
4561
4606
|
# @!attribute [rw] identity
|
4562
4607
|
# The identity for which to enable or disable headers in
|
@@ -4571,8 +4616,8 @@ module Aws::SES
|
|
4571
4616
|
# @!attribute [rw] enabled
|
4572
4617
|
# Sets whether Amazon SES includes the original email headers in
|
4573
4618
|
# Amazon SNS notifications of the specified notification type. A value
|
4574
|
-
# of `true` specifies that Amazon SES
|
4575
|
-
# notifications, and a value of `false` specifies that Amazon SES
|
4619
|
+
# of `true` specifies that Amazon SES includes headers in
|
4620
|
+
# notifications, and a value of `false` specifies that Amazon SES does
|
4576
4621
|
# not include headers in notifications.
|
4577
4622
|
#
|
4578
4623
|
# This value can only be set when `NotificationType` is already set to
|
@@ -4601,34 +4646,33 @@ module Aws::SES
|
|
4601
4646
|
#
|
4602
4647
|
#
|
4603
4648
|
#
|
4604
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
4649
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/mail-from.html
|
4605
4650
|
#
|
4606
4651
|
# @!attribute [rw] identity
|
4607
|
-
# The verified identity
|
4608
|
-
# specified custom MAIL FROM domain.
|
4652
|
+
# The verified identity.
|
4609
4653
|
# @return [String]
|
4610
4654
|
#
|
4611
4655
|
# @!attribute [rw] mail_from_domain
|
4612
|
-
# The custom MAIL FROM domain
|
4613
|
-
#
|
4614
|
-
#
|
4615
|
-
#
|
4616
|
-
#
|
4617
|
-
#
|
4618
|
-
#
|
4656
|
+
# The custom MAIL FROM domain for the verified identity to use. The
|
4657
|
+
# MAIL FROM domain must 1) be a subdomain of the verified identity, 2)
|
4658
|
+
# not be used in a "From" address if the MAIL FROM domain is the
|
4659
|
+
# destination of email feedback forwarding (for more information, see
|
4660
|
+
# the [Amazon SES Developer Guide][1]), and 3) not be used to receive
|
4661
|
+
# emails. A value of `null` disables the custom MAIL FROM setting for
|
4662
|
+
# the identity.
|
4619
4663
|
#
|
4620
4664
|
#
|
4621
4665
|
#
|
4622
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
4666
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/mail-from.html
|
4623
4667
|
# @return [String]
|
4624
4668
|
#
|
4625
4669
|
# @!attribute [rw] behavior_on_mx_failure
|
4626
|
-
# The action
|
4627
|
-
#
|
4628
|
-
#
|
4629
|
-
#
|
4630
|
-
# `
|
4631
|
-
#
|
4670
|
+
# The action for Amazon SES to take if it cannot successfully read the
|
4671
|
+
# required MX record when you send an email. If you choose
|
4672
|
+
# `UseDefaultValue`, Amazon SES uses amazonses.com (or a subdomain of
|
4673
|
+
# that) as the MAIL FROM domain. If you choose `RejectMessage`, Amazon
|
4674
|
+
# SES returns a `MailFromDomainNotVerified` error and not send the
|
4675
|
+
# email.
|
4632
4676
|
#
|
4633
4677
|
# The action specified in `BehaviorOnMXFailure` is taken when the
|
4634
4678
|
# custom MAIL FROM domain setup is in the `Pending`, `Failed`, and
|
@@ -4652,17 +4696,16 @@ module Aws::SES
|
|
4652
4696
|
class SetIdentityMailFromDomainResponse < Aws::EmptyStructure; end
|
4653
4697
|
|
4654
4698
|
# Represents a request to specify the Amazon SNS topic to which Amazon
|
4655
|
-
# SES
|
4656
|
-
#
|
4657
|
-
#
|
4699
|
+
# SES publishes bounce, complaint, or delivery notifications for emails
|
4700
|
+
# sent with that identity as the source. For information about Amazon
|
4701
|
+
# SES notifications, see the [Amazon SES Developer Guide][1].
|
4658
4702
|
#
|
4659
4703
|
#
|
4660
4704
|
#
|
4661
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
4705
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity-using-notifications-sns.html
|
4662
4706
|
#
|
4663
4707
|
# @!attribute [rw] identity
|
4664
|
-
# The identity (email address or domain)
|
4665
|
-
# Amazon SNS topic for.
|
4708
|
+
# The identity (email address or domain) for the Amazon SNS topic.
|
4666
4709
|
#
|
4667
4710
|
# You can only specify a verified identity for this parameter.
|
4668
4711
|
#
|
@@ -4673,8 +4716,8 @@ module Aws::SES
|
|
4673
4716
|
# @return [String]
|
4674
4717
|
#
|
4675
4718
|
# @!attribute [rw] notification_type
|
4676
|
-
# The type of notifications that
|
4677
|
-
#
|
4719
|
+
# The type of notifications that are published to the specified Amazon
|
4720
|
+
# SNS topic.
|
4678
4721
|
# @return [String]
|
4679
4722
|
#
|
4680
4723
|
# @!attribute [rw] sns_topic
|
@@ -4706,7 +4749,7 @@ module Aws::SES
|
|
4706
4749
|
#
|
4707
4750
|
#
|
4708
4751
|
#
|
4709
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
4752
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html
|
4710
4753
|
#
|
4711
4754
|
# @!attribute [rw] rule_set_name
|
4712
4755
|
# The name of the receipt rule set that contains the receipt rule to
|
@@ -4747,7 +4790,7 @@ module Aws::SES
|
|
4747
4790
|
#
|
4748
4791
|
#
|
4749
4792
|
#
|
4750
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
4793
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-stop.html
|
4751
4794
|
#
|
4752
4795
|
# @!attribute [rw] scope
|
4753
4796
|
# The scope of the StopAction. The only acceptable value is `RuleSet`.
|
@@ -4755,14 +4798,16 @@ module Aws::SES
|
|
4755
4798
|
#
|
4756
4799
|
# @!attribute [rw] topic_arn
|
4757
4800
|
# The Amazon Resource Name (ARN) of the Amazon SNS topic to notify
|
4758
|
-
# when the stop action is taken.
|
4759
|
-
#
|
4760
|
-
# information about Amazon SNS topics, see the [Amazon SNS Developer
|
4761
|
-
# Guide][1].
|
4801
|
+
# when the stop action is taken. You can find the ARN of a topic by
|
4802
|
+
# using the [ListTopics][1] Amazon SNS operation.
|
4762
4803
|
#
|
4804
|
+
# For more information about Amazon SNS topics, see the [Amazon SNS
|
4805
|
+
# Developer Guide][2].
|
4763
4806
|
#
|
4764
4807
|
#
|
4765
|
-
#
|
4808
|
+
#
|
4809
|
+
# [1]: https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html
|
4810
|
+
# [2]: https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html
|
4766
4811
|
# @return [String]
|
4767
4812
|
#
|
4768
4813
|
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/StopAction AWS API Documentation
|
@@ -4774,12 +4819,12 @@ module Aws::SES
|
|
4774
4819
|
include Aws::Structure
|
4775
4820
|
end
|
4776
4821
|
|
4777
|
-
# The content of the email, composed of a subject line
|
4778
|
-
#
|
4822
|
+
# The content of the email, composed of a subject line and either an
|
4823
|
+
# HTML part or a text-only part.
|
4779
4824
|
#
|
4780
4825
|
# @!attribute [rw] template_name
|
4781
|
-
# The name of the template. You
|
4782
|
-
#
|
4826
|
+
# The name of the template. You use this name when you send email
|
4827
|
+
# using the `SendTemplatedEmail` or `SendBulkTemplatedEmail`
|
4783
4828
|
# operations.
|
4784
4829
|
# @return [String]
|
4785
4830
|
#
|
@@ -4788,8 +4833,8 @@ module Aws::SES
|
|
4788
4833
|
# @return [String]
|
4789
4834
|
#
|
4790
4835
|
# @!attribute [rw] text_part
|
4791
|
-
# The email body that
|
4792
|
-
#
|
4836
|
+
# The email body that is visible to recipients whose email clients do
|
4837
|
+
# not display HTML content.
|
4793
4838
|
# @return [String]
|
4794
4839
|
#
|
4795
4840
|
# @!attribute [rw] html_part
|
@@ -4841,7 +4886,7 @@ module Aws::SES
|
|
4841
4886
|
end
|
4842
4887
|
|
4843
4888
|
# @!attribute [rw] template_name
|
4844
|
-
# The name of the template
|
4889
|
+
# The name of the template to render.
|
4845
4890
|
# @return [String]
|
4846
4891
|
#
|
4847
4892
|
# @!attribute [rw] template_data
|
@@ -4883,11 +4928,11 @@ module Aws::SES
|
|
4883
4928
|
#
|
4884
4929
|
#
|
4885
4930
|
#
|
4886
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
4931
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/configure-custom-open-click-domains.html
|
4887
4932
|
#
|
4888
4933
|
# @!attribute [rw] custom_redirect_domain
|
4889
|
-
# The custom subdomain that
|
4890
|
-
#
|
4934
|
+
# The custom subdomain that is used to redirect email recipients to
|
4935
|
+
# the Amazon SES event tracking domain.
|
4891
4936
|
# @return [String]
|
4892
4937
|
#
|
4893
4938
|
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/TrackingOptions AWS API Documentation
|
@@ -4935,7 +4980,7 @@ module Aws::SES
|
|
4935
4980
|
#
|
4936
4981
|
# @!attribute [rw] enabled
|
4937
4982
|
# Describes whether email sending is enabled or disabled for your
|
4938
|
-
# Amazon SES account in the current
|
4983
|
+
# Amazon SES account in the current Amazon Web Services Region.
|
4939
4984
|
# @return [Boolean]
|
4940
4985
|
#
|
4941
4986
|
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/UpdateAccountSendingEnabledRequest AWS API Documentation
|
@@ -4953,16 +4998,15 @@ module Aws::SES
|
|
4953
4998
|
#
|
4954
4999
|
#
|
4955
5000
|
#
|
4956
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
5001
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html
|
4957
5002
|
#
|
4958
5003
|
# @!attribute [rw] configuration_set_name
|
4959
5004
|
# The name of the configuration set that contains the event
|
4960
|
-
# destination
|
5005
|
+
# destination.
|
4961
5006
|
# @return [String]
|
4962
5007
|
#
|
4963
5008
|
# @!attribute [rw] event_destination
|
4964
|
-
# The event destination object
|
4965
|
-
# configuration set.
|
5009
|
+
# The event destination object.
|
4966
5010
|
# @return [Types::EventDestination]
|
4967
5011
|
#
|
4968
5012
|
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/UpdateConfigurationSetEventDestinationRequest AWS API Documentation
|
@@ -4984,13 +5028,13 @@ module Aws::SES
|
|
4984
5028
|
# settings for a configuration set.
|
4985
5029
|
#
|
4986
5030
|
# @!attribute [rw] configuration_set_name
|
4987
|
-
# The name of the configuration set
|
5031
|
+
# The name of the configuration set to update.
|
4988
5032
|
# @return [String]
|
4989
5033
|
#
|
4990
5034
|
# @!attribute [rw] enabled
|
4991
|
-
# Describes whether or not Amazon SES
|
4992
|
-
#
|
4993
|
-
#
|
5035
|
+
# Describes whether or not Amazon SES publishes reputation metrics for
|
5036
|
+
# the configuration set, such as bounce and complaint rates, to Amazon
|
5037
|
+
# CloudWatch.
|
4994
5038
|
# @return [Boolean]
|
4995
5039
|
#
|
4996
5040
|
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/UpdateConfigurationSetReputationMetricsEnabledRequest AWS API Documentation
|
@@ -5006,7 +5050,7 @@ module Aws::SES
|
|
5006
5050
|
# capabilities for a specific configuration set.
|
5007
5051
|
#
|
5008
5052
|
# @!attribute [rw] configuration_set_name
|
5009
|
-
# The name of the configuration set
|
5053
|
+
# The name of the configuration set to update.
|
5010
5054
|
# @return [String]
|
5011
5055
|
#
|
5012
5056
|
# @!attribute [rw] enabled
|
@@ -5027,8 +5071,7 @@ module Aws::SES
|
|
5027
5071
|
# configuration set.
|
5028
5072
|
#
|
5029
5073
|
# @!attribute [rw] configuration_set_name
|
5030
|
-
# The name of the configuration set
|
5031
|
-
# custom tracking domain.
|
5074
|
+
# The name of the configuration set.
|
5032
5075
|
# @return [String]
|
5033
5076
|
#
|
5034
5077
|
# @!attribute [rw] tracking_options
|
@@ -5041,7 +5084,7 @@ module Aws::SES
|
|
5041
5084
|
#
|
5042
5085
|
#
|
5043
5086
|
#
|
5044
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
5087
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/configure-custom-open-click-domains.html
|
5045
5088
|
# @return [Types::TrackingOptions]
|
5046
5089
|
#
|
5047
5090
|
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/UpdateConfigurationSetTrackingOptionsRequest AWS API Documentation
|
@@ -5063,8 +5106,7 @@ module Aws::SES
|
|
5063
5106
|
# template.
|
5064
5107
|
#
|
5065
5108
|
# @!attribute [rw] template_name
|
5066
|
-
# The name of the custom verification email template
|
5067
|
-
# update.
|
5109
|
+
# The name of the custom verification email template to update.
|
5068
5110
|
# @return [String]
|
5069
5111
|
#
|
5070
5112
|
# @!attribute [rw] from_email_address
|
@@ -5084,7 +5126,7 @@ module Aws::SES
|
|
5084
5126
|
#
|
5085
5127
|
#
|
5086
5128
|
#
|
5087
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
5129
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom
|
5088
5130
|
# @return [String]
|
5089
5131
|
#
|
5090
5132
|
# @!attribute [rw] success_redirection_url
|
@@ -5116,7 +5158,7 @@ module Aws::SES
|
|
5116
5158
|
#
|
5117
5159
|
#
|
5118
5160
|
#
|
5119
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
5161
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html
|
5120
5162
|
#
|
5121
5163
|
# @!attribute [rw] rule_set_name
|
5122
5164
|
# The name of the receipt rule set that the receipt rule belongs to.
|
@@ -5142,8 +5184,8 @@ module Aws::SES
|
|
5142
5184
|
class UpdateReceiptRuleResponse < Aws::EmptyStructure; end
|
5143
5185
|
|
5144
5186
|
# @!attribute [rw] template
|
5145
|
-
# The content of the email, composed of a subject line
|
5146
|
-
#
|
5187
|
+
# The content of the email, composed of a subject line and either an
|
5188
|
+
# HTML part or a text-only part.
|
5147
5189
|
# @return [Types::Template]
|
5148
5190
|
#
|
5149
5191
|
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/UpdateTemplateRequest AWS API Documentation
|
@@ -5164,7 +5206,7 @@ module Aws::SES
|
|
5164
5206
|
#
|
5165
5207
|
#
|
5166
5208
|
#
|
5167
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
5209
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/send-email-authentication-dkim-easy.html
|
5168
5210
|
#
|
5169
5211
|
# @!attribute [rw] domain
|
5170
5212
|
# The name of the domain to be verified for Easy DKIM signing.
|
@@ -5199,7 +5241,7 @@ module Aws::SES
|
|
5199
5241
|
#
|
5200
5242
|
#
|
5201
5243
|
#
|
5202
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
5244
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/send-email-authentication-dkim-easy.html
|
5203
5245
|
# @return [Array<String>]
|
5204
5246
|
#
|
5205
5247
|
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/VerifyDomainDkimResponse AWS API Documentation
|
@@ -5217,7 +5259,7 @@ module Aws::SES
|
|
5217
5259
|
#
|
5218
5260
|
#
|
5219
5261
|
#
|
5220
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
5262
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#verify-domain-procedure
|
5221
5263
|
#
|
5222
5264
|
# @!attribute [rw] domain
|
5223
5265
|
# The domain to be verified.
|
@@ -5243,8 +5285,9 @@ module Aws::SES
|
|
5243
5285
|
# record, the domain's verification status changes to "Success". If
|
5244
5286
|
# Amazon SES is unable to detect the record within 72 hours, the
|
5245
5287
|
# domain's verification status changes to "Failed." In that case,
|
5246
|
-
#
|
5247
|
-
# verification
|
5288
|
+
# to verify the domain, you must restart the verification process from
|
5289
|
+
# the beginning. The domain's verification status also changes to
|
5290
|
+
# "Success" when it is DKIM verified.
|
5248
5291
|
# @return [String]
|
5249
5292
|
#
|
5250
5293
|
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/VerifyDomainIdentityResponse AWS API Documentation
|
@@ -5261,7 +5304,7 @@ module Aws::SES
|
|
5261
5304
|
#
|
5262
5305
|
#
|
5263
5306
|
#
|
5264
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
5307
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#verify-email-addresses-procedure
|
5265
5308
|
#
|
5266
5309
|
# @!attribute [rw] email_address
|
5267
5310
|
# The email address to be verified.
|
@@ -5281,7 +5324,7 @@ module Aws::SES
|
|
5281
5324
|
#
|
5282
5325
|
#
|
5283
5326
|
#
|
5284
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
5327
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#verify-email-addresses-procedure
|
5285
5328
|
#
|
5286
5329
|
# @!attribute [rw] email_address
|
5287
5330
|
# The email address to be verified.
|
@@ -5303,8 +5346,8 @@ module Aws::SES
|
|
5303
5346
|
|
5304
5347
|
# When included in a receipt rule, this action calls Amazon WorkMail
|
5305
5348
|
# and, optionally, publishes a notification to Amazon Simple
|
5306
|
-
# Notification Service (Amazon SNS).
|
5307
|
-
#
|
5349
|
+
# Notification Service (Amazon SNS). It usually isn't necessary to set
|
5350
|
+
# this up manually, because Amazon WorkMail adds the rule automatically
|
5308
5351
|
# during its setup procedure.
|
5309
5352
|
#
|
5310
5353
|
# For information using a receipt rule to call Amazon WorkMail, see the
|
@@ -5312,30 +5355,40 @@ module Aws::SES
|
|
5312
5355
|
#
|
5313
5356
|
#
|
5314
5357
|
#
|
5315
|
-
# [1]: https://docs.aws.amazon.com/ses/latest/
|
5358
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-workmail.html
|
5316
5359
|
#
|
5317
5360
|
# @!attribute [rw] topic_arn
|
5318
5361
|
# The Amazon Resource Name (ARN) of the Amazon SNS topic to notify
|
5319
|
-
# when the WorkMail action is called.
|
5320
|
-
#
|
5321
|
-
#
|
5322
|
-
#
|
5362
|
+
# when the WorkMail action is called. You can find the ARN of a topic
|
5363
|
+
# by using the [ListTopics][1] operation in Amazon SNS.
|
5364
|
+
#
|
5365
|
+
# For more information about Amazon SNS topics, see the [Amazon SNS
|
5366
|
+
# Developer Guide][2].
|
5323
5367
|
#
|
5324
5368
|
#
|
5325
5369
|
#
|
5326
|
-
# [1]: https://docs.aws.amazon.com/sns/latest/
|
5370
|
+
# [1]: https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html
|
5371
|
+
# [2]: https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html
|
5327
5372
|
# @return [String]
|
5328
5373
|
#
|
5329
5374
|
# @!attribute [rw] organization_arn
|
5330
|
-
# The ARN of the Amazon WorkMail organization.
|
5331
|
-
# WorkMail
|
5332
|
-
#
|
5375
|
+
# The Amazon Resource Name (ARN) of the Amazon WorkMail organization.
|
5376
|
+
# Amazon WorkMail ARNs use the following format:
|
5377
|
+
#
|
5378
|
+
# `arn:aws:workmail:<region>:<awsAccountId>:organization/<workmailOrganizationId>`
|
5379
|
+
#
|
5380
|
+
# You can find the ID of your organization by using the
|
5381
|
+
# [ListOrganizations][1] operation in Amazon WorkMail. Amazon WorkMail
|
5382
|
+
# organization IDs begin with "`m-`", followed by a string of
|
5383
|
+
# alphanumeric characters.
|
5384
|
+
#
|
5333
5385
|
# For information about Amazon WorkMail organizations, see the [Amazon
|
5334
|
-
# WorkMail Administrator Guide][
|
5386
|
+
# WorkMail Administrator Guide][2].
|
5335
5387
|
#
|
5336
5388
|
#
|
5337
5389
|
#
|
5338
|
-
# [1]: https://docs.aws.amazon.com/workmail/latest/
|
5390
|
+
# [1]: https://docs.aws.amazon.com/workmail/latest/APIReference/API_ListOrganizations.html
|
5391
|
+
# [2]: https://docs.aws.amazon.com/workmail/latest/adminguide/organizations_overview.html
|
5339
5392
|
# @return [String]
|
5340
5393
|
#
|
5341
5394
|
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/WorkmailAction AWS API Documentation
|