https://github.com/mimiquate/tower_email

Elixir error tracking and reporting to your e-mail inbox
https://github.com/mimiquate/tower_email

elixir email-notification error-monitoring error-reporting error-tracking tower

Last synced: 3 months ago
JSON representation

Elixir error tracking and reporting to your e-mail inbox

• Host: GitHub
• URL: https://github.com/mimiquate/tower_email
• Owner: mimiquate
• License: apache-2.0
• Created: 2024-07-12T19:36:25.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-09-30T08:43:46.000Z (3 months ago)
• Last Synced: 2024-09-30T09:01:49.135Z (3 months ago)
• Topics: elixir, email-notification, error-monitoring, error-reporting, error-tracking, tower
• Language: Elixir
• Homepage: https://hex.pm/packages/tower_email
• Size: 62.5 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# TowerEmail

[![ci](https://github.com/mimiquate/tower_email/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/mimiquate/tower_email/actions?query=branch%3Amain)

[![Hex.pm](https://img.shields.io/hexpm/v/tower_email.svg)](https://hex.pm/packages/tower_email)

[![Documentation](https://img.shields.io/badge/Documentation-purple.svg)](https://hexdocs.pm/tower_email)

Error tracking and reporting to your e-mail inbox.

Simple send-me-an-email reporter for [Tower](https://github.com/mimiquate/tower) error handler.

## Installation

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

```elixir

# mix.exs

def deps do

  [

    {:tower_email, "~> 0.5.1"}

  ]

end

```

## Usage

Register the reporter with Tower.

```elixir

# config/config.exs

config(

  :tower,

  :reporters,

  [

    # along any other possible reporters

    TowerEmail

  ]

)

```

And make any additional configurations specific to this reporter.

```elixir

# Build-time config (config/{config, dev, test, prod}.exs)

config :tower_email,

  otp_app: :your_app,

  from: {"Tower", "tower@"},

  to: ""

# config/runtime.exs

config :tower_email,

  environment: System.get_env("DEPLOYMENT_ENV", to_string(config_env()))

```

Configuring `Swoosh` adapter for `TowerEmail.Mailer`:

```elixir

# config/dev.exs

config :tower_email, TowerEmail.Mailer, adapter: Swoosh.Adapters.Local

# config/prod.exs

config :tower_email, TowerEmail.Mailer, adapter: Swoosh.Adapters.Postmark,

# config/runtime.exs

config :tower_email, TowerEmail.Mailer, 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.