Twilio的SendGrid C#库官方参考文档在哪里可以查询?
SendGrid NuGet 包类参考文档获取及核心成员说明
本地获取全量结构化参考的方法
你已安装的SendGrid NuGet包默认包含了完整的XML注释文件,无需在线查找资源,可通过以下两种方式获取和Newtonsoft.Json参考文档结构完全一致的内容:
- 在Visual Studio、Rider等IDE中,选中SendGrid相关的类/方法/属性,按
F12(转到定义)即可查看完整的成员说明、参数含义、返回值说明、异常场景等信息,内容和官方参考完全同步 - 如需导出离线HTML格式的完整参考,可使用
Sandcastle Help File Builder工具,导入SendGrid安装目录下的SendGrid.dll和对应SendGrid.xml注释文件,一键生成带类层次结构、方法列表、属性说明的离线文档
核心公共类及常用成员参考
SendGridClient 核心请求客户端类
所有邮件操作的入口类,负责和SendGrid服务端交互:
- 构造方法:
SendGridClient(string apiKey):传入SendGrid API密钥完成客户端初始化 - 核心方法:
Task<Response> SendEmailAsync(SendGridMessage message, CancellationToken cancellationToken = default):异步发送邮件,返回服务端响应结果 - 常用属性:
int Timeout:设置请求超时时间,单位为毫秒
SendGridMessage 邮件实体类
封装所有邮件相关的内容配置:
- 快速创建方法:
static SendGridMessage CreateSingleEmail(EmailAddress from, string subject, EmailAddress to, string plainTextContent, string htmlContent):一键生成单收件人邮件实例 - 常用方法:
void AddTo(string email, string name = null):添加收件人void AddCc(string email, string name = null):添加抄送人void AddBcc(string email, string name = null):添加密送人void AddAttachment(string filename, string base64Content, string type = null, string disposition = null, string contentId = null):添加邮件附件
- 常用属性:
EmailAddress From:发件人信息string Subject:邮件主题List<Content> Contents:邮件正文内容集合
Response 服务端响应类
封装SendGrid接口的返回结果:
- 常用属性:
HttpStatusCode StatusCode:接口返回的HTTP状态码HttpResponseHeaders Headers:响应头集合string Body:响应体字符串内容
使用说明
所有类的成员注释会随NuGet包版本更新同步,你可以直接通过IDE的智能提示功能实时查看任意成员的详细说明,无需依赖在线文档资源。
内容的提问来源于stack exchange,提问作者Diego
相关产品推荐
相关产品推荐

