bamboo
▼
Project version
v2.4.0
v2.3.1
v2.3.0
v2.2.0
v2.1.0
v2.0.2
v2.0.1
v2.0.0
v1.7.1
v1.7.0
v1.6.0
v1.5.0
v1.4.0
v1.3.0
v1.2.0
v1.1.0
v1.0.0
v1.0.0-rc.3
v1.0.0-rc.2
v1.0.0-rc.1
v0.8.0
v0.7.0
v0.6.0
v0.5.0
v0.4.2
v0.4.1
v0.4.0
v0.3.2
v0.3.1
v0.3.0
v0.2.0
Pages
Modules
API Reference
Modules
README
Installation
Getting Started
Using Adapters
Delivering Emails in the Background
Composing with Pipes
Handling Recipients
Interceptors
Using Phoenix Views and Layouts
Viewing Sent Emails
Mandrill Specific Functionality (tags, merge vars, templates, etc.)
SendGrid Specific Functionality (templates, substitution tags, scheduled delivery, etc.)
JSON support
Testing
Available Adapters
Contributing
Upgrading to Bamboo 2.0
Breaking change: Bamboo.Phoenix extracted to bamboo_phoenix
Breaking change: deliver_now/2/deliver_later/2 return :ok & :error tuples
Bamboo.Adapter
Sections
Example
Summary
Types
error/0
Callbacks
deliver/2
handle_config/1
supports_attachments?/0
Bamboo.AdapterHelper
Summary
Functions
hackney_opts/1
Bamboo.Attachment
Summary
Types
t/0
Functions
new/2
Bamboo.DeliverLaterStrategy
Sections
Bamboo ships with two strategies:
Example of setting custom strategies
Example of creating a custom strategy for delivering later using Task.async
Summary
Callbacks
deliver_later/3
Bamboo.Email
Sections
Handling email addresses
Simplest way to create a new email
Extracting common parts (default layout, default from address, etc.)
Summary
Types
address/0
address_list/0
t/0
Functions
all_recipients/1
bcc/2
block/1
cc/2
from/2
get_address/1
html_body/2
new_email/1
put_attachment/2
put_attachment/3
put_header/3
put_private/3
subject/2
text_body/2
to/2
Bamboo.Formatter
Sections
Simple example
Customize formatting based on from, to, cc or bcc
Summary
Types
opts/0
t/0
Functions
format_email_address/2
Bamboo.ImmediateDeliveryStrategy
Bamboo.Interceptor
Sections
Example
Summary
Callbacks
call/1
Bamboo.LocalAdapter
Sections
Example config
Summary
Functions
deliver/2
handle_config/1
supports_attachments?/0
Bamboo.Mailer
Sections
Example
Summary
Functions
build_config/3
deliver_later/2
deliver_later!/2
deliver_now/2
deliver_now!/2
normalize_addresses/1
Bamboo.MailgunAdapter
Sections
Example config
API base URI configuration
Summary
Functions
deliver/2
filter_non_empty_mailgun_fields/1
Bamboo.MailgunHelper
Summary
Functions
deliverytime/2
recipient_variables/2
substitute_variables/2
substitute_variables/3
tag/2
template/2
template_text/2
template_version/2
Bamboo.MandrillAdapter
Sections
Example config
Summary
Functions
deliver/2
Bamboo.MandrillHelper
Summary
Functions
put_merge_vars/3
put_param/3
tag/2
template/3
Bamboo.SendGridAdapter
Sections
Example config
Summary
Functions
deliver/2
Bamboo.SendGridHelper
Sections
Example
Summary
Functions
add_dynamic_field/3
add_personalizations/2
substitute/3
with_asm_group_id/2
with_bypass_list_management/2
with_bypass_unsubscribe_management/2
with_categories/2
with_click_tracking/2
with_custom_args/2
with_google_analytics/3
with_ip_pool_name/2
with_send_at/2
with_subscription_tracking/2
with_template/2
Bamboo.SentEmail
Summary
Functions
all/0
child_spec/1
get/1
get!/1
get_id/1
one/0
push/1
reset/0
start_link/1
Bamboo.SentEmailApiPlug
Sections
Using with Plug or Phoenix
API endpoints
Email response JSON
Summary
Functions
call/2
init/1
Bamboo.SentEmailViewerPlug
Sections
Using with Plug or Phoenix
Summary
Functions
call/2
init/1
Bamboo.TaskSupervisorStrategy
Sections
Why use it?
Summary
Functions
supervisor_name/0
Bamboo.Template
Sections
Examples
HTML Layout Example
Summary
Functions
assign/2
assign/3
put_html_layout/2
put_layout/2
put_text_layout/2
put_view/2
render/3
Bamboo.Test
Sections
Note on sending from other processes
In your config
Unit test
Integration test
Summary
Functions
__using__/1
assert_delivered_email/2
assert_delivered_email_matches/2
assert_email_delivered_with/2
assert_no_emails_delivered/1
refute_delivered_email/2
refute_email_delivered_with/2
Bamboo.TestAdapter
Sections
Example config
Summary
Functions
handle_config/1
Bamboo.View
Sections
Example
Exceptions
Bamboo.ApiError
Summary
Functions
build_api_error/1
build_api_error/4
raise_api_error/1
raise_api_error/4
Bamboo.EmptyFromAddressError
Bamboo.NilRecipientsError
Bamboo.SentEmail.DeliveriesError
Bamboo.SentEmail.NoDeliveriesError
Bamboo.View.UndefinedTemplateError
Summary
Functions
message/1
Search documentation of bamboo
Settings
Bamboo.EmptyFromAddressError
exception
(bamboo v2.4.0)
View Source