README

Pepipost的官方PHP代码库Pepipost

此SDK包含与Pepipost邮件发送API交互的方法，以便在几秒钟内发送电子邮件。

我们正在努力使我们的库成为社区驱动的，我们需要您的帮助来正确地以正确的方式构建正确的事情。您的意见非常宝贵，所以请分享评论，创建问题和拉取请求。

安装（操作系统友好型）

为了顺利的安装过程，我们已经根据操作系统对安装过程进行了分类

先决条件

1. PHP >=5.4.0
1. Composer
1. CURL
1. 在Pepipost上有一个免费账户。如果您还没有，请点击这里注册并每月免费获得30,000封电子邮件。

设置全局变量

在库中设置PEPIPOST API密钥以开始发送电子邮件。例如

通过转到设置-->集成，从您的Pepipost账户复制API密钥。
编辑示例代码并替换您刚刚复制的PEPIPOST_API_KEY。
现在库已经准备好通过Pepipost服务器进行认证以发送电子邮件。

快速开始

熟悉GIT、Composer和某些其他实用工具的开发者可以参考以下步骤快速开始集成。

如果您不确定如何在您的环境中集成此库，请参阅我们上面的详细安装指南。

使用以下命令检查PHP版本。需要PHP >=5.4.0。

php -v

使用以下命令验证是否已安装Composer

composer --version

使用以下命令在您的机器上克隆此存储库

git clone https://github.com/pepipost/pepipost-sdk-php.git testSDK

cd testSDK

以下将安装运行此库所需的所有要求。安装后，将自动创建一个vendor目录

composer install

从simple-usage.php或sampleExample复制代码并粘贴到test.php中。

cp simple-usage.md test.php

从您的Pepipost账户获取您的API密钥和发送域名。

apikey将在Pepipost登录-->设置-->集成下可用
发送域名将在Pepiost登录-->设置-->发送域名下可用

  *Note :: Domains showing with Active status on Sending Domain dashboard are only allowed to send any sort of emails.* In case there are no Sending Domain added under your account, then first add the domain, get the DNS (SPF/DKIM) settings done and get it reviewed by our compliance team for approval. Once the domain is approved, it will be in ACTIVE status and will be ready to send any sort of emails.

在您的脚本test.php中进行必要的更改（添加apikey和发送域名是强制性的）。

将您的 $apiKey = 'api-XX-key-XX-here' 修改为 $apiKey = 'api-key-of-your-pepipost-account';

类似地，更新您的发送域名

$body->from->fromEmail = 'admin@myfirsttest.com'; 修改为 $body->from->fromEmail = 'admin@your-active-domain-on-pepipost';

更新与电子邮件相关的其他负载，如收件人电子邮件地址、电子邮件内容等。下面是带有负载详细信息的示例代码

test.php 的示例代码

<?php

require_once "vendor/autoload.php";
use PepipostLib\Models;
use PepipostLib\Exceptions;

$apiKey = '96c909c62bcc1dfdacef7dfdda34ea8477';

$client = new PepipostLib\PepipostClient($apiKey);
$sendController = $client->getMailSend();

$body = new Models\Send;
$body->from = new Models\From;
$body->from->email = 'hello@your-registered-domain-with-pepipost';
$body->from->name = 'Pepipost';
$body->subject = 'Pepipost Test Mail from PHP SDK';


$body->content = array();
$body->content[0] = new Models\Content;
$body->content[0]->type = Models\TypeEnum::HTML;
$body->content[0]->value = '<html><body>Hello [%NAME%], Email testing is successful. <br> Hope you enjoyed this integration. <br></html>';

$body->personalizations = array();
$body->personalizations[0] = new Models\Personalizations;
$body->personalizations[0]->attributes = PepipostLib\APIHelper::deserialize('{"NAME":"User"}');
$body->personalizations[0]->to = array();

$body->personalizations[0]->to[0] = new Models\EmailStruct;
$body->personalizations[0]->to[0]->name = 'to-address@mydomain.name';
$body->personalizations[0]->to[0]->email = 'my-first-user';

$body->settings = new Models\Settings;
$body->settings->footer = true;
$body->settings->clickTrack = true;
$body->settings->openTrack = true;
$body->settings->unsubscribeTrack = true;

try {
  $result = $sendController->createGenerateTheMailSendRequest($body);
  var_dump($result);
} catch (PepipostLib\APIException $e) {
    echo 'Caught APIException: ',  $e->getMessage(), "\n"; 
}
?>

有关参数的更多信息，我们建议您查看我们的 API 文档

运行您的脚本以发送第一个测试电子邮件

php test.php

这将给出以下输出

{
   "data": {
   	"message_id": "e8820eeb0ee94807f1ce88652b1dd627"
   },
   "message": "OK",
   "status": "success"
}

公告

已发布 v5.1.0！请参阅发布说明获取详细信息。

关于此库的所有更新都在我们的发布中记录。如有任何疑问和反馈，请随时通过 dx@pepipost.com 联系我们

路线图

如果您对这个项目的未来方向感兴趣，请查看我们的公开问题和拉取请求。我们非常欢迎您的反馈。

关于

pepipost-php-sdk 库由 Pepipost 开发者体验团队指导和支持。此 pepipost-php-sdk 库由 Pepipost Ltd 维护和资助。pepipost-php-sdk 的名称和标志是 Pepipost Ltd 的商标。

许可

此代码库由 APIMATIC v2.0 半自动生成，并许可在 MIT 许可证（MIT）下使用。

pepipost / pepipost-sdk-php

维护者

详细信息