Class: SocketLabs::InjectionApi::Message::EmailAddress

Inherits:
Object
  • Object
show all
Includes:
SocketLabs::InjectionApi, Core
Defined in:
lib/socketlabs/injectionapi/message/email_address.rb

Overview

Represents an individual email address for a message. Example:

email_address = EmailAddress.new("[email protected]", "Recipient 1")

Constant Summary

Constants included from SocketLabs::InjectionApi

VERSION

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(email_address, friendly_name = nil) ⇒ EmailAddress

Initializes a new instance of the EmailAddress class

Parameters:

  • email_address (String)
  • friendly_name (String) (defaults to: nil) 


23
24
25
26
27
28
29
 
# File 'lib/socketlabs/injectionapi/message/email_address.rb', line 23

def initialize(
    email_address,
    friendly_name = nil
)
  @email_address = email_address
  @friendly_name = friendly_name
end

Instance Attribute Details

#email_address ⇒ Object

the email address



16
17
18
 
# File 'lib/socketlabs/injectionapi/message/email_address.rb', line 16

def email_address
  @email_address
end

#friendly_name ⇒ Object

the friendly or display name



18
19
20
 
# File 'lib/socketlabs/injectionapi/message/email_address.rb', line 18

def friendly_name
  @friendly_name
end

Instance Method Details

#is_valid ⇒ Boolean

Determines if the EmailAddress is valid. Does simple syntax validation on the email address.

Returns:

  • (Boolean) 


33
34
35
 
# File 'lib/socketlabs/injectionapi/message/email_address.rb', line 33

def is_valid
  StringExtension.new.is_valid_email_address(@email_address)
end

#to_s ⇒ String

Represents the EmailAddress as a string

Returns:

  • (String) 


39
40
41
42
43
44
45
46
 
# File 'lib/socketlabs/injectionapi/message/email_address.rb', line 39

def to_s
  if @friendly_name.nil? || @friendly_name.empty?
    @email_address
  else
    "#{@friendly_name} <#{@email_address}>"
  end

end