SendGrid

配置

发送邮件

操作

发送邮件

SendGrid API 密钥*

••••••••

发件邮箱*

sender@yourdomain.com

发件人名称

收件邮箱*

recipient@example.com

收件人名称

主题

邮件主题（未使用模板时必填）

内容

邮件正文（未使用模板时必填）

内容类型

纯文本

抄送

cc@example.com

密送

bcc@example.com

回复地址

replyto@example.com

回复人名称

模板 ID

SendGrid 模板 ID

动态模板数据

json

{"name": "John", "order_id": "12345"}

附件

上传要附加的文件

附件

引用先前区块的文件

发送邮件（sendgrid_send_mail）

使用 SendGrid API 发送邮件

输入

参数	类型	必填	说明
`apiKey`	string	是	SendGrid API 密钥
`from`	string	是	发件人邮箱地址（必须已在 SendGrid 中验证）
`fromName`	string	否	发件人名称
`to`	string	是	收件人邮箱地址
`toName`	string	否	收件人名称
`subject`	string	否	邮件主题（除非使用已预定义主题的模板，否则必填）
`content`	string	否	邮件正文（除非使用已预定义内容的模板，否则必填）
`contentType`	string	否	内容类型（text/plain 或 text/html）
`cc`	string	否	抄送邮箱地址
`bcc`	string	否	密送邮箱地址
`replyTo`	string	否	回复邮箱地址
`replyToName`	string	否	回复人名称
`attachments`	file[]	否	要附加到邮件的文件
`templateId`	string	否	要使用的 SendGrid 模板 ID
`dynamicTemplateData`	json	否	动态模板数据的 JSON 对象

输出

参数	类型	说明
`success`	boolean	邮件是否发送成功
`messageId`	string	SendGrid 消息 ID
`to`	string	收件人邮箱地址
`subject`	string	邮件主题

添加联系人

操作

添加联系人

SendGrid API 密钥*

••••••••

邮箱*

contact@example.com

名

三

姓

张

自定义字段

json

{"custom_field_1": "value1"}

列表 ID

以逗号分隔的列表 ID

添加联系人 (sendgrid_add_contact)

向 SendGrid 添加新联系人

输入

参数	类型	必填	说明
`apiKey`	string	是	SendGrid API 密钥
`email`	string	是	联系人邮箱地址
`firstName`	string	否	联系人名
`lastName`	string	否	联系人姓
`customFields`	json	否	自定义字段键值对的 JSON 对象 (使用字段 ID，如 e1_T、e2_N、e3_D，不要使用字段名称)
`listIds`	string	否	要将联系人添加到的列表 ID，以逗号分隔

输出

参数	类型	说明
`jobId`	string	用于跟踪异步联系人创建的作业 ID
`email`	string	联系人邮箱地址
`firstName`	string	联系人名字
`lastName`	string	联系人姓氏
`message`	string	状态消息

获取联系人

操作

获取联系人

SendGrid API 密钥*

••••••••

联系人 ID*

联系人 ID

获取联系人 (sendgrid_get_contact)

通过 ID 从 SendGrid 获取指定联系人

输入

参数	类型	必填	说明
`apiKey`	string	是	SendGrid API 密钥
`contactId`	string	是	联系人 ID

输出

参数	类型	说明
`id`	string	联系人 ID
`email`	string	联系人邮箱地址
`firstName`	string	联系人名字
`lastName`	string	联系人姓氏
`createdAt`	string	创建时间戳
`updatedAt`	string	最后更新时间戳
`listIds`	json	该联系人所属列表 ID 的数组
`customFields`	json	自定义字段值

搜索联系人

操作

搜索联系人

SendGrid API 密钥*

••••••••

搜索查询*

email LIKE '%example.com%'

搜索联系人（sendgrid_search_contacts）

使用查询在 SendGrid 中搜索联系人

输入

参数	类型	必填	说明
`apiKey`	string	是	SendGrid API 密钥
`query`	string	是	搜索查询 (例如："email LIKE '%example.com%' AND CONTAINS(list_ids, 'list-id')")

输出

