# @aglyn/plugins-email 中文文档

规范地址：https://npmcn.com/package/%40aglyn/plugins-email/

版本：1\.19\.0
npm 元数据更新时间：2026-11-07T13:59:41.408Z
中文译文更新时间：2026-11-05T23:11:17.937Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40aglyn/plugins-email
原文对照：https://npmcn.com/package/%40aglyn/plugins-email/?lang=original
项目主页：https://aglyn.com/
源码仓库：https://github.com/aglyn/aglyn

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

- 包体积（解压后）：2.9 MB，255 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：16 个
- peer 依赖：next ^16\.3\.3，react ^19\.2\.8，firebase ^13\.0\.0，@mui/material ^9\.3\.1，firebase-admin ^14\.3\.0，@mui/x-data-grid ^9\.12\.0
- 首次发布：2026-09-20T23:53:22.950Z
- 最新版本发布：2026-11-07T13:59:40.962Z
- 近 30 天下载量：9866（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：162（近 12 个月 162 个）

## 中文简介

Aglyn 的电子邮件插件:从电子邮件安全块构建在Besigner的电子邮件设计,加上主题,受众列表,发送域和邮件所搭载的压制. 如果您在 Aglyn 平台上运行或建构并想要设计 ema , 请安装它

## 安装

```sh
npm install @aglyn/plugins-email
```

也可以使用：`pnpm add @aglyn/plugins-email`、`yarn add @aglyn/plugins-email`、`bun add @aglyn/plugins-email`

## README

# @aglyn/plugins-电子邮件

Aglyn 的电子邮件插件:从电子邮件安全块构建在Besigner的电子邮件设计,加上主题,受众列表,发送域和邮件所搭载的压制. 如果您正在运行或建在 Aglyn 平台上并想要设计电子邮件, 请安装它 .

> 从Aglyn monorepo出版到npm. 随后的版本 [语义版本](https://semver.org/)。 。 。 .

## 安装

```
npm install @aglyn/plugins-email
```

同伴依赖性 :

-   `@mui/material`
-   `@mui/x-data-grid`
-   `firebase`
-   `firebase-admin`
-   `next`
-   `react`

无是可选的. `firebase-admin` 财务报告和审定财务报表 `next` 由服务器的半导体使用( e)`@aglyn/plugins-email/server`) (中文(简体) ).

## 里面有什么东西

这个软件包是一个第一党的Aglyn插件. 它通过 Aglyn 的插件管理器被装入: 应用程序读取了单列波的条目 `plugins.config.json`,输入每个表层名称,并呼叫登记员宣布该表层。 它不是一个独立的库;安装在它自己的负载上没有什么.

此插件拥有电子邮件设计, 主题目录, 列表, 发送身份和域以及压制 。 它不拥有运动:发送运动,以及消息列表,报告和作曲页面,属于营销插件(英语:`@aglyn/plugins-marketing`) (中文(简体) ). 两者通过区相接,每个东道主相接相接,具体介绍如下.

### 在签名人

`registerEmailPlugin()` 将电子邮件块登记为画布组件 : `emailSection`, (中文(简体) ), `emailText`, (中文(简体) ), `emailRichtext`, (中文(简体) ), `emailImage`, (中文(简体) ), `emailButton`, (中文(简体) ), `emailDivider`, (中文(简体) ), `emailSpacer`, (中文(简体) ), `emailProduct` 财务报告和审定财务报表 `emailHtml`。电子邮件的设计与任何屏幕一样,核心的电子邮件渲染器将相同的节点树转换为内置式的表格 HTML和发送时的纯文本.

### 在操纵台上

`registerEmailConsole()` 登记册 :

-   一个 **电子邮件** 导航项目和页面 : `/emails`,以信件、模板、听众、主题、发送和禁止为路线。 它要求 `data.manage` 权限,并且是代码分割.
-   组织一级的同一页, `/[orgSlug]/emails` (单位:千美元) `orgNavItems` ,由壳体通用的Org通向Org-wide成员的途径提供服务. 观众和话题是组织的;信息、模板、发送身份和压制清单在被封顶的批次的站点上逐个站点读取,每个属于站点的书写都询问哪个站点.
-   拥有运动的插件的插件主机的三个区域: 信件部分的整个正文( 在一个站点下, 在组织的页面上) `hostId: null` 从模板发送的邮件`emailTemplateReport`,在模板的页面上),谁收到它们(`emailTemplateRecipients`) (中文(简体) ). 此软件包没有绘制它们, 没有读取发送 .
-   在竞选主页主机区域绘制了五个部件: `campaignTopicSelect`, (中文(简体) ), `campaignTopicOptions`, (中文(简体) ), `campaignSenderEditor`, (中文(简体) ), `campaignDesignCreate` 财务报告和审定财务报表 `campaignDesignPreview`。每个报告都通过召回方式进行;没有人写运动.

