PewPew v0.1.0 PewPew.Mailer View Source

This is the module used to manage the messages themselves.

Link to this section Summary

Functions

This function is used to add to the :attach field in the given struct

This function is used to add to the given addresses to the existing (or empty) list of :bcc addresses

This function is used to add to the given addresses to the existing (or empty) list of :cc addresses

This function is used to add to the given addresses to the existing (or empty) list of :to addresses

This is the function used to generate a new mailer. It populates the struct properly, leaving undefined fields at their default values. Note that if you do not specify them here, they will not be sent to the API, for better or for worse

This function is used to send an email, adding any specified attachments, and either text or HTML (or both), depending on what was specified

This function is used to set the :attach field in the given struct, which defines which files should be attached to the email

This function is used to set the :bcc field in the given struct

This function is used to set the :cc field in the given struct

This function is used from set the :from field in the given struct

This function is used to set the :html field in the given struct, which defines the HTML version of the email

This function is used to set the :subject field in the given struct

This function is used to set the :text field in the given struct, which defines the plaintext version of the email

This function is used to set the :to field in the given struct

Link to this section Functions

This function is used to add to the :attach field in the given struct.

This function is used to add to the given addresses to the existing (or empty) list of :bcc addresses.

This function is used to add to the given addresses to the existing (or empty) list of :cc addresses.

This function is used to add to the given addresses to the existing (or empty) list of :to addresses.

This is the function used to generate a new mailer. It populates the struct properly, leaving undefined fields at their default values. Note that if you do not specify them here, they will not be sent to the API, for better or for worse.

If you do not wish to specify them here, you can always modify them later on using normal struct manipulation.

The available fields are:

  • :from which specifies the address the email should be sent from. This can be used to override the configured default (if there is no configured default, then it is required).
  • :to which specifies the addresses the email should be sent to. This can be a list or single address (no more than 1000 addresses long). This is required.
  • :cc which specifies the addresses the email should be CCed to. This can be a list or single address (no more than 1000 addresses long).
  • :bcc which specifies the addresses the email should be BCCed to. This can be a list or single address (no more than 1000 addresses long).
  • :subject which specifies the subject line on the email. This is required.
  • :text which specifies the text/plain version of the email. Either text or html (or both) must be specified.
  • :html which specifies the text/html version of the email. Either text or html (or both) must be specified.
  • :attach which specifies any attachments you want on the email.

This function is used to send an email, adding any specified attachments, and either text or HTML (or both), depending on what was specified.

If :to is a list, we send a batch request, otherwise we send a single request.

For now, if the operation was successful, we return :ok (otherwise an error tuple is returned).

This function is used to set the :attach field in the given struct, which defines which files should be attached to the email.

This function is used to set the :bcc field in the given struct.

This function is used to set the :cc field in the given struct.

This function is used from set the :from field in the given struct.

This function is used to set the :html field in the given struct, which defines the HTML version of the email.

This function is used to set the :subject field in the given struct.

This function is used to set the :text field in the given struct, which defines the plaintext version of the email.

This function is used to set the :to field in the given struct.