class Comet::EmailOptions

EmailOptions is a typed class wrapper around the underlying Comet Server API data structure.

def clear

def clear
  @from_email = ''
  @from_name = ''
  @mode = ''
  @email_reporting_options = []
  @smtphost = ''
  @smtpport = 0
  @smtpusername = ''
  @smtppassword = ''
  @unknown_json_fields = {}
end

def from_hash(obj)

Parameters:
  • obj (Hash) -- The complete object as a Ruby hash
def from_hash(obj)
  raise TypeError, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash
  obj.each do |k, v|
    case k
    when 'FromEmail'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
      @from_email = v
    when 'FromName'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
      @from_name = v
    when 'Mode'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
      @mode = v
    when 'EmailReportingOptions'
      if v.nil?
        @email_reporting_options = []
      else
        @email_reporting_options = Array.new(v.length)
        v.each_with_index do |v1, i1|
          @email_reporting_options[i1] = Comet::EmailReportingOption.new
          @email_reporting_options[i1].from_hash(v1)
        end
      end
    when 'SMTPHost'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
      @smtphost = v
    when 'SMTPPort'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
      @smtpport = v
    when 'SMTPUsername'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
      @smtpusername = v
    when 'SMTPPassword'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
      @smtppassword = v
    when 'SMTPAllowInvalidCertificate'
      @smtpallow_invalid_certificate = v
    when 'SMTPAllowUnencrypted'
      @smtpallow_unencrypted = v
    else
      @unknown_json_fields[k] = v
    end
  end
end

def from_json(json_string)

Parameters:
  • json_string (String) -- The complete object in JSON format
def from_json(json_string)
  raise TypeError, "'json_string' expected String, got #{json_string.class}" unless json_string.is_a? String
  from_hash(JSON.parse(json_string))
end

def initialize

def initialize
  clear
end

def to_h

Returns:
  • (Hash) - The complete object as a Ruby hash
def to_h
  to_hash
end

def to_hash

Returns:
  • (Hash) - The complete object as a Ruby hash
def to_hash
  ret = {}
  ret['FromEmail'] = @from_email
  ret['FromName'] = @from_name
  ret['Mode'] = @mode
  unless @email_reporting_options.nil?
    ret['EmailReportingOptions'] = @email_reporting_options
  end
  unless @smtphost.nil?
    ret['SMTPHost'] = @smtphost
  end
  unless @smtpport.nil?
    ret['SMTPPort'] = @smtpport
  end
  unless @smtpusername.nil?
    ret['SMTPUsername'] = @smtpusername
  end
  unless @smtppassword.nil?
    ret['SMTPPassword'] = @smtppassword
  end
  unless @smtpallow_invalid_certificate.nil?
    ret['SMTPAllowInvalidCertificate'] = @smtpallow_invalid_certificate
  end
  unless @smtpallow_unencrypted.nil?
    ret['SMTPAllowUnencrypted'] = @smtpallow_unencrypted
  end
  @unknown_json_fields.each do |k, v|
    ret[k] = v
  end
  ret
end

def to_json(options = {})

Returns:
  • (String) - The complete object as a JSON string
def to_json(options = {})
  to_hash.to_json(options)
end