### 在服务器上

`@aglyn/plugins-email/server` 进口 `firebase-admin` 并且远离客户进入点.

-   `registerEmailApi()` (单位:千美元) `tenantApi` (表层)在已签名的链接后登记收件人的页面: `email/unsubscribe`, (中文(简体) ), `email/resubscribe`, (中文(简体) ), `email/preferences` 财务报告和审定财务报表 `email/confirm`。 。 。 .
-   `registerEmailConsoleApi()` (单位:千美元) `consoleApi` (表) 登记名单`email/list-rule-preview`, (中文(简体) ), `email/list-members-preview`, (中文(简体) ), `email/list-members-add`),列表导入的筛选读取(`email/list-import-screening`),压制路线,以及核心资源-草稿接合上的电子邮件设计草稿.
-   `registerEmailConsoleServerDeclarations()` (单位:千美元) `consoleServerDeclarations` )主要登记插件的两个传输资源: `email.list-members` (一个名单的成员,从该名单进口或出口)和 `email.suppressions` (一个网站的压制列表,只导入添加). 控制台登记员登记其向导的一半,包括列表导入自己的步骤.

线路由主机API调度器提供 `/api/`。 。 。 .

### 入境点

| 导入 | 目录 |
| --- | --- |
| `@aglyn/plugins-email` | `BUNDLE_ID`电子邮件块组件及其计划, `registerEmailConsole`,站点的一半,以及模型(渲染器再出口、模板出处和发送域状态) |
| `@aglyn/plugins-email/site` | `registerEmailPlugin` 财务报告和审定财务报表 `EMAIL_BUNDLE` 只有,没有控制台代码 |
| `@aglyn/plugins-email/server` | `registerEmailApi`, (中文(简体) ), `registerEmailConsoleApi` 和列表处理器 |
| `@aglyn/plugins-email/*` | 下的任何模块 `src/lib/`。控制台组件是从 `@aglyn/plugins-email/components/...` 并且故意不从根上再出口 |

## 使用量

登记员通常由Aglyn生成的插件加载器调用. 直接调用 :

```ts
// Canvas half
import { registerEmailPlugin } from '@aglyn/plugins-email/site'
registerEmailPlugin()

// Console app
import { registerEmailConsole } from '@aglyn/plugins-email'
registerEmailConsole()

// Server-only API dispatcher
import {
  registerEmailApi,
  registerEmailConsoleApi,
} from '@aglyn/plugins-email/server'
registerEmailApi()
```

## 怎样才合适

插件可以导入租户运行时间,渲染器,Besigner逻辑,核心和共享包. 它从不导入另一个插件,核心也从不导入一个插件. 电子邮件取决于 `@aglyn/aglyn`, (中文(简体) ), `@aglyn/tenant-data-admin`, (中文(简体) ), `@aglyn/tenant-feature-instance` 财务报告和审定财务报表 `@aglyn/shared-*` 软件包,包括 `@aglyn/shared-util-email`。它与营销插件的关系完全通过插件区和在核心中注册的部件槽运行,因此两个软件包都不导入另一个.

## 许可证

阿帕奇2.0 (英语). 资料来源: [https://github.com/aglyn/aglyn/tree/main/libs/plugins/电子邮件 互联网档案馆的存檔,存档日期2013-12-02](https://github.com/aglyn/aglyn/tree/main/libs/plugins/email)

## 常见问题

### @aglyn/plugins-email 是什么？

Aglyn 的电子邮件插件:从电子邮件安全块构建在Besigner的电子邮件设计,加上主题,受众列表,发送域和邮件所搭载的压制\. 如果您在 Aglyn 平台上运行或建构并想要设计 ema , 请安装它

### 如何安装 @aglyn/plugins-email？

在项目目录运行 npm install @aglyn/plugins-email，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：next（^16\.3\.3）、react（^19\.2\.8）、firebase（^13\.0\.0）、@mui/material（^9\.3\.1）、firebase-admin（^14\.3\.0）、@mui/x-data-grid（^9\.12\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @aglyn/plugins-email 支持 TypeScript 吗？

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

### @aglyn/plugins-email 支持 ESM 还是 CommonJS？

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

### @aglyn/plugins-email 可以商用吗？

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

### @aglyn/plugins-email 的下载量有多少？

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

### @aglyn/plugins-email 还在维护吗？

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