How do I send attachments with Mailgun in Elixir?

Use the `attachments` parameter in `send_email` with a list of maps, each containing `filename` and either `path` for files or `content` for raw data. For example, `attachments: [%{path: file_path, filename: 'greetings.png'}]` as shown in the README.

Mailgun Elixir client vs Swoosh: which one should I use?

Mailgun client is specific to Mailgun's API with a simple, declarative interface, ideal for direct Mailgun integration. Swoosh is a more feature-rich library supporting multiple adapters, templating, and async delivery, better for multi-provider or complex email workflows.

How to test emails without sending them in Elixir Mailgun?

Configure test mode by setting `mode: :test` and `test_file_path` in your Mailer module. This writes email data to a JSON file at the specified path, allowing inspection without API calls, as demonstrated in the README.

Can I use Mailgun client with Phoenix applications?

Yes, it integrates easily with Phoenix by adding the dependency to mix.exs and configuring it in config files. The README shows examples in `config/config.exs` and `lib/mailer.ex` for setting up domain and key.

What HTTP client does the Mailgun library use?

It uses Erlang's `httpc` client, and you can customize it via `httpc_opts` in configuration. For instance, you can set timeouts like `connect_timeout: 2000` to control request behavior.

Is the Mailgun Elixir library stable for production?

Given its version 0.1.2, it might be less stable or subject to changes. Check the GitHub repository for recent updates and issue tracking before deploying in critical production environments.

mailgun — Elixir Mailgun API Client

What is mailgun?

Mailgun is an Elixir client library that provides a clean interface for sending emails through the Mailgun email service API. It allows developers to integrate email functionality into their Elixir applications with minimal boilerplate code, handling API communication, attachments, and testing configurations automatically.

Target Audience

Elixir developers building applications that need reliable email delivery functionality, particularly those already using or considering the Mailgun email service.

Value Proposition

Developers choose this library for its declarative, Elixir-idiomatic API that reduces integration complexity while providing essential features like attachment handling and a built-in test mode that prevents accidental email sends during development.

Elixir Mailgun Client

Use Cases

Best For

Adding Mailgun email delivery to Elixir Phoenix applications
Sending transactional emails with attachments in Elixir
Testing email functionality without hitting the Mailgun API
Configuring custom HTTP timeouts for Mailgun API requests
Building reusable email modules in Elixir projects
Sending both HTML and plain text emails from Elixir code

Not Ideal For

Projects needing email delivery through multiple providers or services
Applications requiring advanced email templating or dynamic content generation
Teams preferring a pluggable email client architecture with adapter support
Environments where httpc's limitations in connection pooling or SSL are critical

Pros & Cons

Pros

Declarative Email API

The library offers a clean, function-based interface for sending emails, as shown in the README with examples like `send_email to: user.email, from: @from, subject: 'hello!'`, reducing boilerplate code.

Built-in Test Mode

It includes a test mode that redirects emails to a local JSON file, preventing accidental API calls during testing, configured via `mode: :test` and `test_file_path`.

Attachment Flexibility

Supports attachments via both file paths and raw content strings, demonstrated with `%{path: file_path}` for files and `%{content: pdf}` for in-memory data.

Custom HTTP Control

Allows fine-grained HTTP configuration through `httpc_opts`, enabling settings like timeouts, as seen in the example with `connect_timeout: 2000`.

Cons

Limited HTTP Client

Relies on Erlang's httpc, which may lack features like automatic retries or advanced pooling compared to modern Elixir HTTP clients, and is explicitly mentioned as the underlying mechanism.

Basic Test Integration

Test mode only outputs to a JSON file, which doesn't integrate with Elixir's testing frameworks for in-memory assertions or real-time inspection, limiting testing flexibility.

Early Development Stage

With version 0.1.2, the library is in early stages, potentially leading to breaking changes or missing features, as indicated by the low version number and minimal documentation.

Frequently Asked Questions

What is mailgun?

Target Audience

Elixir developers building applications that need reliable email delivery functionality, particularly those already using or considering the Mailgun email service.

Value Proposition

Use Cases

Best For

Adding Mailgun email delivery to Elixir Phoenix applications
Sending transactional emails with attachments in Elixir
Testing email functionality without hitting the Mailgun API
Configuring custom HTTP timeouts for Mailgun API requests
Building reusable email modules in Elixir projects
Sending both HTML and plain text emails from Elixir code

Not Ideal For

Projects needing email delivery through multiple providers or services
Applications requiring advanced email templating or dynamic content generation
Teams preferring a pluggable email client architecture with adapter support
Environments where httpc's limitations in connection pooling or SSL are critical

Pros & Cons

Pros

Declarative Email API

Built-in Test Mode

It includes a test mode that redirects emails to a local JSON file, preventing accidental API calls during testing, configured via `mode: :test` and `test_file_path`.

Attachment Flexibility

Supports attachments via both file paths and raw content strings, demonstrated with `%{path: file_path}` for files and `%{content: pdf}` for in-memory data.

Custom HTTP Control

Allows fine-grained HTTP configuration through `httpc_opts`, enabling settings like timeouts, as seen in the example with `connect_timeout: 2000`.

Cons

Limited HTTP Client

Relies on Erlang's httpc, which may lack features like automatic retries or advanced pooling compared to modern Elixir HTTP clients, and is explicitly mentioned as the underlying mechanism.

Basic Test Integration

Test mode only outputs to a JSON file, which doesn't integrate with Elixir's testing frameworks for in-memory assertions or real-time inspection, limiting testing flexibility.

Early Development Stage

With version 0.1.2, the library is in early stages, potentially leading to breaking changes or missing features, as indicated by the low version number and minimal documentation.

Frequently Asked Questions

mailgun

What is mailgun?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?

mailgun

What is mailgun?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?