class SocketLabs::InjectionApi::Message::EmailAddress

Represents an individual email address for a message. Example:

email_address = EmailAddress.new("recipient@example.com", "Recipient 1")

Attributes

email_address[RW]

the email address

friendly_name[RW]

the friendly or display name

Public Class Methods

new( email_address, friendly_name = nil ) click to toggle source

Initializes a new instance of the EmailAddress class @param [String] email_address @param [String] friendly_name

# 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

Public Instance Methods

is_valid() click to toggle source

Determines if the EmailAddress is valid. Does simple syntax validation on the email address. @return [Boolean]

# File lib/socketlabs/injectionapi/message/email_address.rb, line 33
def is_valid
  StringExtension.new.is_valid_email_address(@email_address)
end
to_s() click to toggle source

Represents the EmailAddress as a string @return [String]

# 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