Initialize connection to SES
options parameter must include values for :aws_access_key_id and :aws_secret_access_key in order to create a connection
ses = SES.new( :aws_access_key_id => your_aws_access_key_id, :aws_secret_access_key => your_aws_secret_access_key )
options<~Hash> - config arguments for connection. Defaults to {}.
region<~String> - optional region to use. For instance, 'us-east-1' and etc.
# File lib/fog/aws/ses.rb, line 48 def initialize(options={}) require 'fog/core/parser' @use_iam_profile = options[:use_iam_profile] setup_credentials(options) @connection_options = options[:connection_options] || {} options[:region] ||= 'us-east-1' @host = options[:host] || "email.#{options[:region]}.amazonaws.com" @path = options[:path] || '/' @persistent = options[:persistent] || false @port = options[:port] || 443 @scheme = options[:scheme] || 'https' @connection = Fog::Connection.new("#{@scheme}://#{@host}:#{@port}#{@path}", @persistent, @connection_options) end
Delete an existing verified email address
email_address<~String> - Email Address to be removed
response<~Excon::Response>:
body<~Hash>:
'ResponseMetadata'<~Hash>:
'RequestId'<~String> - Id of request
# File lib/fog/aws/requests/ses/delete_verified_email_address.rb, line 17 def delete_verified_email_address(email_address) request({ 'Action' => 'DeleteVerifiedEmailAddress', 'EmailAddress' => email_address, :parser => Fog::Parsers::AWS::SES::DeleteVerifiedEmailAddress.new }) end
Returns the user's current activity limits.
response<~Excon::Response>:
body<~Hash>:
'GetSendQuotaResult'<~Hash>
'Max24HourSend' <~String>
'MaxSendRate' <~String>
'SentLast24Hours' <~String>
'ResponseMetadata'<~Hash>:
'RequestId'<~String> - Id of request
# File lib/fog/aws/requests/ses/get_send_quota.rb, line 21 def get_send_quota request({ 'Action' => 'GetSendQuota', :parser => Fog::Parsers::AWS::SES::GetSendQuota.new }) end
Returns the user's current activity limits.
response<~Excon::Response>:
body<~Hash>:
'GetSendStatisticsResult'<~Hash>
'SendDataPoints' <~Array>
'Bounces' <~String>
'Complaints' <~String>
'DeliveryAttempts' <~String>
'Rejects' <~String>
'Timestamp' <~String>
'ResponseMetadata'<~Hash>:
'RequestId'<~String> - Id of request
# File lib/fog/aws/requests/ses/get_send_statistics.rb, line 24 def get_send_statistics request({ 'Action' => 'GetSendStatistics', :parser => Fog::Parsers::AWS::SES::GetSendStatistics.new }) end
Returns a list containing all of the email addresses that have been verified
response<~Excon::Response>:
body<~Hash>:
'VerifiedEmailAddresses' <~Array>
'ResponseMetadata'<~Hash>:
'RequestId'<~String> - Id of request
# File lib/fog/aws/requests/ses/list_verified_email_addresses.rb, line 18 def list_verified_email_addresses request({ 'Action' => 'ListVerifiedEmailAddresses', :parser => Fog::Parsers::AWS::SES::ListVerifiedEmailAddresses.new }) end
Send an email
Source <~String> - The sender's email address
Destination <~Hash> - The destination for this email, composed of To:, From:, and CC: fields.
BccAddresses <~Array> - The BCC: field(s) of the message.
CcAddresses <~Array> - The CC: field(s) of the message.
ToAddresses <~Array> - The To: field(s) of the message.
Message <~Hash> - The message to be sent.
Body <~Hash>
Html <~Hash>
Charset <~String>
Data <~String>
Text <~Hash>
Charset <~String>
Data <~String>
Subject <~Hash>
Charset <~String>
Data <~String>
options <~Hash>:
ReplyToAddresses <~Array> - The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.
ReturnPath <~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<~Excon::Response>:
body<~Hash>:
'MessageId'<~String> - Id of message
'ResponseMetadata'<~Hash>:
'RequestId'<~String> - Id of request
# File lib/fog/aws/requests/ses/send_email.rb, line 37 def send_email(source, destination, message, options = {}) params = { 'Source' => source } for key, values in destination params.merge!(Fog::AWS.indexed_param("Destination.#{key}.member", [*values])) end for key, value in message['Subject'] params["Message.Subject.#{key}"] = value end for type, data in message['Body'] for key, value in data params["Message.Body.#{type}.#{key}"] = value end end if options.has_key?('ReplyToAddresses') params.merge!(Fog::AWS.indexed_param("ReplyToAddresses.member", [*options['ReplyToAddresses']])) end if options.has_key?('ReturnPath') params['ReturnPath'] = options['ReturnPath'] end request({ 'Action' => 'SendEmail', :parser => Fog::Parsers::AWS::SES::SendEmail.new }.merge(params)) end
Send a raw email
RawMessage <~String> - The message to be sent.
Options <~Hash>
Source <~String> - The sender's email address. Takes precenence over Return-Path if specified in RawMessage
Destinations <~Array> - All destinations for this email.
response<~Excon::Response>:
body<~Hash>:
'MessageId'<~String> - Id of message
'ResponseMetadata'<~Hash>:
'RequestId'<~String> - Id of request
# File lib/fog/aws/requests/ses/send_raw_email.rb, line 22 def send_raw_email(raw_message, options = {}) params = {} if options.has_key?('Destinations') params.merge!(Fog::AWS.indexed_param('Destinations.member', [*options['Destinations']])) end if options.has_key?('Source') params['Source'] = options['Source'] end request({ 'Action' => 'SendRawEmail', 'RawMessage.Data' => Base64.encode64(raw_message).chomp!, :parser => Fog::Parsers::AWS::SES::SendRawEmail.new }.merge(params)) end
Verifies an email address. This action causes a confirmation email message to be sent to the specified address.
email_address<~String> - The email address to be verified
response<~Excon::Response>:
body<~Hash>:
'ResponseMetadata'<~Hash>:
'RequestId'<~String> - Id of request
# File lib/fog/aws/requests/ses/verify_email_address.rb, line 17 def verify_email_address(email_address) request({ 'Action' => 'VerifyEmailAddress', 'EmailAddress' => email_address, :parser => Fog::Parsers::AWS::SES::VerifyEmailAddress.new }) end
Generated with the Darkfish Rdoc Generator 2.