Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/disjfa/mail-bundle
Mail bundle for symfony applications.
https://github.com/disjfa/mail-bundle
foundation-emails inky inline-css mailer symfony symfony-bundle
Last synced: about 7 hours ago
JSON representation
Mail bundle for symfony applications.
- Host: GitHub
- URL: https://github.com/disjfa/mail-bundle
- Owner: disjfa
- License: mit
- Created: 2019-11-01T20:53:13.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2019-11-21T20:22:37.000Z (almost 5 years ago)
- Last Synced: 2024-04-15T01:16:51.182Z (7 months ago)
- Topics: foundation-emails, inky, inline-css, mailer, symfony, symfony-bundle
- Language: CSS
- Homepage:
- Size: 46.9 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Mail bundle
[![Check on packagist][packagist-badge]][packagist]
[![MIT License][license-badge]][LICENSE]
[![Watch on GitHub][github-watch-badge]][github-watch]
[![Star on GitHub][github-star-badge]][github-star]
[![Tweet][twitter-badge]][twitter]
### Why is this bundle here
In every project i need to build a way to send emails. Now symfony has released the [Mime Component](https://symfony.com/doc/current/components/mime.html) and the [Mailer Component](https://symfony.com/doc/current/components/mailer.html). Lets see what we can do to make live easier for us people who send emails.
### Instalation
```
composer require disjfa/mail-bundle
```
### Setup the interface
Setup the routes in `config/routes/disjfa_mail.yaml`. Here you can edit emails setup in your application.
```yaml
disjfa_mail:
resource: '@DisjfaMailBundle/Controller/'
type: annotation
prefix: '/admin'
```
### Make you own template
Create a class that extends the `MailInterface`. Implement the name, subject and content as you want. You can inject the `Translator` to add simple translations or the twig `Environment` to render out templates.
```php
findByName('name');
$mailService->send($mail, [
'param1' => 'value',
'param2' => 'value',
], '[email protected]');
}
```
And done! Mail sent. Now it is time to setup emails and make more in your application.
### Extend the templates
You can manage the templates as is. But you probably want to integrate the files in your own system. Just create a file in your application in `templates/bundles/DisjfaMailBundle/layout.html.twig` and add a body block.
```twig
...
{% block body %}
{% endblock %}
```
And you are good to go. Or you can just [extend](https://twig.symfony.com/doc/2.x/tags/extends.html) your own template. Just make sure you use a block named `body`. You can also just extend the rest of the files as you wish. Just name them like we set up the files.
### One thing missing
One thing missing is sending the emails. We do not have to set up the mailing bit of the application. You can do that yourself. Check the [transports](https://symfony.com/doc/current/components/mailer.html#transport) on how to set up your own mailer as you wish.
### And that is about it.
Now you can make your own emails. Set them up. Create a method to send emails. And when you have set up your favorite mailer you can send them!
### Help
This bundle is a nice way to extend your workflow. But it can be improved. If you have any ideas or solutions to do so don't be shy and tell us! We can only make stuff better in the end.
### Enjoy!
Use the bundle. Check what the bundle does. Fork. Make your own. This is here just to make live easier for us all. Make something beautiful.
[packagist-badge]: https://img.shields.io/packagist/v/disjfa/mail-bundle
[packagist]: https://packagist.org/packages/disjfa/mail-bundle
[license]: https://github.com/disjfa/mail-bundle/blob/master/LICENSE
[license-badge]: https://img.shields.io/github/license/disjfa/mail-bundle.svg
[github-watch-badge]: https://img.shields.io/github/watchers/disjfa/mail-bundle.svg?style=social
[github-watch]: https://github.com/disjfa/mail-bundle/watchers
[github-star-badge]: https://img.shields.io/github/stars/disjfa/mail-bundle.svg?style=social
[github-star]: https://github.com/disjfa/mail-bundle/stargazers
[twitter-badge]: https://img.shields.io/twitter/url/https/github.com/disjfa/mail-bundle.svg?style=social
[twitter]: https://twitter.com/intent/tweet?text=Check%20out%20mail-bundle!%20-%20Cool%mail%20templates%20for%20symfony%20template!%20Thanks%20@disjfa%20https://github.com/disjfa/mail-bundle%20%F0%9F%A4%97