Bamboo Elastic Email Adapter v1.2.0 Bamboo.ElasticEmail View Source

Helper functions for manipulating Bamboo.Email to enable Elastic Email functionality.

Link to this section Summary

Functions

Add attachment identifiers to the email.

Sets the channel for the email.

Sets the character set for the email or one of the MIME parts. Overrides the global default of "utf-8".

Sets the data source of the email.

Sets the email encoding type. The default encoding is :base64, which is the recommended value. Either :base64 or :quoted_printable is recommended if you are validating your domain(s) with DKIM.

The name or names of a contact list you would like to send to.

Sets merge parameters. The params must be a list of maps or keyword lists (or other 2-tuple lists).

The file name of a previously uploaded attachment which is a CSV list of Recipients.

Name of the custom IP Pool to be used in the sending process.

Optional header returned in notifications.

The name or names of the Contact segment(s) you wish to send. Use :all for all active contacts.

The ID of an email template you have created in your account.

The number of minutes in the future this email should be sent up to a maximum of 1 year (524,160 minutes).

Indicates whether clicks should be tracked on this email.

Indicates whether opens should be tracked on this email.

Set UTM Marketing Parameters for campaign links.

Link to this section Functions

Link to this function

attachments(email, attachments)

View Source
attachments(Bamboo.Email.t(), [binary(), ...] | binary()) :: Bamboo.Email.t()

Add attachment identifiers to the email.

Names or IDs of attachments previously uploaded to your account (via the File/Upload request) that should be sent with this e-mail.

Sets the channel for the email.

An ID field (max 191 chars) that can be used for reporting [will default to HTTP API or SMTP API]

Link to this function

charset(email, part \\ nil, charset)

View Source
charset(Bamboo.Email.t(), part :: nil | :amp | :html | :text, binary()) ::
  Bamboo.Email.t()

Sets the character set for the email or one of the MIME parts. Overrides the global default of "utf-8".

Text value of charset encoding for example: iso-8859-1, windows-1251, utf-8, us-ascii, windows-1250 and more…

The part parameter is interpreted as:

  • :amp: sets the charsetBodyAmp option (the AMP body MIME part)
  • :html: sets the charsetBodyHtml option (the HTML body MIME part)
  • :text: sets the charsetBodyText option (the text body MIME part)

Any other value sets the global charset option.

Link to this function

data_source(email, name)

View Source
data_source(Bamboo.Email.t(), binary()) :: Bamboo.Email.t()

Sets the data source of the email.

Name or ID of the previously uploaded file (via the File/Upload request) which should be a CSV list of Recipients.

Link to this function

encoding_type(email, encoding)

View Source
encoding_type(Bamboo.Email.t(), atom()) :: Bamboo.Email.t()

Sets the email encoding type. The default encoding is :base64, which is the recommended value. Either :base64 or :quoted_printable is recommended if you are validating your domain(s) with DKIM.

Supported encoding types are:

  • :none: no encoding
  • :raw_7bit: Raw 7bit. Must be plain ASCII.
  • :raw_8bit: Raw 8bit.
  • :quoted_printable: Quoted printable format.
  • :base64: Base64
  • :uue: UU
Link to this function

lists(email, lists)

View Source
lists(Bamboo.Email.t(), [binary(), ...] | binary()) :: Bamboo.Email.t()

The name or names of a contact list you would like to send to.

Link to this function

merge(email, params)

View Source
merge(Bamboo.Email.t(), map() | keyword() | [map() | keyword(), ...]) ::
  Bamboo.Email.t()

Sets merge parameters. The params must be a list of maps or keyword lists (or other 2-tuple lists).

Repeated list of string keys and string values Request parameters prefixed by merge like merge_firstname, merge_lastname. If sending to a template you can send merge fields to merge data with the template. Template fields are entered with {firstname}, {lastname} etc.

Link to this function

merge_source_filename(email, filename)

View Source
merge_source_filename(Bamboo.Email.t(), binary()) :: Bamboo.Email.t()

The file name of a previously uploaded attachment which is a CSV list of Recipients.

Name of the custom IP Pool to be used in the sending process.

Link to this function

post_back(email, post_back)

View Source
post_back(Bamboo.Email.t(), binary()) :: Bamboo.Email.t()

Optional header returned in notifications.

Link to this function

segments(email, segments)

View Source
segments(Bamboo.Email.t(), :all | binary() | [binary() | :all, ...]) ::
  Bamboo.Email.t()

The name or names of the Contact segment(s) you wish to send. Use :all for all active contacts.

Link to this function

template(email, template)

View Source
template(Bamboo.Email.t(), binary()) :: Bamboo.Email.t()

The ID of an email template you have created in your account.

Link to this function

time_off_set_minutes(email, minutes)

View Source
time_off_set_minutes(Bamboo.Email.t(), 1..524_160) :: Bamboo.Email.t()

The number of minutes in the future this email should be sent up to a maximum of 1 year (524,160 minutes).

Link to this function

track_clicks(email, track_clicks)

View Source
track_clicks(Bamboo.Email.t(), boolean()) :: Bamboo.Email.t()

Indicates whether clicks should be tracked on this email.

Link to this function

track_opens(email, track_opens)

View Source
track_opens(Bamboo.Email.t(), boolean()) :: Bamboo.Email.t()

Indicates whether opens should be tracked on this email.

Link to this function

utm_parameters(email, params)

View Source
utm_parameters(
  Bamboo.Email.t(),
  %{optional(:campaign | :content | :medium | :source) => binary()} | keyword()
) :: Bamboo.Email.t()

Set UTM Marketing Parameters for campaign links.