Skip to content

Commit 7e8d088

Browse files
committed
Update README for polling interval setting
1 parent 09ef135 commit 7e8d088

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,12 +44,15 @@ This channel will use your InterFAX username and password. To use the channel, a
4444
'username' => env('INTERFAX_USERNAME'),
4545
'password' => env('INTERFAX_PASSWORD'),
4646
'pci' => env('INTERFAX_PCI', false),
47+
'interval' => 15,
4748
],
4849
...
4950
```
5051

5152
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.
5253

54+
The `services.interfax.interval` 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.
55+
5356
## Usage
5457

5558
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](https://laravel.com/docs/master/notifications) for this process.

0 commit comments

Comments
 (0)