@aws-sdk/client-ses 3.388.0 → 3.391.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.
- package/README.md +25 -0
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-cjs/models/models_0.js +21 -1
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-es/models/models_0.js +20 -0
- package/dist-types/SES.d.ts +28 -3
- package/dist-types/SESClient.d.ts +28 -3
- package/dist-types/commands/CloneReceiptRuleSetCommand.d.ts +2 -3
- package/dist-types/commands/CreateConfigurationSetCommand.d.ts +4 -4
- package/dist-types/commands/CreateConfigurationSetEventDestinationCommand.d.ts +8 -8
- package/dist-types/commands/CreateConfigurationSetTrackingOptionsCommand.d.ts +5 -5
- package/dist-types/commands/CreateCustomVerificationEmailTemplateCommand.d.ts +3 -2
- package/dist-types/commands/CreateReceiptFilterCommand.d.ts +4 -3
- package/dist-types/commands/CreateReceiptRuleCommand.d.ts +11 -11
- package/dist-types/commands/CreateReceiptRuleSetCommand.d.ts +2 -3
- package/dist-types/commands/CreateTemplateCommand.d.ts +3 -3
- package/dist-types/commands/DeleteConfigurationSetCommand.d.ts +3 -2
- package/dist-types/commands/DeleteConfigurationSetEventDestinationCommand.d.ts +3 -2
- package/dist-types/commands/DeleteConfigurationSetTrackingOptionsCommand.d.ts +5 -5
- package/dist-types/commands/DeleteCustomVerificationEmailTemplateCommand.d.ts +3 -2
- package/dist-types/commands/DeleteIdentityCommand.d.ts +1 -1
- package/dist-types/commands/DeleteIdentityPolicyCommand.d.ts +10 -10
- package/dist-types/commands/DeleteReceiptFilterCommand.d.ts +2 -2
- package/dist-types/commands/DeleteReceiptRuleCommand.d.ts +2 -2
- package/dist-types/commands/DeleteReceiptRuleSetCommand.d.ts +5 -4
- package/dist-types/commands/DeleteTemplateCommand.d.ts +1 -1
- package/dist-types/commands/DescribeActiveReceiptRuleSetCommand.d.ts +6 -7
- package/dist-types/commands/DescribeConfigurationSetCommand.d.ts +7 -7
- package/dist-types/commands/DescribeReceiptRuleCommand.d.ts +7 -7
- package/dist-types/commands/DescribeReceiptRuleSetCommand.d.ts +7 -6
- package/dist-types/commands/GetAccountSendingEnabledCommand.d.ts +2 -2
- package/dist-types/commands/GetCustomVerificationEmailTemplateCommand.d.ts +3 -2
- package/dist-types/commands/GetIdentityDkimAttributesCommand.d.ts +9 -8
- package/dist-types/commands/GetIdentityMailFromDomainAttributesCommand.d.ts +3 -3
- package/dist-types/commands/GetIdentityNotificationAttributesCommand.d.ts +2 -2
- package/dist-types/commands/GetIdentityPoliciesCommand.d.ts +8 -8
- package/dist-types/commands/GetIdentityVerificationAttributesCommand.d.ts +8 -8
- package/dist-types/commands/GetSendQuotaCommand.d.ts +1 -1
- package/dist-types/commands/GetSendStatisticsCommand.d.ts +2 -2
- package/dist-types/commands/GetTemplateCommand.d.ts +1 -1
- package/dist-types/commands/ListConfigurationSetsCommand.d.ts +6 -5
- package/dist-types/commands/ListCustomVerificationEmailTemplatesCommand.d.ts +4 -3
- package/dist-types/commands/ListIdentitiesCommand.d.ts +13 -3
- package/dist-types/commands/ListIdentityPoliciesCommand.d.ts +10 -10
- package/dist-types/commands/ListReceiptFiltersCommand.d.ts +5 -5
- package/dist-types/commands/ListReceiptRuleSetsCommand.d.ts +5 -4
- package/dist-types/commands/ListTemplatesCommand.d.ts +3 -3
- package/dist-types/commands/PutConfigurationSetDeliveryOptionsCommand.d.ts +1 -1
- package/dist-types/commands/PutIdentityPolicyCommand.d.ts +8 -8
- package/dist-types/commands/ReorderReceiptRuleSetCommand.d.ts +7 -7
- package/dist-types/commands/SendBounceCommand.d.ts +11 -10
- package/dist-types/commands/SendBulkTemplatedEmailCommand.d.ts +19 -19
- package/dist-types/commands/SendCustomVerificationEmailCommand.d.ts +5 -5
- package/dist-types/commands/SendEmailCommand.d.ts +19 -21
- package/dist-types/commands/SendRawEmailCommand.d.ts +50 -58
- package/dist-types/commands/SendTemplatedEmailCommand.d.ts +21 -22
- package/dist-types/commands/SetActiveReceiptRuleSetCommand.d.ts +7 -6
- package/dist-types/commands/SetIdentityDkimEnabledCommand.d.ts +6 -5
- package/dist-types/commands/SetIdentityFeedbackForwardingEnabledCommand.d.ts +4 -4
- package/dist-types/commands/SetIdentityHeadersInNotificationsEnabledCommand.d.ts +3 -3
- package/dist-types/commands/SetIdentityMailFromDomainCommand.d.ts +6 -7
- package/dist-types/commands/SetIdentityNotificationTopicCommand.d.ts +4 -4
- package/dist-types/commands/SetReceiptRulePositionCommand.d.ts +2 -2
- package/dist-types/commands/TestRenderTemplateCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAccountSendingEnabledCommand.d.ts +3 -3
- package/dist-types/commands/UpdateConfigurationSetEventDestinationCommand.d.ts +7 -7
- package/dist-types/commands/UpdateConfigurationSetReputationMetricsEnabledCommand.d.ts +2 -2
- package/dist-types/commands/UpdateConfigurationSetSendingEnabledCommand.d.ts +2 -2
- package/dist-types/commands/UpdateConfigurationSetTrackingOptionsCommand.d.ts +5 -5
- package/dist-types/commands/UpdateCustomVerificationEmailTemplateCommand.d.ts +3 -2
- package/dist-types/commands/UpdateReceiptRuleCommand.d.ts +10 -10
- package/dist-types/commands/UpdateTemplateCommand.d.ts +3 -3
- package/dist-types/commands/VerifyDomainDkimCommand.d.ts +13 -13
- package/dist-types/commands/VerifyDomainIdentityCommand.d.ts +5 -6
- package/dist-types/commands/VerifyEmailIdentityCommand.d.ts +2 -2
- package/dist-types/index.d.ts +28 -3
- package/dist-types/models/models_0.d.ts +710 -639
- package/dist-types/ts3.4/models/models_0.d.ts +26 -8
- package/package.json +29 -29
|
@@ -33,7 +33,7 @@ export interface PutConfigurationSetDeliveryOptionsCommandOutput extends PutConf
|
|
|
33
33
|
* const input = { // PutConfigurationSetDeliveryOptionsRequest
|
|
34
34
|
* ConfigurationSetName: "STRING_VALUE", // required
|
|
35
35
|
* DeliveryOptions: { // DeliveryOptions
|
|
36
|
-
* TlsPolicy: "
|
|
36
|
+
* TlsPolicy: "Require" || "Optional",
|
|
37
37
|
* },
|
|
38
38
|
* };
|
|
39
39
|
* const command = new PutConfigurationSetDeliveryOptionsCommand(input);
|
|
@@ -25,15 +25,15 @@ export interface PutIdentityPolicyCommandOutput extends PutIdentityPolicyRespons
|
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Adds or updates a sending authorization policy for the specified identity (an email
|
|
27
27
|
* address or a domain).</p>
|
|
28
|
-
*
|
|
29
|
-
* <p>This
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
*
|
|
28
|
+
* <note>
|
|
29
|
+
* <p>This operation is for the identity owner only. If you have not verified the
|
|
30
|
+
* identity, it returns an error.</p>
|
|
31
|
+
* </note>
|
|
32
|
+
* <p>Sending authorization is a feature that enables an identity owner to authorize other
|
|
33
33
|
* senders to use its identities. For information about using sending authorization, see
|
|
34
|
-
* the <a href="https://docs.aws.amazon.com/ses/latest/
|
|
35
|
-
* Guide</a>.</p>
|
|
36
|
-
*
|
|
34
|
+
* the <a href="https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html">Amazon SES
|
|
35
|
+
* Developer Guide</a>.</p>
|
|
36
|
+
* <p>You can execute this operation no more than once per second.</p>
|
|
37
37
|
* @example
|
|
38
38
|
* Use a bare-bones client and the command you need to make an API call.
|
|
39
39
|
* ```javascript
|
|
@@ -24,13 +24,13 @@ export interface ReorderReceiptRuleSetCommandOutput extends ReorderReceiptRuleSe
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Reorders the receipt rules within a receipt rule set.</p>
|
|
27
|
-
*
|
|
28
|
-
* <p>All of the rules in the rule set must be represented in this request. That is,
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
27
|
+
* <note>
|
|
28
|
+
* <p>All of the rules in the rule set must be represented in this request. That is, it
|
|
29
|
+
* is error if the reorder request doesn't explicitly position all of the rules.</p>
|
|
30
|
+
* </note>
|
|
31
|
+
* <p>For information about managing receipt rule sets, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-receipt-rules-console-walkthrough.html">Amazon SES
|
|
32
|
+
* Developer Guide</a>.</p>
|
|
33
|
+
* <p>You can execute this operation no more than once per second.</p>
|
|
34
34
|
* @example
|
|
35
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
36
36
|
* ```javascript
|
|
@@ -24,14 +24,15 @@ export interface SendBounceCommandOutput extends SendBounceResponse, __MetadataB
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Generates and sends a bounce message to the sender of an email you received through
|
|
27
|
-
* Amazon SES. You can only use this
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
*
|
|
27
|
+
* Amazon SES. You can only use this operation on an email up to 24 hours after you receive
|
|
28
|
+
* it.</p>
|
|
29
|
+
* <note>
|
|
30
|
+
* <p>You cannot use this operation to send generic bounces for mail that was not
|
|
31
|
+
* received by Amazon SES.</p>
|
|
32
|
+
* </note>
|
|
33
|
+
* <p>For information about receiving email through Amazon SES, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email.html">Amazon SES Developer
|
|
34
|
+
* Guide</a>.</p>
|
|
35
|
+
* <p>You can execute this operation no more than once per second.</p>
|
|
35
36
|
* @example
|
|
36
37
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
38
|
* ```javascript
|
|
@@ -56,10 +57,10 @@ export interface SendBounceCommandOutput extends SendBounceResponse, __MetadataB
|
|
|
56
57
|
* { // BouncedRecipientInfo
|
|
57
58
|
* Recipient: "STRING_VALUE", // required
|
|
58
59
|
* RecipientArn: "STRING_VALUE",
|
|
59
|
-
* BounceType: "
|
|
60
|
+
* BounceType: "DoesNotExist" || "MessageTooLarge" || "ExceededQuota" || "ContentRejected" || "Undefined" || "TemporaryFailure",
|
|
60
61
|
* RecipientDsnFields: { // RecipientDsnFields
|
|
61
62
|
* FinalRecipient: "STRING_VALUE",
|
|
62
|
-
* Action: "
|
|
63
|
+
* Action: "failed" || "delayed" || "delivered" || "relayed" || "expanded", // required
|
|
63
64
|
* RemoteMta: "STRING_VALUE",
|
|
64
65
|
* Status: "STRING_VALUE", // required
|
|
65
66
|
* DiagnosticCode: "STRING_VALUE",
|
|
@@ -25,45 +25,45 @@ export interface SendBulkTemplatedEmailCommandOutput extends SendBulkTemplatedEm
|
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Composes an email message to multiple destinations. The message body is created using
|
|
27
27
|
* an email template.</p>
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
*
|
|
28
|
+
* <p>To send email using this operation, your call must meet the following
|
|
29
|
+
* requirements:</p>
|
|
30
|
+
* <ul>
|
|
31
31
|
* <li>
|
|
32
|
-
*
|
|
33
|
-
* templates using
|
|
32
|
+
* <p>The call must refer to an existing email template. You can create email
|
|
33
|
+
* templates using <a>CreateTemplate</a>.</p>
|
|
34
34
|
* </li>
|
|
35
35
|
* <li>
|
|
36
|
-
*
|
|
36
|
+
* <p>The message must be sent from a verified email address or domain.</p>
|
|
37
37
|
* </li>
|
|
38
38
|
* <li>
|
|
39
|
-
*
|
|
39
|
+
* <p>If your account is still in the Amazon SES sandbox, you may send only to verified
|
|
40
40
|
* addresses or domains, or to email addresses associated with the Amazon SES Mailbox
|
|
41
|
-
* Simulator. For more information, see <a href="https://docs.aws.amazon.com/ses/latest/
|
|
42
|
-
*
|
|
41
|
+
* Simulator. For more information, see <a href="https://docs.aws.amazon.com/ses/latest/dg/verify-addresses-and-domains.html">Verifying Email
|
|
42
|
+
* Addresses and Domains</a> in the <i>Amazon SES Developer
|
|
43
43
|
* Guide.</i>
|
|
44
44
|
* </p>
|
|
45
45
|
* </li>
|
|
46
46
|
* <li>
|
|
47
|
-
*
|
|
47
|
+
* <p>The maximum message size is 10 MB.</p>
|
|
48
48
|
* </li>
|
|
49
49
|
* <li>
|
|
50
|
-
*
|
|
50
|
+
* <p>Each <code>Destination</code> parameter must include at least one recipient
|
|
51
51
|
* email address. The recipient address can be a To: address, a CC: address, or a
|
|
52
52
|
* BCC: address. If a recipient email address is invalid (that is, it is not in the
|
|
53
53
|
* format <i>UserName@[SubDomain.]Domain.TopLevelDomain</i>), the
|
|
54
|
-
* entire message
|
|
55
|
-
*
|
|
54
|
+
* entire message is rejected, even if the message contains other recipients that
|
|
55
|
+
* are valid.</p>
|
|
56
56
|
* </li>
|
|
57
57
|
* <li>
|
|
58
|
-
*
|
|
58
|
+
* <p>The message may not include more than 50 recipients, across the To:, CC: and
|
|
59
59
|
* BCC: fields. If you need to send an email message to a larger audience, you can
|
|
60
60
|
* divide your recipient list into groups of 50 or fewer, and then call the
|
|
61
61
|
* <code>SendBulkTemplatedEmail</code> operation several times to send the
|
|
62
62
|
* message to each group.</p>
|
|
63
63
|
* </li>
|
|
64
64
|
* <li>
|
|
65
|
-
*
|
|
66
|
-
*
|
|
65
|
+
* <p>The number of destinations you can contact in a single call can be limited by
|
|
66
|
+
* your account's maximum sending rate.</p>
|
|
67
67
|
* </li>
|
|
68
68
|
* </ul>
|
|
69
69
|
* @example
|
|
@@ -118,7 +118,7 @@ export interface SendBulkTemplatedEmailCommandOutput extends SendBulkTemplatedEm
|
|
|
118
118
|
* // { // SendBulkTemplatedEmailResponse
|
|
119
119
|
* // Status: [ // BulkEmailDestinationStatusList // required
|
|
120
120
|
* // { // BulkEmailDestinationStatus
|
|
121
|
-
* // Status: "
|
|
121
|
+
* // Status: "Success" || "MessageRejected" || "MailFromDomainNotVerified" || "ConfigurationSetDoesNotExist" || "TemplateDoesNotExist" || "AccountSuspended" || "AccountThrottled" || "AccountDailyQuotaExceeded" || "InvalidSendingPoolName" || "AccountSendingPaused" || "ConfigurationSetSendingPaused" || "InvalidParameterValue" || "TransientFailure" || "Failed",
|
|
122
122
|
* // Error: "STRING_VALUE",
|
|
123
123
|
* // MessageId: "STRING_VALUE",
|
|
124
124
|
* // },
|
|
@@ -135,14 +135,14 @@ export interface SendBulkTemplatedEmailCommandOutput extends SendBulkTemplatedEm
|
|
|
135
135
|
*
|
|
136
136
|
* @throws {@link AccountSendingPausedException} (client fault)
|
|
137
137
|
* <p>Indicates that email sending is disabled for your entire Amazon SES account.</p>
|
|
138
|
-
*
|
|
138
|
+
* <p>You can enable or disable email sending for your Amazon SES account using <a>UpdateAccountSendingEnabled</a>.</p>
|
|
139
139
|
*
|
|
140
140
|
* @throws {@link ConfigurationSetDoesNotExistException} (client fault)
|
|
141
141
|
* <p>Indicates that the configuration set does not exist.</p>
|
|
142
142
|
*
|
|
143
143
|
* @throws {@link ConfigurationSetSendingPausedException} (client fault)
|
|
144
144
|
* <p>Indicates that email sending is disabled for the configuration set.</p>
|
|
145
|
-
*
|
|
145
|
+
* <p>You can enable or disable email sending for a configuration set using <a>UpdateConfigurationSetSendingEnabled</a>.</p>
|
|
146
146
|
*
|
|
147
147
|
* @throws {@link MailFromDomainNotVerifiedException} (client fault)
|
|
148
148
|
* <p> Indicates that the message could not be sent because Amazon SES could not read the MX
|
|
@@ -24,14 +24,14 @@ export interface SendCustomVerificationEmailCommandOutput extends SendCustomVeri
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Adds an email address to the list of identities for your Amazon SES account in the current
|
|
27
|
-
*
|
|
27
|
+
* Amazon Web Services Region and attempts to verify it. As a result of executing this operation, a
|
|
28
28
|
* customized verification email is sent to the specified address.</p>
|
|
29
|
-
*
|
|
29
|
+
* <p>To use this operation, you must first create a custom verification email template. For
|
|
30
30
|
* more information about creating and using custom verification email templates, see
|
|
31
|
-
* <a href="https://docs.aws.amazon.com/ses/latest/
|
|
32
|
-
* Verification Email Templates</a> in the <i>Amazon SES Developer
|
|
31
|
+
* <a href="https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom">Using
|
|
32
|
+
* Custom Verification Email Templates</a> in the <i>Amazon SES Developer
|
|
33
33
|
* Guide</i>.</p>
|
|
34
|
-
*
|
|
34
|
+
* <p>You can execute this operation no more than once per second.</p>
|
|
35
35
|
* @example
|
|
36
36
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
37
|
* ```javascript
|
|
@@ -23,51 +23,49 @@ export interface SendEmailCommandOutput extends SendEmailResponse, __MetadataBea
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Composes an email message and immediately queues it for sending.
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
* <ul>
|
|
26
|
+
* <p>Composes an email message and immediately queues it for sending. To send email using
|
|
27
|
+
* this operation, your message must meet the following requirements:</p>
|
|
28
|
+
* <ul>
|
|
31
29
|
* <li>
|
|
32
|
-
*
|
|
33
|
-
* attempt to send email using a non-verified address or domain, the operation
|
|
34
|
-
*
|
|
30
|
+
* <p>The message must be sent from a verified email address or domain. If you
|
|
31
|
+
* attempt to send email using a non-verified address or domain, the operation
|
|
32
|
+
* results in an "Email address not verified" error. </p>
|
|
35
33
|
* </li>
|
|
36
34
|
* <li>
|
|
37
|
-
*
|
|
35
|
+
* <p>If your account is still in the Amazon SES sandbox, you may only send to verified
|
|
38
36
|
* addresses or domains, or to email addresses associated with the Amazon SES Mailbox
|
|
39
|
-
* Simulator. For more information, see <a href="https://docs.aws.amazon.com/ses/latest/
|
|
40
|
-
*
|
|
37
|
+
* Simulator. For more information, see <a href="https://docs.aws.amazon.com/ses/latest/dg/verify-addresses-and-domains.html">Verifying Email
|
|
38
|
+
* Addresses and Domains</a> in the <i>Amazon SES Developer
|
|
41
39
|
* Guide.</i>
|
|
42
40
|
* </p>
|
|
43
41
|
* </li>
|
|
44
42
|
* <li>
|
|
45
|
-
*
|
|
43
|
+
* <p>The maximum message size is 10 MB.</p>
|
|
46
44
|
* </li>
|
|
47
45
|
* <li>
|
|
48
|
-
*
|
|
46
|
+
* <p>The message must include at least one recipient email address. The recipient
|
|
49
47
|
* address can be a To: address, a CC: address, or a BCC: address. If a recipient
|
|
50
48
|
* email address is invalid (that is, it is not in the format
|
|
51
49
|
* <i>UserName@[SubDomain.]Domain.TopLevelDomain</i>), the entire
|
|
52
|
-
* message
|
|
50
|
+
* message is rejected, even if the message contains other recipients that are
|
|
53
51
|
* valid.</p>
|
|
54
52
|
* </li>
|
|
55
53
|
* <li>
|
|
56
|
-
*
|
|
54
|
+
* <p>The message may not include more than 50 recipients, across the To:, CC: and
|
|
57
55
|
* BCC: fields. If you need to send an email message to a larger audience, you can
|
|
58
56
|
* divide your recipient list into groups of 50 or fewer, and then call the
|
|
59
57
|
* <code>SendEmail</code> operation several times to send the message to each
|
|
60
58
|
* group.</p>
|
|
61
59
|
* </li>
|
|
62
60
|
* </ul>
|
|
63
|
-
*
|
|
61
|
+
* <important>
|
|
64
62
|
* <p>For every message that you send, the total number of recipients (including each
|
|
65
63
|
* recipient in the To:, CC: and BCC: fields) is counted against the maximum number of
|
|
66
64
|
* emails you can send in a 24-hour period (your <i>sending quota</i>).
|
|
67
|
-
* For more information about sending quotas in Amazon SES, see <a href="https://docs.aws.amazon.com/ses/latest/
|
|
68
|
-
*
|
|
65
|
+
* For more information about sending quotas in Amazon SES, see <a href="https://docs.aws.amazon.com/ses/latest/dg/manage-sending-quotas.html">Managing Your Amazon SES Sending
|
|
66
|
+
* Limits</a> in the <i>Amazon SES Developer Guide.</i>
|
|
69
67
|
* </p>
|
|
70
|
-
*
|
|
68
|
+
* </important>
|
|
71
69
|
* @example
|
|
72
70
|
* Use a bare-bones client and the command you need to make an API call.
|
|
73
71
|
* ```javascript
|
|
@@ -133,14 +131,14 @@ export interface SendEmailCommandOutput extends SendEmailResponse, __MetadataBea
|
|
|
133
131
|
*
|
|
134
132
|
* @throws {@link AccountSendingPausedException} (client fault)
|
|
135
133
|
* <p>Indicates that email sending is disabled for your entire Amazon SES account.</p>
|
|
136
|
-
*
|
|
134
|
+
* <p>You can enable or disable email sending for your Amazon SES account using <a>UpdateAccountSendingEnabled</a>.</p>
|
|
137
135
|
*
|
|
138
136
|
* @throws {@link ConfigurationSetDoesNotExistException} (client fault)
|
|
139
137
|
* <p>Indicates that the configuration set does not exist.</p>
|
|
140
138
|
*
|
|
141
139
|
* @throws {@link ConfigurationSetSendingPausedException} (client fault)
|
|
142
140
|
* <p>Indicates that email sending is disabled for the configuration set.</p>
|
|
143
|
-
*
|
|
141
|
+
* <p>You can enable or disable email sending for a configuration set using <a>UpdateConfigurationSetSendingEnabled</a>.</p>
|
|
144
142
|
*
|
|
145
143
|
* @throws {@link MailFromDomainNotVerifiedException} (client fault)
|
|
146
144
|
* <p> Indicates that the message could not be sent because Amazon SES could not read the MX
|
|
@@ -24,110 +24,102 @@ export interface SendRawEmailCommandOutput extends SendRawEmailResponse, __Metad
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Composes an email message and immediately queues it for sending.</p>
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
* <p>The <code>SendRawEmail</code> operation has the following requirements:</p>
|
|
35
|
-
* <ul>
|
|
27
|
+
* <p>This operation is more flexible than the <code>SendEmail</code> operation. When you
|
|
28
|
+
* use the <code>SendRawEmail</code> operation, you can specify the headers of the message
|
|
29
|
+
* as well as its content. This flexibility is useful, for example, when you need to send a
|
|
30
|
+
* multipart MIME email (such a message that contains both a text and an HTML version). You
|
|
31
|
+
* can also use this operation to send messages that include attachments.</p>
|
|
32
|
+
* <p>The <code>SendRawEmail</code> operation has the following requirements:</p>
|
|
33
|
+
* <ul>
|
|
36
34
|
* <li>
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
*
|
|
35
|
+
* <p>You can only send email from <a href="https://docs.aws.amazon.com/ses/latest/dg/verify-addresses-and-domains.html">verified email addresses or domains</a>. If you try to send email from
|
|
36
|
+
* an address that isn't verified, the operation results in an "Email address not
|
|
37
|
+
* verified" error.</p>
|
|
40
38
|
* </li>
|
|
41
39
|
* <li>
|
|
42
|
-
*
|
|
43
|
-
*
|
|
44
|
-
* <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/mailbox-simulator.html">Amazon SES mailbox simulator</a>.</p>
|
|
40
|
+
* <p>If your account is still in the <a href="https://docs.aws.amazon.com/ses/latest/dg/request-production-access.html">Amazon SES sandbox</a>, you can only send email to other verified addresses
|
|
41
|
+
* in your account, or to addresses that are associated with the <a href="https://docs.aws.amazon.com/ses/latest/dg/send-an-email-from-console.html">Amazon SES mailbox simulator</a>.</p>
|
|
45
42
|
* </li>
|
|
46
43
|
* <li>
|
|
47
|
-
*
|
|
44
|
+
* <p>The maximum message size, including attachments, is 10 MB.</p>
|
|
48
45
|
* </li>
|
|
49
46
|
* <li>
|
|
50
|
-
*
|
|
47
|
+
* <p>Each message has to include at least one recipient address. A recipient
|
|
51
48
|
* address includes any address on the To:, CC:, or BCC: lines.</p>
|
|
52
49
|
* </li>
|
|
53
50
|
* <li>
|
|
54
|
-
*
|
|
51
|
+
* <p>If you send a single message to more than one recipient address, and one of
|
|
55
52
|
* the recipient addresses isn't in a valid format (that is, it's not in the format
|
|
56
53
|
* <i>UserName@[SubDomain.]Domain.TopLevelDomain</i>), Amazon SES
|
|
57
54
|
* rejects the entire message, even if the other addresses are valid.</p>
|
|
58
55
|
* </li>
|
|
59
56
|
* <li>
|
|
60
|
-
*
|
|
57
|
+
* <p>Each message can include up to 50 recipient addresses across the To:, CC:, or
|
|
61
58
|
* BCC: lines. If you need to send a single message to more than 50 recipients, you
|
|
62
59
|
* have to split the list of recipient addresses into groups of less than 50
|
|
63
60
|
* recipients, and send separate messages to each group.</p>
|
|
64
61
|
* </li>
|
|
65
62
|
* <li>
|
|
66
|
-
*
|
|
63
|
+
* <p>Amazon SES allows you to specify 8-bit Content-Transfer-Encoding for MIME message
|
|
67
64
|
* parts. However, if Amazon SES has to modify the contents of your message (for
|
|
68
65
|
* example, if you use open and click tracking), 8-bit content isn't preserved. For
|
|
69
66
|
* this reason, we highly recommend that you encode all content that isn't 7-bit
|
|
70
|
-
* ASCII. For more information, see <a href="https://docs.aws.amazon.com/ses/latest/
|
|
67
|
+
* ASCII. For more information, see <a href="https://docs.aws.amazon.com/ses/latest/dg/send-email-raw.html#send-email-mime-encoding">MIME Encoding</a> in the <i>Amazon SES Developer
|
|
71
68
|
* Guide</i>.</p>
|
|
72
69
|
* </li>
|
|
73
70
|
* </ul>
|
|
74
|
-
*
|
|
75
|
-
*
|
|
76
|
-
*
|
|
77
|
-
* <p>Additionally, keep the following considerations in mind when using the
|
|
71
|
+
* <p>Additionally, keep the following considerations in mind when using the
|
|
78
72
|
* <code>SendRawEmail</code> operation:</p>
|
|
79
|
-
*
|
|
80
|
-
* <ul>
|
|
73
|
+
* <ul>
|
|
81
74
|
* <li>
|
|
82
|
-
*
|
|
83
|
-
* <code>SendRawEmail</code> operation, Amazon SES
|
|
75
|
+
* <p>Although you can customize the message headers when using the
|
|
76
|
+
* <code>SendRawEmail</code> operation, Amazon SES automatically applies its own
|
|
84
77
|
* <code>Message-ID</code> and <code>Date</code> headers; if you passed these
|
|
85
|
-
* headers when creating the message, they
|
|
86
|
-
*
|
|
78
|
+
* headers when creating the message, they are overwritten by the values that Amazon SES
|
|
79
|
+
* provides.</p>
|
|
87
80
|
* </li>
|
|
88
81
|
* <li>
|
|
89
|
-
*
|
|
82
|
+
* <p>If you are using sending authorization to send on behalf of another user,
|
|
90
83
|
* <code>SendRawEmail</code> enables you to specify the cross-account identity
|
|
91
84
|
* for the email's Source, From, and Return-Path parameters in one of two ways: you
|
|
92
85
|
* can pass optional parameters <code>SourceArn</code>, <code>FromArn</code>,
|
|
93
|
-
* and/or <code>ReturnPathArn</code
|
|
94
|
-
*
|
|
95
|
-
*
|
|
86
|
+
* and/or <code>ReturnPathArn</code>, or you can include the following X-headers in
|
|
87
|
+
* the header of your raw email:</p>
|
|
88
|
+
* <ul>
|
|
96
89
|
* <li>
|
|
97
|
-
*
|
|
98
|
-
*
|
|
99
|
-
*
|
|
100
|
-
*
|
|
90
|
+
* <p>
|
|
91
|
+
* <code>X-SES-SOURCE-ARN</code>
|
|
92
|
+
* </p>
|
|
93
|
+
* </li>
|
|
101
94
|
* <li>
|
|
102
|
-
*
|
|
103
|
-
*
|
|
104
|
-
*
|
|
105
|
-
*
|
|
95
|
+
* <p>
|
|
96
|
+
* <code>X-SES-FROM-ARN</code>
|
|
97
|
+
* </p>
|
|
98
|
+
* </li>
|
|
106
99
|
* <li>
|
|
107
|
-
*
|
|
108
|
-
*
|
|
109
|
-
*
|
|
110
|
-
*
|
|
100
|
+
* <p>
|
|
101
|
+
* <code>X-SES-RETURN-PATH-ARN</code>
|
|
102
|
+
* </p>
|
|
103
|
+
* </li>
|
|
111
104
|
* </ul>
|
|
112
|
-
*
|
|
113
|
-
*
|
|
105
|
+
* <important>
|
|
106
|
+
* <p>Don't include these X-headers in the DKIM signature. Amazon SES removes these
|
|
114
107
|
* before it sends the email.</p>
|
|
115
|
-
*
|
|
116
|
-
*
|
|
108
|
+
* </important>
|
|
109
|
+
* <p>If you only specify the <code>SourceIdentityArn</code> parameter, Amazon SES sets
|
|
117
110
|
* the From and Return-Path addresses to the same identity that you
|
|
118
111
|
* specified.</p>
|
|
119
|
-
*
|
|
120
|
-
* Authorization with Amazon SES</a> in the <i>Amazon SES Developer
|
|
112
|
+
* <p>For more information about sending authorization, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html">Using
|
|
113
|
+
* Sending Authorization with Amazon SES</a> in the <i>Amazon SES Developer
|
|
121
114
|
* Guide.</i>
|
|
122
115
|
* </p>
|
|
123
116
|
* </li>
|
|
124
117
|
* <li>
|
|
125
|
-
*
|
|
118
|
+
* <p>For every message that you send, the total number of recipients (including
|
|
126
119
|
* each recipient in the To:, CC: and BCC: fields) is counted against the maximum
|
|
127
120
|
* number of emails you can send in a 24-hour period (your <i>sending
|
|
128
121
|
* quota</i>). For more information about sending quotas in Amazon SES, see
|
|
129
|
-
* <a href="https://docs.aws.amazon.com/ses/latest/
|
|
130
|
-
* Amazon SES Sending Limits</a> in the <i>Amazon SES Developer
|
|
122
|
+
* <a href="https://docs.aws.amazon.com/ses/latest/dg/manage-sending-quotas.html">Managing Your Amazon SES Sending Limits</a> in the <i>Amazon SES Developer
|
|
131
123
|
* Guide.</i>
|
|
132
124
|
* </p>
|
|
133
125
|
* </li>
|
|
@@ -173,14 +165,14 @@ export interface SendRawEmailCommandOutput extends SendRawEmailResponse, __Metad
|
|
|
173
165
|
*
|
|
174
166
|
* @throws {@link AccountSendingPausedException} (client fault)
|
|
175
167
|
* <p>Indicates that email sending is disabled for your entire Amazon SES account.</p>
|
|
176
|
-
*
|
|
168
|
+
* <p>You can enable or disable email sending for your Amazon SES account using <a>UpdateAccountSendingEnabled</a>.</p>
|
|
177
169
|
*
|
|
178
170
|
* @throws {@link ConfigurationSetDoesNotExistException} (client fault)
|
|
179
171
|
* <p>Indicates that the configuration set does not exist.</p>
|
|
180
172
|
*
|
|
181
173
|
* @throws {@link ConfigurationSetSendingPausedException} (client fault)
|
|
182
174
|
* <p>Indicates that email sending is disabled for the configuration set.</p>
|
|
183
|
-
*
|
|
175
|
+
* <p>You can enable or disable email sending for a configuration set using <a>UpdateConfigurationSetSendingEnabled</a>.</p>
|
|
184
176
|
*
|
|
185
177
|
* @throws {@link MailFromDomainNotVerifiedException} (client fault)
|
|
186
178
|
* <p> Indicates that the message could not be sent because Amazon SES could not read the MX
|
|
@@ -25,54 +25,53 @@ export interface SendTemplatedEmailCommandOutput extends SendTemplatedEmailRespo
|
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Composes an email message using an email template and immediately queues it for
|
|
27
27
|
* sending.</p>
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
*
|
|
28
|
+
* <p>To send email using this operation, your call must meet the following
|
|
29
|
+
* requirements:</p>
|
|
30
|
+
* <ul>
|
|
31
31
|
* <li>
|
|
32
|
-
*
|
|
32
|
+
* <p>The call must refer to an existing email template. You can create email
|
|
33
33
|
* templates using the <a>CreateTemplate</a> operation.</p>
|
|
34
34
|
* </li>
|
|
35
35
|
* <li>
|
|
36
|
-
*
|
|
36
|
+
* <p>The message must be sent from a verified email address or domain.</p>
|
|
37
37
|
* </li>
|
|
38
38
|
* <li>
|
|
39
|
-
*
|
|
39
|
+
* <p>If your account is still in the Amazon SES sandbox, you may only send to verified
|
|
40
40
|
* addresses or domains, or to email addresses associated with the Amazon SES Mailbox
|
|
41
|
-
* Simulator. For more information, see <a href="https://docs.aws.amazon.com/ses/latest/
|
|
42
|
-
*
|
|
41
|
+
* Simulator. For more information, see <a href="https://docs.aws.amazon.com/ses/latest/dg/verify-addresses-and-domains.html">Verifying Email
|
|
42
|
+
* Addresses and Domains</a> in the <i>Amazon SES Developer
|
|
43
43
|
* Guide.</i>
|
|
44
44
|
* </p>
|
|
45
45
|
* </li>
|
|
46
46
|
* <li>
|
|
47
|
-
*
|
|
47
|
+
* <p>The maximum message size is 10 MB.</p>
|
|
48
48
|
* </li>
|
|
49
49
|
* <li>
|
|
50
|
-
*
|
|
51
|
-
* <code>Destination</code> parameter. A destination is a set of recipients
|
|
52
|
-
*
|
|
50
|
+
* <p>Calls to the <code>SendTemplatedEmail</code> operation may only include one
|
|
51
|
+
* <code>Destination</code> parameter. A destination is a set of recipients
|
|
52
|
+
* that receives the same version of the email. The <code>Destination</code>
|
|
53
53
|
* parameter can include up to 50 recipients, across the To:, CC: and BCC:
|
|
54
54
|
* fields.</p>
|
|
55
55
|
* </li>
|
|
56
56
|
* <li>
|
|
57
|
-
*
|
|
57
|
+
* <p>The <code>Destination</code> parameter must include at least one recipient
|
|
58
58
|
* email address. The recipient address can be a To: address, a CC: address, or a
|
|
59
59
|
* BCC: address. If a recipient email address is invalid (that is, it is not in the
|
|
60
60
|
* format <i>UserName@[SubDomain.]Domain.TopLevelDomain</i>), the
|
|
61
|
-
* entire message
|
|
62
|
-
*
|
|
61
|
+
* entire message is rejected, even if the message contains other recipients that
|
|
62
|
+
* are valid.</p>
|
|
63
63
|
* </li>
|
|
64
64
|
* </ul>
|
|
65
|
-
*
|
|
65
|
+
* <important>
|
|
66
66
|
* <p>If your call to the <code>SendTemplatedEmail</code> operation includes all of the
|
|
67
67
|
* required parameters, Amazon SES accepts it and returns a Message ID. However, if Amazon SES
|
|
68
68
|
* can't render the email because the template contains errors, it doesn't send the
|
|
69
69
|
* email. Additionally, because it already accepted the message, Amazon SES doesn't return a
|
|
70
70
|
* message stating that it was unable to send the email.</p>
|
|
71
71
|
* <p>For these reasons, we highly recommend that you set up Amazon SES to send you
|
|
72
|
-
* notifications when Rendering Failure events occur. For more information, see <a href="https://docs.aws.amazon.com/ses/latest/
|
|
73
|
-
*
|
|
74
|
-
*
|
|
75
|
-
* </important>
|
|
72
|
+
* notifications when Rendering Failure events occur. For more information, see <a href="https://docs.aws.amazon.com/ses/latest/dg/send-personalized-email-api.html">Sending Personalized Email Using the Amazon SES API</a> in the
|
|
73
|
+
* <i>Amazon Simple Email Service Developer Guide</i>.</p>
|
|
74
|
+
* </important>
|
|
76
75
|
* @example
|
|
77
76
|
* Use a bare-bones client and the command you need to make an API call.
|
|
78
77
|
* ```javascript
|
|
@@ -125,14 +124,14 @@ export interface SendTemplatedEmailCommandOutput extends SendTemplatedEmailRespo
|
|
|
125
124
|
*
|
|
126
125
|
* @throws {@link AccountSendingPausedException} (client fault)
|
|
127
126
|
* <p>Indicates that email sending is disabled for your entire Amazon SES account.</p>
|
|
128
|
-
*
|
|
127
|
+
* <p>You can enable or disable email sending for your Amazon SES account using <a>UpdateAccountSendingEnabled</a>.</p>
|
|
129
128
|
*
|
|
130
129
|
* @throws {@link ConfigurationSetDoesNotExistException} (client fault)
|
|
131
130
|
* <p>Indicates that the configuration set does not exist.</p>
|
|
132
131
|
*
|
|
133
132
|
* @throws {@link ConfigurationSetSendingPausedException} (client fault)
|
|
134
133
|
* <p>Indicates that email sending is disabled for the configuration set.</p>
|
|
135
|
-
*
|
|
134
|
+
* <p>You can enable or disable email sending for a configuration set using <a>UpdateConfigurationSetSendingEnabled</a>.</p>
|
|
136
135
|
*
|
|
137
136
|
* @throws {@link MailFromDomainNotVerifiedException} (client fault)
|
|
138
137
|
* <p> Indicates that the message could not be sent because Amazon SES could not read the MX
|
|
@@ -24,12 +24,13 @@ export interface SetActiveReceiptRuleSetCommandOutput extends SetActiveReceiptRu
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Sets the specified receipt rule set as the active receipt rule set.</p>
|
|
27
|
-
*
|
|
28
|
-
* <p>To disable your email-receiving through Amazon SES completely, you can call this
|
|
29
|
-
* with RuleSetName set to null.</p>
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
*
|
|
27
|
+
* <note>
|
|
28
|
+
* <p>To disable your email-receiving through Amazon SES completely, you can call this
|
|
29
|
+
* operation with <code>RuleSetName</code> set to null.</p>
|
|
30
|
+
* </note>
|
|
31
|
+
* <p>For information about managing receipt rule sets, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/receiving-email-receipt-rules-console-walkthrough.html">Amazon SES
|
|
32
|
+
* Developer Guide</a>.</p>
|
|
33
|
+
* <p>You can execute this operation no more than once per second.</p>
|
|
33
34
|
* @example
|
|
34
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
36
|
* ```javascript
|