View Source TowerEmail

ci Hex.pm Docs

Simple send-me-an-email reporter for Tower error handler.

Installation

The package can be installed by adding tower_email to your list of dependencies in mix.exs:

# mix.exs

def deps do
  [
    {:tower_email, "~> 0.4.0"}
  ]
end

Usage

First, Tower error handler must be attached.

# lib/<your_app>/application.ex

defmodule YourApp.Application do
  def start(_type, _args) do
    Tower.attach()

    # rest of your code
  end

Then you register the reporter with Tower.

# config/config.exs

config(
  :tower,
  :reporters,
  [
    # along any other possible reporters
    TowerEmail.Reporter
  ]
)

And make any additional configurations specific to this reporter.

# config/runtime.exs

config :tower_email,
  otp_app: :your_app,
  from: {"Tower", "tower@<your_domain>"},
  to: "<recipient email address>",
  environment: System.get_env("DEPLOYMENT_ENV", to_string(config_env()))

# Configuring swoosh adapter in `TowerEmail.Mailer`:

# Example for local development
# config :tower_email, TowerEmail.Mailer, adapter: Swoosh.Adapters.Local

# Example for production
config :tower_email, TowerEmail.Mailer,
  adapter: Swoosh.Adapters.Postmark,
  api_key: System.fetch_env!("POSTMARK_API_KEY")

Configuring TowerEmail.Mailer is analogous on how to configure any Swoosh.Mailer https://hexdocs.pm/swoosh/Swoosh.Mailer.html.

License

Copyright 2024 Mimiquate

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.