swoosh_mailinator/README.md

42 lines
1.0 KiB
Markdown
Raw Permalink Normal View History

2024-06-03 22:56:22 +00:00
# Swoosh Mailinator
This project is an adapter for swoosh that relais any email to the Mailinator.com SMTP server, no mater the internet domain of the recipient.
2024-06-07 06:15:09 +00:00
Mailinator does not support multipart messages (they are processed as attachment which are ignored). So the adapter ensure that there is only htlm or text part and not both.
2024-06-03 22:56:22 +00:00
2024-06-07 06:15:09 +00:00
The service provides no encryption in transit (SSL/TLS) nor authentication.
2024-06-03 22:56:22 +00:00
2024-06-07 06:15:09 +00:00
The service provides public access to mailboxes.
Don't use this adapter for private or confidential information.
2024-06-03 22:56:22 +00:00
Use for tests only.
## Installation
This module can be installed by adding `swoosh_mailinator` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
2024-06-07 06:15:09 +00:00
{:swoosh_mailinator, "~> 0.2.0", git: "https://git.zoocoop.com/setop/swoosh_mailinator"}
2024-06-03 22:56:22 +00:00
]
end
```
## Usage
```elixir
# config/config.exs
config :sample, Sample.Mailer,
adapter: Swoosh.Adapters.Mailinator
# lib/sample/mailer.ex
defmodule Sample.Mailer do
use Swoosh.Mailer, otp_app: :sample
end
```
see also [test/swoosh_mlntr.exs](test/swoosh_mlntr.exs)