avatar

SendGridKit

Documentation Team Chat MIT License Continuous Integration Swift 6.0+

📧 SendGridKit 是一个 Swift 包,它可以帮助你在服务端 Swift 应用程序中与 SendGrid API 通信。

发送简单的电子邮件或充分利用 SendGrid 的 V3 API 的全部功能。

入门

使用 SPM 字符串可以轻松地将依赖项包含在你的 Package.swift 文件中

.package(url: "https://github.com/vapor-community/sendgrid-kit.git", from: "3.0.0"),

并将其添加到你的 target 的依赖项中

.product(name: "SendGridKit", package: "sendgrid-kit"),

概述

注册配置和 provider。

import AsyncHTTPClient
import SendGridKit

let httpClient = HTTPClient(...)
let sendGridClient = SendGridClient(httpClient: httpClient, apiKey: "YOUR_API_KEY")

使用 API

你可以在此处使用所有可用的参数来构建你的 SendGridEmail

在路由闭包中的用法如下所示

import SendGridKit

let email = SendGridEmail(...)
try await sendGridClient.send(email: email)

错误处理

如果由于任何原因,向 API 发出的请求失败,将会抛出一个 SendGridError 错误。这个错误包含一个 errors 属性,其中是一个由 API 返回的错误组成的数组。

只需确保像处理其他抛出错误的函数一样,捕获这些错误即可。

import SendGridKit

do {
    try await sendGridClient.send(email: email)
} catch let error as SendGridError {
    print(error)
}