Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/swoosh/phoenix_swoosh
Swoosh <3 Phoenix
https://github.com/swoosh/phoenix_swoosh
elixir email phoenix swoosh
Last synced: 3 months ago
JSON representation
Swoosh <3 Phoenix
- Host: GitHub
- URL: https://github.com/swoosh/phoenix_swoosh
- Owner: swoosh
- License: mit
- Created: 2016-03-19T23:50:01.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2024-04-12T10:07:53.000Z (7 months ago)
- Last Synced: 2024-04-15T00:49:35.548Z (7 months ago)
- Topics: elixir, email, phoenix, swoosh
- Language: Elixir
- Homepage: https://hexdocs.pm/phoenix_swoosh
- Size: 368 KB
- Stars: 266
- Watchers: 4
- Forks: 31
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Phoenix.Swoosh
[](https://github.com/swoosh/phoenix_swoosh/actions/workflows/elixir.yml)
[](https://hex.pm/packages/phoenix_swoosh)
[](https://hexdocs.pm/phoenix_swoosh/)
[](https://hex.pm/packages/phoenix_swoosh)
[](https://github.com/swoosh/phoenix_swoosh/blob/master/LICENSE)
[](https://github.com/swoosh/phoenix_swoosh/commits/master)
`Phoenix.View` + `Swoosh`. ([Discuss about the future post-Phoenix-1.7 here](https://github.com/swoosh/phoenix_swoosh/issues/287))
This module provides the ability to set the HTML and/or text body of an email by rendering templates.
## Installation
Add `:phoenix_swoosh` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:phoenix_swoosh, "~> 1.0"},
# without phoenix_html, phoenix_swoosh only works with plain text templates
# if you want to use HTML templates
# {:phoenix_html, "~> 3.0"},
]
end
```
You probably also want to install [`finch`](https://hex.pm/packages/finch),
[`hackney`](https://hex.pm/packages/hackney) or an HTTP client of your own choice,
if you are using a provider that `Swoosh` talks to via their HTTP API.
Or [`:gen_smtp`](https://hex.pm/packages/gen_smtp) if you are working with a provider
that only works through SMTP.
See `Swoosh` for more details.
## Usage
### 1. Classic setup
Setting up the templates:
```eex
# path_to/templates/user_notifier/welcome.html.eex
Welcome to Sample, <%= @name %>!
```
```elixir
# path_to/views/user_notifier_view.ex
defmodule Sample.UserNotifierView do
use Phoenix.View, root: "path_to/templates"
end
```
Passing values to templates:
```elixir
# path_to/notifiers/user_notifier.ex
defmodule Sample.UserNotifier do
use Phoenix.Swoosh, view: Sample.UserNotifierView
def welcome(user) do
new()
|> from("[email protected]")
|> to(user.email)
|> subject("Hello, Avengers!")
|> render_body("welcome.html", %{name: name})
end
end
```
Maybe with a layout:
```eex
# path_to/templates/layout/email.html.eex
<%= @email.subject %>
<%= @inner_content %>
```
```elixir
defmodule Sample.LayoutView do
use Phoenix.View, root: "path_to/templates"
end
```
```elixir
# path_to/notifiers/user_notifier.ex
defmodule Sample.UserNotifier do
use Phoenix.Swoosh,
view: Sample.NotifierView,
layout: {Sample.LayoutView, :email}
# ... same welcome ...
end
```
Layout can also be added/changed dynamically with `put_new_layout/2` and `put_layout/2`
### 2. Standalone setup
```eex
# path_to/templates/user_notifier/welcome.html.eex
Welcome to Sample, <%= @name %>!
```
```elixir
# path_to/notifiers/user_notifier.ex
defmodule Sample.UserNotifier do
use Phoenix.Swoosh,
template_root: "path_to/templates",
template_path: "user_notifier"
# ... same welcome ...
end
```
In this setup, the notifier module itself serves as the view module
`template_root`, `template_path` and `template_namespace`
will be passed to `Phoenix.View` as `root`, `path` and `namespace`.
Layout can be setup the same way as classic setup.
## Customization
When using either the classic or standalone setup described above, the
extensions of the templates used can be customized. For example, let's say
MJML is the desired markup language to use for HTML emails, and there's a
template such as:
```eex
# path_to/templates/user_notifier/welcome.mjml.eex
Welcome to Sample, <%= @name %>!
```
Phoenix.Swoosh can be configured to use the "mjml" extension when rendering the
HTML body of the email:
```elixir
# path_to/notifiers/user_notifier.ex
defmodule Sample.UserNotifier do
use Phoenix.Swoosh,
formats: %{"mjml" => :html_body, "text" => :text_body}
# ... same welcome as above ...
end
```
This requires that Phoenix knows how to handle templates using the "mjml"
format. This can be done by creating a module that exports
`encode_to_iodata!/1`:
```elixir
defmodule Sample.Mjml do
def encode_to_iodata!(mjml) do
with {:ok, html} <- Mjml.to_html(mjml) do
html
end
end
end
```
And then configuring Phoenix to use it:
```elixir
config :phoenix, format_encoders: [mjml: Sample.Mjml]
```
The above example is using [`mjml`](https://hex.pm/packages/mjml), which would
need to be installed as well.
## Copyright and License
Copyright (c) 2021 Swoosh contributors
Released under the MIT License, which can be found in [LICENSE.md](./LICENSE.md).