寫在前邊:國內有很多的郵件服務商,尤其幾個大的云廠商都有非常成熟的郵件推送服務,如果可以的話,建議大家直接使用國內云廠商的服務。我們公司因為做的國際業務,很多東西都在亞馬遜,所以拗不過我們老大,只能使用 AWS 的 SES;
進入正題,首先我們需要下載亞馬遜的 SDK , 執行 go get ,我這里用的是 1.43.15 版本(不同版本之間亞馬遜可能會進行細微調整)。
go get github.com/aws/aws-sdk-go@v1.43.15
當然,基本上所有云廠商都支持使用 SMTP 的方式發送郵件,各大語言均對 SMTP 有較好的支持,本文不介紹SMTP,介紹的是 SES 的模板發送。
模板發送的好處有很多,類似于強類型語言,雖然寫起來復雜,但是我們在編寫過程中的錯誤可以更好地暴露出來;其他優點不再贅述。
完整源碼
先上代碼,如果代碼閱讀能力比較強的同學,可以直接拿走開始用了,使用方法比較簡單,將這個代碼新建一個文件,初始化一下,在需要發郵件的地方,調用即可,后邊會展開對下方代碼的分析解讀;
tip: 代碼里邊的 xlog 是我們自己封裝的一個log包,換成fmt打印或者自己的日志包
package aws_ses
import (
"context"
"encoding/json"
"github.com/aws/aws-sdk-go/aws"
"github.com/aws/aws-sdk-go/aws/credentials"
"github.com/aws/aws-sdk-go/aws/session"
"github.com/aws/aws-sdk-go/service/sesv2"
"github.com/aws/aws-sdk-go/service/sesv2/sesv2iface"
"github.com/microcosm-cc/bluemonday"
)
const (
AwsRegion = "us-west-2" // 此處填寫你自己的亞馬遜所屬地區
Endpoint = "https://email-smtp.us-west-2.amazonaws.com" // 此處是對應的所處地址 host
FeedbackForwardingEmailAddress = "" // 發生錯誤時亞馬遜通知地址,前提是開通了aws配套的SNS 花不了多少錢,強烈建議開啟,否則你發不出來郵件,不知道怎么回事兒。。。
)
type AwsSesRepo struct {
SesV2BioAPI sesv2iface.SESV2API
}
func NewAwsSesRepo() *AwsSesRepo {
ctx := context.Background()
sess, err := session.NewSession(&aws.Config{
CredentialsChainVerboseErrors: nil,
Credentials: credentials.NewStaticCredentials(accessKey, accessSecret, ""),
Endpoint: nil,
EndpointResolver: nil,
EnforceShouldRetryCheck: nil,
Region: aws.String(AwsRegion),
DisableSSL: nil,
HTTPClient: nil,
LogLevel: nil,
Logger: nil,
MaxRetries: nil,
Retryer: nil,
DisableParamValidation: nil,
DisableComputeChecksums: nil,
S3ForcePathStyle: nil,
S3Disable100Continue: nil,
S3UseAccelerate: nil,
S3DisableContentMD5Validation: nil,
S3UseARNRegion: nil,
LowerCaseHeaderMaps: nil,
EC2MetadataDisableTimeoutOverride: nil,
UseDualStackEndpoint: 0,
UseFIPSEndpoint: 0,
SleepDelay: nil,
DisableRestProtocolURICleaning: nil,
EnableEndpointDiscovery: nil,
DisableEndpointHostPrefix: nil,
STSRegionalEndpoint: 0,
S3UsEast1RegionalEndpoint: 0,
})
if err != nil {
xlog.Error(ctx, "初始化亞馬遜 session 出錯", "err", err)
return nil
}
svc := sesv2.New(sess)
return &AwsSesRepo{
Conf: conf,
SesV2BioAPI: svc,
}
}
type SendEmailWithCtxParams struct {
FromEmail string
TemplateName string
ToAddress []string
BccAddress []string
CcAddress []string
TemplateData map[string]string
}
// 發送郵件.
func (r *AwsSesRepo) SendEmailWithContext(ctx context.Context, p *SendEmailWithCtxParams) (*sesv2.SendEmailOutput, error) {
// 需要將結構體的內容json一下傳遞給發信接口
templateDataStr, err := json.Marshal(p.TemplateData)
if err != nil {
return nil, err
}
// 如果沒有設置from,建議在這個地方給個默認值
if len(p.FromEmail) == 0 {
p.FromEmail = "demo@toutiao.com" //默認值
}
// 調用 SDK 發送郵件
resp, err := r.SesV2BioAPI.SendEmailWithContext(ctx, &sesv2.SendEmailInput{
ConfigurationSetName: aws.String("default"), // 設置集 后邊有詳解
Content: &sesv2.EmailContent{
Raw: nil, // 原始發送方式,需要自行拼裝各種參數.
Simple: nil,
Template: &sesv2.Template{ // 使用模版方式發送
TemplateArn: nil,
TemplateData: aws.String(string(templateDataStr)), // 模版需要的 value
TemplateName: aws.String(p.TemplateName), // 模版的名稱 必須 唯一
},
},
Destination: &sesv2.Destination{
BccAddresses: aws.StringSlice(p.BccAddress), // 密送
CcAddresses: aws.StringSlice(p.CcAddress), // 抄送
ToAddresses: aws.StringSlice(p.ToAddress), // 要發給誰
},
EmailTags: nil, // 郵件的標簽
FeedbackForwardingEmailAddress: nil,
FeedbackForwardingEmailAddressIdentityArn: nil,
FromEmailAddress: aws.String(p.FromEmail), // 誰發出的
FromEmailAddressIdentityArn: nil,
ListManagementOptions: nil, // 取消訂閱時的通知時間tag.
ReplyToAddresses: aws.StringSlice([]string{""}), // 用戶收到郵件,進行回復時的郵件地址.
})
return resp, err
}
// 創建模版.
func (r *AwsSesRepo) CreateEmailTemplateWithContext(ctx context.Context, templateName, title, content string) (*sesv2.CreateEmailTemplateOutput, error) {
p := bluemonday.UGCPolicy()
outPut, err := r.SesV2BioAPI.CreateEmailTemplateWithContext(ctx, &sesv2.CreateEmailTemplateInput{
TemplateContent: &sesv2.EmailTemplateContent{
html: aws.String(content),
Subject: aws.String(title),
Text: aws.String(p.Sanitize(content)),
},
TemplateName: aws.String(templateName),
})
return outPut, err
}
// 獲取單個郵件模版.
func (r *AwsSesRepo) GetEmailTemplateWithContext(ctx context.Context, templateName string) (*sesv2.GetEmailTemplateOutput, error) {
info, err := r.SesV2BioAPI.GetEmailTemplateWithContext(ctx, &sesv2.GetEmailTemplateInput{
TemplateName: aws.String(templateName),
})
if err != nil {
xlog.Error(ctx, "GetEmailTemplateWithContext ", "err", err)
return nil, err
}
return info, nil
}
// 修改模版
func (r *AwsSesRepo) UpdateEmailTemplateWithContext(ctx context.Context, templateName, html, text, title string) (*sesv2.UpdateEmailTemplateOutput, error) {
data, err := r.SesV2BioAPI.UpdateEmailTemplateWithContext(ctx, &sesv2.UpdateEmailTemplateInput{
TemplateContent: &sesv2.EmailTemplateContent{
Html: aws.String(html),
Subject: aws.String(title),
Text: aws.String(text),
},
TemplateName: aws.String(templateName),
})
if err != nil {
xlog.Error(ctx, "UpdateEmailTemplateWithContext ", "err", err)
return nil, err
}
return data, nil
}
// 批量獲取模版列表
func (r *AwsSesRepo) ListEmailTemplatesWithContext(ctx context.Context, pageSize int64, cursor string) (*sesv2.ListEmailTemplatesOutput, error) {
data, err := r.SesV2BioAPI.ListEmailTemplatesWithContext(ctx, &sesv2.ListEmailTemplatesInput{
NextToken: aws.String(cursor),
PageSize: aws.Int64(pageSize),
})
if err != nil {
xlog.Error(ctx, "ListEmailTemplatesWithContext ", "err", err)
return nil, err
}
return data, nil
}
如何使用:
func main(){
sesRepo := NewAwsSesRepo()
sesRepo.SendEmailWithContext(.....)
}
可以看到我只是對接了幾個簡單的接口
發送郵件
SendEmailWithContext
創建模版
CreateEmailTemplateWithContext
獲取單個模版信息
GetEmailTemplateWithContext
更新模版
UpdateEmailTemplateWithContext
批量獲取模版列表
ListEmailTemplatesWithContext
其他的接口大家可以舉一反三,在自己實際業務情況下進行擴充,亞馬遜的 Golang SDK 提供了非常全面的操作接口,全都封裝在這個文件中:
...mod/github.com/aws/aws-sdk-go@v1.43.15/service/sesv2/sesv2iface/interface.go
如圖所示:
亞馬遜Ses API 接口
詳解步驟
現在我們來逐步拆解,講解每一步參數都是從哪里拿到的。核心的關鍵參數都會用黃色背景加粗展示。
登錄亞馬遜賬號:
https://signin.aws.amazon.com/signin
在亞馬遜中開通 SES 服務 (強烈建議同時開通 SNS 服務,當我們發送一個郵件不成功,尤其在調試階段,希望知道失敗原因,比如模版參數不對,對方拒收等等,SES發送完之后,會通過 SNS 進行回調通知)簡單地說 SES 是發郵件的, SNS是郵件發送之后的消息隊列,用來推送郵件發送過程中的任何階段結果。
Aws ses 控制臺
AwsRegion:
開通完畢,我們要看一下我們開通的服務是屬于哪個區,如圖所示,這個就是我們在代碼中要用到的 AwsRegion
Endpoint(模版發送不需要):
指的是你要將請求發送到aws的哪個集群, SMTP 使用的必要參數,模版發送不需要,與awsRegin 配合使用的,位置如下圖
Verified identities:
身份驗證,這個是指我們要給用戶發郵件的時候,已什么身份發,比如發給 to address: zhangsan艾特126.com, From 的郵箱身份,只有在這里配置過的,才可以放到From 里
點擊右上角的 create 按照步驟一步步來即可。
Configuration sets:
配置集,直接用默認的 default 即可,在上方我提供的源碼中,大家可以看到有填寫配置集合的,我們可以設置多套配置,來分發不同的業務線郵件;
Configuration sets
這里有一個比較重要的概念 Event destinations 這個是關聯你的SNS事件的,發送成功,失敗,被拒收等等事件都可以在這里設置:
Event destinations
重要 Email Templates
這里就是核心了,不過你不能在后臺直接設置,需要通過接口調用,增刪改查模版的信息。
aws 模版設置
上方的代碼里已經封裝了模版的增改查。
Suppression list 禁止列表 了解即可:
這個列表里記錄的是投遞之后被用戶或者用戶郵件服務商彈回的郵箱地址,為了提高郵件的送達率,建議開啟,保持自己的“發信信譽”很重要,超量的彈回郵件,會造成你的賬號信譽降低。支持手動單個、批量添加。
Cross-account notifications & Email receiving 可忽略
Cross-account notifications 跨賬號通知是V1版本的功能,舊版做支持時使用;新版用的是 SNS 通知,aws 正在棄用中;不建議使用這個功能。
Email receiving 用戶設置用戶回信時的相關設置;推薦直接在發信時 ReplyToAddresses 填寫這個 Slice,這樣用戶回信會直接投遞到你指定的回復郵箱。
上邊就是整個 SES 的配置了;
還有一個非常重要的東西 —— 身份驗證: accessKey Secret
Credentials: credentials.NewStaticCredentials(accessKey, accessSecret, ""),
如下圖所示,點擊個人信息 安全憑證,創建憑證,即可拿到屬于自己的密鑰對,注意保管,只顯示一次。
SES郵件發送原理:
配額是你最應該注意到的坑
詳細文檔:
https://docs.aws.amazon.com/ses/latest/dg/quotas.html
- 每個郵件加上附件 base64 編碼之后不能大于10M
- 每一封郵件的最大收件人不能超過 50人,包含(收件人、抄送、密件抄送)
- 每個 區域 中最大可以創建 10k 個郵件模板。
- 每個 模版 不能超過 500kb
- 每個 模版可以有 [無限個] 可以替換的變量位
- Ses API 的調用頻率被限制在了 每秒1個,所以要做好速率控制。所有操作(除了SendEmail、SendRawEmail和SendTemplatedEmail)都被限制為每秒一個請求。喜歡開協程的同學注意下,踩著點兒剎車…
參考資料:
這里的文檔是幫助大家更加深入了解 SES ,以及發生錯誤時的排查方法。
- 亞馬遜官方SES 文檔:https://docs.aws.amazon.com/zh_cn/ses/latest/dg/send-email.html
- 常見錯誤碼列表:https://docs.aws.amazon.com/ses/latest/APIReference/CommonErrors.html
- SMTP 常見錯誤碼: https://docs.aws.amazon.com/zh_cn/ses/latest/dg/troubleshoot-smtp.html
如果大家在使用中遇到問題,歡迎評論提問,我會在第一時間答復,祝大家開發順利~
本文首發于: 今日頭條 —— 全棧社畜小吉 2022-09-27 00:51:25