Zend\Mail\Transport\FileOptions¶
Overview¶
This document details the various options available to the Zend\Mail\Transport\File mail transport.
Quick Start¶
1 2 3 4 5 6 7 8 9 10 11 12 | use Zend\Mail\Transport\File as FileTransport;
use Zend\Mail\Transport\FileOptions;
// Setup File transport
$transport = new FileTransport();
$options = new FileOptions(array(
'path' => 'data/mail/',
'callback' => function (FileTransport $transport) {
return 'Message_' . microtime(true) . '_' . mt_rand() . '.txt';
},
));
$transport->setOptions($options);
|
Configuration Options¶
- path
- The path under which mail files will be written.
- callback
A PHP callable to be invoked in order to generate a unique name for a message file. By default, the following is used:
1 2 3
function (Zend\Mail\FileTransport $transport) { return 'ZendMail_' . time() . '_' . mt_rand() . '.tmp'; }
Available Methods¶
Zend\Mail\Transport\FileOptions extends Zend\Stdlib\Options, and inherits all functionality from that class; this includes ArrayAccess and property overloading. Additionally, the following explicit setters and getters are provided.
- __construct
setPath(string $path)
Set the path under which mail files will be written.
Implements fluent interface.
- getPath
getPath()
Get the path under which mail files will be written.
Returns string
- setCallback
setCallback(Callable $callback)
Set the callback used to generate unique filenames for messages.
Implements fluent interface.
- getCallback
getCallback()
Get the callback used to generate unique filenames for messages.
Returns PHP callable argument.
- __construct
__construct(null|array|Traversable $config)
Initialize the object. Allows passing a PHP array or Traversable object with which to populate the instance.
Examples¶
Please see the Quick Start for examples.