aws-sdk-ses 1.2.0 → 1.3.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/lib/aws-sdk-ses.rb +1 -1
- data/lib/aws-sdk-ses/client.rb +813 -145
- data/lib/aws-sdk-ses/client_api.rb +210 -0
- data/lib/aws-sdk-ses/types.rb +893 -110
- 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: 1ba9fb7042c77497b6f1efee82b4ecb943c360b9
|
4
|
+
data.tar.gz: 4c7bfc56246eb699da01d5412c6ed8e2dc899a8f
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e75e72a4006ec0a590dd7c3f95ab5456940ac791d76049c350f0f9db2cc75461cc52acb8f70141f39f30c5da26bc2dad78b505aa72dfa6f28e3d9ebb82c1f84c
|
7
|
+
data.tar.gz: a4375095baa8c1ce301a6b62e0b43eed73214374cd77a30910775eb648b8f1afa40f5659bbe250203c32d0df1285266e778f9eaf843632fb3b434f57392780b6
|
data/lib/aws-sdk-ses.rb
CHANGED
data/lib/aws-sdk-ses/client.rb
CHANGED
@@ -149,12 +149,15 @@ module Aws::SES
|
|
149
149
|
# rules and configurations are copied to the new receipt rule set and
|
150
150
|
# are completely independent of the source rule set.
|
151
151
|
#
|
152
|
-
# For information about setting up rule sets, see the
|
153
|
-
#
|
154
|
-
# SES Developer Guide</a>.</i>
|
152
|
+
# For information about setting up rule sets, see the [Amazon SES
|
153
|
+
# Developer Guide][1].
|
155
154
|
#
|
156
155
|
# You can execute this operation no more than once per second.
|
157
156
|
#
|
157
|
+
#
|
158
|
+
#
|
159
|
+
# [1]: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rule-set.html
|
160
|
+
#
|
158
161
|
# @option params [required, String] :rule_set_name
|
159
162
|
# The name of the rule set to create. The name must:
|
160
163
|
#
|
@@ -199,12 +202,15 @@ module Aws::SES
|
|
199
202
|
# Creates a configuration set.
|
200
203
|
#
|
201
204
|
# Configuration sets enable you to publish email sending events. For
|
202
|
-
# information about using configuration sets, see the
|
203
|
-
#
|
204
|
-
# SES Developer Guide</a>.</i>
|
205
|
+
# information about using configuration sets, see the [Amazon SES
|
206
|
+
# Developer Guide][1].
|
205
207
|
#
|
206
208
|
# You can execute this operation no more than once per second.
|
207
209
|
#
|
210
|
+
#
|
211
|
+
#
|
212
|
+
# [1]: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html
|
213
|
+
#
|
208
214
|
# @option params [required, Types::ConfigurationSet] :configuration_set
|
209
215
|
# A data structure that contains the name of the configuration set.
|
210
216
|
#
|
@@ -238,12 +244,15 @@ module Aws::SES
|
|
238
244
|
#
|
239
245
|
# An event destination is the AWS service to which Amazon SES publishes
|
240
246
|
# the email sending events associated with a configuration set. For
|
241
|
-
# information about using configuration sets, see the
|
242
|
-
#
|
243
|
-
# SES Developer Guide</a>.</i>
|
247
|
+
# information about using configuration sets, see the [Amazon SES
|
248
|
+
# Developer Guide][1].
|
244
249
|
#
|
245
250
|
# You can execute this operation no more than once per second.
|
246
251
|
#
|
252
|
+
#
|
253
|
+
#
|
254
|
+
# [1]: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html
|
255
|
+
#
|
247
256
|
# @option params [required, String] :configuration_set_name
|
248
257
|
# The name of the configuration set that the event destination should be
|
249
258
|
# associated with.
|
@@ -261,7 +270,7 @@ module Aws::SES
|
|
261
270
|
# event_destination: { # required
|
262
271
|
# name: "EventDestinationName", # required
|
263
272
|
# enabled: false,
|
264
|
-
# matching_event_types: ["send"], # required, accepts send, reject, bounce, complaint, delivery, open, click
|
273
|
+
# matching_event_types: ["send"], # required, accepts send, reject, bounce, complaint, delivery, open, click, renderingFailure
|
265
274
|
# kinesis_firehose_destination: {
|
266
275
|
# iam_role_arn: "AmazonResourceName", # required
|
267
276
|
# delivery_stream_arn: "AmazonResourceName", # required
|
@@ -295,16 +304,14 @@ module Aws::SES
|
|
295
304
|
#
|
296
305
|
# By default, images and links used for tracking open and click events
|
297
306
|
# are hosted on domains operated by Amazon SES. You can configure a
|
298
|
-
# subdomain of your own to handle these events
|
299
|
-
#
|
300
|
-
#
|
301
|
-
# Click Tracking][1] in the <i> <a
|
302
|
-
# href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/Welcome.html">Amazon
|
303
|
-
# SES Developer Guide</a>.</i>
|
307
|
+
# subdomain of your own to handle these events. For information about
|
308
|
+
# using configuration sets, see [Configuring Custom Domains to Handle
|
309
|
+
# Open and Click Tracking][1] in the [Amazon SES Developer Guide][2].
|
304
310
|
#
|
305
311
|
#
|
306
312
|
#
|
307
313
|
# [1]: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/configure-custom-open-click-domains.html
|
314
|
+
# [2]: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/Welcome.html
|
308
315
|
#
|
309
316
|
# @option params [required, String] :configuration_set_name
|
310
317
|
# The name of the configuration set that the tracking options should be
|
@@ -316,13 +323,12 @@ module Aws::SES
|
|
316
323
|
# generated by Amazon SES emails.
|
317
324
|
#
|
318
325
|
# For more information, see [Configuring Custom Domains to Handle Open
|
319
|
-
# and Click Tracking][1] in the
|
320
|
-
# href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/Welcome.html">Amazon
|
321
|
-
# SES Developer Guide</a>.</i>
|
326
|
+
# and Click Tracking][1] in the [Amazon SES Developer Guide][2].
|
322
327
|
#
|
323
328
|
#
|
324
329
|
#
|
325
330
|
# [1]: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/configure-custom-open-click-domains.html
|
331
|
+
# [2]: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/Welcome.html
|
326
332
|
#
|
327
333
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
328
334
|
#
|
@@ -346,12 +352,15 @@ module Aws::SES
|
|
346
352
|
|
347
353
|
# Creates a new IP address filter.
|
348
354
|
#
|
349
|
-
# For information about setting up IP address filters, see the
|
350
|
-
#
|
351
|
-
# SES Developer Guide</a>.</i>
|
355
|
+
# For information about setting up IP address filters, see the [Amazon
|
356
|
+
# SES Developer Guide][1].
|
352
357
|
#
|
353
358
|
# You can execute this operation no more than once per second.
|
354
359
|
#
|
360
|
+
#
|
361
|
+
#
|
362
|
+
# [1]: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-ip-filters.html
|
363
|
+
#
|
355
364
|
# @option params [required, Types::ReceiptFilter] :filter
|
356
365
|
# A data structure that describes the IP address filter to create, which
|
357
366
|
# consists of a name, an IP address range, and whether to allow or block
|
@@ -397,12 +406,15 @@ module Aws::SES
|
|
397
406
|
|
398
407
|
# Creates a receipt rule.
|
399
408
|
#
|
400
|
-
# For information about setting up receipt rules, see the
|
401
|
-
#
|
402
|
-
# SES Developer Guide</a>.</i>
|
409
|
+
# For information about setting up receipt rules, see the [Amazon SES
|
410
|
+
# Developer Guide][1].
|
403
411
|
#
|
404
412
|
# You can execute this operation no more than once per second.
|
405
413
|
#
|
414
|
+
#
|
415
|
+
#
|
416
|
+
# [1]: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rules.html
|
417
|
+
#
|
406
418
|
# @option params [required, String] :rule_set_name
|
407
419
|
# The name of the rule set that the receipt rule will be added to.
|
408
420
|
#
|
@@ -504,12 +516,15 @@ module Aws::SES
|
|
504
516
|
|
505
517
|
# Creates an empty receipt rule set.
|
506
518
|
#
|
507
|
-
# For information about setting up receipt rule sets, see the
|
508
|
-
#
|
509
|
-
# SES Developer Guide</a>.</i>
|
519
|
+
# For information about setting up receipt rule sets, see the [Amazon
|
520
|
+
# SES Developer Guide][1].
|
510
521
|
#
|
511
522
|
# You can execute this operation no more than once per second.
|
512
523
|
#
|
524
|
+
#
|
525
|
+
#
|
526
|
+
# [1]: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rule-set.html
|
527
|
+
#
|
513
528
|
# @option params [required, String] :rule_set_name
|
514
529
|
# The name of the rule set to create. The name must:
|
515
530
|
#
|
@@ -546,14 +561,53 @@ module Aws::SES
|
|
546
561
|
req.send_request(options)
|
547
562
|
end
|
548
563
|
|
564
|
+
# Creates an email template. Email templates enable you to send
|
565
|
+
# personalized email to one or more destinations in a single API
|
566
|
+
# operation. For more information, see the [Amazon SES Developer
|
567
|
+
# Guide][1].
|
568
|
+
#
|
569
|
+
# You can execute this operation no more than once per second.
|
570
|
+
#
|
571
|
+
#
|
572
|
+
#
|
573
|
+
# [1]: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html
|
574
|
+
#
|
575
|
+
# @option params [required, Types::Template] :template
|
576
|
+
# The content of the email, composed of a subject line, an HTML part,
|
577
|
+
# and a text-only part.
|
578
|
+
#
|
579
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
580
|
+
#
|
581
|
+
# @example Request syntax with placeholder values
|
582
|
+
#
|
583
|
+
# resp = client.create_template({
|
584
|
+
# template: { # required
|
585
|
+
# template_name: "TemplateName", # required
|
586
|
+
# subject_part: "SubjectPart",
|
587
|
+
# text_part: "TextPart",
|
588
|
+
# html_part: "HtmlPart",
|
589
|
+
# },
|
590
|
+
# })
|
591
|
+
#
|
592
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/CreateTemplate AWS API Documentation
|
593
|
+
#
|
594
|
+
# @overload create_template(params = {})
|
595
|
+
# @param [Hash] params ({})
|
596
|
+
def create_template(params = {}, options = {})
|
597
|
+
req = build_request(:create_template, params)
|
598
|
+
req.send_request(options)
|
599
|
+
end
|
600
|
+
|
549
601
|
# Deletes a configuration set. Configuration sets enable you to publish
|
550
602
|
# email sending events. For information about using configuration sets,
|
551
|
-
# see the
|
552
|
-
# href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html">Amazon
|
553
|
-
# SES Developer Guide</a>.</i>
|
603
|
+
# see the [Amazon SES Developer Guide][1].
|
554
604
|
#
|
555
605
|
# You can execute this operation no more than once per second.
|
556
606
|
#
|
607
|
+
#
|
608
|
+
#
|
609
|
+
# [1]: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html
|
610
|
+
#
|
557
611
|
# @option params [required, String] :configuration_set_name
|
558
612
|
# The name of the configuration set to delete.
|
559
613
|
#
|
@@ -577,12 +631,14 @@ module Aws::SES
|
|
577
631
|
# Deletes a configuration set event destination. Configuration set event
|
578
632
|
# destinations are associated with configuration sets, which enable you
|
579
633
|
# to publish email sending events. For information about using
|
580
|
-
# configuration sets, see the
|
581
|
-
# href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html">Amazon
|
582
|
-
# SES Developer Guide</a>.</i>
|
634
|
+
# configuration sets, see the [Amazon SES Developer Guide][1].
|
583
635
|
#
|
584
636
|
# You can execute this operation no more than once per second.
|
585
637
|
#
|
638
|
+
#
|
639
|
+
#
|
640
|
+
# [1]: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html
|
641
|
+
#
|
586
642
|
# @option params [required, String] :configuration_set_name
|
587
643
|
# The name of the configuration set from which to delete the event
|
588
644
|
# destination.
|
@@ -613,12 +669,9 @@ module Aws::SES
|
|
613
669
|
#
|
614
670
|
# By default, images and links used for tracking open and click events
|
615
671
|
# are hosted on domains operated by Amazon SES. You can configure a
|
616
|
-
# subdomain of your own to handle these events
|
617
|
-
#
|
618
|
-
#
|
619
|
-
# Click Tracking][1] in the <i> <a
|
620
|
-
# href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/Welcome.html">Amazon
|
621
|
-
# SES Developer Guide</a>.</i>
|
672
|
+
# subdomain of your own to handle these events. For information about
|
673
|
+
# using configuration sets, see [Configuring Custom Domains to Handle
|
674
|
+
# Open and Click Tracking][1] in the [Amazon SES Developer Guide][2].
|
622
675
|
#
|
623
676
|
# <note markdown="1"> Deleting this kind of association will result in emails sent using the
|
624
677
|
# specified configuration set to capture open and click events using the
|
@@ -629,6 +682,7 @@ module Aws::SES
|
|
629
682
|
#
|
630
683
|
#
|
631
684
|
# [1]: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/configure-custom-open-click-domains.html
|
685
|
+
# [2]: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/Welcome.html
|
632
686
|
#
|
633
687
|
# @option params [required, String] :configuration_set_name
|
634
688
|
# The name of the configuration set from which you want to delete the
|
@@ -698,12 +752,14 @@ module Aws::SES
|
|
698
752
|
#
|
699
753
|
# Sending authorization is a feature that enables an identity owner to
|
700
754
|
# authorize other senders to use its identities. For information about
|
701
|
-
# using sending authorization, see the
|
702
|
-
# href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon
|
703
|
-
# SES Developer Guide</a>.</i>
|
755
|
+
# using sending authorization, see the [Amazon SES Developer Guide][1].
|
704
756
|
#
|
705
757
|
# You can execute this operation no more than once per second.
|
706
758
|
#
|
759
|
+
#
|
760
|
+
#
|
761
|
+
# [1]: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
762
|
+
#
|
707
763
|
# @option params [required, String] :identity
|
708
764
|
# The identity that is associated with the policy that you want to
|
709
765
|
# delete. You can specify the identity by using its name or by using its
|
@@ -746,12 +802,15 @@ module Aws::SES
|
|
746
802
|
|
747
803
|
# Deletes the specified IP address filter.
|
748
804
|
#
|
749
|
-
# For information about managing IP address filters, see the
|
750
|
-
#
|
751
|
-
# SES Developer Guide</a>.</i>
|
805
|
+
# For information about managing IP address filters, see the [Amazon SES
|
806
|
+
# Developer Guide][1].
|
752
807
|
#
|
753
808
|
# You can execute this operation no more than once per second.
|
754
809
|
#
|
810
|
+
#
|
811
|
+
#
|
812
|
+
# [1]: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-ip-filters.html
|
813
|
+
#
|
755
814
|
# @option params [required, String] :filter_name
|
756
815
|
# The name of the IP address filter to delete.
|
757
816
|
#
|
@@ -783,12 +842,15 @@ module Aws::SES
|
|
783
842
|
|
784
843
|
# Deletes the specified receipt rule.
|
785
844
|
#
|
786
|
-
# For information about managing receipt rules, see the
|
787
|
-
#
|
788
|
-
# SES Developer Guide</a>.</i>
|
845
|
+
# For information about managing receipt rules, see the [Amazon SES
|
846
|
+
# Developer Guide][1].
|
789
847
|
#
|
790
848
|
# You can execute this operation no more than once per second.
|
791
849
|
#
|
850
|
+
#
|
851
|
+
#
|
852
|
+
# [1]: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rules.html
|
853
|
+
#
|
792
854
|
# @option params [required, String] :rule_set_name
|
793
855
|
# The name of the receipt rule set that contains the receipt rule to
|
794
856
|
# delete.
|
@@ -831,12 +893,15 @@ module Aws::SES
|
|
831
893
|
#
|
832
894
|
# </note>
|
833
895
|
#
|
834
|
-
# For information about managing receipt rule sets, see the
|
835
|
-
#
|
836
|
-
# SES Developer Guide</a>.</i>
|
896
|
+
# For information about managing receipt rule sets, see the [Amazon SES
|
897
|
+
# Developer Guide][1].
|
837
898
|
#
|
838
899
|
# You can execute this operation no more than once per second.
|
839
900
|
#
|
901
|
+
#
|
902
|
+
#
|
903
|
+
# [1]: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html
|
904
|
+
#
|
840
905
|
# @option params [required, String] :rule_set_name
|
841
906
|
# The name of the receipt rule set to delete.
|
842
907
|
#
|
@@ -866,6 +931,30 @@ module Aws::SES
|
|
866
931
|
req.send_request(options)
|
867
932
|
end
|
868
933
|
|
934
|
+
# Deletes an email template.
|
935
|
+
#
|
936
|
+
# You can execute this operation no more than once per second.
|
937
|
+
#
|
938
|
+
# @option params [required, String] :template_name
|
939
|
+
# The name of the template to be deleted.
|
940
|
+
#
|
941
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
942
|
+
#
|
943
|
+
# @example Request syntax with placeholder values
|
944
|
+
#
|
945
|
+
# resp = client.delete_template({
|
946
|
+
# template_name: "TemplateName", # required
|
947
|
+
# })
|
948
|
+
#
|
949
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/DeleteTemplate AWS API Documentation
|
950
|
+
#
|
951
|
+
# @overload delete_template(params = {})
|
952
|
+
# @param [Hash] params ({})
|
953
|
+
def delete_template(params = {}, options = {})
|
954
|
+
req = build_request(:delete_template, params)
|
955
|
+
req.send_request(options)
|
956
|
+
end
|
957
|
+
|
869
958
|
# Deprecated. Use the `DeleteIdentity` operation to delete email
|
870
959
|
# addresses and domains.
|
871
960
|
#
|
@@ -902,12 +991,15 @@ module Aws::SES
|
|
902
991
|
# Returns the metadata and receipt rules for the receipt rule set that
|
903
992
|
# is currently active.
|
904
993
|
#
|
905
|
-
# For information about setting up receipt rule sets, see the
|
906
|
-
#
|
907
|
-
# SES Developer Guide</a>.</i>
|
994
|
+
# For information about setting up receipt rule sets, see the [Amazon
|
995
|
+
# SES Developer Guide][1].
|
908
996
|
#
|
909
997
|
# You can execute this operation no more than once per second.
|
910
998
|
#
|
999
|
+
#
|
1000
|
+
#
|
1001
|
+
# [1]: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rule-set.html
|
1002
|
+
#
|
911
1003
|
# @return [Types::DescribeActiveReceiptRuleSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
912
1004
|
#
|
913
1005
|
# * {Types::DescribeActiveReceiptRuleSetResponse#metadata #metadata} => Types::ReceiptRuleSetMetadata
|
@@ -988,12 +1080,15 @@ module Aws::SES
|
|
988
1080
|
end
|
989
1081
|
|
990
1082
|
# Returns the details of the specified configuration set. For
|
991
|
-
# information about using configuration sets, see the
|
992
|
-
#
|
993
|
-
# SES Developer Guide</a>.</i>
|
1083
|
+
# information about using configuration sets, see the [Amazon SES
|
1084
|
+
# Developer Guide][1].
|
994
1085
|
#
|
995
1086
|
# You can execute this operation no more than once per second.
|
996
1087
|
#
|
1088
|
+
#
|
1089
|
+
#
|
1090
|
+
# [1]: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html
|
1091
|
+
#
|
997
1092
|
# @option params [required, String] :configuration_set_name
|
998
1093
|
# The name of the configuration set to describe.
|
999
1094
|
#
|
@@ -1020,7 +1115,7 @@ module Aws::SES
|
|
1020
1115
|
# resp.event_destinations[0].name #=> String
|
1021
1116
|
# resp.event_destinations[0].enabled #=> Boolean
|
1022
1117
|
# resp.event_destinations[0].matching_event_types #=> Array
|
1023
|
-
# resp.event_destinations[0].matching_event_types[0] #=> String, one of "send", "reject", "bounce", "complaint", "delivery", "open", "click"
|
1118
|
+
# resp.event_destinations[0].matching_event_types[0] #=> String, one of "send", "reject", "bounce", "complaint", "delivery", "open", "click", "renderingFailure"
|
1024
1119
|
# resp.event_destinations[0].kinesis_firehose_destination.iam_role_arn #=> String
|
1025
1120
|
# resp.event_destinations[0].kinesis_firehose_destination.delivery_stream_arn #=> String
|
1026
1121
|
# resp.event_destinations[0].cloud_watch_destination.dimension_configurations #=> Array
|
@@ -1041,12 +1136,15 @@ module Aws::SES
|
|
1041
1136
|
|
1042
1137
|
# Returns the details of the specified receipt rule.
|
1043
1138
|
#
|
1044
|
-
# For information about setting up receipt rules, see the
|
1045
|
-
#
|
1046
|
-
# SES Developer Guide</a>.</i>
|
1139
|
+
# For information about setting up receipt rules, see the [Amazon SES
|
1140
|
+
# Developer Guide][1].
|
1047
1141
|
#
|
1048
1142
|
# You can execute this operation no more than once per second.
|
1049
1143
|
#
|
1144
|
+
#
|
1145
|
+
#
|
1146
|
+
# [1]: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rules.html
|
1147
|
+
#
|
1050
1148
|
# @option params [required, String] :rule_set_name
|
1051
1149
|
# The name of the receipt rule set that the receipt rule belongs to.
|
1052
1150
|
#
|
@@ -1133,12 +1231,15 @@ module Aws::SES
|
|
1133
1231
|
|
1134
1232
|
# Returns the details of the specified receipt rule set.
|
1135
1233
|
#
|
1136
|
-
# For information about managing receipt rule sets, see the
|
1137
|
-
#
|
1138
|
-
# SES Developer Guide</a>.</i>
|
1234
|
+
# For information about managing receipt rule sets, see the [Amazon SES
|
1235
|
+
# Developer Guide][1].
|
1139
1236
|
#
|
1140
1237
|
# You can execute this operation no more than once per second.
|
1141
1238
|
#
|
1239
|
+
#
|
1240
|
+
#
|
1241
|
+
# [1]: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html
|
1242
|
+
#
|
1142
1243
|
# @option params [required, String] :rule_set_name
|
1143
1244
|
# The name of the receipt rule set to describe.
|
1144
1245
|
#
|
@@ -1249,9 +1350,11 @@ module Aws::SES
|
|
1249
1350
|
# DKIM attributes for up to 100 identities at a time.
|
1250
1351
|
#
|
1251
1352
|
# For more information about creating DNS records using DKIM tokens, go
|
1252
|
-
# to the
|
1253
|
-
#
|
1254
|
-
#
|
1353
|
+
# to the [Amazon SES Developer Guide][1].
|
1354
|
+
#
|
1355
|
+
#
|
1356
|
+
#
|
1357
|
+
# [1]: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim-dns-records.html
|
1255
1358
|
#
|
1256
1359
|
# @option params [required, Array<String>] :identities
|
1257
1360
|
# A list of one or more verified identities - email addresses, domains,
|
@@ -1379,9 +1482,11 @@ module Aws::SES
|
|
1379
1482
|
# notification attributes for up to 100 identities at a time.
|
1380
1483
|
#
|
1381
1484
|
# For more information about using notifications with Amazon SES, see
|
1382
|
-
# the
|
1383
|
-
#
|
1384
|
-
#
|
1485
|
+
# the [Amazon SES Developer Guide][1].
|
1486
|
+
#
|
1487
|
+
#
|
1488
|
+
#
|
1489
|
+
# [1]: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications.html
|
1385
1490
|
#
|
1386
1491
|
# @option params [required, Array<String>] :identities
|
1387
1492
|
# A list of one or more identities. You can specify an identity by using
|
@@ -1457,12 +1562,14 @@ module Aws::SES
|
|
1457
1562
|
#
|
1458
1563
|
# Sending authorization is a feature that enables an identity owner to
|
1459
1564
|
# authorize other senders to use its identities. For information about
|
1460
|
-
# using sending authorization, see the
|
1461
|
-
# href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon
|
1462
|
-
# SES Developer Guide</a>.</i>
|
1565
|
+
# using sending authorization, see the [Amazon SES Developer Guide][1].
|
1463
1566
|
#
|
1464
1567
|
# You can execute this operation no more than once per second.
|
1465
1568
|
#
|
1569
|
+
#
|
1570
|
+
#
|
1571
|
+
# [1]: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
1572
|
+
#
|
1466
1573
|
# @option params [required, String] :identity
|
1467
1574
|
# The identity for which the policies will be retrieved. You can specify
|
1468
1575
|
# an identity by using its name or by using its Amazon Resource Name
|
@@ -1699,18 +1806,52 @@ module Aws::SES
|
|
1699
1806
|
req.send_request(options)
|
1700
1807
|
end
|
1701
1808
|
|
1809
|
+
# Displays the template object (which includes the Subject line, HTML
|
1810
|
+
# part and text part) for the template you specify.
|
1811
|
+
#
|
1812
|
+
# You can execute this operation no more than once per second.
|
1813
|
+
#
|
1814
|
+
# @option params [required, String] :template_name
|
1815
|
+
# The name of the template you want to retrieve.
|
1816
|
+
#
|
1817
|
+
# @return [Types::GetTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1818
|
+
#
|
1819
|
+
# * {Types::GetTemplateResponse#template #template} => Types::Template
|
1820
|
+
#
|
1821
|
+
# @example Request syntax with placeholder values
|
1822
|
+
#
|
1823
|
+
# resp = client.get_template({
|
1824
|
+
# template_name: "TemplateName", # required
|
1825
|
+
# })
|
1826
|
+
#
|
1827
|
+
# @example Response structure
|
1828
|
+
#
|
1829
|
+
# resp.template.template_name #=> String
|
1830
|
+
# resp.template.subject_part #=> String
|
1831
|
+
# resp.template.text_part #=> String
|
1832
|
+
# resp.template.html_part #=> String
|
1833
|
+
#
|
1834
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/GetTemplate AWS API Documentation
|
1835
|
+
#
|
1836
|
+
# @overload get_template(params = {})
|
1837
|
+
# @param [Hash] params ({})
|
1838
|
+
def get_template(params = {}, options = {})
|
1839
|
+
req = build_request(:get_template, params)
|
1840
|
+
req.send_request(options)
|
1841
|
+
end
|
1842
|
+
|
1702
1843
|
# Provides a list of the configuration sets associated with your Amazon
|
1703
1844
|
# SES account. For information about using configuration sets, see
|
1704
1845
|
# [Monitoring Your Amazon SES Sending Activity][1] in the *Amazon SES
|
1705
|
-
# Developer Guide
|
1846
|
+
# Developer Guide.*
|
1706
1847
|
#
|
1707
1848
|
# You can execute this operation no more than once per second. This
|
1708
|
-
# operation will return up to
|
1709
|
-
# If your Amazon SES account has more than
|
1710
|
-
# operation will also return a NextToken element. You can
|
1711
|
-
# the `ListConfigurationSets` operation again, passing the
|
1712
|
-
# parameter and the value of the NextToken element to
|
1713
|
-
# additional results.
|
1849
|
+
# operation will return up to 1,000 configuration sets each time it is
|
1850
|
+
# run. If your Amazon SES account has more than 1,000 configuration
|
1851
|
+
# sets, this operation will also return a NextToken element. You can
|
1852
|
+
# then execute the `ListConfigurationSets` operation again, passing the
|
1853
|
+
# `NextToken` parameter and the value of the NextToken element to
|
1854
|
+
# retrieve additional results.
|
1714
1855
|
#
|
1715
1856
|
#
|
1716
1857
|
#
|
@@ -1827,12 +1968,14 @@ module Aws::SES
|
|
1827
1968
|
#
|
1828
1969
|
# Sending authorization is a feature that enables an identity owner to
|
1829
1970
|
# authorize other senders to use its identities. For information about
|
1830
|
-
# using sending authorization, see the
|
1831
|
-
# href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon
|
1832
|
-
# SES Developer Guide</a>.</i>
|
1971
|
+
# using sending authorization, see the [Amazon SES Developer Guide][1].
|
1833
1972
|
#
|
1834
1973
|
# You can execute this operation no more than once per second.
|
1835
1974
|
#
|
1975
|
+
#
|
1976
|
+
#
|
1977
|
+
# [1]: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
1978
|
+
#
|
1836
1979
|
# @option params [required, String] :identity
|
1837
1980
|
# The identity that is associated with the policy for which the policies
|
1838
1981
|
# will be listed. You can specify an identity by using its name or by
|
@@ -1884,12 +2027,15 @@ module Aws::SES
|
|
1884
2027
|
|
1885
2028
|
# Lists the IP address filters associated with your AWS account.
|
1886
2029
|
#
|
1887
|
-
# For information about managing IP address filters, see the
|
1888
|
-
#
|
1889
|
-
# SES Developer Guide</a>.</i>
|
2030
|
+
# For information about managing IP address filters, see the [Amazon SES
|
2031
|
+
# Developer Guide][1].
|
1890
2032
|
#
|
1891
2033
|
# You can execute this operation no more than once per second.
|
1892
2034
|
#
|
2035
|
+
#
|
2036
|
+
#
|
2037
|
+
# [1]: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-ip-filters.html
|
2038
|
+
#
|
1893
2039
|
# @return [Types::ListReceiptFiltersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1894
2040
|
#
|
1895
2041
|
# * {Types::ListReceiptFiltersResponse#filters #filters} => Array<Types::ReceiptFilter>
|
@@ -1936,12 +2082,15 @@ module Aws::SES
|
|
1936
2082
|
# receive a `NextToken` that you can provide to the next call to
|
1937
2083
|
# `ListReceiptRuleSets` to retrieve the additional entries.
|
1938
2084
|
#
|
1939
|
-
# For information about managing receipt rule sets, see the
|
1940
|
-
#
|
1941
|
-
# SES Developer Guide</a>.</i>
|
2085
|
+
# For information about managing receipt rule sets, see the [Amazon SES
|
2086
|
+
# Developer Guide][1].
|
1942
2087
|
#
|
1943
2088
|
# You can execute this operation no more than once per second.
|
1944
2089
|
#
|
2090
|
+
#
|
2091
|
+
#
|
2092
|
+
# [1]: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html
|
2093
|
+
#
|
1945
2094
|
# @option params [String] :next_token
|
1946
2095
|
# A token returned from a previous call to `ListReceiptRuleSets` to
|
1947
2096
|
# indicate the position in the receipt rule set list.
|
@@ -1993,6 +2142,47 @@ module Aws::SES
|
|
1993
2142
|
req.send_request(options)
|
1994
2143
|
end
|
1995
2144
|
|
2145
|
+
# Lists the email templates present in your Amazon SES account.
|
2146
|
+
#
|
2147
|
+
# You can execute this operation no more than once per second.
|
2148
|
+
#
|
2149
|
+
# @option params [String] :next_token
|
2150
|
+
# The token to use for pagination.
|
2151
|
+
#
|
2152
|
+
# @option params [Integer] :max_items
|
2153
|
+
# The maximum number of templates to return. This value must be at least
|
2154
|
+
# 1 and less than or equal to 10. If you do not specify a value, or if
|
2155
|
+
# you specify a value less than 1 or greater than 10, the operation will
|
2156
|
+
# return up to 10 results.
|
2157
|
+
#
|
2158
|
+
# @return [Types::ListTemplatesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2159
|
+
#
|
2160
|
+
# * {Types::ListTemplatesResponse#templates_metadata #templates_metadata} => Array<Types::TemplateMetadata>
|
2161
|
+
# * {Types::ListTemplatesResponse#next_token #next_token} => String
|
2162
|
+
#
|
2163
|
+
# @example Request syntax with placeholder values
|
2164
|
+
#
|
2165
|
+
# resp = client.list_templates({
|
2166
|
+
# next_token: "NextToken",
|
2167
|
+
# max_items: 1,
|
2168
|
+
# })
|
2169
|
+
#
|
2170
|
+
# @example Response structure
|
2171
|
+
#
|
2172
|
+
# resp.templates_metadata #=> Array
|
2173
|
+
# resp.templates_metadata[0].name #=> String
|
2174
|
+
# resp.templates_metadata[0].created_timestamp #=> Time
|
2175
|
+
# resp.next_token #=> String
|
2176
|
+
#
|
2177
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/ListTemplates AWS API Documentation
|
2178
|
+
#
|
2179
|
+
# @overload list_templates(params = {})
|
2180
|
+
# @param [Hash] params ({})
|
2181
|
+
def list_templates(params = {}, options = {})
|
2182
|
+
req = build_request(:list_templates, params)
|
2183
|
+
req.send_request(options)
|
2184
|
+
end
|
2185
|
+
|
1996
2186
|
# Deprecated. Use the `ListIdentities` operation to list the email
|
1997
2187
|
# addresses and domains associated with your account.
|
1998
2188
|
#
|
@@ -2040,12 +2230,14 @@ module Aws::SES
|
|
2040
2230
|
#
|
2041
2231
|
# Sending authorization is a feature that enables an identity owner to
|
2042
2232
|
# authorize other senders to use its identities. For information about
|
2043
|
-
# using sending authorization, see the
|
2044
|
-
# href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon
|
2045
|
-
# SES Developer Guide</a>.</i>
|
2233
|
+
# using sending authorization, see the [Amazon SES Developer Guide][1].
|
2046
2234
|
#
|
2047
2235
|
# You can execute this operation no more than once per second.
|
2048
2236
|
#
|
2237
|
+
#
|
2238
|
+
#
|
2239
|
+
# [1]: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
2240
|
+
#
|
2049
2241
|
# @option params [required, String] :identity
|
2050
2242
|
# The identity that the policy will apply to. You can specify an
|
2051
2243
|
# identity by using its name or by using its Amazon Resource Name (ARN).
|
@@ -2108,12 +2300,15 @@ module Aws::SES
|
|
2108
2300
|
#
|
2109
2301
|
# </note>
|
2110
2302
|
#
|
2111
|
-
# For information about managing receipt rule sets, see the
|
2112
|
-
#
|
2113
|
-
# SES Developer Guide</a>.</i>
|
2303
|
+
# For information about managing receipt rule sets, see the [Amazon SES
|
2304
|
+
# Developer Guide][1].
|
2114
2305
|
#
|
2115
2306
|
# You can execute this operation no more than once per second.
|
2116
2307
|
#
|
2308
|
+
#
|
2309
|
+
#
|
2310
|
+
# [1]: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html
|
2311
|
+
#
|
2117
2312
|
# @option params [required, String] :rule_set_name
|
2118
2313
|
# The name of the receipt rule set to reorder.
|
2119
2314
|
#
|
@@ -2161,13 +2356,15 @@ module Aws::SES
|
|
2161
2356
|
#
|
2162
2357
|
# </note>
|
2163
2358
|
#
|
2164
|
-
# For information about receiving email through Amazon SES, see the
|
2165
|
-
#
|
2166
|
-
# href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email.html">Amazon
|
2167
|
-
# SES Developer Guide</a>.</i>
|
2359
|
+
# For information about receiving email through Amazon SES, see the
|
2360
|
+
# [Amazon SES Developer Guide][1].
|
2168
2361
|
#
|
2169
2362
|
# You can execute this operation no more than once per second.
|
2170
2363
|
#
|
2364
|
+
#
|
2365
|
+
#
|
2366
|
+
# [1]: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email.html
|
2367
|
+
#
|
2171
2368
|
# @option params [required, String] :original_message_id
|
2172
2369
|
# The message ID of the message to be bounced.
|
2173
2370
|
#
|
@@ -2258,6 +2455,199 @@ module Aws::SES
|
|
2258
2455
|
req.send_request(options)
|
2259
2456
|
end
|
2260
2457
|
|
2458
|
+
# Composes an email message to multiple destinations. The message body
|
2459
|
+
# is created using an email template.
|
2460
|
+
#
|
2461
|
+
# In order to send email using the `SendBulkTemplatedEmail` operation,
|
2462
|
+
# your call to the API must meet the following requirements:
|
2463
|
+
#
|
2464
|
+
# * The call must refer to an existing email template. You can create
|
2465
|
+
# email templates using the CreateTemplate operation.
|
2466
|
+
#
|
2467
|
+
# * The message must be sent from a verified email address or domain.
|
2468
|
+
#
|
2469
|
+
# * If your account is still in the Amazon SES sandbox, you may only
|
2470
|
+
# send to verified addresses or domains, or to email addresses
|
2471
|
+
# associated with the Amazon SES Mailbox Simulator. For more
|
2472
|
+
# information, see [Verifying Email Addresses and Domains][1] in the
|
2473
|
+
# *Amazon SES Developer Guide.*
|
2474
|
+
#
|
2475
|
+
# * The total size of the message, including attachments, must be less
|
2476
|
+
# than 10 MB.
|
2477
|
+
#
|
2478
|
+
# * Each `Destination` parameter must include at least one recipient
|
2479
|
+
# email address. The recipient address can be a To: address, a CC:
|
2480
|
+
# address, or a BCC: address. If a recipient email address is invalid
|
2481
|
+
# (that is, it is not in the format
|
2482
|
+
# *UserName@\[SubDomain.\]Domain.TopLevelDomain*), the entire message
|
2483
|
+
# will be rejected, even if the message contains other recipients that
|
2484
|
+
# are valid.
|
2485
|
+
#
|
2486
|
+
#
|
2487
|
+
#
|
2488
|
+
# [1]: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html
|
2489
|
+
#
|
2490
|
+
# @option params [required, String] :source
|
2491
|
+
# The email address that is sending the email. This email address must
|
2492
|
+
# be either individually verified with Amazon SES, or from a domain that
|
2493
|
+
# has been verified with Amazon SES. For information about verifying
|
2494
|
+
# identities, see the [Amazon SES Developer Guide][1].
|
2495
|
+
#
|
2496
|
+
# If you are sending on behalf of another user and have been permitted
|
2497
|
+
# to do so by a sending authorization policy, then you must also specify
|
2498
|
+
# the `SourceArn` parameter. For more information about sending
|
2499
|
+
# authorization, see the [Amazon SES Developer Guide][2].
|
2500
|
+
#
|
2501
|
+
# In all cases, the email address must be 7-bit ASCII. If the text must
|
2502
|
+
# contain any other characters, then you must use MIME encoded-word
|
2503
|
+
# syntax (RFC 2047) instead of a literal string. MIME encoded-word
|
2504
|
+
# syntax uses the following form: `=?charset?encoding?encoded-text?=`.
|
2505
|
+
# For more information, see [RFC 2047][3].
|
2506
|
+
#
|
2507
|
+
#
|
2508
|
+
#
|
2509
|
+
# [1]: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html
|
2510
|
+
# [2]: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
2511
|
+
# [3]: https://tools.ietf.org/html/rfc2047
|
2512
|
+
#
|
2513
|
+
# @option params [String] :source_arn
|
2514
|
+
# This parameter is used only for sending authorization. It is the ARN
|
2515
|
+
# of the identity that is associated with the sending authorization
|
2516
|
+
# policy that permits you to send for the email address specified in the
|
2517
|
+
# `Source` parameter.
|
2518
|
+
#
|
2519
|
+
# For example, if the owner of `example.com` (which has ARN
|
2520
|
+
# `arn:aws:ses:us-east-1:123456789012:identity/example.com`) attaches a
|
2521
|
+
# policy to it that authorizes you to send from `user@example.com`, then
|
2522
|
+
# you would specify the `SourceArn` to be
|
2523
|
+
# `arn:aws:ses:us-east-1:123456789012:identity/example.com`, and the
|
2524
|
+
# `Source` to be `user@example.com`.
|
2525
|
+
#
|
2526
|
+
# For more information about sending authorization, see the [Amazon SES
|
2527
|
+
# Developer Guide][1].
|
2528
|
+
#
|
2529
|
+
#
|
2530
|
+
#
|
2531
|
+
# [1]: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
2532
|
+
#
|
2533
|
+
# @option params [Array<String>] :reply_to_addresses
|
2534
|
+
# The reply-to email address(es) for the message. If the recipient
|
2535
|
+
# replies to the message, each reply-to address will receive the reply.
|
2536
|
+
#
|
2537
|
+
# @option params [String] :return_path
|
2538
|
+
# The email address that bounces and complaints will be forwarded to
|
2539
|
+
# when feedback forwarding is enabled. If the message cannot be
|
2540
|
+
# delivered to the recipient, then an error message will be returned
|
2541
|
+
# from the recipient's ISP; this message will then be forwarded to the
|
2542
|
+
# email address specified by the `ReturnPath` parameter. The
|
2543
|
+
# `ReturnPath` parameter is never overwritten. This email address must
|
2544
|
+
# be either individually verified with Amazon SES, or from a domain that
|
2545
|
+
# has been verified with Amazon SES.
|
2546
|
+
#
|
2547
|
+
# @option params [String] :return_path_arn
|
2548
|
+
# This parameter is used only for sending authorization. It is the ARN
|
2549
|
+
# of the identity that is associated with the sending authorization
|
2550
|
+
# policy that permits you to use the email address specified in the
|
2551
|
+
# `ReturnPath` parameter.
|
2552
|
+
#
|
2553
|
+
# For example, if the owner of `example.com` (which has ARN
|
2554
|
+
# `arn:aws:ses:us-east-1:123456789012:identity/example.com`) attaches a
|
2555
|
+
# policy to it that authorizes you to use `feedback@example.com`, then
|
2556
|
+
# you would specify the `ReturnPathArn` to be
|
2557
|
+
# `arn:aws:ses:us-east-1:123456789012:identity/example.com`, and the
|
2558
|
+
# `ReturnPath` to be `feedback@example.com`.
|
2559
|
+
#
|
2560
|
+
# For more information about sending authorization, see the [Amazon SES
|
2561
|
+
# Developer Guide][1].
|
2562
|
+
#
|
2563
|
+
#
|
2564
|
+
#
|
2565
|
+
# [1]: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
2566
|
+
#
|
2567
|
+
# @option params [String] :configuration_set_name
|
2568
|
+
# The name of the configuration set to use when you send an email using
|
2569
|
+
# `SendBulkTemplatedEmail`.
|
2570
|
+
#
|
2571
|
+
# @option params [Array<Types::MessageTag>] :default_tags
|
2572
|
+
# A list of tags, in the form of name/value pairs, to apply to an email
|
2573
|
+
# that you send to a destination using `SendBulkTemplatedEmail`.
|
2574
|
+
#
|
2575
|
+
# @option params [required, String] :template
|
2576
|
+
# The template to use when sending this email.
|
2577
|
+
#
|
2578
|
+
# @option params [String] :template_arn
|
2579
|
+
# The ARN of the template to use when sending this email.
|
2580
|
+
#
|
2581
|
+
# @option params [String] :default_template_data
|
2582
|
+
# A list of replacement values to apply to the template when replacement
|
2583
|
+
# data is not specified in a Destination object. These values act as a
|
2584
|
+
# default or fallback option when no other data is available.
|
2585
|
+
#
|
2586
|
+
# The template data is a JSON object, typically consisting of key-value
|
2587
|
+
# pairs in which the keys correspond to replacement tags in the email
|
2588
|
+
# template.
|
2589
|
+
#
|
2590
|
+
# @option params [required, Array<Types::BulkEmailDestination>] :destinations
|
2591
|
+
# One or more `Destination` objects. All of the recipients in a
|
2592
|
+
# `Destination` will receive the same version of the email. You can
|
2593
|
+
# specify up to 50 `Destination` objects within a `Destinations` array.
|
2594
|
+
#
|
2595
|
+
# @return [Types::SendBulkTemplatedEmailResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2596
|
+
#
|
2597
|
+
# * {Types::SendBulkTemplatedEmailResponse#status #status} => Array<Types::BulkEmailDestinationStatus>
|
2598
|
+
#
|
2599
|
+
# @example Request syntax with placeholder values
|
2600
|
+
#
|
2601
|
+
# resp = client.send_bulk_templated_email({
|
2602
|
+
# source: "Address", # required
|
2603
|
+
# source_arn: "AmazonResourceName",
|
2604
|
+
# reply_to_addresses: ["Address"],
|
2605
|
+
# return_path: "Address",
|
2606
|
+
# return_path_arn: "AmazonResourceName",
|
2607
|
+
# configuration_set_name: "ConfigurationSetName",
|
2608
|
+
# default_tags: [
|
2609
|
+
# {
|
2610
|
+
# name: "MessageTagName", # required
|
2611
|
+
# value: "MessageTagValue", # required
|
2612
|
+
# },
|
2613
|
+
# ],
|
2614
|
+
# template: "TemplateName", # required
|
2615
|
+
# template_arn: "AmazonResourceName",
|
2616
|
+
# default_template_data: "TemplateData",
|
2617
|
+
# destinations: [ # required
|
2618
|
+
# {
|
2619
|
+
# destination: { # required
|
2620
|
+
# to_addresses: ["Address"],
|
2621
|
+
# cc_addresses: ["Address"],
|
2622
|
+
# bcc_addresses: ["Address"],
|
2623
|
+
# },
|
2624
|
+
# replacement_tags: [
|
2625
|
+
# {
|
2626
|
+
# name: "MessageTagName", # required
|
2627
|
+
# value: "MessageTagValue", # required
|
2628
|
+
# },
|
2629
|
+
# ],
|
2630
|
+
# replacement_template_data: "TemplateData",
|
2631
|
+
# },
|
2632
|
+
# ],
|
2633
|
+
# })
|
2634
|
+
#
|
2635
|
+
# @example Response structure
|
2636
|
+
#
|
2637
|
+
# resp.status #=> Array
|
2638
|
+
# resp.status[0].status #=> String, one of "Success", "MessageRejected", "MailFromDomainNotVerified", "ConfigurationSetDoesNotExist", "TemplateDoesNotExist", "AccountSuspended", "AccountThrottled", "AccountDailyQuotaExceeded", "InvalidSendingPoolName", "InvalidParameterValue", "TransientFailure", "Failed"
|
2639
|
+
# resp.status[0].error #=> String
|
2640
|
+
# resp.status[0].message_id #=> String
|
2641
|
+
#
|
2642
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/SendBulkTemplatedEmail AWS API Documentation
|
2643
|
+
#
|
2644
|
+
# @overload send_bulk_templated_email(params = {})
|
2645
|
+
# @param [Hash] params ({})
|
2646
|
+
def send_bulk_templated_email(params = {}, options = {})
|
2647
|
+
req = build_request(:send_bulk_templated_email, params)
|
2648
|
+
req.send_request(options)
|
2649
|
+
end
|
2650
|
+
|
2261
2651
|
# Composes an email message and immediately queues it for sending. In
|
2262
2652
|
# order to send email using the `SendEmail` operation, your message must
|
2263
2653
|
# meet the following requirements:
|
@@ -2271,7 +2661,7 @@ module Aws::SES
|
|
2271
2661
|
# send to verified addresses or domains, or to email addresses
|
2272
2662
|
# associated with the Amazon SES Mailbox Simulator. For more
|
2273
2663
|
# information, see [Verifying Email Addresses and Domains][1] in the
|
2274
|
-
# *Amazon SES Developer Guide
|
2664
|
+
# *Amazon SES Developer Guide.*
|
2275
2665
|
#
|
2276
2666
|
# * The total size of the message, including attachments, must be
|
2277
2667
|
# smaller than 10 MB.
|
@@ -2294,7 +2684,7 @@ module Aws::SES
|
|
2294
2684
|
# against the maximum number of emails you can send in a 24-hour period
|
2295
2685
|
# (your *sending quota*). For more information about sending quotas in
|
2296
2686
|
# Amazon SES, see [Managing Your Amazon SES Sending Limits][2] in the
|
2297
|
-
# *Amazon SES Developer Guide
|
2687
|
+
# *Amazon SES Developer Guide.*
|
2298
2688
|
#
|
2299
2689
|
#
|
2300
2690
|
#
|
@@ -2513,7 +2903,7 @@ module Aws::SES
|
|
2513
2903
|
# send to verified addresses or domains, or to email addresses
|
2514
2904
|
# associated with the Amazon SES Mailbox Simulator. For more
|
2515
2905
|
# information, see [Verifying Email Addresses and Domains][1] in the
|
2516
|
-
# *Amazon SES Developer Guide
|
2906
|
+
# *Amazon SES Developer Guide.*
|
2517
2907
|
#
|
2518
2908
|
# * The total size of the message, including attachments, must be
|
2519
2909
|
# smaller than 10 MB.
|
@@ -2536,7 +2926,7 @@ module Aws::SES
|
|
2536
2926
|
# against the maximum number of emails you can send in a 24-hour period
|
2537
2927
|
# (your *sending quota*). For more information about sending quotas in
|
2538
2928
|
# Amazon SES, see [Managing Your Amazon SES Sending Limits][2] in the
|
2539
|
-
# *Amazon SES Developer Guide
|
2929
|
+
# *Amazon SES Developer Guide.*
|
2540
2930
|
#
|
2541
2931
|
# Additionally, keep the following considerations in mind when using the
|
2542
2932
|
# `SendRawEmail` operation:
|
@@ -2570,7 +2960,7 @@ module Aws::SES
|
|
2570
2960
|
# From and Return Path addresses to the identity specified in
|
2571
2961
|
# `SourceIdentityArn`. For more information about sending
|
2572
2962
|
# authorization, see the [Using Sending Authorization with Amazon
|
2573
|
-
# SES][3] in the *Amazon SES Developer Guide
|
2963
|
+
# SES][3] in the *Amazon SES Developer Guide.*
|
2574
2964
|
#
|
2575
2965
|
#
|
2576
2966
|
#
|
@@ -2773,6 +3163,189 @@ module Aws::SES
|
|
2773
3163
|
req.send_request(options)
|
2774
3164
|
end
|
2775
3165
|
|
3166
|
+
# Composes an email message using an email template and immediately
|
3167
|
+
# queues it for sending.
|
3168
|
+
#
|
3169
|
+
# In order to send email using the `SendTemplatedEmail` operation, your
|
3170
|
+
# call to the API must meet the following requirements:
|
3171
|
+
#
|
3172
|
+
# * The call must refer to an existing email template. You can create
|
3173
|
+
# email templates using the CreateTemplate operation.
|
3174
|
+
#
|
3175
|
+
# * The message must be sent from a verified email address or domain.
|
3176
|
+
#
|
3177
|
+
# * If your account is still in the Amazon SES sandbox, you may only
|
3178
|
+
# send to verified addresses or domains, or to email addresses
|
3179
|
+
# associated with the Amazon SES Mailbox Simulator. For more
|
3180
|
+
# information, see [Verifying Email Addresses and Domains][1] in the
|
3181
|
+
# *Amazon SES Developer Guide.*
|
3182
|
+
#
|
3183
|
+
# * The total size of the message, including attachments, must be less
|
3184
|
+
# than 10 MB.
|
3185
|
+
#
|
3186
|
+
# * Calls to the `SendTemplatedEmail` operation may only include one
|
3187
|
+
# `Destination` parameter. A destination is a set of recipients who
|
3188
|
+
# will receive the same version of the email. The `Destination`
|
3189
|
+
# parameter can include up to 50 recipients, across the To:, CC: and
|
3190
|
+
# BCC: fields.
|
3191
|
+
#
|
3192
|
+
# * The `Destination` parameter must include at least one recipient
|
3193
|
+
# email address. The recipient address can be a To: address, a CC:
|
3194
|
+
# address, or a BCC: address. If a recipient email address is invalid
|
3195
|
+
# (that is, it is not in the format
|
3196
|
+
# *UserName@\[SubDomain.\]Domain.TopLevelDomain*), the entire message
|
3197
|
+
# will be rejected, even if the message contains other recipients that
|
3198
|
+
# are valid.
|
3199
|
+
#
|
3200
|
+
#
|
3201
|
+
#
|
3202
|
+
# [1]: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html
|
3203
|
+
#
|
3204
|
+
# @option params [required, String] :source
|
3205
|
+
# The email address that is sending the email. This email address must
|
3206
|
+
# be either individually verified with Amazon SES, or from a domain that
|
3207
|
+
# has been verified with Amazon SES. For information about verifying
|
3208
|
+
# identities, see the [Amazon SES Developer Guide][1].
|
3209
|
+
#
|
3210
|
+
# If you are sending on behalf of another user and have been permitted
|
3211
|
+
# to do so by a sending authorization policy, then you must also specify
|
3212
|
+
# the `SourceArn` parameter. For more information about sending
|
3213
|
+
# authorization, see the [Amazon SES Developer Guide][2].
|
3214
|
+
#
|
3215
|
+
# In all cases, the email address must be 7-bit ASCII. If the text must
|
3216
|
+
# contain any other characters, then you must use MIME encoded-word
|
3217
|
+
# syntax (RFC 2047) instead of a literal string. MIME encoded-word
|
3218
|
+
# syntax uses the following form: `=?charset?encoding?encoded-text?=`.
|
3219
|
+
# For more information, see [RFC 2047][3].
|
3220
|
+
#
|
3221
|
+
#
|
3222
|
+
#
|
3223
|
+
# [1]: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html
|
3224
|
+
# [2]: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
3225
|
+
# [3]: https://tools.ietf.org/html/rfc2047
|
3226
|
+
#
|
3227
|
+
# @option params [required, Types::Destination] :destination
|
3228
|
+
# The destination for this email, composed of To:, CC:, and BCC: fields.
|
3229
|
+
# A Destination can include up to 50 recipients across these three
|
3230
|
+
# fields.
|
3231
|
+
#
|
3232
|
+
# @option params [Array<String>] :reply_to_addresses
|
3233
|
+
# The reply-to email address(es) for the message. If the recipient
|
3234
|
+
# replies to the message, each reply-to address will receive the reply.
|
3235
|
+
#
|
3236
|
+
# @option params [String] :return_path
|
3237
|
+
# The email address that bounces and complaints will be forwarded to
|
3238
|
+
# when feedback forwarding is enabled. If the message cannot be
|
3239
|
+
# delivered to the recipient, then an error message will be returned
|
3240
|
+
# from the recipient's ISP; this message will then be forwarded to the
|
3241
|
+
# email address specified by the `ReturnPath` parameter. The
|
3242
|
+
# `ReturnPath` parameter is never overwritten. This email address must
|
3243
|
+
# be either individually verified with Amazon SES, or from a domain that
|
3244
|
+
# has been verified with Amazon SES.
|
3245
|
+
#
|
3246
|
+
# @option params [String] :source_arn
|
3247
|
+
# This parameter is used only for sending authorization. It is the ARN
|
3248
|
+
# of the identity that is associated with the sending authorization
|
3249
|
+
# policy that permits you to send for the email address specified in the
|
3250
|
+
# `Source` parameter.
|
3251
|
+
#
|
3252
|
+
# For example, if the owner of `example.com` (which has ARN
|
3253
|
+
# `arn:aws:ses:us-east-1:123456789012:identity/example.com`) attaches a
|
3254
|
+
# policy to it that authorizes you to send from `user@example.com`, then
|
3255
|
+
# you would specify the `SourceArn` to be
|
3256
|
+
# `arn:aws:ses:us-east-1:123456789012:identity/example.com`, and the
|
3257
|
+
# `Source` to be `user@example.com`.
|
3258
|
+
#
|
3259
|
+
# For more information about sending authorization, see the [Amazon SES
|
3260
|
+
# Developer Guide][1].
|
3261
|
+
#
|
3262
|
+
#
|
3263
|
+
#
|
3264
|
+
# [1]: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
3265
|
+
#
|
3266
|
+
# @option params [String] :return_path_arn
|
3267
|
+
# This parameter is used only for sending authorization. It is the ARN
|
3268
|
+
# of the identity that is associated with the sending authorization
|
3269
|
+
# policy that permits you to use the email address specified in the
|
3270
|
+
# `ReturnPath` parameter.
|
3271
|
+
#
|
3272
|
+
# For example, if the owner of `example.com` (which has ARN
|
3273
|
+
# `arn:aws:ses:us-east-1:123456789012:identity/example.com`) attaches a
|
3274
|
+
# policy to it that authorizes you to use `feedback@example.com`, then
|
3275
|
+
# you would specify the `ReturnPathArn` to be
|
3276
|
+
# `arn:aws:ses:us-east-1:123456789012:identity/example.com`, and the
|
3277
|
+
# `ReturnPath` to be `feedback@example.com`.
|
3278
|
+
#
|
3279
|
+
# For more information about sending authorization, see the [Amazon SES
|
3280
|
+
# Developer Guide][1].
|
3281
|
+
#
|
3282
|
+
#
|
3283
|
+
#
|
3284
|
+
# [1]: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
3285
|
+
#
|
3286
|
+
# @option params [Array<Types::MessageTag>] :tags
|
3287
|
+
# A list of tags, in the form of name/value pairs, to apply to an email
|
3288
|
+
# that you send using `SendTemplatedEmail`. Tags correspond to
|
3289
|
+
# characteristics of the email that you define, so that you can publish
|
3290
|
+
# email sending events.
|
3291
|
+
#
|
3292
|
+
# @option params [String] :configuration_set_name
|
3293
|
+
# The name of the configuration set to use when you send an email using
|
3294
|
+
# `SendTemplatedEmail`.
|
3295
|
+
#
|
3296
|
+
# @option params [required, String] :template
|
3297
|
+
# The template to use when sending this email.
|
3298
|
+
#
|
3299
|
+
# @option params [String] :template_arn
|
3300
|
+
# The ARN of the template to use when sending this email.
|
3301
|
+
#
|
3302
|
+
# @option params [required, String] :template_data
|
3303
|
+
# A list of replacement values to apply to the template. This parameter
|
3304
|
+
# is a JSON object, typically consisting of key-value pairs in which the
|
3305
|
+
# keys correspond to replacement tags in the email template.
|
3306
|
+
#
|
3307
|
+
# @return [Types::SendTemplatedEmailResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3308
|
+
#
|
3309
|
+
# * {Types::SendTemplatedEmailResponse#message_id #message_id} => String
|
3310
|
+
#
|
3311
|
+
# @example Request syntax with placeholder values
|
3312
|
+
#
|
3313
|
+
# resp = client.send_templated_email({
|
3314
|
+
# source: "Address", # required
|
3315
|
+
# destination: { # required
|
3316
|
+
# to_addresses: ["Address"],
|
3317
|
+
# cc_addresses: ["Address"],
|
3318
|
+
# bcc_addresses: ["Address"],
|
3319
|
+
# },
|
3320
|
+
# reply_to_addresses: ["Address"],
|
3321
|
+
# return_path: "Address",
|
3322
|
+
# source_arn: "AmazonResourceName",
|
3323
|
+
# return_path_arn: "AmazonResourceName",
|
3324
|
+
# tags: [
|
3325
|
+
# {
|
3326
|
+
# name: "MessageTagName", # required
|
3327
|
+
# value: "MessageTagValue", # required
|
3328
|
+
# },
|
3329
|
+
# ],
|
3330
|
+
# configuration_set_name: "ConfigurationSetName",
|
3331
|
+
# template: "TemplateName", # required
|
3332
|
+
# template_arn: "AmazonResourceName",
|
3333
|
+
# template_data: "TemplateData", # required
|
3334
|
+
# })
|
3335
|
+
#
|
3336
|
+
# @example Response structure
|
3337
|
+
#
|
3338
|
+
# resp.message_id #=> String
|
3339
|
+
#
|
3340
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/SendTemplatedEmail AWS API Documentation
|
3341
|
+
#
|
3342
|
+
# @overload send_templated_email(params = {})
|
3343
|
+
# @param [Hash] params ({})
|
3344
|
+
def send_templated_email(params = {}, options = {})
|
3345
|
+
req = build_request(:send_templated_email, params)
|
3346
|
+
req.send_request(options)
|
3347
|
+
end
|
3348
|
+
|
2776
3349
|
# Sets the specified receipt rule set as the active receipt rule set.
|
2777
3350
|
#
|
2778
3351
|
# <note markdown="1"> To disable your email-receiving through Amazon SES completely, you can
|
@@ -2780,12 +3353,15 @@ module Aws::SES
|
|
2780
3353
|
#
|
2781
3354
|
# </note>
|
2782
3355
|
#
|
2783
|
-
# For information about managing receipt rule sets, see the
|
2784
|
-
#
|
2785
|
-
# SES Developer Guide</a>.</i>
|
3356
|
+
# For information about managing receipt rule sets, see the [Amazon SES
|
3357
|
+
# Developer Guide][1].
|
2786
3358
|
#
|
2787
3359
|
# You can execute this operation no more than once per second.
|
2788
3360
|
#
|
3361
|
+
#
|
3362
|
+
#
|
3363
|
+
# [1]: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html
|
3364
|
+
#
|
2789
3365
|
# @option params [String] :rule_set_name
|
2790
3366
|
# The name of the receipt rule set to make active. Setting this value to
|
2791
3367
|
# null disables all email receiving.
|
@@ -2832,9 +3408,12 @@ module Aws::SES
|
|
2832
3408
|
#
|
2833
3409
|
# You can execute this operation no more than once per second.
|
2834
3410
|
#
|
2835
|
-
# For more information about Easy DKIM signing, go to the
|
2836
|
-
#
|
2837
|
-
#
|
3411
|
+
# For more information about Easy DKIM signing, go to the [Amazon SES
|
3412
|
+
# Developer Guide][1].
|
3413
|
+
#
|
3414
|
+
#
|
3415
|
+
#
|
3416
|
+
# [1]: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html
|
2838
3417
|
#
|
2839
3418
|
# @option params [required, String] :identity
|
2840
3419
|
# The identity for which DKIM signing should be enabled or disabled.
|
@@ -2885,9 +3464,11 @@ module Aws::SES
|
|
2885
3464
|
# You can execute this operation no more than once per second.
|
2886
3465
|
#
|
2887
3466
|
# For more information about using notifications with Amazon SES, see
|
2888
|
-
# the
|
2889
|
-
#
|
2890
|
-
#
|
3467
|
+
# the [Amazon SES Developer Guide][1].
|
3468
|
+
#
|
3469
|
+
#
|
3470
|
+
#
|
3471
|
+
# [1]: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications.html
|
2891
3472
|
#
|
2892
3473
|
# @option params [required, String] :identity
|
2893
3474
|
# The identity for which to set bounce and complaint notification
|
@@ -2938,9 +3519,11 @@ module Aws::SES
|
|
2938
3519
|
# You can execute this operation no more than once per second.
|
2939
3520
|
#
|
2940
3521
|
# For more information about using notifications with Amazon SES, see
|
2941
|
-
# the
|
2942
|
-
#
|
2943
|
-
#
|
3522
|
+
# the [Amazon SES Developer Guide][1].
|
3523
|
+
#
|
3524
|
+
#
|
3525
|
+
#
|
3526
|
+
# [1]: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications.html
|
2944
3527
|
#
|
2945
3528
|
# @option params [required, String] :identity
|
2946
3529
|
# The identity for which to enable or disable headers in notifications.
|
@@ -2997,12 +3580,15 @@ module Aws::SES
|
|
2997
3580
|
# To send emails using the specified MAIL FROM domain, you must add an
|
2998
3581
|
# MX record to your MAIL FROM domain's DNS settings. If you want your
|
2999
3582
|
# emails to pass Sender Policy Framework (SPF) checks, you must also add
|
3000
|
-
# or update an SPF record. For more information, see the
|
3001
|
-
#
|
3002
|
-
# SES Developer Guide</a>.</i>
|
3583
|
+
# or update an SPF record. For more information, see the [Amazon SES
|
3584
|
+
# Developer Guide][1].
|
3003
3585
|
#
|
3004
3586
|
# You can execute this operation no more than once per second.
|
3005
3587
|
#
|
3588
|
+
#
|
3589
|
+
#
|
3590
|
+
# [1]: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/mail-from-set.html
|
3591
|
+
#
|
3006
3592
|
# @option params [required, String] :identity
|
3007
3593
|
# The verified identity for which you want to enable or disable the
|
3008
3594
|
# specified custom MAIL FROM domain.
|
@@ -3075,9 +3661,12 @@ module Aws::SES
|
|
3075
3661
|
#
|
3076
3662
|
# You can execute this operation no more than once per second.
|
3077
3663
|
#
|
3078
|
-
# For more information about feedback notification, see the
|
3079
|
-
#
|
3080
|
-
#
|
3664
|
+
# For more information about feedback notification, see the [Amazon SES
|
3665
|
+
# Developer Guide][1].
|
3666
|
+
#
|
3667
|
+
#
|
3668
|
+
#
|
3669
|
+
# [1]: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications.html
|
3081
3670
|
#
|
3082
3671
|
# @option params [required, String] :identity
|
3083
3672
|
# The identity for which the Amazon SNS topic will be set. You can
|
@@ -3128,12 +3717,15 @@ module Aws::SES
|
|
3128
3717
|
# Sets the position of the specified receipt rule in the receipt rule
|
3129
3718
|
# set.
|
3130
3719
|
#
|
3131
|
-
# For information about managing receipt rules, see the
|
3132
|
-
#
|
3133
|
-
# SES Developer Guide</a>.</i>
|
3720
|
+
# For information about managing receipt rules, see the [Amazon SES
|
3721
|
+
# Developer Guide][1].
|
3134
3722
|
#
|
3135
3723
|
# You can execute this operation no more than once per second.
|
3136
3724
|
#
|
3725
|
+
#
|
3726
|
+
#
|
3727
|
+
# [1]: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rules.html
|
3728
|
+
#
|
3137
3729
|
# @option params [required, String] :rule_set_name
|
3138
3730
|
# The name of the receipt rule set that contains the receipt rule to
|
3139
3731
|
# reposition.
|
@@ -3175,12 +3767,49 @@ module Aws::SES
|
|
3175
3767
|
req.send_request(options)
|
3176
3768
|
end
|
3177
3769
|
|
3770
|
+
# Creates a preview of the MIME content of an email when provided with a
|
3771
|
+
# template and a set of replacement data.
|
3772
|
+
#
|
3773
|
+
# You can execute this operation no more than once per second.
|
3774
|
+
#
|
3775
|
+
# @option params [required, String] :template_name
|
3776
|
+
# The name of the template that you want to render.
|
3777
|
+
#
|
3778
|
+
# @option params [required, String] :template_data
|
3779
|
+
# A list of replacement values to apply to the template. This parameter
|
3780
|
+
# is a JSON object, typically consisting of key-value pairs in which the
|
3781
|
+
# keys correspond to replacement tags in the email template.
|
3782
|
+
#
|
3783
|
+
# @return [Types::TestRenderTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3784
|
+
#
|
3785
|
+
# * {Types::TestRenderTemplateResponse#rendered_template #rendered_template} => String
|
3786
|
+
#
|
3787
|
+
# @example Request syntax with placeholder values
|
3788
|
+
#
|
3789
|
+
# resp = client.test_render_template({
|
3790
|
+
# template_name: "TemplateName", # required
|
3791
|
+
# template_data: "TemplateData", # required
|
3792
|
+
# })
|
3793
|
+
#
|
3794
|
+
# @example Response structure
|
3795
|
+
#
|
3796
|
+
# resp.rendered_template #=> String
|
3797
|
+
#
|
3798
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/TestRenderTemplate AWS API Documentation
|
3799
|
+
#
|
3800
|
+
# @overload test_render_template(params = {})
|
3801
|
+
# @param [Hash] params ({})
|
3802
|
+
def test_render_template(params = {}, options = {})
|
3803
|
+
req = build_request(:test_render_template, params)
|
3804
|
+
req.send_request(options)
|
3805
|
+
end
|
3806
|
+
|
3178
3807
|
# Updates the event destination of a configuration set. Event
|
3179
3808
|
# destinations are associated with configuration sets, which enable you
|
3180
3809
|
# to publish email sending events to Amazon CloudWatch, Amazon Kinesis
|
3181
3810
|
# Firehose, or Amazon Simple Notification Service (Amazon SNS). For
|
3182
3811
|
# information about using configuration sets, see [Monitoring Your
|
3183
|
-
# Amazon SES Sending Activity][1] in the *Amazon SES Developer Guide
|
3812
|
+
# Amazon SES Sending Activity][1] in the *Amazon SES Developer Guide.*
|
3184
3813
|
#
|
3185
3814
|
# <note markdown="1"> When you create or update an event destination, you must provide one,
|
3186
3815
|
# and only one, destination. The destination can be Amazon CloudWatch,
|
@@ -3212,7 +3841,7 @@ module Aws::SES
|
|
3212
3841
|
# event_destination: { # required
|
3213
3842
|
# name: "EventDestinationName", # required
|
3214
3843
|
# enabled: false,
|
3215
|
-
# matching_event_types: ["send"], # required, accepts send, reject, bounce, complaint, delivery, open, click
|
3844
|
+
# matching_event_types: ["send"], # required, accepts send, reject, bounce, complaint, delivery, open, click, renderingFailure
|
3216
3845
|
# kinesis_firehose_destination: {
|
3217
3846
|
# iam_role_arn: "AmazonResourceName", # required
|
3218
3847
|
# delivery_stream_arn: "AmazonResourceName", # required
|
@@ -3246,16 +3875,14 @@ module Aws::SES
|
|
3246
3875
|
#
|
3247
3876
|
# By default, images and links used for tracking open and click events
|
3248
3877
|
# are hosted on domains operated by Amazon SES. You can configure a
|
3249
|
-
# subdomain of your own to handle these events
|
3250
|
-
#
|
3251
|
-
#
|
3252
|
-
# Click Tracking][1] in the <i> <a
|
3253
|
-
# href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/Welcome.html">Amazon
|
3254
|
-
# SES Developer Guide</a>.</i>
|
3878
|
+
# subdomain of your own to handle these events. For information about
|
3879
|
+
# using configuration sets, see [Configuring Custom Domains to Handle
|
3880
|
+
# Open and Click Tracking][1] in the [Amazon SES Developer Guide][2].
|
3255
3881
|
#
|
3256
3882
|
#
|
3257
3883
|
#
|
3258
3884
|
# [1]: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/configure-custom-open-click-domains.html
|
3885
|
+
# [2]: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/Welcome.html
|
3259
3886
|
#
|
3260
3887
|
# @option params [required, String] :configuration_set_name
|
3261
3888
|
# The name of the configuration set for which you want to update the
|
@@ -3267,13 +3894,12 @@ module Aws::SES
|
|
3267
3894
|
# generated by Amazon SES emails.
|
3268
3895
|
#
|
3269
3896
|
# For more information, see [Configuring Custom Domains to Handle Open
|
3270
|
-
# and Click Tracking][1] in the
|
3271
|
-
# href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide/Welcome.html">Amazon
|
3272
|
-
# SES Developer Guide</a>.</i>
|
3897
|
+
# and Click Tracking][1] in the [Amazon SES Developer Guide][2].
|
3273
3898
|
#
|
3274
3899
|
#
|
3275
3900
|
#
|
3276
3901
|
# [1]: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/configure-custom-open-click-domains.html
|
3902
|
+
# [2]: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/Welcome.html
|
3277
3903
|
#
|
3278
3904
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3279
3905
|
#
|
@@ -3297,12 +3923,15 @@ module Aws::SES
|
|
3297
3923
|
|
3298
3924
|
# Updates a receipt rule.
|
3299
3925
|
#
|
3300
|
-
# For information about managing receipt rules, see the
|
3301
|
-
#
|
3302
|
-
# SES Developer Guide</a>.</i>
|
3926
|
+
# For information about managing receipt rules, see the [Amazon SES
|
3927
|
+
# Developer Guide][1].
|
3303
3928
|
#
|
3304
3929
|
# You can execute this operation no more than once per second.
|
3305
3930
|
#
|
3931
|
+
#
|
3932
|
+
#
|
3933
|
+
# [1]: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rules.html
|
3934
|
+
#
|
3306
3935
|
# @option params [required, String] :rule_set_name
|
3307
3936
|
# The name of the receipt rule set that the receipt rule belongs to.
|
3308
3937
|
#
|
@@ -3394,6 +4023,43 @@ module Aws::SES
|
|
3394
4023
|
req.send_request(options)
|
3395
4024
|
end
|
3396
4025
|
|
4026
|
+
# Updates an email template. Email templates enable you to send
|
4027
|
+
# personalized email to one or more destinations in a single API
|
4028
|
+
# operation. For more information, see the [Amazon SES Developer
|
4029
|
+
# Guide][1].
|
4030
|
+
#
|
4031
|
+
# You can execute this operation no more than once per second.
|
4032
|
+
#
|
4033
|
+
#
|
4034
|
+
#
|
4035
|
+
# [1]: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html
|
4036
|
+
#
|
4037
|
+
# @option params [required, Types::Template] :template
|
4038
|
+
# The content of the email, composed of a subject line, an HTML part,
|
4039
|
+
# and a text-only part.
|
4040
|
+
#
|
4041
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4042
|
+
#
|
4043
|
+
# @example Request syntax with placeholder values
|
4044
|
+
#
|
4045
|
+
# resp = client.update_template({
|
4046
|
+
# template: { # required
|
4047
|
+
# template_name: "TemplateName", # required
|
4048
|
+
# subject_part: "SubjectPart",
|
4049
|
+
# text_part: "TextPart",
|
4050
|
+
# html_part: "HtmlPart",
|
4051
|
+
# },
|
4052
|
+
# })
|
4053
|
+
#
|
4054
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/UpdateTemplate AWS API Documentation
|
4055
|
+
#
|
4056
|
+
# @overload update_template(params = {})
|
4057
|
+
# @param [Hash] params ({})
|
4058
|
+
def update_template(params = {}, options = {})
|
4059
|
+
req = build_request(:update_template, params)
|
4060
|
+
req.send_request(options)
|
4061
|
+
end
|
4062
|
+
|
3397
4063
|
# Returns a set of DKIM tokens for a domain. DKIM *tokens* are character
|
3398
4064
|
# strings that represent your domain's identity. Using these tokens,
|
3399
4065
|
# you will need to create DNS CNAME records that point to DKIM public
|
@@ -3408,9 +4074,11 @@ module Aws::SES
|
|
3408
4074
|
# `SetIdentityDkimEnabled` operation.
|
3409
4075
|
#
|
3410
4076
|
# For more information about creating DNS records using DKIM tokens, go
|
3411
|
-
# to the
|
3412
|
-
#
|
3413
|
-
#
|
4077
|
+
# to the [Amazon SES Developer Guide][1].
|
4078
|
+
#
|
4079
|
+
#
|
4080
|
+
#
|
4081
|
+
# [1]: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim-dns-records.html
|
3414
4082
|
#
|
3415
4083
|
# @option params [required, String] :domain
|
3416
4084
|
# The name of the domain to be verified for Easy DKIM signing.
|
@@ -3460,7 +4128,7 @@ module Aws::SES
|
|
3460
4128
|
# Adds a domain to the list of identities for your Amazon SES account
|
3461
4129
|
# and attempts to verify it. For more information about verifying
|
3462
4130
|
# domains, see [Verifying Email Addresses and Domains][1] in the *Amazon
|
3463
|
-
# SES Developer Guide
|
4131
|
+
# SES Developer Guide.*
|
3464
4132
|
#
|
3465
4133
|
# You can execute this operation no more than once per second.
|
3466
4134
|
#
|
@@ -3588,7 +4256,7 @@ module Aws::SES
|
|
3588
4256
|
params: params,
|
3589
4257
|
config: config)
|
3590
4258
|
context[:gem_name] = 'aws-sdk-ses'
|
3591
|
-
context[:gem_version] = '1.
|
4259
|
+
context[:gem_version] = '1.3.0'
|
3592
4260
|
Seahorse::Client::Request.new(handlers, context)
|
3593
4261
|
end
|
3594
4262
|
|