# @dbx-tools/shared-email-template 中文文档

规范地址：https://npmcn.com/package/%40dbx-tools/shared-email-template/

版本：0\.9\.206
npm 元数据更新时间：2026-11-10T19:18:13.158Z
中文译文更新时间：2026-11-11T17:32:35.574Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40dbx-tools/shared-email-template
原文对照：https://npmcn.com/package/%40dbx-tools/shared-email-template/?lang=original
项目主页：https://github.com/reggie-db/dbx-tools#readme
源码仓库：https://github.com/reggie-db/dbx-tools

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：107 kB，16 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：3 个
- 首次发布：2026-08-02T17:21:11.082Z
- 最新版本发布：2026-11-10T19:18:12.783Z
- 近 30 天下载量：9667（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：267（近 12 个月 267 个）

## 中文简介

通用 React 电子邮件演示文稿,由 dbx 工具服务器和浏览器表面共享

## 安装

```sh
npm install @dbx-tools/shared-email-template
```

也可以使用：`pnpm add @dbx-tools/shared-email-template`、`yarn add @dbx-tools/shared-email-template`、`bun add @dbx-tools/shared-email-template`

## README

# @dbx-tools/ 共享电子邮件模板

在服务器发送的信件中渲染同样的反应电子邮件演示文稿 浏览器预览 。 该套装拥有品牌文档,卡片,身体,品牌 不依赖于 Databricks AppKit, SMTP, 或 DOM API 的映射.

## 快开始

在 SMTP 发送和浏览器预览中渲染相同的品牌文档 :

```tsx
import { EmailDocument } from "@dbx-tools/shared-email-template";

<EmailDocument subject="Incident update" body="## Resolved\nAll systems are healthy." />;
```

出口部件包括:

-   以电子邮件安全内线样式响应回放电子邮件文档.
-   可重新使用的信息-正体组件供批准并作预览.
-   dbx- 工具在默认情况下通过 `BrandContext`。 。 。 .
-   消费者品牌在不与AppKit或SMTP相接模板的情况下,可以覆盖.
-   丰富的内容在收件箱和浏览器中持续渲染.

## 运行时边界

此软件包仅提供演示文稿 :

-   [@dbx-tools/电子邮件](https://npmcn.com/package/node/email) 调制 `EmailDocument` 用于SMTP和 本地发货箱.
-   [@dbx-tools/ui/电子邮件](https://npmcn.com/package/ui/appkit) 用途 `EmailBody` 财务报告和审定财务报表 `EmailCard` 页:1 批准,作曲,和预览表面.
-   [@dbx-tools/ 共享电子邮件](https://npmcn.com/package/%40dbx-tools/email) 拥有电子邮件电线计划而不使用 反应依赖.

软件包不发送消息、批准发送、访问 AppKit 请求 身份,或需要浏览器 DOM API.

## 配置模板

```tsx
import { EmailDocument } from "@dbx-tools/shared-email-template";

<EmailDocument subject="Incident update" body="## Resolved\nAll systems are healthy." />;
```

节点运行时间应将此组件传递至 `@react-email/render`。 。 。 . `@dbx-tools/email` 对 SMTP 和本地发件箱自动执行.

`heading` 默认为 MIME 主题。 主题时通过更短的标题 载有具体通知细节。 一次性编码邮件使用此来保存 在通知中编码而不在打开的卡片内重复:

```tsx
<EmailDocument
  subject="123456 is your verification code"
  heading="Your verification code"
  preview="Your verification code is: 123456"
  body={body}
/>
```

`preview` 设置前标头,即客户端在 主体和推进体通知移动邮件应用程序帖. 这个 默认为主题。 通知应该说些什么的时候就设定 主题不:

```tsx
<EmailDocument
  subject="123456 is your verification code"
  preview="Your verification code is: 123456"
  body={body}
/>
```

移动一次性代码自动填充可以从通知的发送者读取代码, 主题和前标题。 只出现在信件正文中的代码不会 到达自动填充热量.

## 重用正文预览

```tsx
import { EmailBody } from "@dbx-tools/shared-email-template";

<EmailBody body={draft.body} />;
```

机构预览并完成文档共享打字和内容造型. 这个 完整文档添加了品牌头带,头,脚. 信封行数( E)`headers`)是本地发件箱预览的选入。 交付的SMTP 邮件和浏览器批准铬离开收件人和附件 HTML 躯体.

使用 `EmailCard` 当浏览器表面显示完整的演示文稿时 不产生外形 `<html>` 或者说 `<body>` 元素 :

```tsx
import { EmailCard } from "@dbx-tools/shared-email-template";

<EmailCard subject={draft.subject} body={draft.body} />;
```

## 应用一个品牌

```ts
import { brandUtils } from "@dbx-tools/shared-core";
import { emailBrandFromContext } from "@dbx-tools/shared-email-template";

const emailBrand = emailBrandFromContext(brandUtils.defaultBrandContext);
```

选择 `brand` 使用dbx-tools品牌. 消费者可以提供自己的颜色, 字体、名称、标签线、网站和可取取的标志 URL。 脚印使 标记线只当提供的品牌宣布一个.

## 软件包出口

-   `.`数字 : `EmailDocument`, (中文(简体) ), `EmailCard`, (中文(简体) ), `EmailBody`,品牌类型/默认,以及 内容正常化.

给这个包配对 [@dbx-tools/ 共享电子邮件](https://npmcn.com/package/%40dbx-tools/email) 以铁丝网盟誓, [@dbx-tools/电子邮件](https://npmcn.com/package/node/email) 交货,以及 [@dbx-tools/ui/电子邮件](https://npmcn.com/package/ui/appkit) 供批准,并撰写UI.

## 常见问题

### @dbx-tools/shared-email-template 是什么？

通用 React 电子邮件演示文稿,由 dbx 工具服务器和浏览器表面共享

### 如何安装 @dbx-tools/shared-email-template？

在项目目录运行 npm install @dbx-tools/shared-email-template，或使用 pnpm add / yarn add / bun add。

### @dbx-tools/shared-email-template 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @dbx-tools/shared-email-template 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @dbx-tools/shared-email-template 可以商用吗？

@dbx-tools/shared-email-template 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @dbx-tools/shared-email-template 的下载量有多少？

根据 npm 官方下载统计，@dbx-tools/shared-email-template 在 2026/10/12 – 2026/11/10 这 30 天内被下载 9,667 次，日均约 322 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @dbx-tools/shared-email-template 还在维护吗？

最新版本 0\.9\.206 发布于 2026/11/11（今天）；至今共发布 267 个版本，其中过去 12 个月发布了 267 个；首次发布于 2026/08/03。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。