Skip to content

Commit 15c67c9

Browse files
committed
docs: add mailbox
1 parent dea2565 commit 15c67c9

4 files changed

Lines changed: 69 additions & 1 deletion

File tree

docs/.vitepress/sidebar.mts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -382,6 +382,10 @@ export const enSidebar = [
382382
text: 'Lunar Calendar',
383383
link: '/guide/official-plugins/lunar-calendar',
384384
},
385+
{
386+
text: 'Mailbox',
387+
link: '/guide/official-plugins/mailbox',
388+
},
385389
{
386390
text: 'Map',
387391
link: '/guide/official-plugins/map',
@@ -942,6 +946,10 @@ export const zhSidebar = [
942946
text: '万年历',
943947
link: '/zh/guide/official-plugins/lunar-calendar',
944948
},
949+
{
950+
text: '邮箱',
951+
link: '/zh/guide/official-plugins/mailbox',
952+
},
945953
{
946954
text: '地图',
947955
link: '/zh/guide/official-plugins/map',
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# tinker-mailbox
2+
3+
An email client plugin for [TINKER](https://github.com/liriliri/tinker), with IMAP receive ([imapflow](https://imapflow.com/)) and SMTP send ([nodemailer](https://nodemailer.com/)).
4+
5+
![Screenshot](https://raw.githubusercontent.com/liriliri/tinker-plugins/master/packages/tinker-mailbox/screenshot.png)
6+
7+
## Features
8+
9+
- **Multi-account** IMAP/SMTP setup with presets for Gmail, Outlook, QQ, 163, and more
10+
- **Folder browsing** with local cache, idle sync, and pull-to-load older messages
11+
- **Message reading** for plain text and HTML mail
12+
- **Compose & send** with rich-text formatting (bold, lists, font size, etc.)
13+
- **Move & delete** messages via context menu (trash or permanent delete)
14+
- **MCP Tools** for listing accounts/folders/messages, reading mail, and sending from the CLI
15+
16+
## Installation
17+
18+
Download and install [TINKER](https://tinker.liriliri.io/), then run:
19+
20+
```bash
21+
npm i -g tinker-mailbox
22+
```
23+
24+
## Usage
25+
26+
1. Add an email account and fill in IMAP/SMTP settings (or use a provider preset from the email domain)
27+
2. Select a folder in the sidebar to browse messages
28+
3. Click a message to read it; right-click to move or delete
29+
4. Click **Compose** to write and send a new message
30+
5. Use the toolbar to switch accounts, edit settings, or refresh the current folder
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# tinker-mailbox
2+
3+
TINKER 邮箱客户端插件,支持 IMAP 收信([imapflow](https://imapflow.com/))和 SMTP 发信([nodemailer](https://nodemailer.com/))。
4+
5+
![截图](https://raw.githubusercontent.com/liriliri/tinker-plugins/master/packages/tinker-mailbox/screenshot.png)
6+
7+
## 功能特性
8+
9+
- **多账户** IMAP/SMTP 配置,内置 Gmail、Outlook、QQ、163 等预设
10+
- **文件夹浏览**,支持本地缓存、idle 同步,以及下拉加载更早的邮件
11+
- **邮件阅读**,支持纯文本和 HTML 邮件
12+
- **撰写与发送**,支持富文本格式(加粗、列表、字号等)
13+
- **移动与删除**,通过右键菜单将邮件移入垃圾箱或永久删除
14+
- **MCP Tools**,可通过 CLI 列出账户/文件夹/邮件、阅读邮件并发送邮件
15+
16+
## 安装
17+
18+
下载安装 [TINKER](https://tinker.liriliri.io/),然后运行:
19+
20+
```bash
21+
npm i -g tinker-mailbox
22+
```
23+
24+
## 使用方法
25+
26+
1. 添加邮箱账户并填写 IMAP/SMTP 设置(或根据邮箱域名使用服务商预设)
27+
2. 在侧边栏选择文件夹浏览邮件
28+
3. 点击邮件阅读;右键可移动或删除
29+
4. 点击 **撰写** 编写并发送新邮件
30+
5. 使用工具栏切换账户、编辑设置或刷新当前文件夹

tinker-plugins

Submodule tinker-plugins updated 46 files

0 commit comments

Comments
 (0)