Class: GroupDocsConversionCloud::EmailLoadOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/groupdocs_conversion_cloud/models/email_load_options.rb

Overview

Options for loading Email documents

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EmailLoadOptions

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/groupdocs_conversion_cloud/models/email_load_options.rb', line 121

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.key?(:'Format')
    self.format = attributes[:'Format']
  end

  if attributes.key?(:'PreserveOriginalDate')
    self.preserve_original_date = attributes[:'PreserveOriginalDate']
  end

  if attributes.key?(:'FieldLabels')
    if (value = attributes[:'FieldLabels']).is_a?(Array)
      self.field_labels = value
    end
  end

  if attributes.key?(:'TimeZoneOffset')
    self.time_zone_offset = attributes[:'TimeZoneOffset']
  end

  if attributes.key?(:'DisplaySent')
    self.display_sent = attributes[:'DisplaySent']
  end

  if attributes.key?(:'DisplaySubject')
    self.display_subject = attributes[:'DisplaySubject']
  end

  if attributes.key?(:'DisplayAttachments')
    self.display_attachments = attributes[:'DisplayAttachments']
  end

  if attributes.key?(:'DisplayEmailAddresses')
    self.display_email_addresses = attributes[:'DisplayEmailAddresses']
  end

  if attributes.key?(:'DisplayBccEmailAddress')
    self.display_bcc_email_address = attributes[:'DisplayBccEmailAddress']
  end

  if attributes.key?(:'DisplayCcEmailAddress')
    self.display_cc_email_address = attributes[:'DisplayCcEmailAddress']
  end

  if attributes.key?(:'DisplayToEmailAddress')
    self.display_to_email_address = attributes[:'DisplayToEmailAddress']
  end

  if attributes.key?(:'DisplayFromEmailAddress')
    self.display_from_email_address = attributes[:'DisplayFromEmailAddress']
  end

  if attributes.key?(:'DisplayHeader')
    self.display_header = attributes[:'DisplayHeader']
  end

  if attributes.key?(:'DefaultFont')
    self.default_font = attributes[:'DefaultFont']
  end

  if attributes.key?(:'FontSubstitutes')
    if (value = attributes[:'FontSubstitutes']).is_a?(Hash)
      self.font_substitutes = value
    end
  end

end

Instance Attribute Details

#default_font ⇒ Object

Default font for Email document. The following font will be used if a font is missing.



72
73
74
 
# File 'lib/groupdocs_conversion_cloud/models/email_load_options.rb', line 72

def default_font
  @default_font
end

#display_attachments ⇒ Object

Option to display or hide attachments in the header. Default: true.



53
54
55
 
# File 'lib/groupdocs_conversion_cloud/models/email_load_options.rb', line 53

def display_attachments
  @display_attachments
end

#display_bcc_email_address ⇒ Object

Option to display or hide "Bcc" email address. Default: false



57
58
59
 
# File 'lib/groupdocs_conversion_cloud/models/email_load_options.rb', line 57

def display_bcc_email_address
  @display_bcc_email_address
end

#display_cc_email_address ⇒ Object

Option to display or hide "Cc" email address. Default: false



60
61
62
 
# File 'lib/groupdocs_conversion_cloud/models/email_load_options.rb', line 60

def display_cc_email_address
  @display_cc_email_address
end

#display_email_addresses ⇒ Object

Returns the value of attribute display_email_addresses.



54
55
56
 
# File 'lib/groupdocs_conversion_cloud/models/email_load_options.rb', line 54

def display_email_addresses
  @display_email_addresses
end

#display_from_email_address ⇒ Object

Option to display or hide "from" email address. Default: true



66
67
68
 
# File 'lib/groupdocs_conversion_cloud/models/email_load_options.rb', line 66

def display_from_email_address
  @display_from_email_address
end

#display_header ⇒ Object

Option to display or hide the email header. Default: true



69
70
71
 
# File 'lib/groupdocs_conversion_cloud/models/email_load_options.rb', line 69

def display_header
  @display_header
end

#display_sent ⇒ Object

Option to display or hide sent date/time in the header. Default: true.



47
48
49
 
# File 'lib/groupdocs_conversion_cloud/models/email_load_options.rb', line 47

def display_sent
  @display_sent
