ExAws v1.1.3 ExAws.SES

Operations on AWS SES

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

Summary

Functions

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

Fetch identities verification status and token (for domains)

Fetch configuration sets associated with AWS account

List identities associated with the AWS account

Composes an email message

Enables or disables whether Amazon SES forwards notifications as email

Set whether SNS notifications should include original email headers or not

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

Verifies an email address

Types

destination()
destination() :: %{to: [email_address], bcc: [email_address], bcc: [email_address]}
email_address()
email_address() :: binary
list_configuration_sets_opt()
list_configuration_sets_opt ::
  {:max_items, pos_integer} |
  {:next_token, String.t}
list_identities_opt()
list_identities_opt ::
  {:max_items, pos_integer} |
  {:next_token, String.t} |
  {:identity_type, String.t}
message()
message() :: %{body: %{html: %{data: binary, charset: binary}, text: %{data: binary, charset: binary}}, subject: %{data: binary, charset: binary}}
notification_type()
notification_type() :: :bounce | :complaint | :delivery
send_email_opt()
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}}
send_raw_email_opt()
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}}
set_identity_notification_topic_opt()
set_identity_notification_topic_opt() :: {:sns_topic, binary}

Functions

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

Build message object

delete_identity(identity)
delete_identity(binary) :: ExAws.Operation.Query.t

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

get_identity_verification_attributes(identities)
get_identity_verification_attributes([binary]) :: ExAws.Operation.Query.t

Fetch identities verification status and token (for domains)

list_configuration_sets(opts \\ [])
list_configuration_sets(opts :: [] | [list_configuration_sets_opt]) :: ExAws.Operation.Query.t

Fetch configuration sets associated with AWS account

list_identities(opts \\ [])
list_identities(opts :: [] | [list_identities_opt]) :: ExAws.Operation.Query.t

List identities associated with the AWS account

send_email(dst, msg, src, opts \\ [])
send_email(dst :: destination, msg :: message, src :: binary, opts :: [send_email_opt]) :: ExAws.Operation.Query.t

Composes an email message

send_raw_email(raw_msg, opts \\ [])
send_raw_email(binary, opts :: [send_raw_email_opt]) :: message

Send a raw Email.

set_identity_feedback_forwarding_enabled(enabled, identity)
set_identity_feedback_forwarding_enabled(boolean, binary) :: ExAws.Operation.Query.t

Enables or disables whether Amazon SES forwards notifications as email

set_identity_headers_in_notifications_enabled(identity, type, enabled)
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

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.

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

verify_email_identity(email)
verify_email_identity(email :: binary) :: ExAws.Operation.Query.t

Verifies an email address