class SocketLabs::InjectionApi::Message::BasicMessage

Public Class Methods

new(arguments = nil) click to toggle source
Calls superclass method
# File lib/socketlabs/injectionapi/message/basic_message.rb, line 9
def initialize(arguments = nil)
  super

  @to_email_address = Array.new
  @cc_email_address = Array.new
  @bcc_email_address = Array.new

end

Public Instance Methods

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

Add an EmailAddress to the CC recipient list. @param [String] email_address @param [String] friendly_name

# File lib/socketlabs/injectionapi/message/basic_message.rb, line 62
def add_bcc_email_address(email_address, friendly_name = nil)
  convert_email_address(@bcc_email_address, email_address, friendly_name)
end
add_cc_email_address(email_address, friendly_name = nil) click to toggle source

Add an EmailAddress to the CC recipient list. @param [String] email_address @param [String] friendly_name

# File lib/socketlabs/injectionapi/message/basic_message.rb, line 46
def add_cc_email_address(email_address, friendly_name = nil)
  convert_email_address(@cc_email_address, email_address, friendly_name)
end
add_to_email_address(email_address, friendly_name = nil) click to toggle source

Add an EmailAddress to the To recipient list. @param [String] email_address @param [String] friendly_name

# File lib/socketlabs/injectionapi/message/basic_message.rb, line 30
def add_to_email_address(email_address, friendly_name = nil)
  convert_email_address(@to_email_address, email_address, friendly_name)
end
bcc_email_address() click to toggle source

Get the CC EmailAddress list

# File lib/socketlabs/injectionapi/message/basic_message.rb, line 51
def bcc_email_address
  @bcc_email_address
end
bcc_email_address=(value) click to toggle source

Set the CC EmailAddress list

# File lib/socketlabs/injectionapi/message/basic_message.rb, line 55
def bcc_email_address=(value)
  @bcc_email_address = Array.new
  convert_email_address(@bcc_email_address, value)
end
cc_email_address() click to toggle source

Get the CC EmailAddress list

# File lib/socketlabs/injectionapi/message/basic_message.rb, line 35
def cc_email_address
  @cc_email_address
end
cc_email_address=(value) click to toggle source

Set the CC EmailAddress list

# File lib/socketlabs/injectionapi/message/basic_message.rb, line 39
def cc_email_address=(value)
  @cc_email_address = Array.new
  convert_email_address(@cc_email_address, value)
end
to_email_address() click to toggle source

Get the To EmailAddress list

# File lib/socketlabs/injectionapi/message/basic_message.rb, line 19
def to_email_address
  @to_email_address
end
to_email_address=(value) click to toggle source

Set the To EmailAddress list

# File lib/socketlabs/injectionapi/message/basic_message.rb, line 23
def to_email_address=(value)
  @to_email_address = Array.new
  convert_email_address(@to_email_address, value)
end
to_json() click to toggle source
# File lib/socketlabs/injectionapi/message/basic_message.rb, line 76
def to_json
  {
      subject: @subject,
      textBody: @plain_text_body,
      htmlBody: @html_body,
      ampBody: @amp_body,
      apiTemplate: @api_template,
      mailingId: @mailing_id,
      messageId: @message_id,
      charSet: @charset,
      from: @from_email_address,
      replyTo: @reply_to_email_address,
      attachments: @attachments,
      customHeaders: @custom_headers,
      to: @to_email_address,
      cc: @cc_email_address,
      bcc: @bcc_email_address
  }
end
to_s() click to toggle source
# File lib/socketlabs/injectionapi/message/basic_message.rb, line 67
def to_s
  c = @to_email_address.any? ? @to_email_address.count : 0
  c = c + (@cc_email_address.any? ? @cc_email_address.count : 0)
  c = c + (@bcc_email_address.any? ? @bcc_email_address.count : 0)

  "Recipients: #{c}, Subject: '#{@subject}'"

end

Private Instance Methods

convert_email_address(array_instance, email_address, friendly_name = nil) click to toggle source
# File lib/socketlabs/injectionapi/message/basic_message.rb, line 97
def convert_email_address(array_instance, email_address, friendly_name = nil)

  if email_address.kind_of? Array
    convert_email_address_array(array_instance, email_address)
  else
    convert_email_address_object(array_instance, email_address, friendly_name)
  end
end
convert_email_address_array(array_instance, value) click to toggle source
# File lib/socketlabs/injectionapi/message/basic_message.rb, line 124
def convert_email_address_array(array_instance, value)

  if value.kind_of? Array
    value.each do |x|
      convert_email_address_object(array_instance, x)
    end
  end

end
convert_email_address_object(array_instance, email_address, friendly_name = nil) click to toggle source
# File lib/socketlabs/injectionapi/message/basic_message.rb, line 106
def convert_email_address_object(array_instance, email_address, friendly_name = nil)
  unless email_address.nil?

    if email_address.kind_of? EmailAddress
      array_instance.push(email_address)

    elsif email_address.kind_of? String
      array_instance.push(EmailAddress.new(email_address, friendly_name))

    elsif email_address.kind_of? Hash or email_address.kind_of? OpenStruct
      array_instance.push(EmailAddress.new(email_address[:email_address], email_address[:friendly_name]))

    end

  end

end