# nestjs-imap 中文文档

规范地址：https://npmcn.com/package/nestjs-imap/

版本：1\.0\.7
npm 元数据更新时间：2026-11-04T04:15:46.835Z
中文译文更新时间：2026-11-04T06:42:41.520Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/nestjs-imap
原文对照：https://npmcn.com/package/nestjs-imap/?lang=original
项目主页：https://github.com/alperguclu/nestjs-imap#readme
源码仓库：https://github.com/alperguclu/nestjs-imap

弃用说明：Package no longer supported\. Contact Support at https://www\.npmjs\.com/support for more info\.

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

- 包体积（解压后）：81.2 kB，12 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：2 个
- 首次发布：2024-08-02T04:06:59.017Z
- 最新版本发布：2024-08-02T06:02:05.300Z
- 已发布版本数：8（近 12 个月 0 个）

## 中文简介

一个使用node-imap包与IMAP服务器交互的nesstjs模块。

## 安装

```sh
npm install nestjs-imap
```

也可以使用：`pnpm add nestjs-imap`、`yarn add nestjs-imap`、`bun add nestjs-imap`

## README

# nestjs-imap

一个用于与IMAP服务器交互的nesjs模块 `node-imap` 包中。

## 安装

要安装该包，请运行：

```bash
npm install nestjs-imap
```

## 配置

要使用 `nestjs-imap` 模块，您需要将其导入到您的NestJS模块中，并提供必要的IMAP配置。

### 示例配置

```typescript
import { Module } from '@nestjs/common';
import { ImapModule, ImapConfig } from 'nestjs-imap';

const imapConfig: ImapConfig = {
  user: 'your-email@example.com',
  password: 'your-password',
  host: 'imap.example.com',
  port: 993,
  tls: true,
};

@Module({
  imports: [ImapModule.forRoot(imapConfig)],
})
export class AppModule {}
```

## 用法

你可以使用 `ImapService` 与IMAP服务器交互。下面是一个如何使用该服务的示例：

### 示例服务

```typescript
import { Injectable, OnModuleInit } from '@nestjs/common';
import { ImapService } from 'nestjs-imap';

@Injectable()
export class EmailService implements OnModuleInit {
  constructor(private readonly imapService: ImapService) {}

  async onModuleInit() {
    this.imapService.connect();
    this.imapService.on('ready', async () => {
      // Open the mailbox in read-write mode to allow modifying message flags
      await this.imapService.openBox('INBOX', false);
      const messages = await this.imapService.getMessages(['UNSEEN'], {
        bodies: '',
      });

      console.log('Messages:', messages);

      if (messages.length > 0) {
        const message = messages[0];
        const uid = message.attributes.uid;

        console.log('UID:', uid);

        if (uid) {
          try {
            const fullMessage = await this.imapService.readMessage(uid);
            console.log('Full Message:', fullMessage);

            // Mark the message as read
            await this.imapService.markAsRead(uid);
            console.log('Message marked as read');
          } catch (error) {
            console.error('Error:', error);
          }
        } else {
          console.error('Message UID is not valid');
        }
      } else {
        console.log('No new messages');
      }
    });
  }
}
```

## API

### ImapService

#### 方法

-   **connect ()**：连接IMAP服务器。
-   **结束()**：结束IMAP连接。
-   **openBox(boxName: string, readOnly: boolean): Promise**：打开邮箱。
-   **getMessages(criteria: any, fetchOptions: any): Promise<any\[\]>**：获取符合条件的消息。
-   **readMessage(uid: number)：承诺**：按UID读取指定消息。
-   **markAsRead(uid: number): Promise**：根据UID将特定消息标记为已读。
-   **On (event: string, callback:（…）Args: any\[\]) => void): void**：监听IMAP事件。

## 许可证

麻省理工学院

## 常见问题

### nestjs-imap 是什么？

一个使用node-imap包与IMAP服务器交互的nesstjs模块。注意：该包已被作者标记为弃用——Package no longer supported\. Contact Support at https://www\.npmjs\.com/support for more info\.

### 如何安装 nestjs-imap？

在项目目录运行 npm install nestjs-imap，或使用 pnpm add / yarn add / bun add。

### nestjs-imap 支持 TypeScript 吗？

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

### nestjs-imap 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### nestjs-imap 可以商用吗？

nestjs-imap 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### nestjs-imap 还在维护吗？

最新版本 1\.0\.7 发布于 2024/08/02（2 年前）；至今共发布 8 个版本，其中过去 12 个月发布了 0 个；首次发布于 2024/08/02。作者已将其标记为弃用，新项目建议寻找替代方案。