rootwork/php-sfax

PHP client for Scrypt's Sfax service.

php-sfax

PHP client for Scrypt's Sfax service., _(*1)

Installation

composer require rootwork/php-sfax

Usage Examples

Create the Client Instance

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

Send a Fax from a PDF or TIF File

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

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

Send a Fax from a URL

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

Download Inbound Faxes

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

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

Running Tests

Tests can be run using composer helper scripts, test or testdox, depending on your output preferences., _(*2)

composer install
composer test
composer testdox

Code coverage reports are written to build/., _(*3)