README

Query Mail

描述

Query Mail 是一个简单而强大的工具，可以生成用于报告、统计数据或监控数据的精美电子邮件。

您可以定义自己的 SQL 查询以生成所需的 KPI，然后将其封装到单个电子邮件中。

项目内提供了包含 2 个 KPI 和示例布局的电子邮件示例

Query Mail 使用流行的框架 FuelPHP 编写

项目使用预先配置的 SQLite 数据库，因此依赖性最小。

使用 docker 安装

为了正确运行此项目，最简单的方法是使用提供的 docker 安装。

编辑 docker/ssmtp.conf 文件并设置您的邮件服务器凭据。首先，您必须使用 docker-compose run --rm php composer install --no-dev -o 命令安装依赖项。然后在项目的根目录下简单运行 docker-compose up -d。此脚本将为 PHP 创建一个 docker 容器并运行一个 nginx 网络服务器。在您的 /etc/hosts 文件中添加以下行：

127.0.0.1 querymail

然后您可以直接通过 http://querymail 访问 Query Mail

通过 composer 安装

composer create-project querymail/querymail

其他安装方法

如果您愿意，可以设置自己的服务器基础设施。您只需要知道此代码仅适用于 PHP5.4+。

调度

Query Mail 不提供任何调度功能。为了在特定间隔调用 Query Mail Web 服务，我建议使用简单的 Linux crontab。

Query Mail 将为您的每封电子邮件显示可以使用的 URL，您可以使用 Curl 调用。

配置

数据库

将您的数据库列表配置到 fuel/app/config/db.php 文件中。为要添加的每个数据库添加以下行代码：

'myconnection' => array(
    'type' => 'pdo',
    'connection'  => array(
        'dsn'        => 'mysql:host=myhost;dbname=mydb',
        'username'   => 'user',
        'password'   => 'password',
    ),
    'identifier' => '`',
    'table_prefix' => '',
    'charset' => 'utf8',
    'enable_cache' => true,
    'profiling' => false,
),

每个连接都必须有自己的别名，当创建新的 KPI 时将自动出现在 Web 界面中。

电子邮件模板布局

项目内提供了示例 HTML 布局。您可以在 fuel/app/views/emails/ 中创建自己的布局。请注意，由于流行的 Web 邮件限制（如 Gmail、Yahoo 等），模板必须使用旧的 HTML4 风格编写。

项目

为了组织您的电子邮件，您可以设置自己的项目列表。项目列表保存在 SQLite 的 QMAIL_PROJECT 表中。如您所见，在基本配置中，您只有一个名为 My Awesome Project 的项目。

电子邮件驱动程序

如果您使用特定的驱动程序发送电子邮件，您可以在 FuelPHP 框架中配置它。您可以在官方文档中找到更多信息。

querymail / querymail

维护者

详细信息