An Adapter for the Bamboo email app.
The package can be installed as:
- Add
bamboo_smtp
to your list of dependencies inmix.exs
:
def deps do
[{:bamboo_smtp, "~> 1.3.0"}]
end
- Add
bamboo
andbamboo_smtp
to your list of applications inmix.exs
:
def application do
[applications: [:bamboo, :bamboo_smtp]]
end
- Setup your SMTP configuration:
# In your config/config.exs file
config :my_app, MyApp.Mailer,
adapter: Bamboo.SMTPAdapter,
server: "smtp.domain",
port: 1025,
username: "[email protected]", # or {:system, "SMTP_USERNAME"}
password: "pa55word", # or {:system, "SMTP_PASSWORD"}
tls: :if_available, # can be `:always` or `:never`
allowed_tls_versions: [:"tlsv1", :"tlsv1.1", :"tlsv1.2"], # or {":system", ALLOWED_TLS_VERSIONS"} w/ comma seprated values (e.g. "tlsv1.1,tlsv1.2")
ssl: false, # can be `true`
retries: 1
Sensitive credentials should not be committed to source control and are best kept in environment variables.
Using {:system, "ENV_NAME"}
configuration is read from the named environment variable at runtime.
- Follow Bamboo Getting Started Guide
You can find more information about advanced features in the Wiki.
Before opening a pull request you can open an issue if you have any question or need some guidance.
Here's how to setup the project:
$ git clone https://github.com/fewlinesco/bamboo_smtp.git
$ cd bamboo_smtp
$ mix deps.get
$ mix test
Once you've made your additions and mix test
passes, go ahead and open a Pull Request.
Bamboo SMTPAdapter is released under The MIT License (MIT).