aws-sdk-sesv2 1.8.0 → 1.9.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-sesv2.rb +1 -1
- data/lib/aws-sdk-sesv2/client.rb +1014 -10
- data/lib/aws-sdk-sesv2/client_api.rb +507 -5
- data/lib/aws-sdk-sesv2/errors.rb +11 -0
- data/lib/aws-sdk-sesv2/types.rb +1556 -38
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 769519b2cd68b9c9f42d3d9c7d89f4ac5446539bf4db8756e7938e950a2140c9
|
4
|
+
data.tar.gz: a984786077a2f8f9faca256098e1348347e656878d64abc4ab46b5e1445320f6
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: fa3baf68d307164174bed645a86f26c11546f0eeea0c8f703ff809ee67705346d07aab81e2842da2db17a35870ff86487e753aeb68aaddb112b28795d7b29c45
|
7
|
+
data.tar.gz: bdcf3ce4ceec146ab4ea831c2099c516d76fc3610a4f57f6257a555b7439f2d17cd1d05cc3a2a8e5d58e8152ff05104e98f74202f4e1c47e71f713005ea8ac57
|
data/lib/aws-sdk-sesv2.rb
CHANGED
data/lib/aws-sdk-sesv2/client.rb
CHANGED
@@ -449,6 +449,67 @@ module Aws::SESV2
|
|
449
449
|
req.send_request(options)
|
450
450
|
end
|
451
451
|
|
452
|
+
# Creates a new custom verification email template.
|
453
|
+
#
|
454
|
+
# For more information about custom verification email templates, see
|
455
|
+
# [Using Custom Verification Email Templates][1] in the *Amazon SES
|
456
|
+
# Developer Guide*.
|
457
|
+
#
|
458
|
+
# You can execute this operation no more than once per second.
|
459
|
+
#
|
460
|
+
#
|
461
|
+
#
|
462
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-verify-address-custom.html
|
463
|
+
#
|
464
|
+
# @option params [required, String] :template_name
|
465
|
+
# The name of the custom verification email template.
|
466
|
+
#
|
467
|
+
# @option params [required, String] :from_email_address
|
468
|
+
# The email address that the custom verification email is sent from.
|
469
|
+
#
|
470
|
+
# @option params [required, String] :template_subject
|
471
|
+
# The subject line of the custom verification email.
|
472
|
+
#
|
473
|
+
# @option params [required, String] :template_content
|
474
|
+
# The content of the custom verification email. The total size of the
|
475
|
+
# email must be less than 10 MB. The message body may contain HTML, with
|
476
|
+
# some limitations. For more information, see [Custom Verification Email
|
477
|
+
# Frequently Asked Questions][1] in the *Amazon SES Developer Guide*.
|
478
|
+
#
|
479
|
+
#
|
480
|
+
#
|
481
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-verify-address-custom.html#custom-verification-emails-faq
|
482
|
+
#
|
483
|
+
# @option params [required, String] :success_redirection_url
|
484
|
+
# The URL that the recipient of the verification email is sent to if his
|
485
|
+
# or her address is successfully verified.
|
486
|
+
#
|
487
|
+
# @option params [required, String] :failure_redirection_url
|
488
|
+
# The URL that the recipient of the verification email is sent to if his
|
489
|
+
# or her address is not successfully verified.
|
490
|
+
#
|
491
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
492
|
+
#
|
493
|
+
# @example Request syntax with placeholder values
|
494
|
+
#
|
495
|
+
# resp = client.create_custom_verification_email_template({
|
496
|
+
# template_name: "EmailTemplateName", # required
|
497
|
+
# from_email_address: "EmailAddress", # required
|
498
|
+
# template_subject: "EmailTemplateSubject", # required
|
499
|
+
# template_content: "TemplateContent", # required
|
500
|
+
# success_redirection_url: "SuccessRedirectionURL", # required
|
501
|
+
# failure_redirection_url: "FailureRedirectionURL", # required
|
502
|
+
# })
|
503
|
+
#
|
504
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/CreateCustomVerificationEmailTemplate AWS API Documentation
|
505
|
+
#
|
506
|
+
# @overload create_custom_verification_email_template(params = {})
|
507
|
+
# @param [Hash] params ({})
|
508
|
+
def create_custom_verification_email_template(params = {}, options = {})
|
509
|
+
req = build_request(:create_custom_verification_email_template, params)
|
510
|
+
req.send_request(options)
|
511
|
+
end
|
512
|
+
|
452
513
|
# Create a new pool of dedicated IP addresses. A pool can include one or
|
453
514
|
# more dedicated IP addresses that are associated with your AWS account.
|
454
515
|
# You can associate a pool with a configuration set. When you send an
|
@@ -542,8 +603,9 @@ module Aws::SESV2
|
|
542
603
|
# data: "data", # required
|
543
604
|
# },
|
544
605
|
# template: {
|
545
|
-
#
|
546
|
-
#
|
606
|
+
# template_name: "EmailTemplateName",
|
607
|
+
# template_arn: "AmazonResourceName",
|
608
|
+
# template_data: "EmailTemplateData",
|
547
609
|
# },
|
548
610
|
# },
|
549
611
|
# tags: [
|
@@ -660,6 +722,102 @@ module Aws::SESV2
|
|
660
722
|
req.send_request(options)
|
661
723
|
end
|
662
724
|
|
725
|
+
# Creates the specified sending authorization policy for the given
|
726
|
+
# identity (an email address or a domain).
|
727
|
+
#
|
728
|
+
# <note markdown="1"> This API is for the identity owner only. If you have not verified the
|
729
|
+
# identity, this API will return an error.
|
730
|
+
#
|
731
|
+
# </note>
|
732
|
+
#
|
733
|
+
# Sending authorization is a feature that enables an identity owner to
|
734
|
+
# authorize other senders to use its identities. For information about
|
735
|
+
# using sending authorization, see the [Amazon SES Developer Guide][1].
|
736
|
+
#
|
737
|
+
# You can execute this operation no more than once per second.
|
738
|
+
#
|
739
|
+
#
|
740
|
+
#
|
741
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
742
|
+
#
|
743
|
+
# @option params [required, String] :email_identity
|
744
|
+
# The email identity for which you want to create a policy.
|
745
|
+
#
|
746
|
+
# @option params [required, String] :policy_name
|
747
|
+
# The name of the policy.
|
748
|
+
#
|
749
|
+
# The policy name cannot exceed 64 characters and can only include
|
750
|
+
# alphanumeric characters, dashes, and underscores.
|
751
|
+
#
|
752
|
+
# @option params [required, String] :policy
|
753
|
+
# The text of the policy in JSON format. The policy cannot exceed 4 KB.
|
754
|
+
#
|
755
|
+
# For information about the syntax of sending authorization policies,
|
756
|
+
# see the [Amazon SES Developer Guide][1].
|
757
|
+
#
|
758
|
+
#
|
759
|
+
#
|
760
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-policies.html
|
761
|
+
#
|
762
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
763
|
+
#
|
764
|
+
# @example Request syntax with placeholder values
|
765
|
+
#
|
766
|
+
# resp = client.create_email_identity_policy({
|
767
|
+
# email_identity: "Identity", # required
|
768
|
+
# policy_name: "PolicyName", # required
|
769
|
+
# policy: "Policy", # required
|
770
|
+
# })
|
771
|
+
#
|
772
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/CreateEmailIdentityPolicy AWS API Documentation
|
773
|
+
#
|
774
|
+
# @overload create_email_identity_policy(params = {})
|
775
|
+
# @param [Hash] params ({})
|
776
|
+
def create_email_identity_policy(params = {}, options = {})
|
777
|
+
req = build_request(:create_email_identity_policy, params)
|
778
|
+
req.send_request(options)
|
779
|
+
end
|
780
|
+
|
781
|
+
# Creates an email template. Email templates enable you to send
|
782
|
+
# personalized email to one or more destinations in a single API
|
783
|
+
# operation. For more information, see the [Amazon SES Developer
|
784
|
+
# Guide][1].
|
785
|
+
#
|
786
|
+
# You can execute this operation no more than once per second.
|
787
|
+
#
|
788
|
+
#
|
789
|
+
#
|
790
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html
|
791
|
+
#
|
792
|
+
# @option params [required, String] :template_name
|
793
|
+
# The name of the template you want to create.
|
794
|
+
#
|
795
|
+
# @option params [required, Types::EmailTemplateContent] :template_content
|
796
|
+
# The content of the email template, composed of a subject line, an HTML
|
797
|
+
# part, and a text-only part.
|
798
|
+
#
|
799
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
800
|
+
#
|
801
|
+
# @example Request syntax with placeholder values
|
802
|
+
#
|
803
|
+
# resp = client.create_email_template({
|
804
|
+
# template_name: "EmailTemplateName", # required
|
805
|
+
# template_content: { # required
|
806
|
+
# subject: "EmailTemplateSubject",
|
807
|
+
# text: "EmailTemplateText",
|
808
|
+
# html: "EmailTemplateHtml",
|
809
|
+
# },
|
810
|
+
# })
|
811
|
+
#
|
812
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/CreateEmailTemplate AWS API Documentation
|
813
|
+
#
|
814
|
+
# @overload create_email_template(params = {})
|
815
|
+
# @param [Hash] params ({})
|
816
|
+
def create_email_template(params = {}, options = {})
|
817
|
+
req = build_request(:create_email_template, params)
|
818
|
+
req.send_request(options)
|
819
|
+
end
|
820
|
+
|
663
821
|
# Delete an existing configuration set.
|
664
822
|
#
|
665
823
|
# *Configuration sets* are groups of rules that you can apply to the
|
@@ -722,6 +880,39 @@ module Aws::SESV2
|
|
722
880
|
req.send_request(options)
|
723
881
|
end
|
724
882
|
|
883
|
+
# Deletes an existing custom verification email template.
|
884
|
+
#
|
885
|
+
# For more information about custom verification email templates, see
|
886
|
+
# [Using Custom Verification Email Templates][1] in the *Amazon SES
|
887
|
+
# Developer Guide*.
|
888
|
+
#
|
889
|
+
# You can execute this operation no more than once per second.
|
890
|
+
#
|
891
|
+
#
|
892
|
+
#
|
893
|
+
# [1]: https://docs.aws.amazon.com/es/latest/DeveloperGuide/send-email-verify-address-custom.html
|
894
|
+
#
|
895
|
+
# @option params [required, String] :template_name
|
896
|
+
# The name of the custom verification email template that you want to
|
897
|
+
# delete.
|
898
|
+
#
|
899
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
900
|
+
#
|
901
|
+
# @example Request syntax with placeholder values
|
902
|
+
#
|
903
|
+
# resp = client.delete_custom_verification_email_template({
|
904
|
+
# template_name: "EmailTemplateName", # required
|
905
|
+
# })
|
906
|
+
#
|
907
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/DeleteCustomVerificationEmailTemplate AWS API Documentation
|
908
|
+
#
|
909
|
+
# @overload delete_custom_verification_email_template(params = {})
|
910
|
+
# @param [Hash] params ({})
|
911
|
+
def delete_custom_verification_email_template(params = {}, options = {})
|
912
|
+
req = build_request(:delete_custom_verification_email_template, params)
|
913
|
+
req.send_request(options)
|
914
|
+
end
|
915
|
+
|
725
916
|
# Delete a dedicated IP pool.
|
726
917
|
#
|
727
918
|
# @option params [required, String] :pool_name
|
@@ -768,6 +959,76 @@ module Aws::SESV2
|
|
768
959
|
req.send_request(options)
|
769
960
|
end
|
770
961
|
|
962
|
+
# Deletes the specified sending authorization policy for the given
|
963
|
+
# identity (an email address or a domain). This API returns successfully
|
964
|
+
# even if a policy with the specified name does not exist.
|
965
|
+
#
|
966
|
+
# <note markdown="1"> This API is for the identity owner only. If you have not verified the
|
967
|
+
# identity, this API will return an error.
|
968
|
+
#
|
969
|
+
# </note>
|
970
|
+
#
|
971
|
+
# Sending authorization is a feature that enables an identity owner to
|
972
|
+
# authorize other senders to use its identities. For information about
|
973
|
+
# using sending authorization, see the [Amazon SES Developer Guide][1].
|
974
|
+
#
|
975
|
+
# You can execute this operation no more than once per second.
|
976
|
+
#
|
977
|
+
#
|
978
|
+
#
|
979
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
980
|
+
#
|
981
|
+
# @option params [required, String] :email_identity
|
982
|
+
# The email identity for which you want to delete a policy.
|
983
|
+
#
|
984
|
+
# @option params [required, String] :policy_name
|
985
|
+
# The name of the policy.
|
986
|
+
#
|
987
|
+
# The policy name cannot exceed 64 characters and can only include
|
988
|
+
# alphanumeric characters, dashes, and underscores.
|
989
|
+
#
|
990
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
991
|
+
#
|
992
|
+
# @example Request syntax with placeholder values
|
993
|
+
#
|
994
|
+
# resp = client.delete_email_identity_policy({
|
995
|
+
# email_identity: "Identity", # required
|
996
|
+
# policy_name: "PolicyName", # required
|
997
|
+
# })
|
998
|
+
#
|
999
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/DeleteEmailIdentityPolicy AWS API Documentation
|
1000
|
+
#
|
1001
|
+
# @overload delete_email_identity_policy(params = {})
|
1002
|
+
# @param [Hash] params ({})
|
1003
|
+
def delete_email_identity_policy(params = {}, options = {})
|
1004
|
+
req = build_request(:delete_email_identity_policy, params)
|
1005
|
+
req.send_request(options)
|
1006
|
+
end
|
1007
|
+
|
1008
|
+
# Deletes an email template.
|
1009
|
+
#
|
1010
|
+
# You can execute this operation no more than once per second.
|
1011
|
+
#
|
1012
|
+
# @option params [required, String] :template_name
|
1013
|
+
# The name of the template to be deleted.
|
1014
|
+
#
|
1015
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1016
|
+
#
|
1017
|
+
# @example Request syntax with placeholder values
|
1018
|
+
#
|
1019
|
+
# resp = client.delete_email_template({
|
1020
|
+
# template_name: "EmailTemplateName", # required
|
1021
|
+
# })
|
1022
|
+
#
|
1023
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/DeleteEmailTemplate AWS API Documentation
|
1024
|
+
#
|
1025
|
+
# @overload delete_email_template(params = {})
|
1026
|
+
# @param [Hash] params ({})
|
1027
|
+
def delete_email_template(params = {}, options = {})
|
1028
|
+
req = build_request(:delete_email_template, params)
|
1029
|
+
req.send_request(options)
|
1030
|
+
end
|
1031
|
+
|
771
1032
|
# Removes an email address from the suppression list for your account.
|
772
1033
|
#
|
773
1034
|
# @option params [required, String] :email_address
|
@@ -802,6 +1063,7 @@ module Aws::SESV2
|
|
802
1063
|
# * {Types::GetAccountResponse#send_quota #send_quota} => Types::SendQuota
|
803
1064
|
# * {Types::GetAccountResponse#sending_enabled #sending_enabled} => Boolean
|
804
1065
|
# * {Types::GetAccountResponse#suppression_attributes #suppression_attributes} => Types::SuppressionAttributes
|
1066
|
+
# * {Types::GetAccountResponse#details #details} => Types::AccountDetails
|
805
1067
|
#
|
806
1068
|
# @example Response structure
|
807
1069
|
#
|
@@ -814,6 +1076,14 @@ module Aws::SESV2
|
|
814
1076
|
# resp.sending_enabled #=> Boolean
|
815
1077
|
# resp.suppression_attributes.suppressed_reasons #=> Array
|
816
1078
|
# resp.suppression_attributes.suppressed_reasons[0] #=> String, one of "BOUNCE", "COMPLAINT"
|
1079
|
+
# resp.details.mail_type #=> String, one of "MARKETING", "TRANSACTIONAL"
|
1080
|
+
# resp.details.website_url #=> String
|
1081
|
+
# resp.details.contact_language #=> String, one of "EN", "JA"
|
1082
|
+
# resp.details.use_case_description #=> String
|
1083
|
+
# resp.details.additional_contact_email_addresses #=> Array
|
1084
|
+
# resp.details.additional_contact_email_addresses[0] #=> String
|
1085
|
+
# resp.details.review_details.status #=> String, one of "PENDING", "FAILED", "GRANTED", "DENIED"
|
1086
|
+
# resp.details.review_details.case_id #=> String
|
817
1087
|
#
|
818
1088
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetAccount AWS API Documentation
|
819
1089
|
#
|
@@ -961,6 +1231,56 @@ module Aws::SESV2
|
|
961
1231
|
req.send_request(options)
|
962
1232
|
end
|
963
1233
|
|
1234
|
+
# Returns the custom email verification template for the template name
|
1235
|
+
# you specify.
|
1236
|
+
#
|
1237
|
+
# For more information about custom verification email templates, see
|
1238
|
+
# [Using Custom Verification Email Templates][1] in the *Amazon SES
|
1239
|
+
# Developer Guide*.
|
1240
|
+
#
|
1241
|
+
# You can execute this operation no more than once per second.
|
1242
|
+
#
|
1243
|
+
#
|
1244
|
+
#
|
1245
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-verify-address-custom.html
|
1246
|
+
#
|
1247
|
+
# @option params [required, String] :template_name
|
1248
|
+
# The name of the custom verification email template that you want to
|
1249
|
+
# retrieve.
|
1250
|
+
#
|
1251
|
+
# @return [Types::GetCustomVerificationEmailTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1252
|
+
#
|
1253
|
+
# * {Types::GetCustomVerificationEmailTemplateResponse#template_name #template_name} => String
|
1254
|
+
# * {Types::GetCustomVerificationEmailTemplateResponse#from_email_address #from_email_address} => String
|
1255
|
+
# * {Types::GetCustomVerificationEmailTemplateResponse#template_subject #template_subject} => String
|
1256
|
+
# * {Types::GetCustomVerificationEmailTemplateResponse#template_content #template_content} => String
|
1257
|
+
# * {Types::GetCustomVerificationEmailTemplateResponse#success_redirection_url #success_redirection_url} => String
|
1258
|
+
# * {Types::GetCustomVerificationEmailTemplateResponse#failure_redirection_url #failure_redirection_url} => String
|
1259
|
+
#
|
1260
|
+
# @example Request syntax with placeholder values
|
1261
|
+
#
|
1262
|
+
# resp = client.get_custom_verification_email_template({
|
1263
|
+
# template_name: "EmailTemplateName", # required
|
1264
|
+
# })
|
1265
|
+
#
|
1266
|
+
# @example Response structure
|
1267
|
+
#
|
1268
|
+
# resp.template_name #=> String
|
1269
|
+
# resp.from_email_address #=> String
|
1270
|
+
# resp.template_subject #=> String
|
1271
|
+
# resp.template_content #=> String
|
1272
|
+
# resp.success_redirection_url #=> String
|
1273
|
+
# resp.failure_redirection_url #=> String
|
1274
|
+
#
|
1275
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetCustomVerificationEmailTemplate AWS API Documentation
|
1276
|
+
#
|
1277
|
+
# @overload get_custom_verification_email_template(params = {})
|
1278
|
+
# @param [Hash] params ({})
|
1279
|
+
def get_custom_verification_email_template(params = {}, options = {})
|
1280
|
+
req = build_request(:get_custom_verification_email_template, params)
|
1281
|
+
req.send_request(options)
|
1282
|
+
end
|
1283
|
+
|
964
1284
|
# Get information about a dedicated IP address, including the name of
|
965
1285
|
# the dedicated IP pool that it's associated with, as well information
|
966
1286
|
# about the automatic warm-up process for the address.
|
@@ -1260,8 +1580,8 @@ module Aws::SESV2
|
|
1260
1580
|
end
|
1261
1581
|
|
1262
1582
|
# Provides information about a specific identity, including the
|
1263
|
-
# identity's verification status,
|
1264
|
-
# its custom Mail-From settings.
|
1583
|
+
# identity's verification status, sending authorization policies, its
|
1584
|
+
# DKIM authentication status, and its custom Mail-From settings.
|
1265
1585
|
#
|
1266
1586
|
# @option params [required, String] :email_identity
|
1267
1587
|
# The email identity that you want to retrieve details for.
|
@@ -1273,6 +1593,7 @@ module Aws::SESV2
|
|
1273
1593
|
# * {Types::GetEmailIdentityResponse#verified_for_sending_status #verified_for_sending_status} => Boolean
|
1274
1594
|
# * {Types::GetEmailIdentityResponse#dkim_attributes #dkim_attributes} => Types::DkimAttributes
|
1275
1595
|
# * {Types::GetEmailIdentityResponse#mail_from_attributes #mail_from_attributes} => Types::MailFromAttributes
|
1596
|
+
# * {Types::GetEmailIdentityResponse#policies #policies} => Hash<String,String>
|
1276
1597
|
# * {Types::GetEmailIdentityResponse#tags #tags} => Array<Types::Tag>
|
1277
1598
|
#
|
1278
1599
|
# @example Request syntax with placeholder values
|
@@ -1294,6 +1615,8 @@ module Aws::SESV2
|
|
1294
1615
|
# resp.mail_from_attributes.mail_from_domain #=> String
|
1295
1616
|
# resp.mail_from_attributes.mail_from_domain_status #=> String, one of "PENDING", "SUCCESS", "FAILED", "TEMPORARY_FAILURE"
|
1296
1617
|
# resp.mail_from_attributes.behavior_on_mx_failure #=> String, one of "USE_DEFAULT_VALUE", "REJECT_MESSAGE"
|
1618
|
+
# resp.policies #=> Hash
|
1619
|
+
# resp.policies["PolicyName"] #=> String
|
1297
1620
|
# resp.tags #=> Array
|
1298
1621
|
# resp.tags[0].key #=> String
|
1299
1622
|
# resp.tags[0].value #=> String
|
@@ -1307,6 +1630,88 @@ module Aws::SESV2
|
|
1307
1630
|
req.send_request(options)
|
1308
1631
|
end
|
1309
1632
|
|
1633
|
+
# Returns the requested sending authorization policies for the given
|
1634
|
+
# identity (an email address or a domain). The policies are returned as
|
1635
|
+
# a map of policy names to policy contents. You can retrieve a maximum
|
1636
|
+
# of 20 policies at a time.
|
1637
|
+
#
|
1638
|
+
# <note markdown="1"> This API is for the identity owner only. If you have not verified the
|
1639
|
+
# identity, this API will return an error.
|
1640
|
+
#
|
1641
|
+
# </note>
|
1642
|
+
#
|
1643
|
+
# Sending authorization is a feature that enables an identity owner to
|
1644
|
+
# authorize other senders to use its identities. For information about
|
1645
|
+
# using sending authorization, see the [Amazon SES Developer Guide][1].
|
1646
|
+
#
|
1647
|
+
# You can execute this operation no more than once per second.
|
1648
|
+
#
|
1649
|
+
#
|
1650
|
+
#
|
1651
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
1652
|
+
#
|
1653
|
+
# @option params [required, String] :email_identity
|
1654
|
+
# The email identity that you want to retrieve policies for.
|
1655
|
+
#
|
1656
|
+
# @return [Types::GetEmailIdentityPoliciesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1657
|
+
#
|
1658
|
+
# * {Types::GetEmailIdentityPoliciesResponse#policies #policies} => Hash<String,String>
|
1659
|
+
#
|
1660
|
+
# @example Request syntax with placeholder values
|
1661
|
+
#
|
1662
|
+
# resp = client.get_email_identity_policies({
|
1663
|
+
# email_identity: "Identity", # required
|
1664
|
+
# })
|
1665
|
+
#
|
1666
|
+
# @example Response structure
|
1667
|
+
#
|
1668
|
+
# resp.policies #=> Hash
|
1669
|
+
# resp.policies["PolicyName"] #=> String
|
1670
|
+
#
|
1671
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetEmailIdentityPolicies AWS API Documentation
|
1672
|
+
#
|
1673
|
+
# @overload get_email_identity_policies(params = {})
|
1674
|
+
# @param [Hash] params ({})
|
1675
|
+
def get_email_identity_policies(params = {}, options = {})
|
1676
|
+
req = build_request(:get_email_identity_policies, params)
|
1677
|
+
req.send_request(options)
|
1678
|
+
end
|
1679
|
+
|
1680
|
+
# Displays the template object (which includes the subject line, HTML
|
1681
|
+
# part and text part) for the template you specify.
|
1682
|
+
#
|
1683
|
+
# You can execute this operation no more than once per second.
|
1684
|
+
#
|
1685
|
+
# @option params [required, String] :template_name
|
1686
|
+
# The name of the template you want to retrieve.
|
1687
|
+
#
|
1688
|
+
# @return [Types::GetEmailTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1689
|
+
#
|
1690
|
+
# * {Types::GetEmailTemplateResponse#template_name #template_name} => String
|
1691
|
+
# * {Types::GetEmailTemplateResponse#template_content #template_content} => Types::EmailTemplateContent
|
1692
|
+
#
|
1693
|
+
# @example Request syntax with placeholder values
|
1694
|
+
#
|
1695
|
+
# resp = client.get_email_template({
|
1696
|
+
# template_name: "EmailTemplateName", # required
|
1697
|
+
# })
|
1698
|
+
#
|
1699
|
+
# @example Response structure
|
1700
|
+
#
|
1701
|
+
# resp.template_name #=> String
|
1702
|
+
# resp.template_content.subject #=> String
|
1703
|
+
# resp.template_content.text #=> String
|
1704
|
+
# resp.template_content.html #=> String
|
1705
|
+
#
|
1706
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/GetEmailTemplate AWS API Documentation
|
1707
|
+
#
|
1708
|
+
# @overload get_email_template(params = {})
|
1709
|
+
# @param [Hash] params ({})
|
1710
|
+
def get_email_template(params = {}, options = {})
|
1711
|
+
req = build_request(:get_email_template, params)
|
1712
|
+
req.send_request(options)
|
1713
|
+
end
|
1714
|
+
|
1310
1715
|
# Retrieves information about a specific email address that's on the
|
1311
1716
|
# suppression list for your account.
|
1312
1717
|
#
|
@@ -1388,6 +1793,67 @@ module Aws::SESV2
|
|
1388
1793
|
req.send_request(options)
|
1389
1794
|
end
|
1390
1795
|
|
1796
|
+
# Lists the existing custom verification email templates for your
|
1797
|
+
# account in the current AWS Region.
|
1798
|
+
#
|
1799
|
+
# For more information about custom verification email templates, see
|
1800
|
+
# [Using Custom Verification Email Templates][1] in the *Amazon SES
|
1801
|
+
# Developer Guide*.
|
1802
|
+
#
|
1803
|
+
# You can execute this operation no more than once per second.
|
1804
|
+
#
|
1805
|
+
#
|
1806
|
+
#
|
1807
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-verify-address-custom.html
|
1808
|
+
#
|
1809
|
+
# @option params [String] :next_token
|
1810
|
+
# A token returned from a previous call to
|
1811
|
+
# `ListCustomVerificationEmailTemplates` to indicate the position in the
|
1812
|
+
# list of custom verification email templates.
|
1813
|
+
#
|
1814
|
+
# @option params [Integer] :page_size
|
1815
|
+
# The number of results to show in a single call to
|
1816
|
+
# `ListCustomVerificationEmailTemplates`. If the number of results is
|
1817
|
+
# larger than the number you specified in this parameter, then the
|
1818
|
+
# response includes a `NextToken` element, which you can use to obtain
|
1819
|
+
# additional results.
|
1820
|
+
#
|
1821
|
+
# The value you specify has to be at least 1, and can be no more than
|
1822
|
+
# 50.
|
1823
|
+
#
|
1824
|
+
# @return [Types::ListCustomVerificationEmailTemplatesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1825
|
+
#
|
1826
|
+
# * {Types::ListCustomVerificationEmailTemplatesResponse#custom_verification_email_templates #custom_verification_email_templates} => Array<Types::CustomVerificationEmailTemplateMetadata>
|
1827
|
+
# * {Types::ListCustomVerificationEmailTemplatesResponse#next_token #next_token} => String
|
1828
|
+
#
|
1829
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1830
|
+
#
|
1831
|
+
# @example Request syntax with placeholder values
|
1832
|
+
#
|
1833
|
+
# resp = client.list_custom_verification_email_templates({
|
1834
|
+
# next_token: "NextToken",
|
1835
|
+
# page_size: 1,
|
1836
|
+
# })
|
1837
|
+
#
|
1838
|
+
# @example Response structure
|
1839
|
+
#
|
1840
|
+
# resp.custom_verification_email_templates #=> Array
|
1841
|
+
# resp.custom_verification_email_templates[0].template_name #=> String
|
1842
|
+
# resp.custom_verification_email_templates[0].from_email_address #=> String
|
1843
|
+
# resp.custom_verification_email_templates[0].template_subject #=> String
|
1844
|
+
# resp.custom_verification_email_templates[0].success_redirection_url #=> String
|
1845
|
+
# resp.custom_verification_email_templates[0].failure_redirection_url #=> String
|
1846
|
+
# resp.next_token #=> String
|
1847
|
+
#
|
1848
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ListCustomVerificationEmailTemplates AWS API Documentation
|
1849
|
+
#
|
1850
|
+
# @overload list_custom_verification_email_templates(params = {})
|
1851
|
+
# @param [Hash] params ({})
|
1852
|
+
def list_custom_verification_email_templates(params = {}, options = {})
|
1853
|
+
req = build_request(:list_custom_verification_email_templates, params)
|
1854
|
+
req.send_request(options)
|
1855
|
+
end
|
1856
|
+
|
1391
1857
|
# List all of the dedicated IP pools that exist in your AWS account in
|
1392
1858
|
# the current Region.
|
1393
1859
|
#
|
@@ -1610,6 +2076,54 @@ module Aws::SESV2
|
|
1610
2076
|
req.send_request(options)
|
1611
2077
|
end
|
1612
2078
|
|
2079
|
+
# Lists the email templates present in your Amazon SES account in the
|
2080
|
+
# current AWS Region.
|
2081
|
+
#
|
2082
|
+
# You can execute this operation no more than once per second.
|
2083
|
+
#
|
2084
|
+
# @option params [String] :next_token
|
2085
|
+
# A token returned from a previous call to `ListEmailTemplates` to
|
2086
|
+
# indicate the position in the list of email templates.
|
2087
|
+
#
|
2088
|
+
# @option params [Integer] :page_size
|
2089
|
+
# The number of results to show in a single call to
|
2090
|
+
# `ListEmailTemplates`. If the number of results is larger than the
|
2091
|
+
# number you specified in this parameter, then the response includes a
|
2092
|
+
# `NextToken` element, which you can use to obtain additional results.
|
2093
|
+
#
|
2094
|
+
# The value you specify has to be at least 1, and can be no more than
|
2095
|
+
# 10.
|
2096
|
+
#
|
2097
|
+
# @return [Types::ListEmailTemplatesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2098
|
+
#
|
2099
|
+
# * {Types::ListEmailTemplatesResponse#templates_metadata #templates_metadata} => Array<Types::EmailTemplateMetadata>
|
2100
|
+
# * {Types::ListEmailTemplatesResponse#next_token #next_token} => String
|
2101
|
+
#
|
2102
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2103
|
+
#
|
2104
|
+
# @example Request syntax with placeholder values
|
2105
|
+
#
|
2106
|
+
# resp = client.list_email_templates({
|
2107
|
+
# next_token: "NextToken",
|
2108
|
+
# page_size: 1,
|
2109
|
+
# })
|
2110
|
+
#
|
2111
|
+
# @example Response structure
|
2112
|
+
#
|
2113
|
+
# resp.templates_metadata #=> Array
|
2114
|
+
# resp.templates_metadata[0].template_name #=> String
|
2115
|
+
# resp.templates_metadata[0].created_timestamp #=> Time
|
2116
|
+
# resp.next_token #=> String
|
2117
|
+
#
|
2118
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/ListEmailTemplates AWS API Documentation
|
2119
|
+
#
|
2120
|
+
# @overload list_email_templates(params = {})
|
2121
|
+
# @param [Hash] params ({})
|
2122
|
+
def list_email_templates(params = {}, options = {})
|
2123
|
+
req = build_request(:list_email_templates, params)
|
2124
|
+
req.send_request(options)
|
2125
|
+
end
|
2126
|
+
|
1613
2127
|
# Retrieves a list of email addresses that are on the suppression list
|
1614
2128
|
# for your account.
|
1615
2129
|
#
|
@@ -1732,6 +2246,62 @@ module Aws::SESV2
|
|
1732
2246
|
req.send_request(options)
|
1733
2247
|
end
|
1734
2248
|
|
2249
|
+
# Update your Amazon SES account details.
|
2250
|
+
#
|
2251
|
+
# @option params [required, String] :mail_type
|
2252
|
+
# The type of email your account will send.
|
2253
|
+
#
|
2254
|
+
# @option params [required, String] :website_url
|
2255
|
+
# The URL of your website. This information helps us better understand
|
2256
|
+
# the type of content that you plan to send.
|
2257
|
+
#
|
2258
|
+
# @option params [String] :contact_language
|
2259
|
+
# The language you would prefer to be contacted with.
|
2260
|
+
#
|
2261
|
+
# @option params [required, String] :use_case_description
|
2262
|
+
# A description of the types of email that you plan to send.
|
2263
|
+
#
|
2264
|
+
# @option params [Array<String>] :additional_contact_email_addresses
|
2265
|
+
# Additional email addresses that you would like to be notified
|
2266
|
+
# regarding Amazon SES matters.
|
2267
|
+
#
|
2268
|
+
# @option params [Boolean] :production_access_enabled
|
2269
|
+
# Indicates whether or not your account should have production access in
|
2270
|
+
# the current AWS Region.
|
2271
|
+
#
|
2272
|
+
# If the value is `false`, then your account is in the *sandbox*. When
|
2273
|
+
# your account is in the sandbox, you can only send email to verified
|
2274
|
+
# identities. Additionally, the maximum number of emails you can send in
|
2275
|
+
# a 24-hour period (your sending quota) is 200, and the maximum number
|
2276
|
+
# of emails you can send per second (your maximum sending rate) is 1.
|
2277
|
+
#
|
2278
|
+
# If the value is `true`, then your account has production access. When
|
2279
|
+
# your account has production access, you can send email to any address.
|
2280
|
+
# The sending quota and maximum sending rate for your account vary based
|
2281
|
+
# on your specific use case.
|
2282
|
+
#
|
2283
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2284
|
+
#
|
2285
|
+
# @example Request syntax with placeholder values
|
2286
|
+
#
|
2287
|
+
# resp = client.put_account_details({
|
2288
|
+
# mail_type: "MARKETING", # required, accepts MARKETING, TRANSACTIONAL
|
2289
|
+
# website_url: "WebsiteURL", # required
|
2290
|
+
# contact_language: "EN", # accepts EN, JA
|
2291
|
+
# use_case_description: "UseCaseDescription", # required
|
2292
|
+
# additional_contact_email_addresses: ["AdditionalContactEmailAddress"],
|
2293
|
+
# production_access_enabled: false,
|
2294
|
+
# })
|
2295
|
+
#
|
2296
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/PutAccountDetails AWS API Documentation
|
2297
|
+
#
|
2298
|
+
# @overload put_account_details(params = {})
|
2299
|
+
# @param [Hash] params ({})
|
2300
|
+
def put_account_details(params = {}, options = {})
|
2301
|
+
req = build_request(:put_account_details, params)
|
2302
|
+
req.send_request(options)
|
2303
|
+
end
|
2304
|
+
|
1735
2305
|
# Enable or disable the ability of your account to send email.
|
1736
2306
|
#
|
1737
2307
|
# @option params [Boolean] :sending_enabled
|
@@ -2294,6 +2864,193 @@ module Aws::SESV2
|
|
2294
2864
|
req.send_request(options)
|
2295
2865
|
end
|
2296
2866
|
|
2867
|
+
# Composes an email message to multiple destinations.
|
2868
|
+
#
|
2869
|
+
# @option params [String] :from_email_address
|
2870
|
+
# The email address that you want to use as the "From" address for the
|
2871
|
+
# email. The address that you specify has to be verified.
|
2872
|
+
#
|
2873
|
+
# @option params [String] :from_email_address_identity_arn
|
2874
|
+
# This parameter is used only for sending authorization. It is the ARN
|
2875
|
+
# of the identity that is associated with the sending authorization
|
2876
|
+
# policy that permits you to use the email address specified in the
|
2877
|
+
# `FromEmailAddress` parameter.
|
2878
|
+
#
|
2879
|
+
# For example, if the owner of example.com (which has ARN
|
2880
|
+
# arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a
|
2881
|
+
# policy to it that authorizes you to use sender@example.com, then you
|
2882
|
+
# would specify the `FromEmailAddressIdentityArn` to be
|
2883
|
+
# arn:aws:ses:us-east-1:123456789012:identity/example.com, and the
|
2884
|
+
# `FromEmailAddress` to be sender@example.com.
|
2885
|
+
#
|
2886
|
+
# For more information about sending authorization, see the [Amazon SES
|
2887
|
+
# Developer Guide][1].
|
2888
|
+
#
|
2889
|
+
#
|
2890
|
+
#
|
2891
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
2892
|
+
#
|
2893
|
+
# @option params [Array<String>] :reply_to_addresses
|
2894
|
+
# The "Reply-to" email addresses for the message. When the recipient
|
2895
|
+
# replies to the message, each Reply-to address receives the reply.
|
2896
|
+
#
|
2897
|
+
# @option params [String] :feedback_forwarding_email_address
|
2898
|
+
# The address that you want bounce and complaint notifications to be
|
2899
|
+
# sent to.
|
2900
|
+
#
|
2901
|
+
# @option params [String] :feedback_forwarding_email_address_identity_arn
|
2902
|
+
# This parameter is used only for sending authorization. It is the ARN
|
2903
|
+
# of the identity that is associated with the sending authorization
|
2904
|
+
# policy that permits you to use the email address specified in the
|
2905
|
+
# `FeedbackForwardingEmailAddress` parameter.
|
2906
|
+
#
|
2907
|
+
# For example, if the owner of example.com (which has ARN
|
2908
|
+
# arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a
|
2909
|
+
# policy to it that authorizes you to use feedback@example.com, then you
|
2910
|
+
# would specify the `FeedbackForwardingEmailAddressIdentityArn` to be
|
2911
|
+
# arn:aws:ses:us-east-1:123456789012:identity/example.com, and the
|
2912
|
+
# `FeedbackForwardingEmailAddress` to be feedback@example.com.
|
2913
|
+
#
|
2914
|
+
# For more information about sending authorization, see the [Amazon SES
|
2915
|
+
# Developer Guide][1].
|
2916
|
+
#
|
2917
|
+
#
|
2918
|
+
#
|
2919
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
2920
|
+
#
|
2921
|
+
# @option params [Array<Types::MessageTag>] :default_email_tags
|
2922
|
+
# A list of tags, in the form of name/value pairs, to apply to an email
|
2923
|
+
# that you send using the `SendEmail` operation. Tags correspond to
|
2924
|
+
# characteristics of the email that you define, so that you can publish
|
2925
|
+
# email sending events.
|
2926
|
+
#
|
2927
|
+
# @option params [required, Types::BulkEmailContent] :default_content
|
2928
|
+
# An object that contains the body of the message. You can specify a
|
2929
|
+
# template message.
|
2930
|
+
#
|
2931
|
+
# @option params [required, Array<Types::BulkEmailEntry>] :bulk_email_entries
|
2932
|
+
# The list of bulk email entry objects.
|
2933
|
+
#
|
2934
|
+
# @option params [String] :configuration_set_name
|
2935
|
+
# The name of the configuration set that you want to use when sending
|
2936
|
+
# the email.
|
2937
|
+
#
|
2938
|
+
# @return [Types::SendBulkEmailResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2939
|
+
#
|
2940
|
+
# * {Types::SendBulkEmailResponse#bulk_email_entry_results #bulk_email_entry_results} => Array<Types::BulkEmailEntryResult>
|
2941
|
+
#
|
2942
|
+
# @example Request syntax with placeholder values
|
2943
|
+
#
|
2944
|
+
# resp = client.send_bulk_email({
|
2945
|
+
# from_email_address: "EmailAddress",
|
2946
|
+
# from_email_address_identity_arn: "AmazonResourceName",
|
2947
|
+
# reply_to_addresses: ["EmailAddress"],
|
2948
|
+
# feedback_forwarding_email_address: "EmailAddress",
|
2949
|
+
# feedback_forwarding_email_address_identity_arn: "AmazonResourceName",
|
2950
|
+
# default_email_tags: [
|
2951
|
+
# {
|
2952
|
+
# name: "MessageTagName", # required
|
2953
|
+
# value: "MessageTagValue", # required
|
2954
|
+
# },
|
2955
|
+
# ],
|
2956
|
+
# default_content: { # required
|
2957
|
+
# template: {
|
2958
|
+
# template_name: "EmailTemplateName",
|
2959
|
+
# template_arn: "AmazonResourceName",
|
2960
|
+
# template_data: "EmailTemplateData",
|
2961
|
+
# },
|
2962
|
+
# },
|
2963
|
+
# bulk_email_entries: [ # required
|
2964
|
+
# {
|
2965
|
+
# destination: { # required
|
2966
|
+
# to_addresses: ["EmailAddress"],
|
2967
|
+
# cc_addresses: ["EmailAddress"],
|
2968
|
+
# bcc_addresses: ["EmailAddress"],
|
2969
|
+
# },
|
2970
|
+
# replacement_tags: [
|
2971
|
+
# {
|
2972
|
+
# name: "MessageTagName", # required
|
2973
|
+
# value: "MessageTagValue", # required
|
2974
|
+
# },
|
2975
|
+
# ],
|
2976
|
+
# replacement_email_content: {
|
2977
|
+
# replacement_template: {
|
2978
|
+
# replacement_template_data: "EmailTemplateData",
|
2979
|
+
# },
|
2980
|
+
# },
|
2981
|
+
# },
|
2982
|
+
# ],
|
2983
|
+
# configuration_set_name: "ConfigurationSetName",
|
2984
|
+
# })
|
2985
|
+
#
|
2986
|
+
# @example Response structure
|
2987
|
+
#
|
2988
|
+
# resp.bulk_email_entry_results #=> Array
|
2989
|
+
# resp.bulk_email_entry_results[0].status #=> String, one of "SUCCESS", "MESSAGE_REJECTED", "MAIL_FROM_DOMAIN_NOT_VERIFIED", "CONFIGURATION_SET_NOT_FOUND", "TEMPLATE_NOT_FOUND", "ACCOUNT_SUSPENDED", "ACCOUNT_THROTTLED", "ACCOUNT_DAILY_QUOTA_EXCEEDED", "INVALID_SENDING_POOL_NAME", "ACCOUNT_SENDING_PAUSED", "CONFIGURATION_SET_SENDING_PAUSED", "INVALID_PARAMETER", "TRANSIENT_FAILURE", "FAILED"
|
2990
|
+
# resp.bulk_email_entry_results[0].error #=> String
|
2991
|
+
# resp.bulk_email_entry_results[0].message_id #=> String
|
2992
|
+
#
|
2993
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/SendBulkEmail AWS API Documentation
|
2994
|
+
#
|
2995
|
+
# @overload send_bulk_email(params = {})
|
2996
|
+
# @param [Hash] params ({})
|
2997
|
+
def send_bulk_email(params = {}, options = {})
|
2998
|
+
req = build_request(:send_bulk_email, params)
|
2999
|
+
req.send_request(options)
|
3000
|
+
end
|
3001
|
+
|
3002
|
+
# Adds an email address to the list of identities for your Amazon SES
|
3003
|
+
# account in the current AWS Region and attempts to verify it. As a
|
3004
|
+
# result of executing this operation, a customized verification email is
|
3005
|
+
# sent to the specified address.
|
3006
|
+
#
|
3007
|
+
# To use this operation, you must first create a custom verification
|
3008
|
+
# email template. For more information about creating and using custom
|
3009
|
+
# verification email templates, see [Using Custom Verification Email
|
3010
|
+
# Templates][1] in the *Amazon SES Developer Guide*.
|
3011
|
+
#
|
3012
|
+
# You can execute this operation no more than once per second.
|
3013
|
+
#
|
3014
|
+
#
|
3015
|
+
#
|
3016
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-verify-address-custom.html
|
3017
|
+
#
|
3018
|
+
# @option params [required, String] :email_address
|
3019
|
+
# The email address to verify.
|
3020
|
+
#
|
3021
|
+
# @option params [required, String] :template_name
|
3022
|
+
# The name of the custom verification email template to use when sending
|
3023
|
+
# the verification email.
|
3024
|
+
#
|
3025
|
+
# @option params [String] :configuration_set_name
|
3026
|
+
# Name of a configuration set to use when sending the verification
|
3027
|
+
# email.
|
3028
|
+
#
|
3029
|
+
# @return [Types::SendCustomVerificationEmailResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3030
|
+
#
|
3031
|
+
# * {Types::SendCustomVerificationEmailResponse#message_id #message_id} => String
|
3032
|
+
#
|
3033
|
+
# @example Request syntax with placeholder values
|
3034
|
+
#
|
3035
|
+
# resp = client.send_custom_verification_email({
|
3036
|
+
# email_address: "EmailAddress", # required
|
3037
|
+
# template_name: "EmailTemplateName", # required
|
3038
|
+
# configuration_set_name: "ConfigurationSetName",
|
3039
|
+
# })
|
3040
|
+
#
|
3041
|
+
# @example Response structure
|
3042
|
+
#
|
3043
|
+
# resp.message_id #=> String
|
3044
|
+
#
|
3045
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/SendCustomVerificationEmail AWS API Documentation
|
3046
|
+
#
|
3047
|
+
# @overload send_custom_verification_email(params = {})
|
3048
|
+
# @param [Hash] params ({})
|
3049
|
+
def send_custom_verification_email(params = {}, options = {})
|
3050
|
+
req = build_request(:send_custom_verification_email, params)
|
3051
|
+
req.send_request(options)
|
3052
|
+
end
|
3053
|
+
|
2297
3054
|
# Sends an email message. You can use the Amazon SES API v2 to send two
|
2298
3055
|
# types of messages:
|
2299
3056
|
#
|
@@ -2307,11 +3064,39 @@ module Aws::SESV2
|
|
2307
3064
|
# messages that contain attachments. The message that you specify has
|
2308
3065
|
# to be a valid MIME message.
|
2309
3066
|
#
|
3067
|
+
# * **Templated** – A message that contains personalization tags. When
|
3068
|
+
# you send this type of email, Amazon SES API v2 automatically
|
3069
|
+
# replaces the tags with values that you specify.
|
3070
|
+
#
|
2310
3071
|
# @option params [String] :from_email_address
|
2311
3072
|
# The email address that you want to use as the "From" address for the
|
2312
3073
|
# email. The address that you specify has to be verified.
|
2313
3074
|
#
|
2314
|
-
# @option params [
|
3075
|
+
# @option params [String] :from_email_address_identity_arn
|
3076
|
+
# This parameter is used only for sending authorization. It is the ARN
|
3077
|
+
# of the identity that is associated with the sending authorization
|
3078
|
+
# policy that permits you to use the email address specified in the
|
3079
|
+
# `FromEmailAddress` parameter.
|
3080
|
+
#
|
3081
|
+
# For example, if the owner of example.com (which has ARN
|
3082
|
+
# arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a
|
3083
|
+
# policy to it that authorizes you to use sender@example.com, then you
|
3084
|
+
# would specify the `FromEmailAddressIdentityArn` to be
|
3085
|
+
# arn:aws:ses:us-east-1:123456789012:identity/example.com, and the
|
3086
|
+
# `FromEmailAddress` to be sender@example.com.
|
3087
|
+
#
|
3088
|
+
# For more information about sending authorization, see the [Amazon SES
|
3089
|
+
# Developer Guide][1].
|
3090
|
+
#
|
3091
|
+
# For Raw emails, the `FromEmailAddressIdentityArn` value overrides the
|
3092
|
+
# X-SES-SOURCE-ARN and X-SES-FROM-ARN headers specified in raw email
|
3093
|
+
# message content.
|
3094
|
+
#
|
3095
|
+
#
|
3096
|
+
#
|
3097
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
3098
|
+
#
|
3099
|
+
# @option params [Types::Destination] :destination
|
2315
3100
|
# An object that contains the recipients of the email message.
|
2316
3101
|
#
|
2317
3102
|
# @option params [Array<String>] :reply_to_addresses
|
@@ -2322,9 +3107,29 @@ module Aws::SESV2
|
|
2322
3107
|
# The address that you want bounce and complaint notifications to be
|
2323
3108
|
# sent to.
|
2324
3109
|
#
|
3110
|
+
# @option params [String] :feedback_forwarding_email_address_identity_arn
|
3111
|
+
# This parameter is used only for sending authorization. It is the ARN
|
3112
|
+
# of the identity that is associated with the sending authorization
|
3113
|
+
# policy that permits you to use the email address specified in the
|
3114
|
+
# `FeedbackForwardingEmailAddress` parameter.
|
3115
|
+
#
|
3116
|
+
# For example, if the owner of example.com (which has ARN
|
3117
|
+
# arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a
|
3118
|
+
# policy to it that authorizes you to use feedback@example.com, then you
|
3119
|
+
# would specify the `FeedbackForwardingEmailAddressIdentityArn` to be
|
3120
|
+
# arn:aws:ses:us-east-1:123456789012:identity/example.com, and the
|
3121
|
+
# `FeedbackForwardingEmailAddress` to be feedback@example.com.
|
3122
|
+
#
|
3123
|
+
# For more information about sending authorization, see the [Amazon SES
|
3124
|
+
# Developer Guide][1].
|
3125
|
+
#
|
3126
|
+
#
|
3127
|
+
#
|
3128
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
3129
|
+
#
|
2325
3130
|
# @option params [required, Types::EmailContent] :content
|
2326
3131
|
# An object that contains the body of the message. You can send either a
|
2327
|
-
# Simple message or a
|
3132
|
+
# Simple message Raw message or a template Message.
|
2328
3133
|
#
|
2329
3134
|
# @option params [Array<Types::MessageTag>] :email_tags
|
2330
3135
|
# A list of tags, in the form of name/value pairs, to apply to an email
|
@@ -2344,13 +3149,15 @@ module Aws::SESV2
|
|
2344
3149
|
#
|
2345
3150
|
# resp = client.send_email({
|
2346
3151
|
# from_email_address: "EmailAddress",
|
2347
|
-
#
|
3152
|
+
# from_email_address_identity_arn: "AmazonResourceName",
|
3153
|
+
# destination: {
|
2348
3154
|
# to_addresses: ["EmailAddress"],
|
2349
3155
|
# cc_addresses: ["EmailAddress"],
|
2350
3156
|
# bcc_addresses: ["EmailAddress"],
|
2351
3157
|
# },
|
2352
3158
|
# reply_to_addresses: ["EmailAddress"],
|
2353
3159
|
# feedback_forwarding_email_address: "EmailAddress",
|
3160
|
+
# feedback_forwarding_email_address_identity_arn: "AmazonResourceName",
|
2354
3161
|
# content: { # required
|
2355
3162
|
# simple: {
|
2356
3163
|
# subject: { # required
|
@@ -2372,8 +3179,9 @@ module Aws::SESV2
|
|
2372
3179
|
# data: "data", # required
|
2373
3180
|
# },
|
2374
3181
|
# template: {
|
2375
|
-
#
|
2376
|
-
#
|
3182
|
+
# template_name: "EmailTemplateName",
|
3183
|
+
# template_arn: "AmazonResourceName",
|
3184
|
+
# template_data: "EmailTemplateData",
|
2377
3185
|
# },
|
2378
3186
|
# },
|
2379
3187
|
# email_tags: [
|
@@ -2442,6 +3250,43 @@ module Aws::SESV2
|
|
2442
3250
|
req.send_request(options)
|
2443
3251
|
end
|
2444
3252
|
|
3253
|
+
# Creates a preview of the MIME content of an email when provided with a
|
3254
|
+
# template and a set of replacement data.
|
3255
|
+
#
|
3256
|
+
# You can execute this operation no more than once per second.
|
3257
|
+
#
|
3258
|
+
# @option params [required, String] :template_name
|
3259
|
+
# The name of the template that you want to render.
|
3260
|
+
#
|
3261
|
+
# @option params [required, String] :template_data
|
3262
|
+
# A list of replacement values to apply to the template. This parameter
|
3263
|
+
# is a JSON object, typically consisting of key-value pairs in which the
|
3264
|
+
# keys correspond to replacement tags in the email template.
|
3265
|
+
#
|
3266
|
+
# @return [Types::TestRenderEmailTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3267
|
+
#
|
3268
|
+
# * {Types::TestRenderEmailTemplateResponse#rendered_template #rendered_template} => String
|
3269
|
+
#
|
3270
|
+
# @example Request syntax with placeholder values
|
3271
|
+
#
|
3272
|
+
# resp = client.test_render_email_template({
|
3273
|
+
# template_name: "EmailTemplateName", # required
|
3274
|
+
# template_data: "EmailTemplateData", # required
|
3275
|
+
# })
|
3276
|
+
#
|
3277
|
+
# @example Response structure
|
3278
|
+
#
|
3279
|
+
# resp.rendered_template #=> String
|
3280
|
+
#
|
3281
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/TestRenderEmailTemplate AWS API Documentation
|
3282
|
+
#
|
3283
|
+
# @overload test_render_email_template(params = {})
|
3284
|
+
# @param [Hash] params ({})
|
3285
|
+
def test_render_email_template(params = {}, options = {})
|
3286
|
+
req = build_request(:test_render_email_template, params)
|
3287
|
+
req.send_request(options)
|
3288
|
+
end
|
3289
|
+
|
2445
3290
|
# Remove one or more tags (keys and values) from a specified resource.
|
2446
3291
|
#
|
2447
3292
|
# @option params [required, String] :resource_arn
|
@@ -2537,6 +3382,165 @@ module Aws::SESV2
|
|
2537
3382
|
req.send_request(options)
|
2538
3383
|
end
|
2539
3384
|
|
3385
|
+
# Updates an existing custom verification email template.
|
3386
|
+
#
|
3387
|
+
# For more information about custom verification email templates, see
|
3388
|
+
# [Using Custom Verification Email Templates][1] in the *Amazon SES
|
3389
|
+
# Developer Guide*.
|
3390
|
+
#
|
3391
|
+
# You can execute this operation no more than once per second.
|
3392
|
+
#
|
3393
|
+
#
|
3394
|
+
#
|
3395
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-verify-address-custom.html
|
3396
|
+
#
|
3397
|
+
# @option params [required, String] :template_name
|
3398
|
+
# The name of the custom verification email template that you want to
|
3399
|
+
# update.
|
3400
|
+
#
|
3401
|
+
# @option params [required, String] :from_email_address
|
3402
|
+
# The email address that the custom verification email is sent from.
|
3403
|
+
#
|
3404
|
+
# @option params [required, String] :template_subject
|
3405
|
+
# The subject line of the custom verification email.
|
3406
|
+
#
|
3407
|
+
# @option params [required, String] :template_content
|
3408
|
+
# The content of the custom verification email. The total size of the
|
3409
|
+
# email must be less than 10 MB. The message body may contain HTML, with
|
3410
|
+
# some limitations. For more information, see [Custom Verification Email
|
3411
|
+
# Frequently Asked Questions][1] in the *Amazon SES Developer Guide*.
|
3412
|
+
#
|
3413
|
+
#
|
3414
|
+
#
|
3415
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-verify-address-custom.html#custom-verification-emails-faq
|
3416
|
+
#
|
3417
|
+
# @option params [required, String] :success_redirection_url
|
3418
|
+
# The URL that the recipient of the verification email is sent to if his
|
3419
|
+
# or her address is successfully verified.
|
3420
|
+
#
|
3421
|
+
# @option params [required, String] :failure_redirection_url
|
3422
|
+
# The URL that the recipient of the verification email is sent to if his
|
3423
|
+
# or her address is not successfully verified.
|
3424
|
+
#
|
3425
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3426
|
+
#
|
3427
|
+
# @example Request syntax with placeholder values
|
3428
|
+
#
|
3429
|
+
# resp = client.update_custom_verification_email_template({
|
3430
|
+
# template_name: "EmailTemplateName", # required
|
3431
|
+
# from_email_address: "EmailAddress", # required
|
3432
|
+
# template_subject: "EmailTemplateSubject", # required
|
3433
|
+
# template_content: "TemplateContent", # required
|
3434
|
+
# success_redirection_url: "SuccessRedirectionURL", # required
|
3435
|
+
# failure_redirection_url: "FailureRedirectionURL", # required
|
3436
|
+
# })
|
3437
|
+
#
|
3438
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/UpdateCustomVerificationEmailTemplate AWS API Documentation
|
3439
|
+
#
|
3440
|
+
# @overload update_custom_verification_email_template(params = {})
|
3441
|
+
# @param [Hash] params ({})
|
3442
|
+
def update_custom_verification_email_template(params = {}, options = {})
|
3443
|
+
req = build_request(:update_custom_verification_email_template, params)
|
3444
|
+
req.send_request(options)
|
3445
|
+
end
|
3446
|
+
|
3447
|
+
# Updates the specified sending authorization policy for the given
|
3448
|
+
# identity (an email address or a domain). This API returns successfully
|
3449
|
+
# even if a policy with the specified name does not exist.
|
3450
|
+
#
|
3451
|
+
# <note markdown="1"> This API is for the identity owner only. If you have not verified the
|
3452
|
+
# identity, this API will return an error.
|
3453
|
+
#
|
3454
|
+
# </note>
|
3455
|
+
#
|
3456
|
+
# Sending authorization is a feature that enables an identity owner to
|
3457
|
+
# authorize other senders to use its identities. For information about
|
3458
|
+
# using sending authorization, see the [Amazon SES Developer Guide][1].
|
3459
|
+
#
|
3460
|
+
# You can execute this operation no more than once per second.
|
3461
|
+
#
|
3462
|
+
#
|
3463
|
+
#
|
3464
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
|
3465
|
+
#
|
3466
|
+
# @option params [required, String] :email_identity
|
3467
|
+
# The email identity for which you want to update policy.
|
3468
|
+
#
|
3469
|
+
# @option params [required, String] :policy_name
|
3470
|
+
# The name of the policy.
|
3471
|
+
#
|
3472
|
+
# The policy name cannot exceed 64 characters and can only include
|
3473
|
+
# alphanumeric characters, dashes, and underscores.
|
3474
|
+
#
|
3475
|
+
# @option params [required, String] :policy
|
3476
|
+
# The text of the policy in JSON format. The policy cannot exceed 4 KB.
|
3477
|
+
#
|
3478
|
+
# For information about the syntax of sending authorization policies,
|
3479
|
+
# see the [Amazon SES Developer Guide][1].
|
3480
|
+
#
|
3481
|
+
#
|
3482
|
+
#
|
3483
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-policies.html
|
3484
|
+
#
|
3485
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3486
|
+
#
|
3487
|
+
# @example Request syntax with placeholder values
|
3488
|
+
#
|
3489
|
+
# resp = client.update_email_identity_policy({
|
3490
|
+
# email_identity: "Identity", # required
|
3491
|
+
# policy_name: "PolicyName", # required
|
3492
|
+
# policy: "Policy", # required
|
3493
|
+
# })
|
3494
|
+
#
|
3495
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/UpdateEmailIdentityPolicy AWS API Documentation
|
3496
|
+
#
|
3497
|
+
# @overload update_email_identity_policy(params = {})
|
3498
|
+
# @param [Hash] params ({})
|
3499
|
+
def update_email_identity_policy(params = {}, options = {})
|
3500
|
+
req = build_request(:update_email_identity_policy, params)
|
3501
|
+
req.send_request(options)
|
3502
|
+
end
|
3503
|
+
|
3504
|
+
# Updates an email template. Email templates enable you to send
|
3505
|
+
# personalized email to one or more destinations in a single API
|
3506
|
+
# operation. For more information, see the [Amazon SES Developer
|
3507
|
+
# Guide][1].
|
3508
|
+
#
|
3509
|
+
# You can execute this operation no more than once per second.
|
3510
|
+
#
|
3511
|
+
#
|
3512
|
+
#
|
3513
|
+
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html
|
3514
|
+
#
|
3515
|
+
# @option params [required, String] :template_name
|
3516
|
+
# The name of the template you want to update.
|
3517
|
+
#
|
3518
|
+
# @option params [required, Types::EmailTemplateContent] :template_content
|
3519
|
+
# The content of the email template, composed of a subject line, an HTML
|
3520
|
+
# part, and a text-only part.
|
3521
|
+
#
|
3522
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3523
|
+
#
|
3524
|
+
# @example Request syntax with placeholder values
|
3525
|
+
#
|
3526
|
+
# resp = client.update_email_template({
|
3527
|
+
# template_name: "EmailTemplateName", # required
|
3528
|
+
# template_content: { # required
|
3529
|
+
# subject: "EmailTemplateSubject",
|
3530
|
+
# text: "EmailTemplateText",
|
3531
|
+
# html: "EmailTemplateHtml",
|
3532
|
+
# },
|
3533
|
+
# })
|
3534
|
+
#
|
3535
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sesv2-2019-09-27/UpdateEmailTemplate AWS API Documentation
|
3536
|
+
#
|
3537
|
+
# @overload update_email_template(params = {})
|
3538
|
+
# @param [Hash] params ({})
|
3539
|
+
def update_email_template(params = {}, options = {})
|
3540
|
+
req = build_request(:update_email_template, params)
|
3541
|
+
req.send_request(options)
|
3542
|
+
end
|
3543
|
+
|
2540
3544
|
# @!endgroup
|
2541
3545
|
|
2542
3546
|
# @param params ({})
|
@@ -2550,7 +3554,7 @@ module Aws::SESV2
|
|
2550
3554
|
params: params,
|
2551
3555
|
config: config)
|
2552
3556
|
context[:gem_name] = 'aws-sdk-sesv2'
|
2553
|
-
context[:gem_version] = '1.
|
3557
|
+
context[:gem_version] = '1.9.0'
|
2554
3558
|
Seahorse::Client::Request.new(handlers, context)
|
2555
3559
|
end
|
2556
3560
|
|