ExAws

v1.1.4

ExAws v1.1.4 ExAws.SES View Source

Operations on AWS SES

http://docs.aws.amazon.com/ses/latest/APIReference/Welcome.html

Link to this section Summary

Types

destination()
email_address()
list_configuration_sets_opt()
list_identities_opt()
message()
notification_type()
send_email_opt()
send_raw_email_opt()
set_identity_notification_topic_opt()

Functions

build_message(html, txt, subject, charset \\ "UTF-8")

Build message object

delete_identity(identity)

Deletes the specified identity (an email address or a domain) from the list of verified identities

get_identity_verification_attributes(identities)

Fetch identities verification status and token (for domains)

list_configuration_sets(opts \\ [])

Fetch configuration sets associated with AWS account

list_identities(opts \\ [])

List identities associated with the AWS account

send_email(dst, msg, src, opts \\ [])

Composes an email message

send_raw_email(raw_msg, opts \\ [])

Send a raw Email

set_identity_feedback_forwarding_enabled(enabled, identity)

Enables or disables whether Amazon SES forwards notifications as email

set_identity_headers_in_notifications_enabled(identity, type, enabled)

Set whether SNS notifications should include original email headers or not

set_identity_notification_topic(identity, type, opts \\ [])

Sets the Amazon Simple Notification Service (Amazon SNS) topic to which Amazon SES will publish delivery notifications for emails sent with given identity. Absent sns_topic options cleans SnsTopic and disables publishing

verify_email_identity(email)

Verifies an email address

Link to this section Types

Link to this type destination() View Source 
destination() :: %{to: [email_address], bcc: [email_address], bcc: [email_address]}
Link to this type email_address() View Source 
email_address() :: binary
Link to this type list_configuration_sets_opt() View Source 
list_configuration_sets_opt ::
  {:max_items, pos_integer} |
  {:next_token, String.t}
Link to this type list_identities_opt() View Source 
list_identities_opt ::
  {:max_items, pos_integer} |
  {:next_token, String.t} |
  {:identity_type, String.t}
Link to this type message() View Source 
message() :: %{body: %{html: %{data: binary, charset: binary}, text: %{data: binary, charset: binary}}, subject: %{data: binary, charset: binary}}
Link to this type notification_type() View Source 
notification_type() :: :bounce | :complaint | :delivery
Link to this type send_email_opt() View Source 
send_email_opt ::
  {:configuration_set_name, String.t} |
  {:reply_to, [email_address]} |
  {:return_path, String.t} |
  {:return_path_arn, String.t} |
  {:source, String.t} |
  {:source_arn, String.t} |
  {:tags, %{optional(String.t | atom) => String.t}}
Link to this type send_raw_email_opt() View Source 
send_raw_email_opt ::
  {:configuration_set_name, String.t} |
  {:from_arn, String.t} |
  {:return_path_arn, String.t} |
  {:source, String.t} |
  {:source_arn, String.t} |
  {:tags, %{optional(String.t | atom) => String.t}}
Link to this type set_identity_notification_topic_opt() View Source 
set_identity_notification_topic_opt() :: {:sns_topic, binary}

Link to this section Functions

Link to this function build_message(html, txt, subject, charset \\ "UTF-8") View Source 
build_message(binary, binary, binary, binary) :: message

Build message object

Link to this function delete_identity(identity) View Source 
delete_identity(binary) :: ExAws.Operation.Query.t

Deletes the specified identity (an email address or a domain) from the list of verified identities.

Link to this function get_identity_verification_attributes(identities) View Source 
get_identity_verification_attributes([binary]) :: ExAws.Operation.Query.t

Fetch identities verification status and token (for domains)

Link to this function list_configuration_sets(opts \\ []) View Source 
list_configuration_sets(opts :: [] | [list_configuration_sets_opt]) :: ExAws.Operation.Query.t

Fetch configuration sets associated with AWS account

Link to this function list_identities(opts \\ []) View Source 
list_identities(opts :: [] | [list_identities_opt]) :: ExAws.Operation.Query.t

List identities associated with the AWS account

Link to this function send_email(dst, msg, src, opts \\ []) View Source 
send_email(dst :: destination, msg :: message, src :: binary, opts :: [send_email_opt]) :: ExAws.Operation.Query.t

Composes an email message

Link to this function send_raw_email(raw_msg, opts \\ []) View Source 
send_raw_email(binary, opts :: [send_raw_email_opt]) :: message

Send a raw Email.

Link to this function set_identity_feedback_forwarding_enabled(enabled, identity) View Source 
set_identity_feedback_forwarding_enabled(boolean, binary) :: ExAws.Operation.Query.t

Enables or disables whether Amazon SES forwards notifications as email

Link to this function set_identity_headers_in_notifications_enabled(identity, type, enabled) View Source 
set_identity_headers_in_notifications_enabled(binary, notification_type, boolean) :: ExAws.Operation.Query.t

Set whether SNS notifications should include original email headers or not

Link to this function set_identity_notification_topic(identity, type, opts \\ []) View Source 
set_identity_notification_topic(binary, notification_type, set_identity_notification_topic_opt) :: ExAws.Operation.Query.t

Sets the Amazon Simple Notification Service (Amazon SNS) topic to which Amazon SES will publish delivery notifications for emails sent with given identity. Absent sns_topic options cleans SnsTopic and disables publishing.

Notification type can be on of the :bounce, :complaint or :delivery. Requests are throttled to one per second.

Link to this function verify_email_identity(email) View Source 
verify_email_identity(email :: binary) :: ExAws.Operation.Query.t

Verifies an email address