Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/korridor/symfony-scaleway-tem-mailer
Scaleway transactional email (TEM) integration for Symfony Mailer (Works with Laravel)
https://github.com/korridor/symfony-scaleway-tem-mailer
laravel php scaleway scaleway-api symfony symfony-mailer
Last synced: about 1 month ago
JSON representation
Scaleway transactional email (TEM) integration for Symfony Mailer (Works with Laravel)
- Host: GitHub
- URL: https://github.com/korridor/symfony-scaleway-tem-mailer
- Owner: korridor
- License: mit
- Created: 2023-01-05T04:44:04.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-01T14:21:26.000Z (9 months ago)
- Last Synced: 2024-08-13T09:20:30.481Z (3 months ago)
- Topics: laravel, php, scaleway, scaleway-api, symfony, symfony-mailer
- Language: PHP
- Homepage:
- Size: 35.2 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: readme.md
- License: license.md
Awesome Lists containing this project
README
# Symfony Scaleway TEM mailer
[](https://packagist.org/packages/korridor/symfony-scaleway-tem-mailer)
[](license.md)
[](https://packagist.org/packages/korridor/symfony-scaleway-tem-mailer)
[](https://github.com/korridor/symfony-scaleway-tem-mailer/actions/workflows/unittests.yml)
[](https://github.com/korridor/symfony-scaleway-tem-mailer/actions/workflows/lint.yml)
[](https://codecov.io/gh/korridor/symfony-scaleway-tem-mailer)
> [!WARNING]
> This package is no longer necessary since Symfony created their own mailer for Scaleway TEM.
>
> Please use this instead: [Symfony Mailer - Scaleway](https://github.com/symfony/scaleway-mailer)
## Installation
You can install the package via composer with following command:
```bash
composer require korridor/symfony-scaleway-tem-mailer
```
### Requirements
This package is tested for the following Laravel and PHP versions:
- 9.* (PHP 8.1)
## Usage examples
### Laravel
Add the following code to the `AppServiceProvider`:
```php
use Korridor\SymfonyScalewayTemMailer\Transport\ScalewayApiTransport;
use Korridor\SymfonyScalewayTemMailer\Transport\ScalewaySmtpTransport;
// ..
/**
* Bootstrap any application services.
*
* @return void
*/
public function boot(): void
{
// ...
Mail::extend('scaleway-api', function (array $config = []) {
return new ScalewayApiTransport($config['token'], $config['region'], $config['project_id']);
});
Mail::extend('scaleway-smtp', function (array $config = []) {
return new ScalewaySmtpTransport($config['token'], $config['region'], $config['project_id']);
});
}
```
Now add the following lines to the `config/mail.php` file in the `mailers` array:
```php
'scaleway' => [
'transport' => 'scaleway-api',
'region' => env('MAIL_SCALEWAY_REGION', 'fr-par'),
'token' => env('MAIL_SCALEWAY_TOKEN'),
'project_id' => env('MAIL_SCALEWAY_PROJECT_ID'),
],
```
If you want to use the SMTP integration instead use following lines:
```php
'scaleway' => [
'transport' => 'scaleway-smtp',
'region' => env('MAIL_SCALEWAY_REGION', 'fr-par'),
'token' => env('MAIL_SCALEWAY_TOKEN'),
'project_id' => env('MAIL_SCALEWAY_PROJECT_ID'),
],
```
### Symfony
Add the following lines to the `config/services.yaml` file:
```yaml
mailer.transport_factory.scaleway:
class: Korridor\SymfonyScalewayTemMailer\Transport\ScalewayTransportFactory
parent: mailer.transport_factory.abstract
tags:
- {name: mailer.transport_factory}
```
Then `MAILER_DSN` environment variable for example like this:
```dotenv
MAILER_DSN=scaleway+api://SCW_PROJECT_ID:[email protected]
```
## Contributing
I am open for suggestions and contributions. Just create an issue or a pull request.
### Local docker environment
The `docker` folder contains a local docker environment for development.
The docker workspace has composer and xdebug installed.
```bash
docker-compose run workspace bash
```
### Testing
The `composer test` command runs all tests with [phpunit](https://phpunit.de/).
The `composer test-coverage` command runs all tests with phpunit and creates a coverage report into the `coverage`
folder.
### Codeformatting/Linting
The `composer fix` command formats the code with [php-cs-fixer](https://github.com/FriendsOfPHP/PHP-CS-Fixer).
The `composer lint` command checks the code with [phpcs](https://github.com/squizlabs/PHP_CodeSniffer).
## Credits
The structure of the repository is inspired by the project [symfony/postmark-mailer](https://github.com/symfony/postmark-mailer).
## License
This package is licensed under the MIT License (MIT). Please see [license file](license.md) for more information.