Class: AWS::SimpleEmailService::Client

Inherits:
Core::Client show all
Extended by:
Core::Client::QueryXML
Defined in:
lib/aws/simple_email_service/client.rb

Overview

Client class for Amazon Simple E-mail Service (SES).

Constant Summary collapse

API_VERSION = 
'2010-12-01'
REGION_US_E1 = 
'email.us-east-1.amazonaws.com'

Instance Attribute Summary

Attributes inherited from Core::Client

#config, #http_read_timeout

Instance Method Summary collapse

Methods inherited from Core::Client

#initialize, #operations, #with_http_handler, #with_options

Constructor Details

This class inherits a constructor from AWS::Core::Client

Instance Method Details

#delete_identity(options = {}) ⇒ Core::Response

Calls the DeleteIdentity API operation.

Options:

  • :identity - required - (String) The identity to be removed from the list of identities for the AWS Account.

Response Structure:

This method returns no response data.

Returns:



45
 
# File 'lib/aws/simple_email_service/client.rb', line 45

define_client_method :delete_identity, 'DeleteIdentity'

#delete_verified_email_address(options = {}) ⇒ Core::Response

Calls the DeleteVerifiedEmailAddress API operation.

Options:

  • :email_address - required - (String) An email address to be removed from the list of verified addresses.

Response Structure:

This method returns no response data.

Returns:



61
 
# File 'lib/aws/simple_email_service/client.rb', line 61

define_client_method :delete_verified_email_address, 'DeleteVerifiedEmailAddress'

#get_identity_notification_attributes(options = {}) ⇒ Core::Response

Calls the GetIdentityNotificationAttributes API operation.

Options:

  • :identities - required - (Array<String>) A list of one or more identities.

Response Structure:

  • :notification_attributes - (Hash<String,Hash>)

    • :bounce_topic - (String)

    • :complaint_topic - (String)

    • :forwarding_enabled - (Boolean)

Returns:



80
 
# File 'lib/aws/simple_email_service/client.rb', line 80

define_client_method :get_identity_notification_attributes, 'GetIdentityNotificationAttributes'

#get_identity_verification_attributes(options = {}) ⇒ Core::Response

Calls the GetIdentityVerificationAttributes API operation.

Options:

  • :identities - required - (Array<String>) A list of identities.

Response Structure:

  • :verification_attributes - (Hash<String,Hash>)

    • :verification_status - (String)

    • :verification_token - (String)

Returns:



97
 
# File 'lib/aws/simple_email_service/client.rb', line 97

define_client_method :get_identity_verification_attributes, 'GetIdentityVerificationAttributes'

#get_send_quota(options = {}) ⇒ Core::Response

Calls the GetSendQuota API operation.

Options:

This method accepts no options.

Response Structure:

  • :max_24_hour_send - (Numeric)

  • :max_send_rate - (Numeric)

  • :sent_last_24_hours - (Numeric)

Returns:



114
 
# File 'lib/aws/simple_email_service/client.rb', line 114

define_client_method :get_send_quota, 'GetSendQuota'

#get_send_statistics(options = {}) ⇒ Core::Response

Calls the GetSendStatistics API operation.

Options:

This method accepts no options.

Response Structure:

  • :send_data_points - (Array<Hash>)

    • :timestamp - (Time)

    • :delivery_attempts - (Integer)

    • :bounces - (Integer)

    • :complaints - (Integer)

    • :rejects - (Integer)

Returns:



134
 
# File 'lib/aws/simple_email_service/client.rb', line 134

define_client_method :get_send_statistics, 'GetSendStatistics'

#list_identities(options = {}) ⇒ Core::Response

Calls the ListIdentities API operation.

Options:

  • :identity_type - (String) The type of the identities to list. Possible values are “EmailAddress” and “Domain”. If this parameter is omitted, then all identities will be listed.

  • :next_token - (String) The token to use for pagination.

  • :max_items - (Integer) The maximum number of identities per page. Possible values are 1-100 inclusive.

Response Structure:

  • :identities - (Array<String>)

  • :next_token - (String)

Returns:



155
 
# File 'lib/aws/simple_email_service/client.rb', line 155

define_client_method :list_identities, 'ListIdentities'

#list_verified_email_addresses(options = {}) ⇒ Core::Response

Calls the ListVerifiedEmailAddresses API operation.

Options:

This method accepts no options.

Response Structure:

  • :verified_email_addresses - (Array<String>)

Returns:



170
 
# File 'lib/aws/simple_email_service/client.rb', line 170

define_client_method :list_verified_email_addresses, 'ListVerifiedEmailAddresses'

#send_email(options = {}) ⇒ Core::Response

Calls the SendEmail API operation.

