View Source BambooSes.Message.Destination (bamboo_ses v0.4.2)

Contains functions for composing destination information

Link to this section Summary

Functions

Adds single recipient or list of recipients to the "Bcc" field of the destination struct

Adds single recipient or list of recipients to the "Cc" field of the destination struct

Adds single recipient or list of recipients to the "To" field of the destination struct

Link to this section Types

@type recipients() :: [Bamboo.Email.address()]
@type t() :: %BambooSes.Message.Destination{
  BccAddresses: recipients(),
  CcAddresses: recipients(),
  ToAddresses: recipients()
}

Link to this section Functions

Link to this function

put_bcc(destination, recipients)

View Source

Adds single recipient or list of recipients to the "Bcc" field of the destination struct

example

Example

put_bcc(destination, [{"John Doe", "john.doe@example.com"}, {"Jane Doe", "jane.doe@example.com"}]
put_bcc(destination, {"John Doe", "john.doe@example.com"})
Link to this function

put_cc(destination, recipients)

View Source
@spec put_cc(t(), [Bamboo.Email.address()]) :: t()
@spec put_cc(t(), Bamboo.Email.address()) :: t()

Adds single recipient or list of recipients to the "Cc" field of the destination struct

example

Example

put_cc(destination, [{"John Doe", "john.doe@example.com"}, {"Jane Doe", "jane.doe@example.com"}]
put_cc(destination, {"John Doe", "john.doe@example.com"})
Link to this function

put_to(destination, recipients)

View Source
@spec put_to(t(), [Bamboo.Email.address()]) :: t()
@spec put_to(t(), Bamboo.Email.address()) :: t()

Adds single recipient or list of recipients to the "To" field of the destination struct

example

Example

put_to(destination, [{"John Doe", "john.doe@example.com"}, {"Jane Doe", "jane.doe@example.com"}]
put_to(destination, {"John Doe", "john.doe@example.com"})