Client

ses	R Documentation

Amazon Simple Email Service¶

Description¶

This document contains reference information for the Amazon Simple Email Service (Amazon SES) API, version 2010-12-01. This document is best used in conjunction with the Amazon SES Developer Guide.

For a list of Amazon SES endpoints to use in service requests, see Regions and Amazon SES in the Amazon SES Developer Guide.

This documentation contains reference information related to the following:

Usage¶

ses(config = list(), credentials = list(), endpoint = NULL, region = NULL)

Arguments¶

config

Optional configuration of credentials, endpoint, and/or region.

credentials:
- creds:
  - access_key_id: AWS access key ID
  - secret_access_key: AWS secret access key
  - session_token: AWS temporary session token
- profile: The name of a profile to use. If not given, then the default profile is used.
- anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

creds:
- access_key_id: AWS access key ID
- secret_access_key: AWS secret access key
- session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

Value¶

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax¶

svc <- ses(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations¶

clone_receipt_rule_set: Creates a receipt rule set by cloning an existing one
create_configuration_set: Creates a configuration set; Creates a configuration set event destination; Creates an association between a configuration set and a custom domain for open and click event tracking; Creates a new custom verification email template
create_receipt_filter: Creates a new IP address filter
create_receipt_rule: Creates a receipt rule
create_receipt_rule_set: Creates an empty receipt rule set
create_template: Creates an email template
delete_configuration_set: Deletes a configuration set; Deletes a configuration set event destination; Deletes an association between a configuration set and a custom domain for open and click event tracking; Deletes an existing custom verification email template
delete_identity: Deletes the specified identity (an email address or a domain) from the list of verified identities
delete_identity_policy: Deletes the specified sending authorization policy for the given identity (an email address or a domain)
delete_receipt_filter: Deletes the specified IP address filter
delete_receipt_rule: Deletes the specified receipt rule
delete_receipt_rule_set: Deletes the specified receipt rule set and all of the receipt rules it contains
delete_template: Deletes an email template
delete_verified_email_address: Deprecated
describe_active_receipt_rule_set: Returns the metadata and receipt rules for the receipt rule set that is currently active
describe_configuration_set: Returns the details of the specified configuration set
describe_receipt_rule: Returns the details of the specified receipt rule
describe_receipt_rule_set: Returns the details of the specified receipt rule set
get_account_sending_enabled: Returns the email sending status of the Amazon SES account for the current Region; Returns the custom email verification template for the template name you specify
get_identity_dkim_attributes: Returns the current status of Easy DKIM signing for an entity; Returns the custom MAIL FROM attributes for a list of identities (email addresses : domains)
get_identity_notification_attributes: Given a list of verified identities (email addresses and/or domains), returns a structure describing identity notification attributes
get_identity_policies: Returns the requested sending authorization policies for the given identity (an email address or a domain)
get_identity_verification_attributes: Given a list of identities (email addresses and/or domains), returns the verification status and (for domain identities) the verification token for each identity
get_send_quota: Provides the sending limits for the Amazon SES account
get_send_statistics: Provides sending statistics for the current Amazon Web Services Region
get_template: Displays the template object (which includes the Subject line, HTML part and text part) for the template you specify
list_configuration_sets: Provides a list of the configuration sets associated with your Amazon SES account in the current Amazon Web Services Region; Lists the existing custom verification email templates for your account in the current Amazon Web Services Region
list_identities: Returns a list containing all of the identities (email addresses and domains) for your Amazon Web Services account in the current Amazon Web Services Region, regardless of verification status
list_identity_policies: Returns a list of sending authorization policies that are attached to the given identity (an email address or a domain)
list_receipt_filters: Lists the IP address filters associated with your Amazon Web Services account in the current Amazon Web Services Region
list_receipt_rule_sets: Lists the receipt rule sets that exist under your Amazon Web Services account in the current Amazon Web Services Region
list_templates: Lists the email templates present in your Amazon SES account in the current Amazon Web Services Region
list_verified_email_addresses: Deprecated; Adds or updates the delivery options for a configuration set
put_identity_policy: Adds or updates a sending authorization policy for the specified identity (an email address or a domain)
reorder_receipt_rule_set: Reorders the receipt rules within a receipt rule set
send_bounce: Generates and sends a bounce message to the sender of an email you received through Amazon SES
send_bulk_templated_email: Composes an email message to multiple destinations
send_custom_verification_email: Adds an email address to the list of identities for your Amazon SES account in the current Amazon Web Services Region and attempts to verify it
send_email: Composes an email message and immediately queues it for sending
send_raw_email: Composes an email message and immediately queues it for sending
send_templated_email: Composes an email message using an email template and immediately queues it for sending
set_active_receipt_rule_set: Sets the specified receipt rule set as the active receipt rule set
set_identity_dkim_enabled: Enables or disables Easy DKIM signing of email sent from an identity; Given an identity (an email address or a domain), enables or disables whether Amazon SES forwards bounce and complaint notifications as email; Given an identity (an email address or a domain), sets whether Amazon SES includes the original email headers in the Amazon Simple Notification Service (Amazon SNS) notifications of a specified type
set_identity_mail_from_domain: Enables or disables the custom MAIL FROM domain setup for a verified identity (an email address or a domain)
set_identity_notification_topic: Sets an Amazon Simple Notification Service (Amazon SNS) topic to use when delivering notifications
set_receipt_rule_position: Sets the position of the specified receipt rule in the receipt rule set
test_render_template: Creates a preview of the MIME content of an email when provided with a template and a set of replacement data
update_account_sending_enabled: Enables or disables email sending across your entire Amazon SES account in the current Amazon Web Services Region; Updates the event destination of a configuration set; Enables or disables the publishing of reputation metrics for emails sent using a specific configuration set in a given Amazon Web Services Region; Enables or disables email sending for messages sent using a specific configuration set in a given Amazon Web Services Region; Modifies an association between a configuration set and a custom domain for open and click event tracking; Updates an existing custom verification email template
update_receipt_rule: Updates a receipt rule
update_template: Updates an email template
verify_domain_dkim: Returns a set of DKIM tokens for a domain identity
verify_domain_identity: Adds a domain to the list of identities for your Amazon SES account in the current Amazon Web Services Region and attempts to verify it
verify_email_address: Deprecated
verify_email_identity: Adds an email address to the list of identities for your Amazon SES account in the current Amazon Web Services Region and attempts to verify it

Examples¶

## Not run: 
svc <- ses()
# The following example creates a receipt rule set by cloning an existing
# one:
svc$clone_receipt_rule_set(
  OriginalRuleSetName = "RuleSetToClone",
  RuleSetName = "RuleSetToCreate"
)

## End(Not run)