https://github.com/railsware/mailtrap-php
The official mailtrap.io PHP client
https://github.com/railsware/mailtrap-php
email mail mailtrap-io php
Last synced: 2 months ago
JSON representation
The official mailtrap.io PHP client
- Host: GitHub
- URL: https://github.com/railsware/mailtrap-php
- Owner: railsware
- License: mit
- Created: 2023-02-21T12:00:53.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-27T09:07:02.000Z (5 months ago)
- Last Synced: 2025-03-29T11:03:29.563Z (2 months ago)
- Topics: email, mail, mailtrap-io, php
- Language: PHP
- Homepage: https://mailtrap.io
- Size: 204 KB
- Stars: 38
- Watchers: 19
- Forks: 8
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Official Mailtrap PHP client
===============
[](https://packagist.org/packages/railsware/mailtrap-php)
[](https://packagist.org/packages/railsware/mailtrap-php)
[](https://packagist.org/packages/railsware/mailtrap-php)
## Installation
You can install the package via [composer](http://getcomposer.org/)
The Mailtrap API Client is not hard coupled to Guzzle, React, Zend, Symfony HTTP or any other library that sends
HTTP messages. Instead, it uses the [PSR-18](https://www.php-fig.org/psr/psr-18/) client abstraction.
This will give you the flexibility to choose what [HTTP client](https://docs.php-http.org/en/latest/clients.html) you want to use.
If you just want to get started quickly you should run one of the following command (depends on which HTTP client you want to use):
```bash
# With symfony http client (recommend)
composer require railsware/mailtrap-php symfony/http-client nyholm/psr7
# Or with guzzle http client
composer require railsware/mailtrap-php guzzlehttp/guzzle php-http/guzzle7-adapter
```
## Usage
You should use Composer autoloader in your application to automatically load your dependencies.
Here's how to send a message using the SDK:
```php
from(new Address('[email protected]', 'Mailtrap Test'))
->replyTo(new Address('[email protected]'))
->to(new Address('[email protected]', 'Jon'))
->priority(Email::PRIORITY_HIGH)
->cc('[email protected]')
->addCc('[email protected]')
->bcc('[email protected]')
->subject('Best practices of building HTML emails')
->text('Hey! Learn the best practices of building HTML emails and play with ready-to-go templates. Mailtrap’s Guide on How to Build HTML Email is live on our blog')
->html(
'
Hey
Learn the best practices of building HTML emails and play with ready-to-go templates.
Mailtrap’s Guide on How to Build HTML Email is live on our blog
![]()
'
)
->embed(fopen('https://mailtrap.io/wp-content/uploads/2021/04/mailtrap-new-logo.svg', 'r'), 'logo', 'image/svg+xml')
->category('Integration Test')
->customVariables([
'user_id' => '45982',
'batch_id' => 'PSJ-12'
])
;
// Custom email headers (optional)
$email->getHeaders()
->addTextHeader('X-Message-Source', 'domain.com')
->add(new UnstructuredHeader('X-Mailer', 'Mailtrap PHP Client')) // the same as addTextHeader
;
try {
$response = $mailtrap->send($email);
var_dump(ResponseHelper::toArray($response)); // body (array)
} catch (Exception $e) {
echo 'Caught exception: ', $e->getMessage(), "\n";
}
// OR -> Mailtrap BULK SENDING client (real)
try {
$mailtrapBulkSending = MailtrapClient::initSendingEmails(
apiKey: getenv('MAILTRAP_API_KEY'), # your API token from here https://mailtrap.io/api-tokens
isBulk: true # Bulk sending (@see https://help.mailtrap.io/article/113-sending-streams)
);
$response = $mailtrapBulkSending->send($email);
var_dump(ResponseHelper::toArray($response)); // body (array)
} catch (Exception $e) {
echo 'Caught exception: ', $e->getMessage(), "\n";
}
// OR -> Mailtrap Testing client (sandbox)
try {
$mailtrapTesting = MailtrapClient::initSendingEmails(
apiKey: getenv('MAILTRAP_API_KEY'), # your API token from here https://mailtrap.io/api-tokens
isSandbox: true, # Sandbox sending (@see https://help.mailtrap.io/article/109-getting-started-with-mailtrap-email-testing)
inboxId: getenv('MAILTRAP_INBOX_ID') # required param for sandbox sending
);
$response = $mailtrapTesting->send($email);
var_dump(ResponseHelper::toArray($response)); // body (array)
} catch (Exception $e) {
echo 'Caught exception: ', $e->getMessage(), "\n";
}
```
### All usage examples
You can find more examples [here](examples).
* [General examples](examples/general)
* [Testing examples](examples/testing)
* [Sending examples](examples/sending)
## Framework integration
If you are using a framework you might consider these composer packages to make the framework integration easier.
* [Symfony](src/Bridge/Symfony)
* [Laravel](src/Bridge/Laravel)
## Contributing
Bug reports and pull requests are welcome on [GitHub](https://github.com/railsware/mailtrap-php). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](CODE_OF_CONDUCT.md).
## License
The package is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the Mailtrap project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).