// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. package ses import ( "context" "fmt" "github.com/aws/aws-sdk-go-v2/aws" "github.com/aws/aws-sdk-go-v2/internal/awsutil" ) // Represents a request to send a single formatted email using Amazon SES. For // more information, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-formatted.html). type SendEmailInput struct { _ struct{} `type:"structure"` // The name of the configuration set to use when you send an email using SendEmail. ConfigurationSetName *string `type:"string"` // The destination for this email, composed of To:, CC:, and BCC: fields. // // Destination is a required field Destination *Destination `type:"structure" required:"true"` // The message to be sent. // // Message is a required field Message *Message `type:"structure" required:"true"` // The reply-to email address(es) for the message. If the recipient replies // to the message, each reply-to address will receive the reply. ReplyToAddresses []string `type:"list"` // The email address that bounces and complaints will be forwarded to when feedback // forwarding is enabled. If the message cannot be delivered to the recipient, // then an error message will be returned from the recipient's ISP; this message // will then be forwarded to the email address specified by the ReturnPath parameter. // The ReturnPath parameter is never overwritten. This email address must be // either individually verified with Amazon SES, or from a domain that has been // verified with Amazon SES. ReturnPath *string `type:"string"` // 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 ReturnPath parameter. // // 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 ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, // and the ReturnPath to be feedback@example.com. // // For more information about sending authorization, see the Amazon SES Developer // Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). ReturnPathArn *string `type:"string"` // The email address that is sending the email. This email address must be either // individually verified with Amazon SES, or from a domain that has been verified // with Amazon SES. For information about verifying identities, see the Amazon // SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html). // // If you are sending on behalf of another user and have been permitted to do // so by a sending authorization policy, then you must also specify the SourceArn // parameter. For more information about sending authorization, see the Amazon // SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). // // Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531 // (https://tools.ietf.org/html/rfc6531). For this reason, the local part of // a source email address (the part of the email address that precedes the @ // sign) may only contain 7-bit ASCII characters (https://en.wikipedia.org/wiki/Email_address#Local-part). // If the domain part of an address (the part after the @ sign) contains non-ASCII // characters, they must be encoded using Punycode, as described in RFC3492 // (https://tools.ietf.org/html/rfc3492.html). The sender name (also known as // the friendly name) may contain non-ASCII characters. These characters must // be encoded using MIME encoded-word syntax, as described in RFC 2047 (https://tools.ietf.org/html/rfc2047). // MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=. // // Source is a required field Source *string `type:"string" required:"true"` // 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 send for the email address specified in the Source parameter. // // 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 send from user@example.com, // then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, // and the Source to be user@example.com. // // For more information about sending authorization, see the Amazon SES Developer // Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). SourceArn *string `type:"string"` // A list of tags, in the form of name/value pairs, to apply to an email that // you send using SendEmail. Tags correspond to characteristics of the email // that you define, so that you can publish email sending events. Tags []MessageTag `type:"list"` } // String returns the string representation func (s SendEmailInput) String() string { return awsutil.Prettify(s) } // Validate inspects the fields of the type to determine if they are valid. func (s *SendEmailInput) Validate() error { invalidParams := aws.ErrInvalidParams{Context: "SendEmailInput"} if s.Destination == nil { invalidParams.Add(aws.NewErrParamRequired("Destination")) } if s.Message == nil { invalidParams.Add(aws.NewErrParamRequired("Message")) } if s.Source == nil { invalidParams.Add(aws.NewErrParamRequired("Source")) } if s.Message != nil { if err := s.Message.Validate(); err != nil { invalidParams.AddNested("Message", err.(aws.ErrInvalidParams)) } } if s.Tags != nil { for i, v := range s.Tags { if err := v.Validate(); err != nil { invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(aws.ErrInvalidParams)) } } } if invalidParams.Len() > 0 { return invalidParams } return nil } // Represents a unique message ID. type SendEmailOutput struct { _ struct{} `type:"structure"` // The unique message identifier returned from the SendEmail action. // // MessageId is a required field MessageId *string `type:"string" required:"true"` } // String returns the string representation func (s SendEmailOutput) String() string { return awsutil.Prettify(s) } const opSendEmail = "SendEmail" // SendEmailRequest returns a request value for making API operation for // Amazon Simple Email Service. // // Composes an email message and immediately queues it for sending. In order // to send email using the SendEmail operation, your message must meet the following // requirements: // // * The message must be sent from a verified email address or domain. If // you attempt to send email using a non-verified address or domain, the // operation will result in an "Email address not verified" error. // // * If your account is still in the Amazon SES sandbox, you may only send // to verified addresses or domains, or to email addresses associated with // the Amazon SES Mailbox Simulator. For more information, see Verifying // Email Addresses and Domains (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html) // in the Amazon SES Developer Guide. // // * The maximum message size is 10 MB. // // * The message must include at least one recipient email address. The recipient // address can be a To: address, a CC: address, or a BCC: address. If a recipient // email address is invalid (that is, it is not in the format UserName@[SubDomain.]Domain.TopLevelDomain), // the entire message will be rejected, even if the message contains other // recipients that are valid. // // * The message may not include more than 50 recipients, across the To:, // CC: and BCC: fields. If you need to send an email message to a larger // audience, you can divide your recipient list into groups of 50 or fewer, // and then call the SendEmail operation several times to send the message // to each group. // // For every message that you send, the total number of recipients (including // each recipient in the To:, CC: and BCC: fields) is counted against the maximum // number of emails you can send in a 24-hour period (your sending quota). For // more information about sending quotas in Amazon SES, see Managing Your Amazon // SES Sending Limits (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/manage-sending-limits.html) // in the Amazon SES Developer Guide. // // // Example sending a request using SendEmailRequest. // req := client.SendEmailRequest(params) // resp, err := req.Send(context.TODO()) // if err == nil { // fmt.Println(resp) // } // // Please also see https://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/SendEmail func (c *Client) SendEmailRequest(input *SendEmailInput) SendEmailRequest { op := &aws.Operation{ Name: opSendEmail, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { input = &SendEmailInput{} } req := c.newRequest(op, input, &SendEmailOutput{}) return SendEmailRequest{Request: req, Input: input, Copy: c.SendEmailRequest} } // SendEmailRequest is the request type for the // SendEmail API operation. type SendEmailRequest struct { *aws.Request Input *SendEmailInput Copy func(*SendEmailInput) SendEmailRequest } // Send marshals and sends the SendEmail API request. func (r SendEmailRequest) Send(ctx context.Context) (*SendEmailResponse, error) { r.Request.SetContext(ctx) err := r.Request.Send() if err != nil { return nil, err } resp := &SendEmailResponse{ SendEmailOutput: r.Request.Data.(*SendEmailOutput), response: &aws.Response{Request: r.Request}, } return resp, nil } // SendEmailResponse is the response type for the // SendEmail API operation. type SendEmailResponse struct { *SendEmailOutput response *aws.Response } // SDKResponseMetdata returns the response metadata for the // SendEmail request. func (r *SendEmailResponse) SDKResponseMetdata() *aws.Response { return r.response }