# Swoosh v1.25.0 - API Reference

## Modules

- [Swoosh](Swoosh.md): [![hex.pm](https://img.shields.io/hexpm/v/swoosh.svg)](https://hex.pm/packages/swoosh)
[![hex.pm](https://img.shields.io/hexpm/dt/swoosh.svg)](https://hex.pm/packages/swoosh)
[![hex.pm](https://img.shields.io/hexpm/l/swoosh.svg)](https://hex.pm/packages/swoosh)
[![github.com](https://img.shields.io/github/last-commit/swoosh/swoosh.svg)](https://github.com/swoosh/swoosh)
- [Swoosh.Adapter](Swoosh.Adapter.md): Specification of the email delivery adapter.

- [Swoosh.Adapters.Local.Storage.Manager](Swoosh.Adapters.Local.Storage.Manager.md): Manages the creation/monitoring of the global in-memory storage driver,
`Swoosh.Adapters.Local.Storage.Memory`

- [Swoosh.Adapters.Local.Storage.Memory](Swoosh.Adapters.Local.Storage.Memory.md): In-memory storage driver used by the
[Swoosh.Adapters.Local](Swoosh.Adapters.Local.html) module.
- [Swoosh.Application](Swoosh.Application.md)
- [Swoosh.Attachment](Swoosh.Attachment.md): Struct representing an attachment in an email.
- [Swoosh.Mailer](Swoosh.Mailer.md): Defines a mailer.

- Email
  - [Swoosh.Email](Swoosh.Email.md): Defines an Email.
  - [Swoosh.Email.Recipient](Swoosh.Email.Recipient.md): Recipient Protocol controls how data is formatted into an email recipient

- Adapters
  - [Swoosh.Adapters.AmazonSES](Swoosh.Adapters.AmazonSES.md): An adapter that sends email using the Amazon Simple Email Service (SES) Query API.
This adapter does not depend on `ExAws`; if you are already using it, you may
prefer `Swoosh.Adapters.ExAwsAmazonSES`.
  - [Swoosh.Adapters.AzureCommunicationServices](Swoosh.Adapters.AzureCommunicationServices.md): An adapter that sends email using the Azure Communication Services (ACS) Email API.
  - [Swoosh.Adapters.Brevo](Swoosh.Adapters.Brevo.md): An adapter that sends email using the Brevo API (Transactional emails only).
  - [Swoosh.Adapters.CustomerIO](Swoosh.Adapters.CustomerIO.md): An adapter that sends email using the CustomerIO API.
  - [Swoosh.Adapters.Dyn](Swoosh.Adapters.Dyn.md): An adapter that sends email using the Dyn API.
  - [Swoosh.Adapters.ExAwsAmazonSES](Swoosh.Adapters.ExAwsAmazonSES.md): An adapter that wraps `Swoosh.Adapters.AmazonSES` to use credentials from `ExAws`.
  - [Swoosh.Adapters.Gmail](Swoosh.Adapters.Gmail.md): An adapter that sends email using Gmail api
  - [Swoosh.Adapters.Lettermint](Swoosh.Adapters.Lettermint.md): An adapter that sends email using the Lettermint API.
  - [Swoosh.Adapters.Local](Swoosh.Adapters.Local.md): An adapter that stores the email locally, using the specified storage driver.
  - [Swoosh.Adapters.Logger](Swoosh.Adapters.Logger.md): An adapter that only logs email using Logger.
  - [Swoosh.Adapters.Loops](Swoosh.Adapters.Loops.md): An adapter that sends email using the Loops API.
  - [Swoosh.Adapters.MailPace](Swoosh.Adapters.MailPace.md): 
An adapter that sends email using the MailPace API.
  - [Swoosh.Adapters.Mailersend](Swoosh.Adapters.Mailersend.md): An adapter that sends email using the MailerSend API.
  - [Swoosh.Adapters.Mailgun](Swoosh.Adapters.Mailgun.md): An adapter that sends email using the Mailgun API.
  - [Swoosh.Adapters.Mailjet](Swoosh.Adapters.Mailjet.md): An adapter that sends email using the Mailjet API.
  - [Swoosh.Adapters.Mailtrap](Swoosh.Adapters.Mailtrap.md): An adapter that sends email using the Mailtrap API.
  - [Swoosh.Adapters.Mandrill](Swoosh.Adapters.Mandrill.md): An adapter that sends email using the Mandrill API.
  - [Swoosh.Adapters.MsGraph](Swoosh.Adapters.MsGraph.md): An adapter that sends email using the Microsoft Graph API.
  - [Swoosh.Adapters.Mua](Swoosh.Adapters.Mua.md): An adapter for sending emails using the SMTP protocol.
  - [Swoosh.Adapters.PostUp](Swoosh.Adapters.PostUp.md): An adapter that sends email using the PostUp API, specifically triggered mailing. This
corresponds to transactional emails.
  - [Swoosh.Adapters.Postal](Swoosh.Adapters.Postal.md): An adapter that sends email using the Postal API.
[Postal](https://docs.postalserver.io/) is open-source, self-hosted mail delivery platform.
  - [Swoosh.Adapters.Postmark](Swoosh.Adapters.Postmark.md): An adapter that sends email using the Postmark API.
  - [Swoosh.Adapters.ProtonBridge](Swoosh.Adapters.ProtonBridge.md): An adapter that sends email using the local Protonmail Bridge.
  - [Swoosh.Adapters.Resend](Swoosh.Adapters.Resend.md): An adapter that sends email using the Resend API.
  - [Swoosh.Adapters.SMTP](Swoosh.Adapters.SMTP.md): An adapter that sends email using the SMTP protocol.
  - [Swoosh.Adapters.SMTP2GO](Swoosh.Adapters.SMTP2GO.md): An adapter that sends email using the SMTP2GO API.
  - [Swoosh.Adapters.Sandbox](Swoosh.Adapters.Sandbox.md): A sandbox adapter for email delivery in tests, analogous to
[`Ecto.Adapters.SQL.Sandbox`](https://hexdocs.pm/ecto_sql/Ecto.Adapters.SQL.Sandbox.html).
  - [Swoosh.Adapters.Scaleway](Swoosh.Adapters.Scaleway.md): An adapter that sends email using the Scaleway API (Transactional emails only).
  - [Swoosh.Adapters.Sendgrid](Swoosh.Adapters.Sendgrid.md): An adapter that sends email using the Sendgrid API.
  - [Swoosh.Adapters.Sendmail](Swoosh.Adapters.Sendmail.md): An adapter that sends email using the sendmail binary.
  - [Swoosh.Adapters.SocketLabs](Swoosh.Adapters.SocketLabs.md): An adapter that sends email using the SocketLabs Injection API.
  - [Swoosh.Adapters.SparkPost](Swoosh.Adapters.SparkPost.md): An adapter that sends email using the SparkPost API.
  - [Swoosh.Adapters.Test](Swoosh.Adapters.Test.md): An adapter that sends emails as messages to the current process.
  - [Swoosh.Adapters.ZeptoMail](Swoosh.Adapters.ZeptoMail.md): An adapter that sends transactional email using the ZeptoMail API.

- Api Client
  - [Swoosh.ApiClient](Swoosh.ApiClient.md): Specification for a Swoosh API client.
  - [Swoosh.ApiClient.Finch](Swoosh.ApiClient.Finch.md): Finch-based ApiClient for Swoosh.
  - [Swoosh.ApiClient.Hackney](Swoosh.ApiClient.Hackney.md): Built-in hackney-based ApiClient.

  - [Swoosh.ApiClient.Req](Swoosh.ApiClient.Req.md): Req-based ApiClient for Swoosh.

- Plug
  - [Plug.Swoosh.MailboxPreview](Plug.Swoosh.MailboxPreview.md): Plug that serves pages useful for previewing emails in development.

- Test
  - [Swoosh.TestAssertions](Swoosh.TestAssertions.md): This module contains a set of assertions functions that you can import in your
test cases.
  - [Swoosh.X.TestAssertions](Swoosh.X.TestAssertions.md): Experimental New TestAssertions Module that may replace the old new in v2.

- Deprecated
  - [Swoosh.Adapters.OhMySmtp](Swoosh.Adapters.OhMySmtp.md): 
**Deprecated - use MailPace now**
  - [Swoosh.Adapters.Sendinblue](Swoosh.Adapters.Sendinblue.md): **Deprecated - use Brevo now**

- Exceptions
  - [Swoosh.Adapters.Mua.MultihostError](Swoosh.Adapters.Mua.MultihostError.md): Raised when no relay is used and recipients contain addresses across multiple hosts.
  - [Swoosh.AttachmentContentError](Swoosh.AttachmentContentError.md)
  - [Swoosh.DeliveryError](Swoosh.DeliveryError.md)

## Mix Tasks

- [mix swoosh.mailbox.server](Mix.Tasks.Swoosh.Mailbox.Server.md): Starts the mailbox preview server.