Options:

  • :source - required - (String) The identity’s email address.

  • :destination - required - (Hash) The destination for this email, composed of To:, CC:, and BCC: fields.

    • :to_addresses - (Array<String>) The To: field(s) of the message.

    • :cc_addresses - (Array<String>) The CC: field(s) of the message.

    • :bcc_addresses - (Array<String>) The BCC: field(s) of the message.

  • :message - required - (Hash) The message to be sent.

    • :subject - required - (Hash) The subject of the message: A short summary of the content, which will appear in the recipient’s inbox.

      • :data - required - (String) The textual data of the content.

      • :charset - (String) The character set of the content.

    • :body - required - (Hash) The message body.

      • :text - (Hash) The content of the message, in text format. Use this for text-based email clients, or clients on high-latency networks (such as mobile devices).

        • :data - required - (String) The textual data of the content.

        • :charset - (String) The character set of the content.

      • :html - (Hash) The content of the message, in HTML format. Use this for email clients that can process HTML. You can include clickable links, formatted text, and much more in an HTML message.

        • :data - required - (String) The textual data of the content.

        • :charset - (String) The character set of the content.

  • :reply_to_addresses - (Array<String>) The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.

  • :return_path - (String) The email address to which bounce notifications are to be forwarded. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient’s ISP; this message will then be forwarded to the email address specified by the ReturnPath parameter.

Response Structure:

  • :message_id - (String)

Returns:



219
 
# File 'lib/aws/simple_email_service/client.rb', line 219

define_client_method :send_email, 'SendEmail'

#send_raw_email(options = {}) ⇒ Core::Response

Calls the SendRawEmail API operation.

Options:

  • :source - (String) The identity’s email address. If you specify the Source parameter, then bounce notifications and complaints will be sent to this email address. This takes precedence over any Return-Path header that you might include in the raw text of the message.

  • :destinations - (Array<String>) A list of destinations for the message.

  • :raw_message - required - (Hash) The raw text of the message. The client is responsible for ensuring the following: Message must contain a header and a body, separated by a blank line. All required header fields must be present. Each part of a multipart MIME message must be formatted properly. MIME content types must be among those supported by Amazon SES. Refer to the Amazon SES Developer Guide for more details. Content must be base64-encoded, if MIME requires it.

    • :data - required - (String) The raw data of the message. The client must ensure that the message format complies with Internet email standards regarding email header fields, MIME types, MIME encoding, and base64 encoding (if necessary). For more information, go to theAmazon SES Developer Guide.

Response Structure:

  • :message_id - (String)

Returns:



252
 
# File 'lib/aws/simple_email_service/client.rb', line 252

define_client_method :send_raw_email, 'SendRawEmail'

#set_identity_feedback_forwarding_enabled(options = {}) ⇒ Core::Response

Calls the SetIdentityFeedbackForwardingEnabled API operation.

Options:

  • :identity - required - (String) The identity for which to set feedback notification forwarding. Examples: [email protected], example.com.

  • :forwarding_enabled - required - (Boolean) Sets whether Amazon SES will forward feedback notifications as email. true specifies that Amazon SES will forward feedback notifications as email, in addition to any Amazon SNS topic publishing otherwise specified. false specifies that Amazon SES will publish feedback notifications only through Amazon SNS. This value can only be set to false when topics are specified for both Bounce and Complaint topic types.

Response Structure:

This method returns no response data.

Returns:



276
 
# File 'lib/aws/simple_email_service/client.rb', line 276

define_client_method :set_identity_feedback_forwarding_enabled, 'SetIdentityFeedbackForwardingEnabled'

#set_identity_notification_topic(options = {}) ⇒ Core::Response

Calls the SetIdentityNotificationTopic API operation.

Options:

  • :identity - required - (String) The identity for which the topic will be set. Examples: [email protected], example.com.

  • :notification_type - required - (String) The type of feedback notifications that will be published to the specified topic.

  • :sns_topic - (String) The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (Amazon SNS) topic. If the parameter is ommited from the request or a null value is passed, the topic is cleared and publishing is disabled.

Response Structure:

This method returns no response data.

Returns:



298
 
# File 'lib/aws/simple_email_service/client.rb', line 298

define_client_method :set_identity_notification_topic, 'SetIdentityNotificationTopic'

#verify_domain_identity(options = {}) ⇒ Core::Response

Calls the VerifyDomainIdentity API operation.

Options:

  • :domain - required - (String) The domain to be verified.

Response Structure:

  • :verification_token - (String)

Returns:



313
 
# File 'lib/aws/simple_email_service/client.rb', line 313

define_client_method :verify_domain_identity, 'VerifyDomainIdentity'

#verify_email_address(options = {}) ⇒ Core::Response

Calls the VerifyEmailAddress API operation.

Options:

  • :email_address - required - (String) The email address to be verified.

Response Structure:

This method returns no response data.

Returns:



329
 
# File 'lib/aws/simple_email_service/client.rb', line 329

define_client_method :verify_email_address, 'VerifyEmailAddress'

#verify_email_identity(options = {}) ⇒ Core::Response

Calls the VerifyEmailIdentity API operation.

Options:

  • :email_address - required - (String) The email address to be verified.

Response Structure:

This method returns no response data.

Returns:



345
 
# File 'lib/aws/simple_email_service/client.rb', line 345

define_client_method :verify_email_identity, 'VerifyEmailIdentity'