README

Notifea服务的纯PHP仓库。

Notifea 为客户提供了非常用户友好的方式，向他们的用户发送事务性电子邮件和短信。

安装

要安装SDK，您需要在项目中使用Composer。有关安装方法，请参阅 文档。

安装Composer后，安装SDK

composer require notifea/notifea-php

最低要求

此包将要求您使用

• PHP 7.0或更高版本
• guzzlehttp/guzzle 6.0或更高版本
• ext-json

用法

所有电子邮件和短信端点都是通过 NotifeaClient 访问的。首先，开始配置此客户端。

$client = new NotifeaClient(
    'https://api.notifea.com/v1',
    'Bearer {authorization}'
);

您的 authentication token 可以在 access-tokens 部分生成。

用法 - 电子邮件

要与电子邮件端点交互，请使用 EmailService。首先进行实例化。

$client = new NotifeaClient(
    'https://api.notifea.com/v1',
    'Bearer {authorization}'
);

$emailService = new EmailService($client);

发送电子邮件

发送电子邮件可以像使用以下几行代码一样简单

$email = new Email();
$email->setFrom('newadress@notifea.com', 'New Address')
    ->setRecipient('customer@business.com')
    ->setReplyTo('reply_to@notifea.com')
    ->setSubject('My first email')
    ->setHtmlBody('<p>This is my first email</p>')
    ->setCc('cc@notifea.com')
;

$sentEmail = $emailService->sendEmail($email);

$sentEmail 将包含带有所有有趣信息的更新后的 Email 对象。

获取电子邮件

要获取电子邮件，请使用此段代码

$emails = $emailService->getEmails();

$emails 将是一个包含所有返回的 Email 对象的新 Collection。

获取单个电子邮件

要获取单个电子邮件实体，只需要电子邮件uuid

$email = $emailService->getEmail('8fc2c850-81c0-4424-823a-aa4727441864');

$email 将是一个 Email 对象

删除电子邮件

要从notifea数据库中删除单个电子邮件实体，此函数的使用就足够了

$result = $emailService->deleteEmail('8fc2c850-81c0-4424-823a-aa4727441864');

$result 将是在成功删除的情况下返回 true，或者在失败（例如，找不到电子邮件）时触发 NotifeaException。

用法 - 短信

要与短信端点交互，请使用 SmsService。首先进行实例化。

$client = new NotifeaClient(
    'https://api.notifea.com/v1',
    'Bearer {authorization}'
);

$smsService = new SmsService($client);

发送短信

发送短信可以像使用以下几行代码一样简单

$sms = new Sms();
$sms
    ->setRecipient('+421902739429')
    ->setSmsSenderid('59634971-e57f-44af-b530-038e27e7064e')
    ->setContent('My awesome SMS message.')
;

$sentSms = $smsService->sendSms($sms);

$sentSms 将包含带有所有有趣信息的更新后的 Sms 对象。

要找到您的 sms_sender_id，请进入您的短信发送者管理部分。

获取短信

要获取所有短信，请使用此段代码

$smss = $smsService->getSmss();

$smss 将是一个包含所有返回的 Sms 对象的新 Collection。

获取单个短信

要获取单个短信实体，只需要短信uuid

$sms = $smsService->getSms('8fc2c850-81c0-4424-823a-aa4727441864');

$sms 将是一个 Sms 对象

删除短信

要从notifea数据库中删除单个短信实体，此函数就足够了

$result = $smsService->deleteSms('8fc2c850-81c0-4424-823a-aa4727441864');

$result 将是在成功删除的情况下返回 true，或者在失败（例如，找不到短信）时触发 NotifeaException。

用法 - 短信发送者

自5月份以来，我们的客户可以通过使用 SmsSenderService 与短信发送者交互。如果您需要在不同短信中显示不同的发送者名称，这将特别有用。

首先进行实例化。

$client = new NotifeaClient(
    'https://api.notifea.com/v1',
    'Bearer {authorization}'
);

$smsSenderService = new SmsSenderService($client);

创建短信发送者

创建短信发送者可以像使用以下几行代码一样简单

$smsSender = new SmsSender();
$smsSender
    ->setSenderName('My Sender')
;

$createdSmsSender = $smsSenderService->createSmsSender($smsSender);

$createdSmsSender 将包含带有所有有趣信息的更新后的 SmsSender 对象，例如您用于发送短信所需的sms_sender_id。

获取短信发送者

要获取所有短信发送者，请使用此段代码

$smsSenders = $smsSenderService->getSmsSenders();

$smsSenders 将是一个包含所有返回的 SmsSender 对象的新 Collection。

获取单个短信发送者

要获取单个短信发送实体，只需短信发送者的UUID即可

$smsSender = $smsSenderService->getSmsSender('8fc2c850-81c0-4424-823a-aa4727441864');

$smsSender 将是一个 SmsSender 对象

更新短信发送者

要更新单个短信发送实体，可以使用 updateSmsSender() 方法并传入一个带有更新数据的 SmsSender 对象

$smsSender = new SmsSender();
$smsSender
    ->setUuid('8fc2c850-81c0-4424-823a-aa4727441864') // required in order to know which sms sender do you wish to update
    ->setSenderName('My New Name')
    ->setLiveTime(25)
;

$result = $smsSenderService->updateSmsSender($smsSender);

删除短信发送者

要从 notifea 数据库中删除单个短信发送实体，此函数就足够了

$result = $smsSenderService->deleteSmsSender('8fc2c850-81c0-4424-823a-aa4727441864');

$result 将是 true 表示删除成功，或者在出现任何失败（例如短信发送者未找到）时将触发 NotifeaException

社区

• 文档
• 报告问题

贡献

依赖项通过 composer 管理

$ composer install

可以通过 phpunit 运行测试

$ vendor/bin/phpunit