参数	类型	说明
`contacts`	json	匹配的联系人数组
`contactCount`	number	找到的联系人总数

删除联系人

操作

删除联系人

SendGrid API 密钥*

••••••••

联系人 ID*

逗号分隔的联系人 ID

删除联系人 (sendgrid_delete_contacts)

从 SendGrid 删除一个或多个联系人

输入

参数	类型	必填	说明
`apiKey`	string	是	SendGrid API 密钥
`contactIds`	string	是	要删除的联系人 ID，以逗号分隔

输出

参数	类型	说明
`jobId`	string	删除请求的作业 ID

创建列表

操作

创建列表

SendGrid API 密钥*

••••••••

列表名称*

列表名称

创建列表（sendgrid_create_list）

在 SendGrid 中创建新的联系人列表

输入

参数	类型	必填	说明
`apiKey`	string	是	SendGrid API 密钥
`name`	string	是	列表名称

输出

参数	类型	说明
`id`	string	列表 ID
`name`	string	列表名称
`contactCount`	number	列表中的联系人数量

获取列表

操作

获取列表

SendGrid API 密钥*

••••••••

列表 ID*

列表 ID

获取列表 (sendgrid_get_list)

根据 ID 从 SendGrid 获取指定列表

输入

参数	类型	必填	说明
`apiKey`	string	是	SendGrid API 密钥
`listId`	string	是	列表 ID

输出

参数	类型	说明
`id`	string	列表 ID
`name`	string	列表名称
`contactCount`	number	列表中的联系人数量

列出所有列表

操作

列出所有列表

SendGrid API 密钥*

••••••••

每页条数

100

列出所有列表（sendgrid_list_all_lists）

从 SendGrid 获取所有联系人列表

输入

参数	类型	必填	说明
`apiKey`	string	是	SendGrid API 密钥
`pageSize`	number	否	每页返回的列表数量 (默认：100)

输出

参数	类型	说明
`lists`	json	列表数组

删除列表

操作

删除列表

SendGrid API 密钥*

••••••••

列表 ID*

列表 ID

删除列表 (sendgrid_delete_list)

从 SendGrid 删除联系人列表

输入

参数	类型	必填	说明
`apiKey`	string	是	SendGrid API 密钥
`listId`	string	是	要删除的列表 ID

输出

参数	类型	说明
`message`	string	成功消息

将联系人添加到列表

操作

将联系人添加到列表

SendGrid API 密钥*

••••••••

联系人（JSON 数组）*

json

[{"email": "user@example.com", "first_name": "John"}]

列表 ID*

列表 ID

将联系人添加到列表 (sendgrid_add_contacts_to_list)

在 SendGrid 中添加或更新联系人，并将其分配到列表（使用 PUT /v3/marketing/contacts）

输入

参数	类型	必填	说明
`apiKey`	string	是	SendGrid API 密钥
`listId`	string	是	要添加联系人的列表 ID
`contacts`	json	是	联系人对象的 JSON 数组。每个联系人至少须包含：email (或 phone_number_id/external_id/anonymous_id)。示例：[{"email": "user@example.com", "first_name": "John"}]

输出

参数	类型	说明
`jobId`	string	用于跟踪异步操作的作业 ID
`message`	string	状态消息

从列表中移除联系人

操作

从列表中移除联系人

SendGrid API 密钥*

••••••••

联系人 ID*

逗号分隔的联系人 ID

列表 ID*

列表 ID

从列表移除联系人 (sendgrid_remove_contacts_from_list)

从 SendGrid 的指定列表中移除联系人

输入

参数	类型	必填	说明
`apiKey`	string	是	SendGrid API 密钥
`listId`	string	是	列表 ID
`contactIds`	string	是	要从列表中移除的联系人 ID，逗号分隔

输出

参数	类型	说明
`jobId`	string	该请求的作业 ID

创建模板

操作

创建模板

SendGrid API 密钥*

••••••••

模板名称*

模板名称

模板生成类型

动态

创建模板 (sendgrid_create_template)

在 SendGrid 中创建新的电子邮件模板

输入

