Here it is.
", use_case_id: process.env.NEVARMAIL_USE_CASE_TRANSACTIONAL, }); console.log(result.id, result.status); ``` ## 租赁——一键是一角 NevarMail API 密钥 **实值** 该组织。 任何请求机构都不存在Org id 服务器从密钥中解析并忽略您发送的任何东西。 有两个后果: - 每人一把钥匙 键不能被指向第二个键 和一个多租户应用程序 代表 NevarMail orgs 发送若干键. - 永远不要接受来自终端用户的Org标识符并经过. 无处可去 说吧,尝试是一个征兆 融合是建模租借错误. ## 键、表面和模式 钥匙看起来像 `nvm_api_live_…`, (中文(简体) ), `nvm_api_test_…`, (中文(简体) ), `nvm_mcp_live_…`, (中文(简体) ), `nvm_mcp_test_…`。 。 。 . - **表面** (单位:千美元)`api` 对 `mcp`)——这个包裹会说REST,所以它需要一个 `api` 键。 通过一个 `mcp` 键和构造器会立即扔出,而不是让服务器回答 `403 KEY_TYPE_MISMATCH` 在您的第一个发送, 它读起来像一个认证错误. - **模式** (单位:千美元)`live` 对 `test`)——测试密钥只发送到org测试上的地址 允许列表; 其他任何东西都是 `422 TEST_MODE_RECIPIENT_NOT_ALLOWED`模式为 属性,绝不是客户端选项: `client.mode` 报告关键是什么. ```ts const nevarmail = new NevarMail({ apiKey: key }); if (nevarmail.mode === "test") console.warn("test key — sends are allow-list only"); ``` ## 错误 每一次失败都是 `NevarMailError`数字 : ```ts import { NevarMail, NevarMailError } from "@bernierllc/nevarmail"; try { await nevarmail.sendEmail({ to, subject, html }); } catch (err) { if (err instanceof NevarMailError && err.code === "RECIPIENT_SUPPRESSED") { // Expected: this person opted out. Not an outage. return; } throw err; // everything else is worth waking someone for } ``` | 外地 | 含义 | | --- | --- | | `status` | HTTP 状态 ; `0` 当请求从未到达 API 时 | | `code` | 机器可读代码——这个分支,永远不要打开 `message` | | `requestId` | 引用支持; 匹配 API `x-request-id` | | `retryAfter` | 秒,从 `Retry-After` 在429号公路上 等待30多或更短的时间会为你重试;一个更长的时间(每天一顶帽子)会同时抛出 | | `body` | 解析的回复, 对于比您安装的版本更新的代码 | 值得明确处理的代码: | 代码 | 状态 | 这是什么意思 | | --- | --- | --- | | `RECIPIENT_SUPPRESSED` | 422个 | 被弹出,被抱怨,或未认购. 不要重试. | | `COMPLIANCE_ADDRESS_REQUIRED` | 422个 | `emailType: "marketing"` (或用例收件人可以选择退出)从一个没有邮政地址的项目. 设定为 `setProjectAddress`。 。 。 . | | `TEST_MODE_RECIPIENT_NOT_ALLOWED` | 422个 | 测试密钥, 收件人不在允许列表中 . | | `CC_BCC_NOT_SUPPORTED_FOR_TEMPLATE` | 400个 | 按收件人制作模板邮件; 发送一个请求 . | | `VALIDATION_ERROR` | 400个 | 身体错. 复试无益. | | `SCOPE_DENIED` | 403 (韩语) | 密钥缺乏这条路线需要的范围. | | `KEY_TYPE_MISMATCH` | 403 (韩语) | 在 REST 路径上的 MCP 密钥( 此客户端在构建时拒绝) . | | `RATE_LIMITED` | 429个 | 自动复试;预算用完后浮出水面. | | `SCHEDULE_NOT_CANCELLABLE` | 409个 | 预定发送已发射或已取消 . | | `NETWORK_ERROR` | 0 个 | 完全没有反应——DNS,TLS,或超时. | ## 检索 复试: `429` (荣誉) `Retry-After`, (中文(简体) ), `5xx`,和网络故障——指数倒置 与 jitter , 默认的两次额外尝试(`maxRetries`) (中文(简体) ). 从未再审:任何其他 `4xx`它会永远失败 所以重试会变成一个坏的 请求为三。 发送不是同位素 `5xx` 可能交付两次. ## 案件使用和制止范围 每个项目都有禁忌. `checkSuppression(email, useCaseId?, projectId?)` 答案为 一个项目: `projectId`,否则项目 `useCaseId`,否则组织的唯一 项目。 一个有多个项目的组织 `400 PROJECT_REQUIRED` 当两者都不是 通过了。 对供应商账户的回弹或垃圾邮件投诉会阻碍每个项目;任何其他 镇压只能阻止它自己. `use_case_id` 命名信件类别。 这是区别于 "这个人不订阅你的通讯"和"这个人不能再被电子邮件": - **说吧**,并选择退出 _不同_ 类别列表不阻碍发送, 并且标记为不可压制的类别可免于选择不适用. - **别管了**,并且对该项目的每一个积极抑制都适用——严格解读. 仅a **项目范围密钥** 可能会漏掉 `sendEmail` 编号 : `scheduleEmail`: 发送为 那个项目的默认使用大小写。 一个 **粗略键** 省略它会得到 `422 USE_CASE_REQUIRED`· ; `listUseCases()` 显示你的. 弹跳、垃圾邮件投诉和手动压制 阻止了每个类别 仅a `use_case_id` 您通过自身可以缩小一个块;默认服务器解析不能. `sendEmail` 也用"弹"来表示 `useCase: "receipts"` - 而不是其编号(其中之一 两个,不是两个。 弹簧必须存在于键可以打开的完全一个工程中:未知是一个 404, 几个项目中的同一颗子弹是: `400 USE_CASE_AMBIGUOUS` (通过) `use_case_id` ) (中文(简体) ). `listUseCases` 显示弹壳. ## 方法 | 方法 | 路线 | 范围 | | --- | --- | --- | | `sendEmail` | `POST /api/v1/email/send` | `email:send` | | `sendEmailToList` | `POST /api/v1/email/send-to-list` | `email:send` | | `scheduleEmail` | `POST /api/v1/email/schedule` | `email:send` | | `listScheduledEmails` | `GET /api/v1/email/schedule` | `email:send` | | `cancelScheduledEmail` | `DELETE /api/v1/email/schedule/{id}` | `email:send` | | `checkSuppression` | `GET /api/v1/suppressions/check` | `org:read` | | `getPreferences(email, projectId?)` - 一个项目中的一个地址名单; `projectId` 当鼠标有多个时需要 | `GET /api/v1/preferences` | `contacts:read` | | `setPreferences(email, { subscribedListIds, unsubscribeAll, projectId? })` ——保留完整的一组名单 | `PUT /api/v1/preferences` | `contacts:write` | | `listTemplates` 编号 : `createTemplate` 编号 : `getTemplate` 编号 : `updateTemplate` 编号 : `deleteTemplate` | `/api/v1/templates` | `templates:read` 编号 : `templates:write` | | `renderTemplate` | `POST /api/v1/templates/{id}/render` | `templates:read` | | `listCampaigns({ projectId?, page?, perPage? })` 编号 : `getCampaign(id, { projectId? })` ——只读 | `GET /api/v1/campaigns`, (中文(简体) ), `GET /api/v1/campaigns/{id}` | `campaigns:read` | | `getCampaignAnalytics(id, { projectId? })` ——计数加交付/打开/点击/弹出/不认购率(0比1) | `GET /api/v1/campaigns/{id}/analytics` | `analytics:read` | | `getAnalyticsSummary({ period? } | { start, end })` - 总体计算和跟踪率 `7d`编号 :`30d`编号 :`90d` (默认) `30d`)或包容性世界协调时 `YYYY-MM-DD` 范围 | `GET /api/v1/analytics/summary` | `analytics:read` | | `getUsage({ start, end })` ——用于包容性世界协调世界时的计量吸入器外送电子邮件计数(可填单和测试模式分开) `YYYY-MM-DD` 最多366天; 仅计数,不计费用 | `GET /api/v1/usage` | `usage:read` | | `listLists` 编号 : `createList` 编号 : `getList` | `/api/v1/lists` | `contacts:read` 编号 : `contacts:write` | | `addListContacts` | `POST /api/v1/lists/{id}/contacts` | `contacts:write` | | `removeListContact` | `DELETE /api/v1/lists/{id}/contacts?email=` (只列出一个清单;保持联系) | `contacts:write` | | `listContacts` 编号 : `upsertContacts` 编号 : `updateContact` 编号 : `deleteContact` | `/api/v1/contacts` | `contacts:read` 编号 : `contacts:write` | | `listBusinesses({ projectId?, page?, perPage? })` 编号 : `getBusiness(id, { projectId? })` | `GET /api/v1/businesses`, (中文(简体) ), `GET /api/v1/businesses/{id}` | `contacts:read` | | `createBusiness(input)` 编号 : `updateBusiness(id, input)` 编号 : `deleteBusiness(id, { projectId? })` - 更新替换 `domains`合并 `attributes`; 删除保留联系人 | `POST /api/v1/businesses`, (中文(简体) ), `PATCH` 编号 : `DELETE /api/v1/businesses/{id}` | `contacts:write` | | `upsertBusinessByExternalRef(system, ref, input)` ——同位素;返回 `{ business, created }` | `PUT /api/v1/businesses/by-ref/{system}/{ref}` | `contacts:write` | | `listBusinessMembers(id, { projectId?, page?, perPage? })` | `GET /api/v1/businesses/{id}/members` | `contacts:read` | | `addBusinessMembers(id, members, { addedBy?, projectId? })` (最多100个)/ `removeBusinessMembers(id, { contactIds?, emails?, projectId? })` 仅限成员 | `POST` 编号 : `DELETE /api/v1/businesses/{id}/members` | `contacts:write` | | `addBusinessMembersByDomain(id, { projectId? })` - 在企业领域增加联系人 | `POST /api/v1/businesses/{id}/members/by-domain` | `contacts:write` | | `listSenders` 编号 : `createSender(input)` —— 说 `input.projectId?` 当鼠标有多个时, 目标为项目 | `/api/v1/senders` | `senders:read` 编号 : `senders:write` | | `getSender` 编号 : `updateSender` 编号 : `deleteSender` | `/api/v1/senders/{id}` | `senders:read` 编号 : `senders:write` | | `listUseCases({ projectId?, includeArchived? })` 编号 : `createUseCase(input)` —— 说 `input.projectId?` 关于 `createSender` | `/api/v1/use-cases` | `use-cases:read` 编号 : `use-cases:write` | | `getUseCase` 编号 : `updateUseCase` 编号 : `archiveUseCase` 编号 : `restoreUseCase` ——删除档案;恢复撤销 | `/api/v1/use-cases/{id}` | `use-cases:read` 编号 : `use-cases:write` | | `importSenders({ projectId? })` ——采用项目供应商账户身份;再运行以获取供应商核查 | `POST /api/v1/senders/import` | `senders:write` | | `listDomains` 编号 : `createDomain(domain, { projectId })` 编号 : `getDomain` 编号 : `deleteDomain` | `/api/v1/domains` | `domains:read` 编号 : `domains:write` | | `getDomainDnsRecords` 编号 : `verifyDomain` | `/api/v1/domains/{id}/…` | `domains:read` 编号 : `domains:write` | | `getDomainBrandedTracking` 编号 : `enableDomainBrandedTracking` | `GET` 编号 : `POST /api/v1/domains/{id}/branded-tracking` | `domains:read` 编号 : `domains:write` | | `listInboxes` 编号 : `getInbox` 编号 : `updateInbox(id, { displayName?, forwardTo?, storeMessages?, openTracking?, status? })` —— 说 `openTracking: true` 需要一个活跃的 HTTPS 品牌主机 | `/api/v1/inboxes`, (中文(简体) ), `/api/v1/inboxes/{id}` | `inboxes:read` 编号 : `inboxes:write` | | `listSuppressions` 编号 : `addSuppressions` | `/api/v1/suppressions` | `org:read` 编号 : `org:write` | | `getProjectAddress(projectId)` 编号 : `setProjectAddress(projectId, { physicalAddress, addressComponents? })` | `GET` 编号 : `PUT /api/v1/projects/{id}/address` | `org:read` 编号 : `org:write` | | `getInboxDbStatus` | `GET /api/v1/inbox-db/status` | `org:read` | | `connectInboxDb({ connectionString, provider? })` (202,启动背景连接) / `testInboxDbConnection` | `POST /api/v1/inbox-db/connection` 编号 : `…/connection/test` | `org:write` | | `getInboxDbConnectAttempt` (投弹直到 `status` 没有 `running`(中文(简体) ) | `GET /api/v1/inbox-db/connection` | `org:read` | 应用程序级别的细节, 在您击中它们之前需要知道 : - **列表方法保持pagination.** `listTemplates` 和朋友回来 `{ data, pagination: { page, perPage, total } }` - 信封的标注是 调用列表路由, 因此它不会被取消 。 单资源方法返回有效载荷 直接,与发送方法相同. - **企业.** `client.businesses` 组合十种商业方法: `list`, (中文(简体) ), `get`, (中文(简体) ), `create`, (中文(简体) ), `update`, (中文(简体) ), `delete`, (中文(简体) ), `upsertByExternalRef`, (中文(简体) ), `addByDomain` 财务报告和审定财务报表 `members.{list, add, remove}`,每个 授权给上面的平面方法。 租赁: `projectId` 查询中 `get`, (中文(简体) ), `delete` 财务报告和审定财务报表 `addByDomain`,在体内为 `update`, (中文(简体) ), `createBusiness` 而会员写作。 别管了 仅当 org 有一个项目时. - **更新为 `PATCH`和部分.** 只发送您正在更改的字段 . - **运动读取选择 `projectId`。 。 。 .** 只有在雄兽有一个项目时才开放; 否则服务器会回答 400 `PROJECT_REQUIRED`. 另一个项目中的运动是404 `NOT_FOUND`和失踪的一样 无工程的Org得到422 `NO_PROJECT`; 无 销售商得到404 `NO_MARKETING_PROVIDER`。 。 。 . `listCampaigns` 在提供者的页面后过滤, 所以是一个页面 可持有少于 `perPage` 作行相会. 分析路径需要 `analytics:read`没有 `campaigns:read`。 。 。 . - **`renderTemplate(id, variables)` 将变量映射为整个正文** - 不包着 (单位:千美元) `variables` 键. - **`deleteTemplate` 从来没有404s**: 未知的 id 解析 `{ deleted: false }` 两百块 每个 其他删除将丢入缺失的资源. - **列表没有更新或删除** ——API不曝光;SDK不发明. - **禁止范围是跨战地的**数字 : `scope: "use_case"` 需求 `use_case_id`,以及 `use_case_id` 与 `scope: "account"` 是一个 `400`。 。 。 . `projectId` 命名工程所在区域 输入;省略后,它们会降落在使用项目中,否则每个项目中钥匙的所有人都可以打开. - **管理中的账户无法删除域** —— 说 `deleteDomain` 掷出 `403 MANAGED_ACCOUNT`。 。 。 . - **收件箱- db 连接字符串发送一次, 从未重复 .** `connectInboxDb` 存储加密; `InboxDbStatus` 省却. `schemaName` 您数据库中的Postgres schema NevarMail 拥有 . 任何尚未覆盖的东西——一个网点——都经过 `request()` (或 `requestPaginated()` 用于列表路由),它应用相同的认证,信封 打开、丢弃和重试 : ```ts const endpoints = await nevarmail.request