conjoon/lumen-app-email

IMAP/SMTP电子邮件消息的后端服务。

安装: 117

依赖项: 0

建议者: 0

安全: 0

星级: 4

关注者: 2

分支: 1

开放问题: 13

类型:项目

v1.1.5 2024-02-01 16:40 UTC

README

IMAP/SMTP电子邮件消息的后端服务。

什么是lumen-app-email?

conjoon/lumen-app-email 是一个使用 Lumen 构建 PHP🐘 应用程序,是一个独立的应用程序。它根据 https://github.com/conjoon/rest-api-description 提供 Email 消息的后端,并通过 IMAP/SMTP 提供读取、写入和发送电子邮件消息的端点。

lumen-app-email 脚本小,易于安装。

安装

$ composer create-project conjoon/lumen-app-email htdocs "1.*" 

有关安装和配置的更多信息,请参阅 lumen-app-email 的官方 文档

功能

lumen-app-email 采用了面向服务的架构。服务可以通过前端的 DI 配置和相关绑定轻松替换。

使用 lumen-app-email,如果您...

  • 需要一个与 IMAP / SMTP 服务器通信的完整功能的中间件
  • 希望提供具有各种身份验证方法(例如)的 webmail 解决方案
    • 通过服务器编排的特定域名登录 IMAP 账户
    • 仅通过用户配置的 IMAP 账户连接
  • 寻找一个脚本小、易于分发的电子邮件消息解决方案
  • 需要一个无头、面向服务的独立应用程序,在您的基础设施中运行,也可以独立于前端运行

API 示例

# Return a list of available MailAccounts for the requesting client
GET /MailAccounts HTTP/1.1
Content-Type: application/json
Authorization: Basic Y29uam9vbjpIZWxsb1dvcmxk
Host: hostname

# Return the envelope data of the first 50 MessageItems w/o previewText of the INBOX mailbox
# for the MailAccount identified by "gmail"
GET /MailAccounts/gmail/MailFolders/INBOX/MessageItems?start=0&limit=50&attributes=*,previewText HTTP/1.1
Content-Type: application/json
Authorization: Basic Y29uam9vbjpIZWxsb1dvcmxk
Host: hostname

# Return the email identified with the uid 4356 of the INBOX mailbox for the MailAccount identified by "gmail"
GET /MailAccounts/gmail/MailFolders/INBOX/MessageItems/4356 HTTP/1.1
Content-Type: application/json
Authorization: Basic Y29uam9vbjpIZWxsb1dvcmxk
Host: hostname

后端 API 文档


有关此服务提供的端点列表,请参阅 rest-api-email 的 OpenApi 文档,可在 conjoon.stoplight.io 找到

附加说明

官方文档

官方文档可以在 conjoon 的项目页面找到。此文档与官方项目页面保持一致。

正在进行中

lumen-app-email 是一个正在进行中的项目。我们正在不断改进 API,并努力实现 RESTful 实现。您可以在 Github 上关注我们的更新,包括此项目和相关项目。

Composer 2.0 - Pear/Horde vows

v1.0.1 版本起,php-lib-conjoon 不再需要 Composer 1.* 进行安装。为了 Composer 2.* 兼容性,php-lib-conjoon 依赖于以下私有 composer 包仓库

https://horde-satis.maintaina.com

此仓库在本包的 composer.json 中提及。此仓库也位于 horde/horde_deploymentcomposer.json 文件中。