Download the PHP package laravel-notification-channels/interfax without Composer
On this page you can find all versions of the php package laravel-notification-channels/interfax. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download laravel-notification-channels/interfax
More information about laravel-notification-channels/interfax
Files in laravel-notification-channels/interfax
Package interfax
Short Description This package makes it easy to send files as faxes via InterFAX with Laravel notifications
License MIT
Homepage https://github.com/laravel-notification-channels/interfax
Informations about the package interfax
InterFAX notification channel for Laravel 10.x, 11.x
This package makes it easy to send notifications using InterFAX with Laravel 10.x and 11.x.
Contents
- Installation
- Setting up the InterFAX service
- Usage
- Available Message methods
- Changelog
- Testing
- Security
- Contributing
- Credits
- License
Installation
You can install this package via composer:
The service provider gets loaded automatically.
Setting up the InterFAX service
This channel will use your InterFAX username and password. To use the channel, add this to your config/services.php
file:
This will load your InterFAX credentials from the .env
file. If your requests must be PCI-DSS-compliant, set INTERFAX_PCI=true
in your .env
file.
The services.interfax.interval
configuration setting is the polling interval, in seconds, for a fax if it is set to check the status until it is complete. This is optional and will default to 15 if left empty. The interval has a minimum of 10 seconds, as the outbound service in the API has a maximum freqncy of 6 requests per minute and can return errors if polled more frequently.
Faxes can sometimes take more than 10 minutes to send, so it is recommended to configure a long-running queue and to push your fax notifications to that queue. More information on configuring long-running queues can be found here.
The services.interfax.chunk_size
configuration setting is the maximum file size before the InterFAX core SDK starts chunking files. The default chunk size is 1048576. When chunking, an \Interfax\Document
object is created, but the /outbound/documents
endpoint does not exist for the PCI-DSS-compliant API. If services.interfax.pci
is set to true
, it is recommended to increase the chunk size to avoid 404 errors.
Usage
To use this package, you can create a notification class, like DocumentWasSent
from the example below, in your Laravel application. Make sure to check out Laravel's documentation for this process.
Send PDF via fax
The Notifiable model will need to return a destination fax number.
Available Message methods
file(string $file)
: Accepts the full path to a single file (full list of supported file types found here).
files(array $array)
: Accepts an array of file paths. If overriding the default chunk_size in the config and using an \Interfax\File
object in the array, use \NotificationChannels\Interfax\InterfaxFile
instead to automatically set the file's chunk size on initialization.
stream(Filestream $stream, string $name)
: Accepts a file stream.
addMetadata(array $data)
: Add metadata for logging purposes in case of an error.
Changelog
Please see CHANGELOG for more information what has changed recently.
Testing
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Contributing
Please see CONTRIBUTING for details.
Credits
- Craig Spivack
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
All versions of interfax with dependencies
illuminate/notifications Version ^10.0|^11.0
illuminate/support Version ^10.0|^11.0
interfax/interfax Version ^2.0
psr/log Version ^2.0