Docs
电子邮件

电子邮件

创建和管理电子邮件

请勿滥用免费电子邮件服务。如果发现任何非法或恶意活动,账户将被封禁。如果您需要帮助,请联系我们。

概述

我们为用户收发电子邮件提供免费的电子邮件服务。用户可以生成一个独一无二的电子邮件地址,并使用该地址收发电子邮件。 请从 https://qf.edu.kg/emails 开始使用电子邮件服务!

工作原理

我们使用 resend 发送电子邮件。Resend 是一项免费的电子邮件服务,允许用户发送和接收电子邮件。 在接收电子邮件方面,我们使用 cloudflare 电子邮件工作程序来接收电子邮件和转发电子邮件。 它功能强大,性能稳定。而且易于使用。

到期

除非您手动删除,否则电子邮件永远不会被删除。

一旦删除,将无法恢复。收件箱中的所有邮件将同时被删除。

限制

电子邮件地址的最大数量为 1000 个。

每个电子邮件地址可接收无限量的电子邮件

发送电子邮件时,每天最多可发送 10 封电子邮件。

应用程序接口参考

通过电子邮件 API,您可以创建和管理电子邮件地址,并检索收件箱中已收到的电子邮件。

创建电子邮件地址

通过 POST /api/v1/email 端点,您可以创建一个新的电子邮件地址。

curl -X POST \
  -H "Content-Type: application/json" \
  -H "wrdo-api-key: YOUR_API_KEY" \
  -d '{
    "emailAddress": "your-suffix@mail.qf.eud.kg"
  }' \
  https://qf.edu.kg/api/v1/email

请求正文(参数)

{
  "emailAddress": "your-suffix@mail.qf.edu.kg" // 必填,后缀必须至少为 5 个字符
}

授权标头

  • wrdo-api-key: 您可以使用 API 密钥验证您的请求。 您可以在[账户设置](/dashboard/settings)中找到您的 API 密钥。 在请求中添加标头 wrdo-api-key: YOUR_API_KEY`。

回应

On success (Status 201):

{
  id: string;
  userId: string;
  emailAddress: string;
  createdAt: Date;
  updatedAt: Date;
  deletedAt: Date | null;
}

错误回复

  • 401 Unauthorized: 缺少或无效的 API 密钥
  • 400 Bad Request: 缺少电子邮件地址或后缀无效(少于 5 个字符)
  • 403 Forbidden: 电子邮件地址配额已满
  • 409 Conflict: 电子邮件地址已存在
  • 500 Internal Server Error: 服务器错误

获取电子邮件收件箱

通过 "GET /api/v1/email/inbox "端点,您可以检索特定电子邮件地址的所有转发电子邮件。

您必须先创建一个电子邮件地址,然后才能获得收件箱。

curl -X GET \
  -H "wrdo-api-key: YOUR_API_KEY" \
  "https://qf.edu.kg/api/v1/email/inbox?emailAddress=your-suffix@qf.edu.kg&page=1&size=10"

查询参数

  • emailAddress: 要获取收件箱的电子邮件地址(必填)
  • page: 用于分页的页码(可选,默认为 1)
  • size: 每页的邮件数(可选,默认为 10)

授权标头

  • wrdo-api-key: 您可以使用 API 密钥来验证您的请求。 您可以在 [账户设置] (/dashboard/settings) 中找到您的 API 密钥。 在请求中添加标头 wrdo-api-key: YOUR_API_KEY

回应

On success (Status 200):

{
  "list": [
    {
      id: string
      from: string
      fromName: string
      to: string
      subject: string | null
      text: string | null
      html: string | null
      date: string | null
      messageId: string | null
      replyTo: string | null
      cc: string | null
      headers: string | null
      attachments: string | null
      readAt: Date | null
      createdAt: Date
      updatedAt: Date
    },
  ],
  "total": 25
}

错误回复

  • 401 Unauthorized: 缺少或无效的 API 密钥
  • 400 Bad Request: 缺少电子邮件地址参数
  • 404 Not Found: 未找到电子邮件地址或已删除
  • 500 Internal Server Error: 服务器错误

删除电子邮件地址

通过 DELETE /api/v1/email端点,您可以删除特定的电子邮件地址。

curl -X DELETE \
  -H "wrdo-api-key: YOUR_API_KEY" \
  -d '{
    "emailAddress": "your-suffix@mail.qf.edu.kg"
  }' \
  "https://qf.edu.kg/api/v1/email"