SMTP

Use Pigeon as the SMTP server for Rails, Django, WordPress, or any app that already speaks SMTP. Credentials are unique per account.

Open SMTP in the dashboard. Copy the host, port, and authentication method, then generate a username and password for that app. The password is shown once.

Local development listens on localhost port 2525 with no encryption. Production defaults to port 587. Put a TLS terminator in front, or set SMTP_ENCRYPTION, SMTP_HOST, and SMTP_PORT.

shell
Host: localhost
Port: 2525
Encryption: none
Authentication: PLAIN or LOGIN
Username: smtp_your_username
Password: smtppw_your_password

AUTH PLAIN and AUTH LOGIN are required before MAIL FROM. The From address must use a domain you verified. Recipients, quotas, bounces, and logs are the same as the HTTP API.

A password-reset message can include X-Pigeon-Filter-Transaction-Id and X-Pigeon-Filter-Admin. Those headers match filter.transaction_id and filter.admin on the HTTP API. A burst on that key pauses for 60 minutes, and the account owner is notified.

Elixir
config :my_app, MyApp.Mailer,
  adapter: Swoosh.Adapters.SMTP,
  relay: "localhost",
  port: 2525,
  username: "smtp_your_username",
  password: "smtppw_your_password",
  tls: :never,
  auth: :always