aws_sdk_sesv2/client/
send_bulk_email.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`SendBulkEmail`](crate::operation::send_bulk_email::builders::SendBulkEmailFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`from_email_address(impl Into<String>)`](crate::operation::send_bulk_email::builders::SendBulkEmailFluentBuilder::from_email_address) / [`set_from_email_address(Option<String>)`](crate::operation::send_bulk_email::builders::SendBulkEmailFluentBuilder::set_from_email_address):<br>required: **false**<br><p>The email address to use as the "From" address for the email. The address that you specify has to be verified.</p><br>
7    ///   - [`from_email_address_identity_arn(impl Into<String>)`](crate::operation::send_bulk_email::builders::SendBulkEmailFluentBuilder::from_email_address_identity_arn) / [`set_from_email_address_identity_arn(Option<String>)`](crate::operation::send_bulk_email::builders::SendBulkEmailFluentBuilder::set_from_email_address_identity_arn):<br>required: **false**<br><p>This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the <code>FromEmailAddress</code> parameter.</p> <p>For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use sender@example.com, then you would specify the <code>FromEmailAddressIdentityArn</code> to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the <code>FromEmailAddress</code> to be sender@example.com.</p> <p>For more information about sending authorization, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer Guide</a>.</p><br>
8    ///   - [`reply_to_addresses(impl Into<String>)`](crate::operation::send_bulk_email::builders::SendBulkEmailFluentBuilder::reply_to_addresses) / [`set_reply_to_addresses(Option<Vec::<String>>)`](crate::operation::send_bulk_email::builders::SendBulkEmailFluentBuilder::set_reply_to_addresses):<br>required: **false**<br><p>The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.</p><br>
9    ///   - [`feedback_forwarding_email_address(impl Into<String>)`](crate::operation::send_bulk_email::builders::SendBulkEmailFluentBuilder::feedback_forwarding_email_address) / [`set_feedback_forwarding_email_address(Option<String>)`](crate::operation::send_bulk_email::builders::SendBulkEmailFluentBuilder::set_feedback_forwarding_email_address):<br>required: **false**<br><p>The address that you want bounce and complaint notifications to be sent to.</p><br>
10    ///   - [`feedback_forwarding_email_address_identity_arn(impl Into<String>)`](crate::operation::send_bulk_email::builders::SendBulkEmailFluentBuilder::feedback_forwarding_email_address_identity_arn) / [`set_feedback_forwarding_email_address_identity_arn(Option<String>)`](crate::operation::send_bulk_email::builders::SendBulkEmailFluentBuilder::set_feedback_forwarding_email_address_identity_arn):<br>required: **false**<br><p>This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the <code>FeedbackForwardingEmailAddress</code> parameter.</p> <p>For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the <code>FeedbackForwardingEmailAddressIdentityArn</code> to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the <code>FeedbackForwardingEmailAddress</code> to be feedback@example.com.</p> <p>For more information about sending authorization, see the <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html">Amazon SES Developer Guide</a>.</p><br>
11    ///   - [`default_email_tags(MessageTag)`](crate::operation::send_bulk_email::builders::SendBulkEmailFluentBuilder::default_email_tags) / [`set_default_email_tags(Option<Vec::<MessageTag>>)`](crate::operation::send_bulk_email::builders::SendBulkEmailFluentBuilder::set_default_email_tags):<br>required: **false**<br><p>A list of tags, in the form of name/value pairs, to apply to an email that you send using the <code>SendEmail</code> operation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.</p><br>
12    ///   - [`default_content(BulkEmailContent)`](crate::operation::send_bulk_email::builders::SendBulkEmailFluentBuilder::default_content) / [`set_default_content(Option<BulkEmailContent>)`](crate::operation::send_bulk_email::builders::SendBulkEmailFluentBuilder::set_default_content):<br>required: **true**<br><p>An object that contains the body of the message. You can specify a template message.</p><br>
13    ///   - [`bulk_email_entries(BulkEmailEntry)`](crate::operation::send_bulk_email::builders::SendBulkEmailFluentBuilder::bulk_email_entries) / [`set_bulk_email_entries(Option<Vec::<BulkEmailEntry>>)`](crate::operation::send_bulk_email::builders::SendBulkEmailFluentBuilder::set_bulk_email_entries):<br>required: **true**<br><p>The list of bulk email entry objects.</p><br>
14    ///   - [`configuration_set_name(impl Into<String>)`](crate::operation::send_bulk_email::builders::SendBulkEmailFluentBuilder::configuration_set_name) / [`set_configuration_set_name(Option<String>)`](crate::operation::send_bulk_email::builders::SendBulkEmailFluentBuilder::set_configuration_set_name):<br>required: **false**<br><p>The name of the configuration set to use when sending the email.</p><br>
15    ///   - [`endpoint_id(impl Into<String>)`](crate::operation::send_bulk_email::builders::SendBulkEmailFluentBuilder::endpoint_id) / [`set_endpoint_id(Option<String>)`](crate::operation::send_bulk_email::builders::SendBulkEmailFluentBuilder::set_endpoint_id):<br>required: **false**<br><p>The ID of the multi-region endpoint (global-endpoint).</p><br>
16    ///   - [`tenant_name(impl Into<String>)`](crate::operation::send_bulk_email::builders::SendBulkEmailFluentBuilder::tenant_name) / [`set_tenant_name(Option<String>)`](crate::operation::send_bulk_email::builders::SendBulkEmailFluentBuilder::set_tenant_name):<br>required: **false**<br><p>The name of the tenant through which this bulk email will be sent.</p><note>  <p>The email sending operation will only succeed if all referenced resources (identities, configuration sets, and templates) are associated with this tenant.</p> </note><br>
17    /// - On success, responds with [`SendBulkEmailOutput`](crate::operation::send_bulk_email::SendBulkEmailOutput) with field(s):
18    ///   - [`bulk_email_entry_results(Vec::<BulkEmailEntryResult>)`](crate::operation::send_bulk_email::SendBulkEmailOutput::bulk_email_entry_results): <p>One object per intended recipient. Check each response object and retry any messages with a failure status.</p>
19    /// - On failure, responds with [`SdkError<SendBulkEmailError>`](crate::operation::send_bulk_email::SendBulkEmailError)
20    pub fn send_bulk_email(&self) -> crate::operation::send_bulk_email::builders::SendBulkEmailFluentBuilder {
21        crate::operation::send_bulk_email::builders::SendBulkEmailFluentBuilder::new(self.handle.clone())
22    }
23}