Class: Comet::EmailOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/comet/models/email_options.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ EmailOptions

Returns a new instance of EmailOptions.



47
48
49
 
# File 'lib/comet/models/email_options.rb', line 47

def initialize
  clear
end

Instance Attribute Details

#from_email ⇒ Object

Returns the value of attribute from_email.



21
22
23
 
# File 'lib/comet/models/email_options.rb', line 21

def from_email
  @from_email
end

#from_name ⇒ Object

Returns the value of attribute from_name.



24
25
26
 
# File 'lib/comet/models/email_options.rb', line 24

def from_name
  @from_name
end

#mode ⇒ Object

Returns the value of attribute mode.



18
19
20
 
# File 'lib/comet/models/email_options.rb', line 18

def mode
  @mode
end

#smtpallow_invalid_certificate ⇒ Object

Returns the value of attribute smtpallow_invalid_certificate.



39
40
41
 
# File 'lib/comet/models/email_options.rb', line 39

def smtpallow_invalid_certificate
  @smtpallow_invalid_certificate
end

#smtpallow_unencrypted ⇒ Object

Returns the value of attribute smtpallow_unencrypted.



42
43
44
 
# File 'lib/comet/models/email_options.rb', line 42

def smtpallow_unencrypted
  @smtpallow_unencrypted
end

#smtphost ⇒ Object

Returns the value of attribute smtphost.



27
28
29
 
# File 'lib/comet/models/email_options.rb', line 27

def smtphost
  @smtphost
end

#smtppassword ⇒ Object

Returns the value of attribute smtppassword.



36
37
38
 
# File 'lib/comet/models/email_options.rb', line 36

def smtppassword
  @smtppassword
end

#smtpport ⇒ Object

Returns the value of attribute smtpport.



30
31
32
 
# File 'lib/comet/models/email_options.rb', line 30

def smtpport
  @smtpport
end

#smtpusername ⇒ Object

Returns the value of attribute smtpusername.



33
34
35
 
# File 'lib/comet/models/email_options.rb', line 33

def smtpusername
  @smtpusername
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



45
46
47
 
# File 'lib/comet/models/email_options.rb', line 45

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clear ⇒ Object 



51
52
53
54
55
56
57
58
59
60
 
# File 'lib/comet/models/email_options.rb', line 51

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

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/comet/models/email_options.rb', line 70

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 'Mode'
      raise TypeError "'v' expected String, got #{v.class}" unless v.is_a? String

      @mode = v
    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 '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

#from_json(json_string) ⇒ Object

Parameters:

  • json_string (String) —

    The complete object in JSON format



63
64
65
66
67
 
# File 'lib/comet/models/email_options.rb', line 63

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

#to_h ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



144
145
146
 
# File 'lib/comet/models/email_options.rb', line 144

def to_h
  to_hash
end

#to_hash ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/comet/models/email_options.rb', line 114

def to_hash
  ret = {}
  ret['Mode'] = @mode
  ret['FromEmail'] = @from_email
  ret['FromName'] = @from_name
  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

#to_json(options = {}) ⇒ String

Returns The complete object as a JSON string.

Returns:

  • (String) —

    The complete object as a JSON string



149
150
151
 
# File 'lib/comet/models/email_options.rb', line 149

def to_json(options = {})
  to_hash.to_json(options)
end