README

Shoutbox.net 是一个用于大规模发送事务性电子邮件的开发者 API。此库提供了一个简单高效的方式与 Shoutbox API 交互，使您能够轻松将电子邮件功能集成到您的 PHP 应用程序中。

安装

您可以使用 Composer 安装 shoutboxnet/shoutbox 包。

使用 Composer

composer require shoutboxnet/shoutbox

用法

要使用 shoutboxnet/shoutbox 库，您需要从 Shoutbox.net 获取一个 API 密钥。您可以直接传递此密钥给 Shoutbox 类或将其设置为环境变量（SHOUTBOX_API_KEY）。

发送简单电子邮件

以下是一个发送基本电子邮件的示例

<?php

require 'vendor/autoload.php';

use Shoutbox\Shoutbox;
use Shoutbox\EmailOptions;

$shoutbox = new Shoutbox();

$options = new EmailOptions();
$options->name = "Vlad";
$options->from = "no-reply@shoutbox.net";
$options->to = "test@example.com";
$options->subject = "A question about the meetup";
$options->html = "<b>Hi, Are you still going to that meetup?</b>";

$shoutbox->sendEmail($options);

发送带附件的电子邮件

您还可以发送带有附件的电子邮件

<?php

require 'vendor/autoload.php';

use Shoutbox\Shoutbox;
use Shoutbox\EmailOptions;
use Shoutbox\Attachment;

$shoutbox = new Shoutbox();

$options = new EmailOptions();
$options->name = "Vlad";
$options->from = "no-reply@shoutbox.net";
$options->to = "test@example.com";
$options->subject = "A question about the meetup";
$options->html = "<b>Hi, Are you still going to that meetup?</b>";

$attachment = new Attachment();
$attachment->filepath = "./examples/important.txt";

$options->attachments[] = $attachment;

$shoutbox->sendEmail($options);

发送带 CC 的电子邮件

您还可以包括 CC 收件人

<?php

require 'vendor/autoload.php';

use Shoutbox\Shoutbox;
use Shoutbox\EmailOptions;

$shoutbox = new Shoutbox();

$options = new EmailOptions();
$options->name = "Vlad";
$options->from = "no-reply@shoutbox.net";
$options->to = "test@example.com";
$options->subject = "A question about the meetup";
$options->html = "<b>Hi, Are you still going to that meetup?</b>";
$options->cc = "tycho@shoutbox.net";

$shoutbox->sendEmail($options);

EmailOptions 接口

EmailOptions 类允许您自定义电子邮件。以下是您可以设置的属性

• from（字符串）：发件人的电子邮件地址（必需）。
• name（字符串）：发件人的姓名（可选）。
• to（字符串 | 字符串数组）：收件人的电子邮件地址（必需）。
• subject（字符串）：电子邮件的主题（必需）。
• html（字符串）：电子邮件的 HTML 内容（可选）。
• text（字符串）：电子邮件的纯文本内容（可选）。
• attachments（附件数组）：附件对象数组（可选）。
• replyTo（字符串）：回复的电子邮件地址（可选）。
• tags（数组）：标签数组（可选）。
• headers（数组）：电子邮件的自定义头（可选）。
• cc（字符串 | 字符串数组）：CC 收件人（可选）。

Attachment 接口

Attachment 类允许您将文件附加到电子邮件中

• filename（字符串）：文件的名称（可选）。
• filepath（字符串）：附件的文件路径（必需）。
• contentType（字符串）：附件的 MIME 类型（可选）。
• content（字符串）：附件的 Base64 编码内容（可选）。

环境变量

为了避免硬编码您的 API 密钥，您可以将其设置为环境变量

export SHOUTBOX_API_KEY=your_api_key

开发

如果您想在此包上开发，请按照以下步骤操作

1. 克隆存储库

git clone https://github.com/yourusername/shoutboxnet.git

1. 导航到项目目录

cd shoutboxnet

1. 安装依赖项

composer install

1. 运行测试

composer test

您可以对源代码进行更改并运行测试，以确保一切按预期工作。

许可证

此库受 MIT 许可证的许可。有关更多详细信息，请参阅 LICENSE 文件。

贡献

我们欢迎贡献！请提交拉取请求或打开一个问题来讨论您的更改。

支持

如果您有任何问题或需要帮助，请随时在 GitHub 上打开一个问题。

通过遵循本指南，您应该能够成功集成和使用 Shoutbox.net 开发者 API 以大规模发送事务性电子邮件。有关更多示例和详细信息，请参阅此存储库中提供的源代码和文档。