Class: SocketLabs::InjectionApi::AddressResult

Inherits:
Object
  • Object
show all
Defined in:
lib/socketlabs/injectionapi/address_result.rb

Overview

The result of a single recipient in the Injection request.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(email_address = nil, accepted = nil, error_code = nil) ⇒ AddressResult

Returns a new instance of AddressResult.



13
14
15
16
17
18
19
20
21
 
# File 'lib/socketlabs/injectionapi/address_result.rb', line 13

def initialize (
    email_address= nil,
    accepted= nil,
    error_code= nil
)
  @email_address = email_address
  @accepted = accepted
  @error_code = error_code
end

Instance Attribute Details

#accepted ⇒ Object

Whether the recipient was accepted for delivery.



9
10
11
 
# File 'lib/socketlabs/injectionapi/address_result.rb', line 9

def accepted
  @accepted
end

#email_address ⇒ Object

The recipient’s email address.



7
8
9
 
# File 'lib/socketlabs/injectionapi/address_result.rb', line 7

def email_address
  @email_address
end

#error_code ⇒ Object

An error code detailing why the recipient was not accepted.



11
12
13
 
# File 'lib/socketlabs/injectionapi/address_result.rb', line 11

def error_code
  @error_code
end

Instance Method Details

#to_json ⇒ Object

build json hash for AddressResult



30
31
32
33
34
35
36
 
# File 'lib/socketlabs/injectionapi/address_result.rb', line 30

def to_json(*)
  {
      :errorCode => @error_code,
      :accepted => @accepted,
      :emailAddress => @email_address
  }.delete_if { |_, value| value.to_s.strip == '' || value == [] || value == {}}
end

#to_s ⇒ String

Represents the AddressResult as a str. Useful for debugging.

Returns:

  • (String) 


25
26
27
 
# File 'lib/socketlabs/injectionapi/address_result.rb', line 25

def to_s
  "#{@error_code}: #{@email_address}"
end