end

#display_subject ⇒ Object

Option to display or hide subject in the header. Default: true.



50
51
52
 
# File 'lib/groupdocs_conversion_cloud/models/email_load_options.rb', line 50

def display_subject
  @display_subject
end

#display_to_email_address ⇒ Object

Option to display or hide "to" email address. Default: true



63
64
65
 
# File 'lib/groupdocs_conversion_cloud/models/email_load_options.rb', line 63

def display_to_email_address
  @display_to_email_address
end

#field_labels ⇒ Object

The mapping between email message field and field text representation



41
42
43
 
# File 'lib/groupdocs_conversion_cloud/models/email_load_options.rb', line 41

def field_labels
  @field_labels
end

#font_substitutes ⇒ Object

List of font substitutes.



75
76
77
 
# File 'lib/groupdocs_conversion_cloud/models/email_load_options.rb', line 75

def font_substitutes
  @font_substitutes
end

#format ⇒ Object

The format of input file, ("docx", for example). This field must be filled with correct input file format when using ConvertDirect method, which accept input file as binary stream, and, because of that, API can correctly handle LoadOptions. In regular conversion, the input file format taken from the input file name and this field ignored.



35
36
37
 
# File 'lib/groupdocs_conversion_cloud/models/email_load_options.rb', line 35

def format
  @format
end

#preserve_original_date ⇒ Object

Defines whether need to keep original date header string in mail message when saving or not (Default value is true)



38
39
40
 
# File 'lib/groupdocs_conversion_cloud/models/email_load_options.rb', line 38

def preserve_original_date
  @preserve_original_date
end

#time_zone_offset ⇒ Object

Gets or sets the Coordinated Universal Time (UTC) offset for the message dates. This property defines the time zone difference, between the localtime and UTC.



44
45
46
 
# File 'lib/groupdocs_conversion_cloud/models/email_load_options.rb', line 44

def time_zone_offset
  @time_zone_offset
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/groupdocs_conversion_cloud/models/email_load_options.rb', line 78

