aws-sdk-ses 1.21.0 → 1.22.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-ses.rb +1 -1
- data/lib/aws-sdk-ses/client.rb +156 -101
- data/lib/aws-sdk-ses/client_api.rb +24 -0
- data/lib/aws-sdk-ses/types.rb +218 -143
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 82ea81fbc4e7df983d487dfdbcb4022dfc5b2b10
|
4
|
+
data.tar.gz: c10cbae2e4068525655471fb4668f11a4cdb83f5
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 0c8deb0c4b4c0577fdeeaf015cd1fb4f00c7ed61851217dbe96c151775ba776f3a18e0d61623d3185e2bc7cdd32ba7e233ac1d06fb47399856ac89985a0a925e
|
7
|
+
data.tar.gz: 52b5c3f0481475823bde7ff5f5e6bfb8cd222282a790931e6192a58260ca74ccd2e95f341c3ecb3eb8efe25e48d9b5fb5ef3f861c35a802e8ef133fa003fdbb7
|
data/lib/aws-sdk-ses.rb
CHANGED
data/lib/aws-sdk-ses/client.rb
CHANGED
@@ -261,7 +261,7 @@ module Aws::SES
|
|
261
261
|
#
|
262
262
|
#
|
263
263
|
#
|
264
|
-
# [1]:
|
264
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rule-set.html
|
265
265
|
#
|
266
266
|
# @option params [required, String] :rule_set_name
|
267
267
|
# The name of the rule set to create. The name must:
|
@@ -314,7 +314,7 @@ module Aws::SES
|
|
314
314
|
#
|
315
315
|
#
|
316
316
|
#
|
317
|
-
# [1]:
|
317
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html
|
318
318
|
#
|
319
319
|
# @option params [required, Types::ConfigurationSet] :configuration_set
|
320
320
|
# A data structure that contains the name of the configuration set.
|
@@ -355,7 +355,7 @@ module Aws::SES
|
|
355
355
|
#
|
356
356
|
#
|
357
357
|
#
|
358
|
-
# [1]:
|
358
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html
|
359
359
|
#
|
360
360
|
# @option params [required, String] :configuration_set_name
|
361
361
|
# The name of the configuration set that the event destination should be
|
@@ -413,7 +413,7 @@ module Aws::SES
|
|
413
413
|
#
|
414
414
|
#
|
415
415
|
#
|
416
|
-
# [1]:
|
416
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/configure-custom-open-click-domains.html
|
417
417
|
#
|
418
418
|
# @option params [required, String] :configuration_set_name
|
419
419
|
# The name of the configuration set that the tracking options should be
|
@@ -425,9 +425,11 @@ module Aws::SES
|
|
425
425
|
# generated by Amazon SES emails.
|
426
426
|
#
|
427
427
|
# For more information, see [Configuring Custom Domains to Handle Open
|
428
|
-
# and Click
|
429
|
-
#
|
430
|
-
#
|
428
|
+
# and Click Tracking][1] in the *Amazon SES Developer Guide*.
|
429
|
+
#
|
430
|
+
#
|
431
|
+
#
|
432
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/configure-custom-open-click-domains.html
|
431
433
|
#
|
432
434
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
433
435
|
#
|
@@ -459,7 +461,7 @@ module Aws::SES
|
|
459
461
|
#
|
460
462
|
#
|
461
463
|
#
|
462
|
-
# [1]:
|
464
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/custom-verification-emails.html
|
463
465
|
#
|
464
466
|
# @option params [required, String] :template_name
|
465
467
|
# The name of the custom verification email template.
|
@@ -478,7 +480,7 @@ module Aws::SES
|
|
478
480
|
#
|
479
481
|
#
|
480
482
|
#
|
481
|
-
# [1]:
|
483
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/custom-verification-emails.html#custom-verification-emails-faq
|
482
484
|
#
|
483
485
|
# @option params [required, String] :success_redirection_url
|
484
486
|
# The URL that the recipient of the verification email is sent to if his
|
@@ -519,7 +521,7 @@ module Aws::SES
|
|
519
521
|
#
|
520
522
|
#
|
521
523
|
#
|
522
|
-
# [1]:
|
524
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-ip-filters.html
|
523
525
|
#
|
524
526
|
# @option params [required, Types::ReceiptFilter] :filter
|
525
527
|
# A data structure that describes the IP address filter to create, which
|
@@ -573,7 +575,7 @@ module Aws::SES
|
|
573
575
|
#
|
574
576
|
#
|
575
577
|
#
|
576
|
-
# [1]:
|
578
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rules.html
|
577
579
|
#
|
578
580
|
# @option params [required, String] :rule_set_name
|
579
581
|
# The name of the rule set that the receipt rule will be added to.
|
@@ -683,7 +685,7 @@ module Aws::SES
|
|
683
685
|
#
|
684
686
|
#
|
685
687
|
#
|
686
|
-
# [1]:
|
688
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rule-set.html
|
687
689
|
#
|
688
690
|
# @option params [required, String] :rule_set_name
|
689
691
|
# The name of the rule set to create. The name must:
|
@@ -730,7 +732,7 @@ module Aws::SES
|
|
730
732
|
#
|
731
733
|
#
|
732
734
|
#
|
733
|
-
# [1]:
|
735
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html
|
734
736
|
#
|
735
737
|
# @option params [required, Types::Template] :template
|
736
738
|
# The content of the email, composed of a subject line, an HTML part,
|
@@ -766,7 +768,7 @@ module Aws::SES
|
|
766
768
|
#
|
767
769
|
#
|
768
770
|
#
|
769
|
-
# [1]:
|
771
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html
|
770
772
|
#
|
771
773
|
# @option params [required, String] :configuration_set_name
|
772
774
|
# The name of the configuration set to delete.
|
@@ -797,7 +799,7 @@ module Aws::SES
|
|
797
799
|
#
|
798
800
|
#
|
799
801
|
#
|
800
|
-
# [1]:
|
802
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html
|
801
803
|
#
|
802
804
|
# @option params [required, String] :configuration_set_name
|
803
805
|
# The name of the configuration set from which to delete the event
|
@@ -840,7 +842,7 @@ module Aws::SES
|
|
840
842
|
#
|
841
843
|
#
|
842
844
|
#
|
843
|
-
# [1]:
|
845
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/configure-custom-open-click-domains.html
|
844
846
|
#
|
845
847
|
# @option params [required, String] :configuration_set_name
|
846
848
|
# The name of the configuration set from which you want to delete the
|
@@ -873,7 +875,7 @@ module Aws::SES
|
|
873
875
|
#
|
874
876
|
#
|
875
877
|
#
|
876
|
-
# [1]:
|
878
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/custom-verification-emails.html
|
877
879
|
#
|
878
880
|
# @option params [required, String] :template_name
|
879
881
|
# The name of the custom verification email template that you want to
|
@@ -949,7 +951,7 @@ module Aws::SES
|
|
949
951
|
#
|
950
952
|
#
|
951
953
|
#
|
952
|
-
# [1]:
|
954
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
953
955
|
#
|
954
956
|
# @option params [required, String] :identity
|
955
957
|
# The identity that is associated with the policy that you want to
|
@@ -1000,7 +1002,7 @@ module Aws::SES
|
|
1000
1002
|
#
|
1001
1003
|
#
|
1002
1004
|
#
|
1003
|
-
# [1]:
|
1005
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-ip-filters.html
|
1004
1006
|
#
|
1005
1007
|
# @option params [required, String] :filter_name
|
1006
1008
|
# The name of the IP address filter to delete.
|
@@ -1040,7 +1042,7 @@ module Aws::SES
|
|
1040
1042
|
#
|
1041
1043
|
#
|
1042
1044
|
#
|
1043
|
-
# [1]:
|
1045
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rules.html
|
1044
1046
|
#
|
1045
1047
|
# @option params [required, String] :rule_set_name
|
1046
1048
|
# The name of the receipt rule set that contains the receipt rule to
|
@@ -1091,7 +1093,7 @@ module Aws::SES
|
|
1091
1093
|
#
|
1092
1094
|
#
|
1093
1095
|
#
|
1094
|
-
# [1]:
|
1096
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html
|
1095
1097
|
#
|
1096
1098
|
# @option params [required, String] :rule_set_name
|
1097
1099
|
# The name of the receipt rule set to delete.
|
@@ -1189,7 +1191,7 @@ module Aws::SES
|
|
1189
1191
|
#
|
1190
1192
|
#
|
1191
1193
|
#
|
1192
|
-
# [1]:
|
1194
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rule-set.html
|
1193
1195
|
#
|
1194
1196
|
# @return [Types::DescribeActiveReceiptRuleSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1195
1197
|
#
|
@@ -1278,7 +1280,7 @@ module Aws::SES
|
|
1278
1280
|
#
|
1279
1281
|
#
|
1280
1282
|
#
|
1281
|
-
# [1]:
|
1283
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html
|
1282
1284
|
#
|
1283
1285
|
# @option params [required, String] :configuration_set_name
|
1284
1286
|
# The name of the configuration set to describe.
|
@@ -1291,13 +1293,14 @@ module Aws::SES
|
|
1291
1293
|
# * {Types::DescribeConfigurationSetResponse#configuration_set #configuration_set} => Types::ConfigurationSet
|
1292
1294
|
# * {Types::DescribeConfigurationSetResponse#event_destinations #event_destinations} => Array<Types::EventDestination>
|
1293
1295
|
# * {Types::DescribeConfigurationSetResponse#tracking_options #tracking_options} => Types::TrackingOptions
|
1296
|
+
# * {Types::DescribeConfigurationSetResponse#delivery_options #delivery_options} => Types::DeliveryOptions
|
1294
1297
|
# * {Types::DescribeConfigurationSetResponse#reputation_options #reputation_options} => Types::ReputationOptions
|
1295
1298
|
#
|
1296
1299
|
# @example Request syntax with placeholder values
|
1297
1300
|
#
|
1298
1301
|
# resp = client.describe_configuration_set({
|
1299
1302
|
# configuration_set_name: "ConfigurationSetName", # required
|
1300
|
-
# configuration_set_attribute_names: ["eventDestinations"], # accepts eventDestinations, trackingOptions, reputationOptions
|
1303
|
+
# configuration_set_attribute_names: ["eventDestinations"], # accepts eventDestinations, trackingOptions, deliveryOptions, reputationOptions
|
1301
1304
|
# })
|
1302
1305
|
#
|
1303
1306
|
# @example Response structure
|
@@ -1316,6 +1319,7 @@ module Aws::SES
|
|
1316
1319
|
# resp.event_destinations[0].cloud_watch_destination.dimension_configurations[0].default_dimension_value #=> String
|
1317
1320
|
# resp.event_destinations[0].sns_destination.topic_arn #=> String
|
1318
1321
|
# resp.tracking_options.custom_redirect_domain #=> String
|
1322
|
+
# resp.delivery_options.tls_policy #=> String, one of "Require", "Optional"
|
1319
1323
|
# resp.reputation_options.sending_enabled #=> Boolean
|
1320
1324
|
# resp.reputation_options.reputation_metrics_enabled #=> Boolean
|
1321
1325
|
# resp.reputation_options.last_fresh_start #=> Time
|
@@ -1338,7 +1342,7 @@ module Aws::SES
|
|
1338
1342
|
#
|
1339
1343
|
#
|
1340
1344
|
#
|
1341
|
-
# [1]:
|
1345
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rules.html
|
1342
1346
|
#
|
1343
1347
|
# @option params [required, String] :rule_set_name
|
1344
1348
|
# The name of the receipt rule set that the receipt rule belongs to.
|
@@ -1433,7 +1437,7 @@ module Aws::SES
|
|
1433
1437
|
#
|
1434
1438
|
#
|
1435
1439
|
#
|
1436
|
-
# [1]:
|
1440
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html
|
1437
1441
|
#
|
1438
1442
|
# @option params [required, String] :rule_set_name
|
1439
1443
|
# The name of the receipt rule set to describe.
|
@@ -1570,7 +1574,7 @@ module Aws::SES
|
|
1570
1574
|
#
|
1571
1575
|
#
|
1572
1576
|
#
|
1573
|
-
# [1]:
|
1577
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/custom-verification-emails.html
|
1574
1578
|
#
|
1575
1579
|
# @option params [required, String] :template_name
|
1576
1580
|
# The name of the custom verification email template that you want to
|
@@ -1634,7 +1638,7 @@ module Aws::SES
|
|
1634
1638
|
#
|
1635
1639
|
#
|
1636
1640
|
#
|
1637
|
-
# [1]:
|
1641
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim-dns-records.html
|
1638
1642
|
#
|
1639
1643
|
# @option params [required, Array<String>] :identities
|
1640
1644
|
# A list of one or more verified identities - email addresses, domains,
|
@@ -1766,7 +1770,7 @@ module Aws::SES
|
|
1766
1770
|
#
|
1767
1771
|
#
|
1768
1772
|
#
|
1769
|
-
# [1]:
|
1773
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications.html
|
1770
1774
|
#
|
1771
1775
|
# @option params [required, Array<String>] :identities
|
1772
1776
|
# A list of one or more identities. You can specify an identity by using
|
@@ -1848,7 +1852,7 @@ module Aws::SES
|
|
1848
1852
|
#
|
1849
1853
|
#
|
1850
1854
|
#
|
1851
|
-
# [1]:
|
1855
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
1852
1856
|
#
|
1853
1857
|
# @option params [required, String] :identity
|
1854
1858
|
# The identity for which the policies will be retrieved. You can specify
|
@@ -2135,7 +2139,7 @@ module Aws::SES
|
|
2135
2139
|
#
|
2136
2140
|
#
|
2137
2141
|
#
|
2138
|
-
# [1]:
|
2142
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html
|
2139
2143
|
#
|
2140
2144
|
# @option params [String] :next_token
|
2141
2145
|
# A token returned from a previous call to `ListConfigurationSets` to
|
@@ -2183,7 +2187,7 @@ module Aws::SES
|
|
2183
2187
|
#
|
2184
2188
|
#
|
2185
2189
|
#
|
2186
|
-
# [1]:
|
2190
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/custom-verification-emails.html
|
2187
2191
|
#
|
2188
2192
|
# @option params [String] :next_token
|
2189
2193
|
# An array the contains the name and creation time stamp for each
|
@@ -2309,7 +2313,7 @@ module Aws::SES
|
|
2309
2313
|
#
|
2310
2314
|
#
|
2311
2315
|
#
|
2312
|
-
# [1]:
|
2316
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
2313
2317
|
#
|
2314
2318
|
# @option params [required, String] :identity
|
2315
2319
|
# The identity that is associated with the policy for which the policies
|
@@ -2370,7 +2374,7 @@ module Aws::SES
|
|
2370
2374
|
#
|
2371
2375
|
#
|
2372
2376
|
#
|
2373
|
-
# [1]:
|
2377
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-ip-filters.html
|
2374
2378
|
#
|
2375
2379
|
# @return [Types::ListReceiptFiltersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2376
2380
|
#
|
@@ -2425,7 +2429,7 @@ module Aws::SES
|
|
2425
2429
|
#
|
2426
2430
|
#
|
2427
2431
|
#
|
2428
|
-
# [1]:
|
2432
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html
|
2429
2433
|
#
|
2430
2434
|
# @option params [String] :next_token
|
2431
2435
|
# A token returned from a previous call to `ListReceiptRuleSets` to
|
@@ -2558,6 +2562,36 @@ module Aws::SES
|
|
2558
2562
|
req.send_request(options)
|
2559
2563
|
end
|
2560
2564
|
|
2565
|
+
# Adds or updates the delivery options for a configuration set.
|
2566
|
+
#
|
2567
|
+
# @option params [required, String] :configuration_set_name
|
2568
|
+
# The name of the configuration set that you want to specify the
|
2569
|
+
# delivery options for.
|
2570
|
+
#
|
2571
|
+
# @option params [Types::DeliveryOptions] :delivery_options
|
2572
|
+
# Specifies whether messages that use the configuration set are required
|
2573
|
+
# to use Transport Layer Security (TLS).
|
2574
|
+
#
|
2575
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2576
|
+
#
|
2577
|
+
# @example Request syntax with placeholder values
|
2578
|
+
#
|
2579
|
+
# resp = client.put_configuration_set_delivery_options({
|
2580
|
+
# configuration_set_name: "ConfigurationSetName", # required
|
2581
|
+
# delivery_options: {
|
2582
|
+
# tls_policy: "Require", # accepts Require, Optional
|
2583
|
+
# },
|
2584
|
+
# })
|
2585
|
+
#
|
2586
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/PutConfigurationSetDeliveryOptions AWS API Documentation
|
2587
|
+
#
|
2588
|
+
# @overload put_configuration_set_delivery_options(params = {})
|
2589
|
+
# @param [Hash] params ({})
|
2590
|
+
def put_configuration_set_delivery_options(params = {}, options = {})
|
2591
|
+
req = build_request(:put_configuration_set_delivery_options, params)
|
2592
|
+
req.send_request(options)
|
2593
|
+
end
|
2594
|
+
|
2561
2595
|
# Adds or updates a sending authorization policy for the specified
|
2562
2596
|
# identity (an email address or a domain).
|
2563
2597
|
#
|
@@ -2574,7 +2608,7 @@ module Aws::SES
|
|
2574
2608
|
#
|
2575
2609
|
#
|
2576
2610
|
#
|
2577
|
-
# [1]:
|
2611
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
2578
2612
|
#
|
2579
2613
|
# @option params [required, String] :identity
|
2580
2614
|
# The identity that the policy will apply to. You can specify an
|
@@ -2598,7 +2632,7 @@ module Aws::SES
|
|
2598
2632
|
#
|
2599
2633
|
#
|
2600
2634
|
#
|
2601
|
-
# [1]:
|
2635
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-policies.html
|
2602
2636
|
#
|
2603
2637
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2604
2638
|
#
|
@@ -2645,7 +2679,7 @@ module Aws::SES
|
|
2645
2679
|
#
|
2646
2680
|
#
|
2647
2681
|
#
|
2648
|
-
# [1]:
|
2682
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html
|
2649
2683
|
#
|
2650
2684
|
# @option params [required, String] :rule_set_name
|
2651
2685
|
# The name of the receipt rule set to reorder.
|
@@ -2701,7 +2735,7 @@ module Aws::SES
|
|
2701
2735
|
#
|
2702
2736
|
#
|
2703
2737
|
#
|
2704
|
-
# [1]:
|
2738
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email.html
|
2705
2739
|
#
|
2706
2740
|
# @option params [required, String] :original_message_id
|
2707
2741
|
# The message ID of the message to be bounced.
|
@@ -2734,7 +2768,7 @@ module Aws::SES
|
|
2734
2768
|
#
|
2735
2769
|
#
|
2736
2770
|
#
|
2737
|
-
# [1]:
|
2771
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
2738
2772
|
#
|
2739
2773
|
# @return [Types::SendBounceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2740
2774
|
#
|
@@ -2831,7 +2865,7 @@ module Aws::SES
|
|
2831
2865
|
#
|
2832
2866
|
#
|
2833
2867
|
#
|
2834
|
-
# [1]:
|
2868
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html
|
2835
2869
|
#
|
2836
2870
|
# @option params [required, String] :source
|
2837
2871
|
# The email address that is sending the email. This email address must
|
@@ -2859,8 +2893,8 @@ module Aws::SES
|
|
2859
2893
|
#
|
2860
2894
|
#
|
2861
2895
|
#
|
2862
|
-
# [1]:
|
2863
|
-
# [2]:
|
2896
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html
|
2897
|
+
# [2]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
2864
2898
|
# [3]: https://tools.ietf.org/html/rfc6531
|
2865
2899
|
# [4]: https://en.wikipedia.org/wiki/Email_address#Local-part
|
2866
2900
|
# [5]: https://tools.ietf.org/html/rfc3492.html
|
@@ -2884,7 +2918,7 @@ module Aws::SES
|
|
2884
2918
|
#
|
2885
2919
|
#
|
2886
2920
|
#
|
2887
|
-
# [1]:
|
2921
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
2888
2922
|
#
|
2889
2923
|
# @option params [Array<String>] :reply_to_addresses
|
2890
2924
|
# The reply-to email address(es) for the message. If the recipient
|
@@ -2918,7 +2952,7 @@ module Aws::SES
|
|
2918
2952
|
#
|
2919
2953
|
#
|
2920
2954
|
#
|
2921
|
-
# [1]:
|
2955
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
2922
2956
|
#
|
2923
2957
|
# @option params [String] :configuration_set_name
|
2924
2958
|
# The name of the configuration set to use when you send an email using
|
@@ -3018,7 +3052,7 @@ module Aws::SES
|
|
3018
3052
|
#
|
3019
3053
|
#
|
3020
3054
|
#
|
3021
|
-
# [1]:
|
3055
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/custom-verification-emails.html
|
3022
3056
|
#
|
3023
3057
|
# @option params [required, String] :email_address
|
3024
3058
|
# The email address to verify.
|
@@ -3095,8 +3129,8 @@ module Aws::SES
|
|
3095
3129
|
#
|
3096
3130
|
#
|
3097
3131
|
#
|
3098
|
-
# [1]:
|
3099
|
-
# [2]:
|
3132
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html
|
3133
|
+
# [2]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/manage-sending-limits.html
|
3100
3134
|
#
|
3101
3135
|
# @option params [required, String] :source
|
3102
3136
|
# The email address that is sending the email. This email address must
|
@@ -3124,8 +3158,8 @@ module Aws::SES
|
|
3124
3158
|
#
|
3125
3159
|
#
|
3126
3160
|
#
|
3127
|
-
# [1]:
|
3128
|
-
# [2]:
|
3161
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html
|
3162
|
+
# [2]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
3129
3163
|
# [3]: https://tools.ietf.org/html/rfc6531
|
3130
3164
|
# [4]: https://en.wikipedia.org/wiki/Email_address#Local-part
|
3131
3165
|
# [5]: https://tools.ietf.org/html/rfc3492.html
|
@@ -3169,7 +3203,7 @@ module Aws::SES
|
|
3169
3203
|
#
|
3170
3204
|
#
|
3171
3205
|
#
|
3172
|
-
# [1]:
|
3206
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
3173
3207
|
#
|
3174
3208
|
# @option params [String] :return_path_arn
|
3175
3209
|
# This parameter is used only for sending authorization. It is the ARN
|
@@ -3189,7 +3223,7 @@ module Aws::SES
|
|
3189
3223
|
#
|
3190
3224
|
#
|
3191
3225
|
#
|
3192
|
-
# [1]:
|
3226
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
3193
3227
|
#
|
3194
3228
|
# @option params [Array<Types::MessageTag>] :tags
|
3195
3229
|
# A list of tags, in the form of name/value pairs, to apply to an email
|
@@ -3392,12 +3426,12 @@ module Aws::SES
|
|
3392
3426
|
#
|
3393
3427
|
#
|
3394
3428
|
#
|
3395
|
-
# [1]:
|
3396
|
-
# [2]:
|
3397
|
-
# [3]:
|
3398
|
-
# [4]:
|
3399
|
-
# [5]:
|
3400
|
-
# [6]:
|
3429
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html
|
3430
|
+
# [2]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/request-production-access.html
|
3431
|
+
# [3]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/mailbox-simulator.html
|
3432
|
+
# [4]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-raw.html#send-email-mime-encoding
|
3433
|
+
# [5]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
3434
|
+
# [6]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/manage-sending-limits.html
|
3401
3435
|
#
|
3402
3436
|
# @option params [String] :source
|
3403
3437
|
# The identity's email address. If you do not provide a value for this
|
@@ -3460,8 +3494,8 @@ module Aws::SES
|
|
3460
3494
|
#
|
3461
3495
|
#
|
3462
3496
|
#
|
3463
|
-
# [1]:
|
3464
|
-
# [2]:
|
3497
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/mime-types.html
|
3498
|
+
# [2]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-raw.html
|
3465
3499
|
# [3]: https://tools.ietf.org/html/rfc5321#section-4.5.3.1.6
|
3466
3500
|
#
|
3467
3501
|
# @option params [String] :from_arn
|
@@ -3483,7 +3517,7 @@ module Aws::SES
|
|
3483
3517
|
#
|
3484
3518
|
#
|
3485
3519
|
#
|
3486
|
-
# [1]:
|
3520
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-delegate-sender-tasks-email.html
|
3487
3521
|
#
|
3488
3522
|
# @option params [String] :source_arn
|
3489
3523
|
# This parameter is used only for sending authorization. It is the ARN
|
@@ -3511,7 +3545,7 @@ module Aws::SES
|
|
3511
3545
|
#
|
3512
3546
|
#
|
3513
3547
|
#
|
3514
|
-
# [1]:
|
3548
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-delegate-sender-tasks-email.html
|
3515
3549
|
#
|
3516
3550
|
# @option params [String] :return_path_arn
|
3517
3551
|
# This parameter is used only for sending authorization. It is the ARN
|
@@ -3539,7 +3573,7 @@ module Aws::SES
|
|
3539
3573
|
#
|
3540
3574
|
#
|
3541
3575
|
#
|
3542
|
-
# [1]:
|
3576
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-delegate-sender-tasks-email.html
|
3543
3577
|
#
|
3544
3578
|
# @option params [Array<Types::MessageTag>] :tags
|
3545
3579
|
# A list of tags, in the form of name/value pairs, to apply to an email
|
@@ -3657,8 +3691,8 @@ module Aws::SES
|
|
3657
3691
|
#
|
3658
3692
|
#
|
3659
3693
|
#
|
3660
|
-
# [1]:
|
3661
|
-
# [2]:
|
3694
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html
|
3695
|
+
# [2]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html
|
3662
3696
|
#
|
3663
3697
|
# @option params [required, String] :source
|
3664
3698
|
# The email address that is sending the email. This email address must
|
@@ -3686,8 +3720,8 @@ module Aws::SES
|
|
3686
3720
|
#
|
3687
3721
|
#
|
3688
3722
|
#
|
3689
|
-
# [1]:
|
3690
|
-
# [2]:
|
3723
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html
|
3724
|
+
# [2]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
3691
3725
|
# [3]: https://tools.ietf.org/html/rfc6531
|
3692
3726
|
# [4]: https://en.wikipedia.org/wiki/Email_address#Local-part
|
3693
3727
|
# [5]: https://tools.ietf.org/html/rfc3492.html
|
@@ -3730,7 +3764,7 @@ module Aws::SES
|
|
3730
3764
|
#
|
3731
3765
|
#
|
3732
3766
|
#
|
3733
|
-
# [1]:
|
3767
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
3734
3768
|
#
|
3735
3769
|
# @option params [String] :return_path_arn
|
3736
3770
|
# This parameter is used only for sending authorization. It is the ARN
|
@@ -3750,7 +3784,7 @@ module Aws::SES
|
|
3750
3784
|
#
|
3751
3785
|
#
|
3752
3786
|
#
|
3753
|
-
# [1]:
|
3787
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
3754
3788
|
#
|
3755
3789
|
# @option params [Array<Types::MessageTag>] :tags
|
3756
3790
|
# A list of tags, in the form of name/value pairs, to apply to an email
|
@@ -3829,7 +3863,7 @@ module Aws::SES
|
|
3829
3863
|
#
|
3830
3864
|
#
|
3831
3865
|
#
|
3832
|
-
# [1]:
|
3866
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html
|
3833
3867
|
#
|
3834
3868
|
# @option params [String] :rule_set_name
|
3835
3869
|
# The name of the receipt rule set to make active. Setting this value to
|
@@ -3882,7 +3916,7 @@ module Aws::SES
|
|
3882
3916
|
#
|
3883
3917
|
#
|
3884
3918
|
#
|
3885
|
-
# [1]:
|
3919
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html
|
3886
3920
|
#
|
3887
3921
|
# @option params [required, String] :identity
|
3888
3922
|
# The identity for which DKIM signing should be enabled or disabled.
|
@@ -3937,7 +3971,7 @@ module Aws::SES
|
|
3937
3971
|
#
|
3938
3972
|
#
|
3939
3973
|
#
|
3940
|
-
# [1]:
|
3974
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications.html
|
3941
3975
|
#
|
3942
3976
|
# @option params [required, String] :identity
|
3943
3977
|
# The identity for which to set bounce and complaint notification
|
@@ -3992,7 +4026,7 @@ module Aws::SES
|
|
3992
4026
|
#
|
3993
4027
|
#
|
3994
4028
|
#
|
3995
|
-
# [1]:
|
4029
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications.html
|
3996
4030
|
#
|
3997
4031
|
# @option params [required, String] :identity
|
3998
4032
|
# The identity for which to enable or disable headers in notifications.
|
@@ -4056,7 +4090,7 @@ module Aws::SES
|
|
4056
4090
|
#
|
4057
4091
|
#
|
4058
4092
|
#
|
4059
|
-
# [1]:
|
4093
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/mail-from-set.html
|
4060
4094
|
#
|
4061
4095
|
# @option params [required, String] :identity
|
4062
4096
|
# The verified identity for which you want to enable or disable the
|
@@ -4073,7 +4107,7 @@ module Aws::SES
|
|
4073
4107
|
#
|
4074
4108
|
#
|
4075
4109
|
#
|
4076
|
-
# [1]:
|
4110
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/mail-from.html
|
4077
4111
|
#
|
4078
4112
|
# @option params [String] :behavior_on_mx_failure
|
4079
4113
|
# The action that you want Amazon SES to take if it cannot successfully
|
@@ -4132,7 +4166,7 @@ module Aws::SES
|
|
4132
4166
|
#
|
4133
4167
|
#
|
4134
4168
|
#
|
4135
|
-
# [1]:
|
4169
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications.html
|
4136
4170
|
#
|
4137
4171
|
# @option params [required, String] :identity
|
4138
4172
|
# The identity (email address or domain) that you want to set the Amazon
|
@@ -4195,7 +4229,7 @@ module Aws::SES
|
|
4195
4229
|
#
|
4196
4230
|
#
|
4197
4231
|
#
|
4198
|
-
# [1]:
|
4232
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rules.html
|
4199
4233
|
#
|
4200
4234
|
# @option params [required, String] :rule_set_name
|
4201
4235
|
# The name of the receipt rule set that contains the receipt rule to
|
@@ -4332,7 +4366,7 @@ module Aws::SES
|
|
4332
4366
|
#
|
4333
4367
|
#
|
4334
4368
|
#
|
4335
|
-
# [1]:
|
4369
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html
|
4336
4370
|
#
|
4337
4371
|
# @option params [required, String] :configuration_set_name
|
4338
4372
|
# The name of the configuration set that contains the event destination
|
@@ -4479,7 +4513,7 @@ module Aws::SES
|
|
4479
4513
|
#
|
4480
4514
|
#
|
4481
4515
|
#
|
4482
|
-
# [1]:
|
4516
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/configure-custom-open-click-domains.html
|
4483
4517
|
#
|
4484
4518
|
# @option params [required, String] :configuration_set_name
|
4485
4519
|
# The name of the configuration set for which you want to update the
|
@@ -4491,9 +4525,11 @@ module Aws::SES
|
|
4491
4525
|
# generated by Amazon SES emails.
|
4492
4526
|
#
|
4493
4527
|
# For more information, see [Configuring Custom Domains to Handle Open
|
4494
|
-
# and Click
|
4495
|
-
#
|
4496
|
-
#
|
4528
|
+
# and Click Tracking][1] in the *Amazon SES Developer Guide*.
|
4529
|
+
#
|
4530
|
+
#
|
4531
|
+
#
|
4532
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/configure-custom-open-click-domains.html
|
4497
4533
|
#
|
4498
4534
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4499
4535
|
#
|
@@ -4525,7 +4561,7 @@ module Aws::SES
|
|
4525
4561
|
#
|
4526
4562
|
#
|
4527
4563
|
#
|
4528
|
-
# [1]:
|
4564
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/custom-verification-emails.html
|
4529
4565
|
#
|
4530
4566
|
# @option params [required, String] :template_name
|
4531
4567
|
# The name of the custom verification email template that you want to
|
@@ -4545,7 +4581,7 @@ module Aws::SES
|
|
4545
4581
|
#
|
4546
4582
|
#
|
4547
4583
|
#
|
4548
|
-
# [1]:
|
4584
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/custom-verification-emails.html#custom-verification-emails-faq
|
4549
4585
|
#
|
4550
4586
|
# @option params [String] :success_redirection_url
|
4551
4587
|
# The URL that the recipient of the verification email is sent to if his
|
@@ -4586,7 +4622,7 @@ module Aws::SES
|
|
4586
4622
|
#
|
4587
4623
|
#
|
4588
4624
|
#
|
4589
|
-
# [1]:
|
4625
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rules.html
|
4590
4626
|
#
|
4591
4627
|
# @option params [required, String] :rule_set_name
|
4592
4628
|
# The name of the receipt rule set that the receipt rule belongs to.
|
@@ -4688,7 +4724,7 @@ module Aws::SES
|
|
4688
4724
|
#
|
4689
4725
|
#
|
4690
4726
|
#
|
4691
|
-
# [1]:
|
4727
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html
|
4692
4728
|
#
|
4693
4729
|
# @option params [required, Types::Template] :template
|
4694
4730
|
# The content of the email, composed of a subject line, an HTML part,
|
@@ -4716,25 +4752,44 @@ module Aws::SES
|
|
4716
4752
|
req.send_request(options)
|
4717
4753
|
end
|
4718
4754
|
|
4719
|
-
# Returns a set of DKIM tokens for a domain.
|
4720
|
-
# strings that represent your domain's identity. Using these tokens,
|
4721
|
-
# you will need to create DNS CNAME records that point to DKIM public
|
4722
|
-
# keys hosted by Amazon SES. Amazon Web Services will eventually detect
|
4723
|
-
# that you have updated your DNS records; this detection process may
|
4724
|
-
# take up to 72 hours. Upon successful detection, Amazon SES will be
|
4725
|
-
# able to DKIM-sign email originating from that domain.
|
4755
|
+
# Returns a set of DKIM tokens for a domain identity.
|
4726
4756
|
#
|
4727
|
-
#
|
4757
|
+
# When you execute the `VerifyDomainDkim` operation, the domain that you
|
4758
|
+
# specify is added to the list of identities that are associated with
|
4759
|
+
# your account. This is true even if you haven't already associated the
|
4760
|
+
# domain with your account by using the `VerifyDomainIdentity`
|
4761
|
+
# operation. However, you can't send email from the domain until you
|
4762
|
+
# either successfully [verify it][1] or you successfully [set up DKIM
|
4763
|
+
# for it][2].
|
4728
4764
|
#
|
4729
|
-
#
|
4730
|
-
#
|
4765
|
+
# You use the tokens that are generated by this operation to create
|
4766
|
+
# CNAME records. When Amazon SES detects that you've added these
|
4767
|
+
# records to the DNS configuration for a domain, you can start sending
|
4768
|
+
# email from that domain. You can start sending email even if you
|
4769
|
+
# haven't added the TXT record provided by the VerifyDomainIdentity
|
4770
|
+
# operation to the DNS configuration for your domain. All email that you
|
4771
|
+
# send from the domain is authenticated using DKIM.
|
4731
4772
|
#
|
4732
|
-
#
|
4733
|
-
#
|
4773
|
+
# To create the CNAME records for DKIM authentication, use the following
|
4774
|
+
# values:
|
4775
|
+
#
|
4776
|
+
# * **Name**\: *token*.\_domainkey.*example.com*
|
4777
|
+
#
|
4778
|
+
# * **Type**\: CNAME
|
4779
|
+
#
|
4780
|
+
# * **Value**\: *token*.dkim.amazonses.com
|
4781
|
+
#
|
4782
|
+
# In the preceding example, replace *token* with one of the tokens that
|
4783
|
+
# are generated when you execute this operation. Replace *example.com*
|
4784
|
+
# with your domain. Repeat this process for each token that's generated
|
4785
|
+
# by this operation.
|
4786
|
+
#
|
4787
|
+
# You can execute this operation no more than once per second.
|
4734
4788
|
#
|
4735
4789
|
#
|
4736
4790
|
#
|
4737
|
-
# [1]:
|
4791
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-domains.html
|
4792
|
+
# [2]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html
|
4738
4793
|
#
|
4739
4794
|
# @option params [required, String] :domain
|
4740
4795
|
# The name of the domain to be verified for Easy DKIM signing.
|
@@ -4790,7 +4845,7 @@ module Aws::SES
|
|
4790
4845
|
#
|
4791
4846
|
#
|
4792
4847
|
#
|
4793
|
-
# [1]:
|
4848
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html
|
4794
4849
|
#
|
4795
4850
|
# @option params [required, String] :domain
|
4796
4851
|
# The domain to be verified.
|
@@ -4913,7 +4968,7 @@ module Aws::SES
|
|
4913
4968
|
params: params,
|
4914
4969
|
config: config)
|
4915
4970
|
context[:gem_name] = 'aws-sdk-ses'
|
4916
|
-
context[:gem_version] = '1.
|
4971
|
+
context[:gem_version] = '1.22.0'
|
4917
4972
|
Seahorse::Client::Request.new(handlers, context)
|
4918
4973
|
end
|
4919
4974
|
|