Swoosh
▼
Project version
v1.18.4
v1.18.3
v1.18.2
v1.18.1
v1.18.0
v1.17.10
v1.17.9
v1.17.8
v1.17.7
v1.17.6
v1.17.5
v1.17.4
v1.17.3
v1.17.2
v1.17.1
v1.17.0
v1.16.12
v1.16.11
v1.16.10
v1.16.9
v1.16.8
v1.16.7
v1.16.6
v1.16.5
v1.16.4
v1.16.3
v1.16.2
v1.16.1
v1.16.0
v1.15.3
v1.15.2
v1.15.1
v1.15.0
v1.14.4
v1.14.3
v1.14.2
v1.14.1
v1.14.0
v1.13.0
v1.12.0
v1.11.6
v1.11.5
v1.11.4
v1.11.3
v1.11.2
v1.11.1
v1.11.0
v1.10.3
v1.10.2
v1.10.1
v1.10.0
v1.9.1
v1.9.0
v1.8.3
v1.8.2
v1.8.1
v1.8.0
v1.7.5
v1.7.4
v1.7.3
v1.7.2
v1.7.1
v1.7.0
v1.6.6
v1.6.5
v1.6.4
v1.6.3
v1.6.2
v1.6.1
v1.6.0
v1.5.2
v1.5.1
v1.5.0
v1.4.0
v1.3.11
v1.3.10
v1.3.9
v1.3.8
v1.3.7
v1.3.6
v1.3.5
v1.3.4
v1.3.3
v1.3.2
v1.3.1
v1.3.0
v1.2.2
v1.2.1
v1.2.0
v1.1.2
v1.1.1
v1.1.0
v1.0.9
v1.0.8
v1.0.7
v1.0.6
v1.0.5
v1.0.4
v1.0.3
v1.0.2
v1.0.1
v1.0.0
v0.25.6
v0.25.5
v0.25.4
v0.25.3
v0.25.2
v0.25.1
v0.25.0
v0.24.4
v0.24.3
v0.24.2
v0.24.1
v0.24.0
v0.23.5
v0.23.4
v0.23.3
v0.23.2
v0.23.1
v0.23.0
v0.22.2
v0.22.1
v0.22.0
v0.21.1
v0.21.0
v0.20.0
v0.19.0
v0.18.0
v0.17.0
v0.16.1
v0.16.0
v0.15.0
v0.14.0
v0.13.0
v0.12.1
v0.12.0
v0.11.0
v0.10.0
v0.9.1
v0.9.0
v0.8.1
v0.8.0
v0.7.0
v0.6.0
v0.5.0
v0.4.0
v0.3.0
v0.2.0
v0.1.0
Pages
Modules
Mix
Tasks
API Reference
Modules
Mix Tasks
Changelog
1.18.4
1.18.3
1.18.2
1.18.1
1.18.0
1.17.10
1.17.9
1.17.8 (deprecated: broken css priv path, fixed in 1.17.9)
1.17.7 (deprecated: broken css priv path, fixed in 1.17.9)
1.17.6
1.17.5
1.17.4
1.17.3
1.17.2
1.17.1
1.17.0
1.16.12
1.16.11
1.16.10
1.16.9
1.16.8
1.16.7
1.16.6
1.16.5
1.16.4
1.16.3
1.16.2
1.16.1
🐛 Bug Fixes
1.16.0
1.15.3
1.15.2
1.15.1
1.15.0
1.14.4
1.14.3
1.14.2
1.14.1
1.14.0
1.13.0
1.12.0
1.11.6
1.11.5
1.11.4
1.11.3
1.11.2
1.11.1
1.11.0
1.10.3
1.10.2
1.10.1
1.10.0
1.9.1
1.9.0
1.8.3
1.8.2
1.8.1
1.8.0
1.7.5
1.7.4
1.7.3
1.7.2
1.7.1
1.7.0
1.6.6
1.6.5
1.6.4
1.6.3
1.6.2
1.6.1
1.6.0
1.5.2
1.5.1
1.5.0
1.4.0
Contributor Code of Conduct
Contributing to Swoosh
Opening Issues
Submitting Pull Requests
Style guidelines
Swoosh
Sections
Requirements
Getting started
Installation
Adapters
Recipient
Async Emails
Attachments
Testing
Custom JSON Library
Mailbox preview in the browser
Telemetry
Documentation
Contributing
LICENSE
Swoosh.Adapter
Summary
Types
config/0
email/0
t/0
Callbacks
deliver/2
deliver_many/2
validate_config/1
validate_dependency/0
Functions
validate_config/2
validate_dependency/1
Swoosh.Adapters.Local.Storage.Manager
Summary
Functions
child_spec/1
start_link/1
Swoosh.Adapters.Local.Storage.Memory
Summary
Functions
all/0
child_spec/1
delete_all/0
get/1
init/1
pop/0
push/1
start/1
stop/0
Swoosh.Application
Summary
Functions
start/2
Swoosh.Attachment
Sections
Usage
Inline Example
Summary
Types
content_encoding/0
t/0
Functions
get_content/1
get_content/2
new/2
Swoosh.Mailer
Sections
Usage
Dynamic config
Telemetry
Summary
Functions
deliver/2
deliver_many/2
Email
Swoosh.Email
Sections
Email fields
Private
Provider options
Examples
Summary
Types
address/0
html_body/0
mailbox/0
name/0
subject/0
t/0
text_body/0
Functions
assign/3
attachment/2
bcc/2
cc/2
from/2
header/3
html_body/2
new/1
put_bcc/2
put_cc/2
put_private/3
put_provider_option/3
put_to/2
reply_to/2
subject/2
text_body/2
to/2
Swoosh.Email.Recipient
Sections
Deriving
Example
Summary
Types
t/0
Functions
format/1
Adapters
Swoosh.Adapters.AmazonSES
Sections
Configuration options
Examples
Using with tags and configuration set
Provider Options
IAM role
Summary
Functions
deliver/2
validate_config/1
validate_dependency/0
Swoosh.Adapters.Brevo
Sections
Example
Using with provider options
Provider Options
Summary
Functions
deliver/2
validate_config/1
validate_dependency/0
Swoosh.Adapters.CustomerIO
Sections
Example
Using with provider options
Provider Options
Summary
Functions
validate_config/1
validate_dependency/0
Swoosh.Adapters.Dyn
Sections
Example
Sending sample email
Summary
Functions
deliver/2
validate_config/1
validate_dependency/0
Swoosh.Adapters.ExAwsAmazonSES
Sections
Example
Summary
Functions
deliver/2
validate_config/1
validate_dependency/0
Swoosh.Adapters.Gmail
Sections
Example
Required config parameters
Summary
Functions
deliver/2
validate_config/1
validate_dependency/0
Swoosh.Adapters.Local
Sections
Example
Summary
Functions
deliver/2
deliver_many/2
validate_config/1
validate_dependency/0
Swoosh.Adapters.Logger
Sections
Example
Summary
Functions
deliver/2
validate_config/1
validate_dependency/0
Swoosh.Adapters.Loops
Sections
Example
Using with provider options
Provider Options
Summary
Functions
validate_config/1
validate_dependency/0
Swoosh.Adapters.MailPace
Sections
Example
Summary
Functions
deliver/2
validate_config/1
validate_dependency/0
Swoosh.Adapters.Mailgun
Sections
Configuration options
Example
Using with provider options
Provider options
Custom headers
Summary
Functions
deliver/2
validate_config/1
validate_dependency/0
Swoosh.Adapters.Mailjet
Sections
Example
Using with provider options
Provider options
Summary
Functions
deliver/2
deliver_many/2
validate_config/1
validate_dependency/0
Swoosh.Adapters.Mailtrap
Sections
Example
Sandbox mode
Using with provider options
Provider Options
Summary
Functions
deliver/2
validate_config/1
validate_dependency/0
Swoosh.Adapters.Mandrill
Sections
Example
Using with provider options
Provider options
Template-configured 'from' address
Summary
Functions
deliver/2
validate_config/1
validate_dependency/0
Swoosh.Adapters.MsGraph
Sections
Configuration options
Example
Summary
Functions
deliver/2
validate_config/1
validate_dependency/0
Swoosh.Adapters.Mua
Sections
Configuration
Sending Email Directly
Sending Email via a Relay
CA Certificates
Summary
Types
option/0
Functions
deliver/2
validate_config/1
validate_dependency/0
Swoosh.Adapters.PostUp
Sections
Example
Using with provider options
Usage with just template and no other options
Provider Options
Summary
Functions
validate_config/1
validate_dependency/0
Swoosh.Adapters.Postal
Sections
Configuration options
Example
Using with provider options
Summary
Functions
validate_config/1
validate_dependency/0
Swoosh.Adapters.Postmark
Sections
Example
Example of sending emails using templates
Example of sending emails with a tag
Provider Options
Summary
Functions
deliver/2
deliver_many/2
validate_config/1
validate_dependency/0
Swoosh.Adapters.ProtonBridge
Sections
Example
Summary
Functions
deliver/2
validate_config/1
validate_dependency/0
Swoosh.Adapters.SMTP
Sections
Example
Note
Summary
Functions
deliver/2
gen_smtp_config/1
validate_config/1
validate_dependency/0
Swoosh.Adapters.SMTP2GO
Sections
Example
Usage
Summary
Functions
deliver/2
validate_config/1
validate_dependency/0
Swoosh.Adapters.Scaleway
Sections
Example
Using with provider options
Provider Options
Summary
Functions
deliver/2
validate_config/1
validate_dependency/0
Swoosh.Adapters.Sendgrid
Sections
Example
Using with provider options
Provider Options
Sandbox mode
Summary
Functions
deliver/2
validate_config/1
validate_dependency/0
Swoosh.Adapters.Sendmail
Sections
Example
Summary
Functions
deliver/2
validate_config/1
validate_dependency/0
Swoosh.Adapters.SocketLabs
Sections
Example
Using with provider options
Provider Options
Summary
Functions
deliver/2
validate_config/1
validate_dependency/0
Swoosh.Adapters.SparkPost
Sections
Example
Using with SparkPost templates
Setting SparkPost transmission options
Provider Options
Summary
Functions
deliver/2
validate_config/1
validate_dependency/0
Swoosh.Adapters.Test
Sections
Example
Summary
Functions
deliver/2
deliver_many/2
validate_config/1
validate_dependency/0
Swoosh.Adapters.ZeptoMail
Sections
Configuration options
Example
Using with provider options
Batch Sending
Provider options
Summary
Functions
deliver/2
validate_config/1
validate_dependency/0
Api Client
Swoosh.ApiClient
Summary
Types
body/0
headers/0
status/0
url/0
Callbacks
init/0
post/4
Functions
post/4
Swoosh.ApiClient.Finch
Swoosh.ApiClient.Hackney
Swoosh.ApiClient.Req
Plug
Plug.Swoosh.MailboxPreview
Sections
Examples
Summary
Functions
call/2
init/1
Test
Swoosh.TestAssertions
Summary
Types
email_assertion/0
Functions
assert_email_not_sent/1
assert_email_sent/0
assert_email_sent/1
assert_emails_sent/0
assert_emails_sent/1
assert_no_email_sent/0
refute_email_sent/0
refute_email_sent/1
set_swoosh_global/1
Swoosh.X.TestAssertions
Summary
Types
email_assertion/0
Functions
assert_email_not_sent/1
assert_email_sent/0
assert_email_sent/1
assert_emails_sent/0
assert_emails_sent/1
assert_no_email_sent/0
flush_emails/0
refute_email_sent/0
refute_email_sent/1
set_swoosh_global/1
Deprecated
Swoosh.Adapters.OhMySmtp
Sections
Example
Summary
Functions
deliver/2
validate_config/1
validate_dependency/0
Swoosh.Adapters.Sendinblue
Sections
Example
Using with provider options
Provider Options
Summary
Functions
deliver/2
validate_config/1
validate_dependency/0
Exceptions
Swoosh.Adapters.Mua.MultihostError
Summary
Types
t/0
Functions
message/1
Swoosh.AttachmentContentError
Swoosh.DeliveryError
Summary
Functions
message/1
mix swoosh.mailbox.server
Sections
Command line options
Summary
Functions
run/1
Search documentation of Swoosh
Settings
Swoosh.AttachmentContentError
exception
(Swoosh v1.18.4)
View Source