Package Home

Zend Framework 2 Documentation (Manual)

PHK Home

File: /modules/zend.mail.using-file-transport.html

Size:9392
Storage flags:no_autoload,compress/gzip (32%)

Using File Transport — Zend Framework 2 2.4.2 documentation

Using File TransportΒΆ

Zend\Mail\Transport\File is useful in a development environment or for testing purposes. Instead of sending any real emails it simply dumps the email’s body and headers to a file in the filesystem.

The transport has two optional parameters that can be passed to the constructor or via setOptions() method. The path option specifies the base path where new files are saved. If nothing is set transport tries to get the default system directory for temporary files calling sys_get_temp_dir. The second parameter, callback, defines what function is used to generate a filename. As an example, assume we need to use recipient’s email plus some hash as the filename:

1
2
3
4
5
6
7
$mail = new Zend\Mail\Message();
$mail->addTo('somebody@example.com', 'Some Recipient');
// build message...
$tr = new Zend\Mail\Transport\File(array('callback' => function ($transport){
    return $transport->recipients . '_' . mt_rand() . '.tmp';
}));
$mail->send($tr);

The resulting file will be something like somebody@example.com_1493362665.tmp

This Page

Note: You need to stay logged into your GitHub account to contribute to the documentation.

Edit this document

Edit this document

The source code of this file is hosted on GitHub. Everyone can update and fix errors in this document with few clicks - no downloads needed.

  1. Login with your GitHub account.
  2. Go to Using File Transport on GitHub.
  3. Edit file contents using GitHub's text editor in your web browser
  4. Fill in the Commit message text box at the end of the page telling why you did the changes. Press Propose file change button next to it when done.
  5. On Send a pull request page you don't need to fill in text anymore. Just press Send pull request button.
  6. Your changes are now queued for review under project's Pull requests tab on GitHub.

For more information about the PHK package format: http://phk.tekwire.net