You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-4Lines changed: 7 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -45,13 +45,16 @@ This channel will use your InterFAX username and password. To use the channel, a
45
45
'password' => env('INTERFAX_PASSWORD'),
46
46
'pci' => env('INTERFAX_PCI', false),
47
47
'interval' => 15,
48
+
'chunk_size' => null,
48
49
],
49
50
...
50
51
```
51
52
52
53
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.
53
54
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
+
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.
56
+
57
+
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.
55
58
56
59
## Usage
57
60
@@ -108,8 +111,8 @@ public function routeNotificationForInterfax($notification)
108
111
### Available Message methods
109
112
110
113
`file(string $file)` : Accepts the full path to a single file (full list of supported file types [found here](https://www.interfax.net/en/help/supported_file_types)).
111
-
`files(array $array)` : Accepts an array of file paths.
112
-
`stream(Filestream $stream, string $name)` : Accepts a file stream.
114
+
`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.
115
+
`stream(Filestream $stream, string $name)` : Accepts a file stream.
113
116
`addMetadata(array $data)`: Add metadata for logging purposes in case of an error.
114
117
115
118
## Changelog
@@ -137,4 +140,4 @@ Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
137
140
138
141
## License
139
142
140
-
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
143
+
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
0 commit comments