You are viewing documentation for version 1 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: AWS::SimpleEmailService::EmailAddressCollection

Inherits:
Object
  • Object
show all
Includes:
Enumerable
Defined in:
lib/aws/simple_email_service/email_address_collection.rb

Overview

Note:

This class is deprecated. Please use #identities instead.

Helps you manage your verified SimpleEmailService email addresses.

Instance Method Summary collapse

Instance Method Details

#delete(email_address) ⇒ nil

Note:

This method is deprecated.

Parameters:

  • email_address (String) —

    An email address to remove from the list of verified email addresses. Useful for cleanup as there is a 100 email address limit.

Returns:

  • (nil) 


43
44
45
46
 
# File 'lib/aws/simple_email_service/email_address_collection.rb', line 43

def delete email_address
  client.delete_verified_email_address(:email_address => email_address)
  nil
end

#each(&block) ⇒ nil

Note:

This method is deprecated.

Yields each verified email address as a string.

Returns:

  • (nil) —

    yielded.



59
60
61
62
63
64
65
 
# File 'lib/aws/simple_email_service/email_address_collection.rb', line 59

def each &block
  response = client.list_verified_email_addresses({})
  response.verified_email_addresses.each do |email_address|
    yield(email_address)
  end
  nil
end

#include? ⇒ Boolean Also known as: verified?

Note:

This method is deprecated.

Returns:

  • (Boolean) 


49
50
51
52
 
# File 'lib/aws/simple_email_service/email_address_collection.rb', line 49

def include?
  # this is so jruby can detect that verified? is an alias
  super
end

#verify(email_address) ⇒ nil Also known as: create

Note:

This method is deprecated.

Requests for an email address to be verified. An email will be sent to the given email_address with a link to click. Once the link has been followed the email_address will be verified.

Parameters:

  • email_address (String) —

    The email address to verify.

Returns:

  • (nil) 


32
33
34
35
 
# File 'lib/aws/simple_email_service/email_address_collection.rb', line 32

def verify email_address
  client.verify_email_address(:email_address => email_address)
  nil
end