参数	类型	必填	说明
`apiKey`	string	是	SendGrid API 密钥
`name`	string	是	模板名称
`generation`	string	否	模板生成类型 (legacy 或 dynamic，默认：dynamic)

输出

参数	类型	说明
`id`	string	模板 ID
`name`	string	模板名称
`generation`	string	模板生成
`updatedAt`	string	上次更新时间戳
`versions`	json	模板版本数组

获取模板

操作

获取模板

SendGrid API 密钥*

••••••••

模板 ID*

模板 ID

获取模板 (sendgrid_get_template)

根据 ID 从 SendGrid 获取指定模板

输入

参数	类型	必填	说明
`apiKey`	string	是	SendGrid API 密钥
`templateId`	string	是	模板 ID

输出

参数	类型	说明
`id`	string	模板 ID
`name`	string	模板名称
`generation`	string	模板生成类型
`updatedAt`	string	最后更新时间戳
`versions`	json	模板版本数组

列出模板

操作

列出模板

SendGrid API 密钥*

••••••••

按生成类型筛选

legacy、dynamic 或 both

每页数量

列出模板 (sendgrid_list_templates)

获取 SendGrid 中的全部邮件模板

输入

参数	类型	必填	说明
`apiKey`	string	是	SendGrid API 密钥
`generations`	string	否	按 generation 筛选（legacy、dynamic 或 both）
`pageSize`	number	否	每页返回的模板数量（默认：20）

输出

参数	类型	说明
`templates`	json	模板数组

删除模板

操作

删除模板

SendGrid API 密钥*

••••••••

模板 ID*

模板 ID

删除模板（sendgrid_delete_template）

从 SendGrid 删除邮件模板

输入

参数	类型	必填	说明
`apiKey`	string	是	SendGrid API 密钥
`templateId`	string	是	要删除的模板 ID

输出（区块级契约）

参数	类型	说明
`success`	boolean	操作是否成功
`message`	string	状态或成功消息
`messageId`	string	邮件消息 ID (send_mail)
`to`	string	收件人邮箱地址 (send_mail)
`subject`	string	邮件主题 (send_mail, create_template_version)
`id`	string	资源 ID
`jobId`	string	异步操作的作业 ID
`email`	string	联系人邮箱地址
`firstName`	string	联系人名字
`lastName`	string	联系人姓氏
`createdAt`	string	创建时间戳
`updatedAt`	string	上次更新时间戳
`listIds`	json	联系人所属列表 ID 数组
`customFields`	json	自定义字段值
`contacts`	json	联系人数组
`contactCount`	number	联系人数量
`lists`	json	列表数组
`name`	string	资源名称
`templates`	json	模板数组
`generation`	string	模板世代
`versions`	json	模板版本数组
`templateId`	string	模板 ID
`active`	boolean	模板版本是否处于活动状态
`htmlContent`	string	HTML 内容
`plainContent`	string	纯文本内容

创建模板版本

操作

创建模板版本

SendGrid API 密钥*

••••••••

模板 ID*

模板 ID

版本名称*

版本名称

模板主题*

邮件主题

HTML 内容

html

纯文本内容

激活

是

创建模板版本（sendgrid_create_template_version）

在 SendGrid 中创建邮件模板的新版本

输入

参数	类型	必填	说明
`apiKey`	string	是	SendGrid API 密钥
`templateId`	string	是	模板 ID
`name`	string	是	版本名称
`subject`	string	是	邮件主题行
`htmlContent`	string	否	模板的 HTML 内容
`plainContent`	string	否	模板的纯文本内容
`active`	boolean	否	此版本是否处于活动状态 (默认：true)

输出

参数	类型	说明
`id`	string	版本 ID
`templateId`	string	模板 ID
`name`	string	版本名称
`subject`	string	邮件主题
`active`	boolean	此版本是否处于活动状态
`htmlContent`	string	HTML 内容
`plainContent`	string	纯文本内容
`updatedAt`	string	上次更新时间戳

使用说明

将 SendGrid 集成到你的工作流中。发送事务性邮件，管理营销联系人和列表，并处理邮件模板。支持动态模板、附件和全面的联系人管理。

备注

类别：tools
类型：sendgrid

SendGrid

On this page