rootwork/php-sfax

Scrypt的Sfax服务的PHP客户端。

2.0.1 2024-08-08 19:53 UTC

README

Scrypt的Sfax服务的PHP客户端。

安装

composer require rootwork/php-sfax

使用示例

创建客户端实例

<?php
$sfax = new Rootwork\Sfax\Client(
    'https://api.sfaxme.com/api',
    'YOURUSERNAME',
    'YOURAPIKEY',
    'YOURENCRYPTIONKEY',
    'YOURIV'
);

从PDF或TIF文件发送传真

<?php
$result = $sfax->sendFax(
    'Malcolm Reynolds',
    '19999999999',
    '/path/to/file.pdf'
);

if ($result->isSuccess) {
    $queueId = $result->SendFaxQueueId;
}

从URL发送传真

<?php
$result = $sfax->sendFaxFromUrl(
    'Malcolm Reynolds', 
    '19999999999',
    Rootwork\Sfax\Client::FORMAT_TIF,
    'https://www.yoursite.com/getFile?token=ABC123&file=12345678.tif'
);

下载传入的传真

<?php
$result = $sfax->receiveInboundFax();

foreach ($result->InboundFaxItems as $fax) {
    $fileData = $sfax->downloadInboundFaxAsPdf($fax->FaxId);
    file_put_contents("/faxes/$fax->FaxId.pdf", $fileData);
}

运行测试

可以使用composer辅助脚本运行测试,例如testtestdox,具体取决于您的输出偏好。

composer install
composer test
composer testdox

代码覆盖率报告写入到build/目录。