ExAws.SES v2.1.0 ExAws.SES View Source
Operations on AWS SES
http://docs.aws.amazon.com/ses/latest/APIReference/Welcome.html
Link to this section Summary
Functions
Build message object
Create an email template
Deletes the specified identity (an email address or a domain) from the list of verified identities
Delete an email template
Fetch identities verification status and token (for domains)
Fetch configuration sets associated with AWS account
List identities associated with the AWS account
Send a templated email to multiple destinations
Composes an email message
Send a raw Email
Send a templated Email
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
Link to this section Types
bulk_destination()
View Source
bulk_destination() :: [
%{destination: destination(), replacement_template_data: binary()}
]
bulk_destination() :: [ %{destination: destination(), replacement_template_data: binary()} ]
create_template_opt()
View Source
create_template_opt() :: {:configuration_set_name, String.t()}
create_template_opt() :: {:configuration_set_name, String.t()}
destination()
View Source
destination() :: %{
to: [email_address()],
cc: [email_address()],
bcc: [email_address()]
}
destination() :: %{ to: [email_address()], cc: [email_address()], bcc: [email_address()] }
email_address()
View Source
email_address() :: binary()
email_address() :: binary()
list_configuration_sets_opt()
View Source
list_configuration_sets_opt() ::
{:max_items, pos_integer()} | {:next_token, String.t()}
list_configuration_sets_opt() :: {:max_items, pos_integer()} | {:next_token, String.t()}
list_identities_opt()
View Source
list_identities_opt() ::
{:max_items, pos_integer()}
| {:next_token, String.t()}
| {:identity_type, String.t()}
list_identities_opt() :: {:max_items, pos_integer()} | {:next_token, String.t()} | {:identity_type, String.t()}
message() View Source
notification_type()
View Source
notification_type() :: :bounce | :complaint | :delivery
notification_type() :: :bounce | :complaint | :delivery
send_bulk_templated_email_opt() View Source
send_email_opt() View Source
send_raw_email_opt() View Source
send_templated_email_opt() View Source
set_identity_notification_topic_opt()
View Source
set_identity_notification_topic_opt() :: {:sns_topic, binary()}
set_identity_notification_topic_opt() :: {:sns_topic, binary()}
Link to this section Functions
build_message(html, txt, subject, charset \\ "UTF-8") View Source
Build message object
create_template(template_name, subject, html, text, opts \\ [])
View Source
create_template(
binary(),
binary(),
binary(),
binary(),
opts :: [create_template_opt()]
) :: ExAws.Operation.Query.t()
create_template( binary(), binary(), binary(), binary(), opts :: [create_template_opt()] ) :: ExAws.Operation.Query.t()
Create an email template.
delete_identity(identity)
View Source
delete_identity(binary()) :: ExAws.Operation.Query.t()
delete_identity(binary()) :: ExAws.Operation.Query.t()
Deletes the specified identity (an email address or a domain) from the list of verified identities.
delete_template(template_name)
View Source
delete_template(binary()) :: ExAws.Operation.Query.t()
delete_template(binary()) :: ExAws.Operation.Query.t()
Delete an email template.
get_identity_verification_attributes(identities)
View Source
get_identity_verification_attributes([binary()]) :: ExAws.Operation.Query.t()
get_identity_verification_attributes([binary()]) :: ExAws.Operation.Query.t()
Fetch identities verification status and token (for domains)
list_configuration_sets(opts \\ [])
View Source
list_configuration_sets(opts :: [] | [list_configuration_sets_opt()]) ::
ExAws.Operation.Query.t()
list_configuration_sets(opts :: [] | [list_configuration_sets_opt()]) :: ExAws.Operation.Query.t()
Fetch configuration sets associated with AWS account
list_identities(opts \\ [])
View Source
list_identities(opts :: [] | [list_identities_opt()]) ::
ExAws.Operation.Query.t()
list_identities(opts :: [] | [list_identities_opt()]) :: ExAws.Operation.Query.t()
List identities associated with the AWS account
send_bulk_templated_email(template, source, destinations, opts \\ [])
View Source
send_bulk_templated_email(
template :: binary(),
source :: binary(),
destinations :: bulk_destination(),
opts :: [send_bulk_templated_email_opt()]
) :: ExAws.Operation.Query.t()
send_bulk_templated_email( template :: binary(), source :: binary(), destinations :: bulk_destination(), opts :: [send_bulk_templated_email_opt()] ) :: ExAws.Operation.Query.t()
Send a templated email to multiple destinations.
send_email(dst, msg, src, opts \\ [])
View Source
send_email(
dst :: destination(),
msg :: message(),
src :: binary(),
opts :: [send_email_opt()]
) :: ExAws.Operation.Query.t()
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 \\ [])
View Source
send_raw_email(binary(), opts :: [send_raw_email_opt()]) ::
ExAws.Operation.Query.t()
send_raw_email(binary(), opts :: [send_raw_email_opt()]) :: ExAws.Operation.Query.t()
Send a raw Email.
send_templated_email(dst, src, template, template_data, opts \\ [])
View Source
send_templated_email(
dst :: destination(),
src :: binary(),
template :: binary(),
template_data :: binary(),
opts :: [send_templated_email_opt()]
) :: ExAws.Operation.Query.t()
send_templated_email( dst :: destination(), src :: binary(), template :: binary(), template_data :: binary(), opts :: [send_templated_email_opt()] ) :: ExAws.Operation.Query.t()
Send a templated Email.
set_identity_feedback_forwarding_enabled(enabled, identity)
View Source
set_identity_feedback_forwarding_enabled(boolean(), binary()) ::
ExAws.Operation.Query.t()
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)
View Source
set_identity_headers_in_notifications_enabled(
binary(),
notification_type(),
boolean()
) :: ExAws.Operation.Query.t()
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 \\ [])
View Source
set_identity_notification_topic(
binary(),
notification_type(),
set_identity_notification_topic_opt() | []
) :: ExAws.Operation.Query.t()
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.
verify_email_identity(email)
View Source
verify_email_identity(email :: binary()) :: ExAws.Operation.Query.t()
verify_email_identity(email :: binary()) :: ExAws.Operation.Query.t()
Verifies an email address