def self.attribute_map
  {
    :'format' => :'Format',
    :'preserve_original_date' => :'PreserveOriginalDate',
    :'field_labels' => :'FieldLabels',
    :'time_zone_offset' => :'TimeZoneOffset',
    :'display_sent' => :'DisplaySent',
    :'display_subject' => :'DisplaySubject',
    :'display_attachments' => :'DisplayAttachments',
    :'display_email_addresses' => :'DisplayEmailAddresses',
    :'display_bcc_email_address' => :'DisplayBccEmailAddress',
    :'display_cc_email_address' => :'DisplayCcEmailAddress',
    :'display_to_email_address' => :'DisplayToEmailAddress',
    :'display_from_email_address' => :'DisplayFromEmailAddress',
    :'display_header' => :'DisplayHeader',
    :'default_font' => :'DefaultFont',
    :'font_substitutes' => :'FontSubstitutes'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/groupdocs_conversion_cloud/models/email_load_options.rb', line 99

def self.swagger_types
  {
    :'format' => :'String',
    :'preserve_original_date' => :'BOOLEAN',
    :'field_labels' => :'Array<FieldLabel>',
    :'time_zone_offset' => :'String',
    :'display_sent' => :'BOOLEAN',
    :'display_subject' => :'BOOLEAN',
    :'display_attachments' => :'BOOLEAN',
    :'display_email_addresses' => :'BOOLEAN',
    :'display_bcc_email_address' => :'BOOLEAN',
    :'display_cc_email_address' => :'BOOLEAN',
    :'display_to_email_address' => :'BOOLEAN',
    :'display_from_email_address' => :'BOOLEAN',
    :'display_header' => :'BOOLEAN',
    :'default_font' => :'String',
    :'font_substitutes' => :'Hash<String, String>'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/groupdocs_conversion_cloud/models/email_load_options.rb', line 258

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      format == other.format &&
      preserve_original_date == other.preserve_original_date &&
      field_labels == other.field_labels &&
      time_zone_offset == other.time_zone_offset &&
      display_sent == other.display_sent &&
      display_subject == other.display_subject &&
      display_attachments == other.display_attachments &&
      display_email_addresses == other.display_email_addresses &&
      display_bcc_email_address == other.display_bcc_email_address &&
      display_cc_email_address == other.display_cc_email_address &&
      display_to_email_address == other.display_to_email_address &&
      display_from_email_address == other.display_from_email_address &&
      display_header == other.display_header &&
      default_font == other.default_font &&
      font_substitutes == other.font_substitutes
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/groupdocs_conversion_cloud/models/email_load_options.rb', line 323

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    Date.parse value
  when :Date
    Date.parse value
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else
  # model
    temp_model = GroupDocsConversionCloud.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/groupdocs_conversion_cloud/models/email_load_options.rb', line 390

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/groupdocs_conversion_cloud/models/email_load_options.rb', line 299

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    pname = uncap(self.class.attribute_map[key]).intern
    value = attributes[pname]
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not                    
      if value.is_a?(Array)
        self.send("#{key}=", value.map { |v| _deserialize($1, v) })
      end
    elsif !value.nil?
      self.send("#{key}=", _deserialize(type, value))
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


280
281
282
 
# File 'lib/groupdocs_conversion_cloud/models/email_load_options.rb', line 280

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



286
287
288
 
# File 'lib/groupdocs_conversion_cloud/models/email_load_options.rb', line 286

def hash
  [format, preserve_original_date, field_labels, time_zone_offset, display_sent, display_subject, display_attachments, display_email_addresses, display_bcc_email_address, display_cc_email_address, display_to_email_address, display_from_email_address, display_header, default_font, font_substitutes].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/groupdocs_conversion_cloud/models/email_load_options.rb', line 195

def list_invalid_properties
  invalid_properties = []
  if @preserve_original_date.nil?
    invalid_properties.push("invalid value for 'preserve_original_date', preserve_original_date cannot be nil.")
  end

  if @display_sent.nil?
    invalid_properties.push("invalid value for 'display_sent', display_sent cannot be nil.")
  end

  if @display_subject.nil?
    invalid_properties.push("invalid value for 'display_subject', display_subject cannot be nil.")
  end

  if @display_attachments.nil?
    invalid_properties.push("invalid value for 'display_attachments', display_attachments cannot be nil.")
  end

  if @display_email_addresses.nil?
    invalid_properties.push("invalid value for 'display_email_addresses', display_email_addresses cannot be nil.")
  end

  if @display_bcc_email_address.nil?
    invalid_properties.push("invalid value for 'display_bcc_email_address', display_bcc_email_address cannot be nil.")
  end

  if @display_cc_email_address.nil?
    invalid_properties.push("invalid value for 'display_cc_email_address', display_cc_email_address cannot be nil.")
  end

  if @display_to_email_address.nil?
    invalid_properties.push("invalid value for 'display_to_email_address', display_to_email_address cannot be nil.")
  end

  if @display_from_email_address.nil?
    invalid_properties.push("invalid value for 'display_from_email_address', display_from_email_address cannot be nil.")
  end

  if @display_header.nil?
    invalid_properties.push("invalid value for 'display_header', display_header cannot be nil.")
  end

  return invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



370
371
372
 
# File 'lib/groupdocs_conversion_cloud/models/email_load_options.rb', line 370

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



376
377
378
379
380
381
382
383
384
 
# File 'lib/groupdocs_conversion_cloud/models/email_load_options.rb', line 376

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



364
365
366
 
# File 'lib/groupdocs_conversion_cloud/models/email_load_options.rb', line 364

def to_s
  to_hash.to_s
end

#uncap(str) ⇒ Object

Downcases first letter.

Returns:

  • downcased string



292
293
294
 
# File 'lib/groupdocs_conversion_cloud/models/email_load_options.rb', line 292

def uncap(str)
  str[0, 1].downcase + str[1..-1]
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/groupdocs_conversion_cloud/models/email_load_options.rb', line 242

def valid?
  return false if @preserve_original_date.nil?
  return false if @display_sent.nil?
  return false if @display_subject.nil?
  return false if @display_attachments.nil?
  return false if @display_email_addresses.nil?
  return false if @display_bcc_email_address.nil?
  return false if @display_cc_email_address.nil?
  return false if @display_to_email_address.nil?
  return false if @display_from_email_address.nil?
  return false if @display_header.nil?
  return true
end