Gmail YAML Filters 项目启动与配置教程

1. 项目目录结构及介绍

Gmail YAML Filters 项目的主要目录结构如下所示：

gmail-yaml-filters/
├── filters.yaml         # YAML 格式的过滤器规则文件
├── gmail.py             # 项目的主要脚本文件
├── README.md           # 项目说明文件
├── requirements.txt    # 项目依赖文件
└── utils.py            # 辅助功能模块

• filters.yaml：这是存放 Gmail 过滤规则的 YAML 格式文件，你可以在这里定义自己的过滤规则。
• gmail.py：这是项目的主要脚本文件，用于读取 YAML 文件中的规则，并与 Gmail API 进行交互。
• README.md：项目的说明文件，包含了项目的基本信息和使用指南。
• requirements.txt：项目所需的 Python 依赖库列表。
• utils.py：包含了一些辅助功能的 Python 模块，例如处理日期、时间等。

2. 项目的启动文件介绍

项目的启动文件是 gmail.py。这个脚本负责初始化 Gmail API 客户端，读取 filters.yaml 文件中的规则，并将这些规则应用到你的 Gmail 账户中。

启动步骤：

1. 确保安装了所有必要的依赖库，运行以下命令安装：

   pip install -r requirements.txt
   

2. 在 gmail.py 文件中配置你的 Gmail API 凭据，包括服务账户的凭据文件路径。

3. 运行以下命令启动脚本：

   python gmail.py
   

脚本将会读取 filters.yaml 文件中的规则，并自动应用到你的 Gmail 账户中。

3. 项目的配置文件介绍

项目的配置文件是 filters.yaml。这个文件定义了你需要应用到 Gmail 的过滤规则。

配置文件示例：

- name: "Star important emails"
  criteria:
    - to: "[e-mail]"
    - importance: "high"
  action:
    - addLabel: "Important"

- name: "Archive emails older than 30 days"
  criteria:
    - older_than: "30d"
  action:
    - archive

在这个例子中，我们定义了两个规则：

1. 所有发送到 "[e-mail]" 且标记为高重要性的邮件将会被添加到 "Important" 标签。
2. 所有超过30天的邮件将会被存档。

你可以根据需要自定义这些规则，并在 filters.yaml 文件中添加新的规则。

请确保按照 YAML 格式的规范编写规则，否则脚本可能无法正确解析。