Class: GroupDocsConversionCloud::EmlLoadOptions
- Inherits:
-
Object
- Object
- GroupDocsConversionCloud::EmlLoadOptions
- Defined in:
- lib/groupdocs_conversion_cloud/models/eml_load_options.rb
Overview
Eml load options
Instance Attribute Summary collapse
-
#convert_attachments ⇒ Object
Option to convert attachments in source email or not.
-
#display_bcc_email_address ⇒ Object
Option to display or hide "Bcc" email address.
-
#display_cc_email_address ⇒ Object
Option to display or hide "Cc" email address.
-
#display_from_email_address ⇒ Object
Option to display or hide "from" email address.
-
#display_header ⇒ Object
Option to display or hide the email header.
-
#display_to_email_address ⇒ Object
Option to display or hide "to" email address.
-
#field_labels ⇒ Object
The mapping between email message field and field text representation.
-
#format ⇒ Object
The format of input file, ("docx", for example).
-
#preserve_original_date ⇒ Object
Defines whether need to keep original date header string in mail message when saving or not (Default value is true).
-
#time_zone_offset ⇒ Object
Gets or sets the Coordinated Universal Time (UTC) offset for the message dates.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ EmlLoadOptions
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#uncap(str) ⇒ Object
Downcases first letter.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ EmlLoadOptions
Initializes the object
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 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 142 143 144 145 146 |
# File 'lib/groupdocs_conversion_cloud/models/eml_load_options.rb', line 98 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?(:'DisplayHeader') self.display_header = attributes[:'DisplayHeader'] end if attributes.key?(:'DisplayFromEmailAddress') self.display_from_email_address = attributes[:'DisplayFromEmailAddress'] end if attributes.key?(:'DisplayToEmailAddress') self.display_to_email_address = attributes[:'DisplayToEmailAddress'] end if attributes.key?(:'DisplayCcEmailAddress') self.display_cc_email_address = attributes[:'DisplayCcEmailAddress'] end if attributes.key?(:'DisplayBccEmailAddress') self.display_bcc_email_address = attributes[:'DisplayBccEmailAddress'] end if attributes.key?(:'TimeZoneOffset') self.time_zone_offset = attributes[:'TimeZoneOffset'] end if attributes.key?(:'ConvertAttachments') self. = attributes[:'ConvertAttachments'] end if attributes.key?(:'FieldLabels') if (value = attributes[:'FieldLabels']).is_a?(Array) self.field_labels = value end end if attributes.key?(:'PreserveOriginalDate') self.preserve_original_date = attributes[:'PreserveOriginalDate'] end end |
Instance Attribute Details
#convert_attachments ⇒ Object
Option to convert attachments in source email or not. Default: false.
56 57 58 |
# File 'lib/groupdocs_conversion_cloud/models/eml_load_options.rb', line 56 def @convert_attachments end |
#display_bcc_email_address ⇒ Object
Option to display or hide "Bcc" email address. Default: false
50 51 52 |
# File 'lib/groupdocs_conversion_cloud/models/eml_load_options.rb', line 50 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
47 48 49 |
# File 'lib/groupdocs_conversion_cloud/models/eml_load_options.rb', line 47 def display_cc_email_address @display_cc_email_address end |
#display_from_email_address ⇒ Object
Option to display or hide "from" email address. Default: true
41 42 43 |
# File 'lib/groupdocs_conversion_cloud/models/eml_load_options.rb', line 41 def display_from_email_address @display_from_email_address end |
#display_header ⇒ Object
Option to display or hide the email header. Default: true
38 39 40 |
# File 'lib/groupdocs_conversion_cloud/models/eml_load_options.rb', line 38 def display_header @display_header end |
#display_to_email_address ⇒ Object
Option to display or hide "to" email address. Default: true
44 45 46 |
# File 'lib/groupdocs_conversion_cloud/models/eml_load_options.rb', line 44 def display_to_email_address @display_to_email_address end |
#field_labels ⇒ Object
The mapping between email message field and field text representation
59 60 61 |
# File 'lib/groupdocs_conversion_cloud/models/eml_load_options.rb', line 59 def field_labels @field_labels 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/eml_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)
62 63 64 |
# File 'lib/groupdocs_conversion_cloud/models/eml_load_options.rb', line 62 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.
53 54 55 |
# File 'lib/groupdocs_conversion_cloud/models/eml_load_options.rb', line 53 def time_zone_offset @time_zone_offset end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
65 66 67 68 69 70 71 72 73 74 75 76 77 78 |
# File 'lib/groupdocs_conversion_cloud/models/eml_load_options.rb', line 65 def self.attribute_map { :'format' => :'Format', :'display_header' => :'DisplayHeader', :'display_from_email_address' => :'DisplayFromEmailAddress', :'display_to_email_address' => :'DisplayToEmailAddress', :'display_cc_email_address' => :'DisplayCcEmailAddress', :'display_bcc_email_address' => :'DisplayBccEmailAddress', :'time_zone_offset' => :'TimeZoneOffset', :'convert_attachments' => :'ConvertAttachments', :'field_labels' => :'FieldLabels', :'preserve_original_date' => :'PreserveOriginalDate' } end |
.swagger_types ⇒ Object
Attribute type mapping.
81 82 83 84 85 86 87 88 89 90 91 92 93 94 |
# File 'lib/groupdocs_conversion_cloud/models/eml_load_options.rb', line 81 def self.swagger_types { :'format' => :'String', :'display_header' => :'BOOLEAN', :'display_from_email_address' => :'BOOLEAN', :'display_to_email_address' => :'BOOLEAN', :'display_cc_email_address' => :'BOOLEAN', :'display_bcc_email_address' => :'BOOLEAN', :'time_zone_offset' => :'String', :'convert_attachments' => :'BOOLEAN', :'field_labels' => :'Array<FieldLabel>', :'preserve_original_date' => :'BOOLEAN' } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
198 199 200 201 202 203 204 205 206 207 208 209 210 211 |
# File 'lib/groupdocs_conversion_cloud/models/eml_load_options.rb', line 198 def ==(other) return true if self.equal?(other) self.class == other.class && format == other.format && display_header == other.display_header && display_from_email_address == other.display_from_email_address && display_to_email_address == other.display_to_email_address && display_cc_email_address == other.display_cc_email_address && display_bcc_email_address == other.display_bcc_email_address && time_zone_offset == other.time_zone_offset && == other. && field_labels == other.field_labels && preserve_original_date == other.preserve_original_date end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 |
# File 'lib/groupdocs_conversion_cloud/models/eml_load_options.rb', line 258 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
325 326 327 328 329 330 331 332 333 334 335 336 337 |
# File 'lib/groupdocs_conversion_cloud/models/eml_load_options.rb', line 325 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
234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 |
# File 'lib/groupdocs_conversion_cloud/models/eml_load_options.rb', line 234 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
215 216 217 |
# File 'lib/groupdocs_conversion_cloud/models/eml_load_options.rb', line 215 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
221 222 223 |
# File 'lib/groupdocs_conversion_cloud/models/eml_load_options.rb', line 221 def hash [format, display_header, display_from_email_address, display_to_email_address, display_cc_email_address, display_bcc_email_address, time_zone_offset, , field_labels, preserve_original_date].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
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 |
# File 'lib/groupdocs_conversion_cloud/models/eml_load_options.rb', line 150 def list_invalid_properties invalid_properties = [] if @display_header.nil? invalid_properties.push("invalid value for 'display_header', display_header 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_to_email_address.nil? invalid_properties.push("invalid value for 'display_to_email_address', display_to_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_bcc_email_address.nil? invalid_properties.push("invalid value for 'display_bcc_email_address', display_bcc_email_address cannot be nil.") end if @convert_attachments.nil? invalid_properties.push("invalid value for 'convert_attachments', convert_attachments cannot be nil.") end if @preserve_original_date.nil? invalid_properties.push("invalid value for 'preserve_original_date', preserve_original_date cannot be nil.") end return invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
305 306 307 |
# File 'lib/groupdocs_conversion_cloud/models/eml_load_options.rb', line 305 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
311 312 313 314 315 316 317 318 319 |
# File 'lib/groupdocs_conversion_cloud/models/eml_load_options.rb', line 311 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
299 300 301 |
# File 'lib/groupdocs_conversion_cloud/models/eml_load_options.rb', line 299 def to_s to_hash.to_s end |
#uncap(str) ⇒ Object
Downcases first letter.
227 228 229 |
# File 'lib/groupdocs_conversion_cloud/models/eml_load_options.rb', line 227 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
185 186 187 188 189 190 191 192 193 194 |
# File 'lib/groupdocs_conversion_cloud/models/eml_load_options.rb', line 185 def valid? return false if @display_header.nil? return false if @display_from_email_address.nil? return false if @display_to_email_address.nil? return false if @display_cc_email_address.nil? return false if @display_bcc_email_address.nil? return false if @convert_attachments.nil? return false if @preserve_original_date.nil? return true end |