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'
CACHEABLE_REQUESTS =
Set[]

Instance Attribute Summary

Attributes inherited from Core::Client

#config, #endpoint, #port, #service_ruby_name, #signer

Instance Method Summary collapse

Methods included from Core::Client::QueryXML

extended, option_parsers, xml_parsers

Methods inherited from Core::Client

#initialize, #new_stub_for, #operations, #stub_for, #with_config, #with_http_handler, #with_options

Methods included from Core::Naming

#service_name, #service_ruby_name

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 name of the identity to be removed from the list of verified identities.

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 addreses.

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_verification_attributes(options = {}) ⇒ Core::Response

Calls the GetIdentityVerificationAttributes API operation.

Options:

  • :identities - required - (Array<String>)

Response Structure:

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

    • :verification_status - (String)

    • :verification_token - (String)

Returns:


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

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:


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

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:


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

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 listed. Possible values are: “EmailAddress”, “Domain” or null.

  • :next_token - (String) The token used for retrieving the next set of items.

  • :max_items - (Integer) The maximum number of items returned.

Response Structure:

  • :identities - (Array<String>)

  • :next_token - (String)

Returns:


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

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:


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

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:


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

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:


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

define_client_method :send_raw_email, 'SendRawEmail'

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

Calls the VerifyDomainIdentity API operation.

Options:

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

Response Structure:

  • :verification_token - (String)

Returns:


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

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:


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

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:


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

define_client_method :verify_email_identity, 'VerifyEmailIdentity'