Class: MailSlurpClient::InboxDto
- Inherits:
-
Object
- Object
- MailSlurpClient::InboxDto
- Defined in:
- lib/mailslurp_client/models/inbox_dto.rb
Overview
Representation of a MailSlurp inbox. An inbox has an ID and a real email address. Emails can be sent to or from this email address. Inboxes are either `SMTP` or `HTTP` mailboxes. The default, `HTTP` inboxes, use AWS SES to process emails and are best suited as test email accounts and do not support IMAP or POP3. `SMTP` inboxes use a custom mail server at `mx.mailslurp.com` and support SMTP login, IMAP and POP3. Use the `EmailController` or the `InboxController` methods to send and receive emails and attachments. Inboxes may have a description, name, and tags for display purposes. You can also favourite an inbox for easier searching.
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#created_at ⇒ Object
When the inbox was created.
-
#description ⇒ Object
Description of an inbox for labelling and searching purposes.
-
#domain_id ⇒ Object
ID of custom domain used by the inbox if any.
-
#email_address ⇒ Object
The inbox's email address.
-
#expires_at ⇒ Object
Inbox expiration time.
-
#favourite ⇒ Object
Is the inbox a favorite inbox.
-
#id ⇒ Object
ID of the inbox.
-
#inbox_type ⇒ Object
Type of inbox.
-
#name ⇒ Object
Name of the inbox and used as the sender name when sending emails .Displayed in the dashboard for easier search.
-
#read_only ⇒ Object
Is the inbox readOnly for the caller.
-
#tags ⇒ Object
Tags that inbox has been tagged with.
-
#user_id ⇒ Object
ID of user that inbox belongs to.
-
#virtual_inbox ⇒ Object
Virtual inbox can receive email but will not send emails to real recipients.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_nullable ⇒ Object
List of attributes with nullable: true.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ 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?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ InboxDto
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.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ InboxDto
Initializes the object
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 192 193 194 195 196 197 198 |
# File 'lib/mailslurp_client/models/inbox_dto.rb', line 132 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `MailSlurpClient::InboxDto` initialize method" end # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.attribute_map.key?(k.to_sym)) fail ArgumentError, "`#{k}` is not a valid attribute in `MailSlurpClient::InboxDto`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect end h[k.to_sym] = v } if attributes.key?(:'id') self.id = attributes[:'id'] end if attributes.key?(:'user_id') self.user_id = attributes[:'user_id'] end if attributes.key?(:'created_at') self.created_at = attributes[:'created_at'] end if attributes.key?(:'name') self.name = attributes[:'name'] end if attributes.key?(:'domain_id') self.domain_id = attributes[:'domain_id'] end if attributes.key?(:'description') self.description = attributes[:'description'] end if attributes.key?(:'email_address') self.email_address = attributes[:'email_address'] end if attributes.key?(:'expires_at') self.expires_at = attributes[:'expires_at'] end if attributes.key?(:'favourite') self.favourite = attributes[:'favourite'] end if attributes.key?(:'tags') if (value = attributes[:'tags']).is_a?(Array) self. = value end end if attributes.key?(:'inbox_type') self.inbox_type = attributes[:'inbox_type'] end if attributes.key?(:'read_only') self.read_only = attributes[:'read_only'] end if attributes.key?(:'virtual_inbox') self.virtual_inbox = attributes[:'virtual_inbox'] end end |
Instance Attribute Details
#created_at ⇒ Object
When the inbox was created. Time stamps are in ISO DateTime Format `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` e.g. `2000-10-31T01:30:00.000-05:00`.
25 26 27 |
# File 'lib/mailslurp_client/models/inbox_dto.rb', line 25 def created_at @created_at end |
#description ⇒ Object
Description of an inbox for labelling and searching purposes
34 35 36 |
# File 'lib/mailslurp_client/models/inbox_dto.rb', line 34 def description @description end |
#domain_id ⇒ Object
ID of custom domain used by the inbox if any
31 32 33 |
# File 'lib/mailslurp_client/models/inbox_dto.rb', line 31 def domain_id @domain_id end |
#email_address ⇒ Object
The inbox's email address. Inbox projections and previews may not include the email address. To view the email address fetch the inbox entity directly. Send an email to this address and the inbox will receive and store it for you. Note the email address in MailSlurp match characters exactly and are case sensitive so `+123` additions are considered different addresses. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID.
37 38 39 |
# File 'lib/mailslurp_client/models/inbox_dto.rb', line 37 def email_address @email_address end |
#expires_at ⇒ Object
Inbox expiration time. When, if ever, the inbox should expire and be deleted. If null then this inbox is permanent and the emails in it won't be deleted. This is the default behavior unless expiration date is set. If an expiration date is set and the time is reached MailSlurp will expire the inbox and move it to an expired inbox entity. You can still access the emails belonging to it but it can no longer send or receive email.
40 41 42 |
# File 'lib/mailslurp_client/models/inbox_dto.rb', line 40 def expires_at @expires_at end |
#favourite ⇒ Object
Is the inbox a favorite inbox. Make an inbox a favorite is typically done in the dashboard for quick access or filtering
43 44 45 |
# File 'lib/mailslurp_client/models/inbox_dto.rb', line 43 def favourite @favourite end |
#id ⇒ Object
ID of the inbox. The ID is a UUID-V4 format string. Use the inboxId for calls to Inbox and Email Controller endpoints. See the emailAddress property for the email address or the inbox. To get emails in an inbox use the WaitFor and Inbox Controller methods `waitForLatestEmail` and `getEmails` methods respectively. Inboxes can be used with aliases to forward emails automatically.
19 20 21 |
# File 'lib/mailslurp_client/models/inbox_dto.rb', line 19 def id @id end |
#inbox_type ⇒ Object
Type of inbox. HTTP inboxes are faster and better for most cases. SMTP inboxes are more suited for public facing inbound messages (but cannot send).
49 50 51 |
# File 'lib/mailslurp_client/models/inbox_dto.rb', line 49 def inbox_type @inbox_type end |
#name ⇒ Object
Name of the inbox and used as the sender name when sending emails .Displayed in the dashboard for easier search
28 29 30 |
# File 'lib/mailslurp_client/models/inbox_dto.rb', line 28 def name @name end |
#read_only ⇒ Object
Is the inbox readOnly for the caller. Read only means can not be deleted or modified. This flag is present when using team accounts and shared inboxes.
52 53 54 |
# File 'lib/mailslurp_client/models/inbox_dto.rb', line 52 def read_only @read_only end |
#tags ⇒ Object
Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI.
46 47 48 |
# File 'lib/mailslurp_client/models/inbox_dto.rb', line 46 def @tags end |
#user_id ⇒ Object
ID of user that inbox belongs to
22 23 24 |
# File 'lib/mailslurp_client/models/inbox_dto.rb', line 22 def user_id @user_id end |
#virtual_inbox ⇒ Object
Virtual inbox can receive email but will not send emails to real recipients. Will save sent email record but never send an actual email. Perfect for testing mail server actions.
55 56 57 |
# File 'lib/mailslurp_client/models/inbox_dto.rb', line 55 def virtual_inbox @virtual_inbox end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 |
# File 'lib/mailslurp_client/models/inbox_dto.rb', line 80 def self.attribute_map { :'id' => :'id', :'user_id' => :'userId', :'created_at' => :'createdAt', :'name' => :'name', :'domain_id' => :'domainId', :'description' => :'description', :'email_address' => :'emailAddress', :'expires_at' => :'expiresAt', :'favourite' => :'favourite', :'tags' => :'tags', :'inbox_type' => :'inboxType', :'read_only' => :'readOnly', :'virtual_inbox' => :'virtualInbox' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
290 291 292 |
# File 'lib/mailslurp_client/models/inbox_dto.rb', line 290 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
118 119 120 121 122 123 124 125 126 127 128 |
# File 'lib/mailslurp_client/models/inbox_dto.rb', line 118 def self.openapi_nullable Set.new([ :'user_id', :'name', :'domain_id', :'description', :'expires_at', :'tags', :'inbox_type', ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 |
# File 'lib/mailslurp_client/models/inbox_dto.rb', line 99 def self.openapi_types { :'id' => :'String', :'user_id' => :'String', :'created_at' => :'DateTime', :'name' => :'String', :'domain_id' => :'String', :'description' => :'String', :'email_address' => :'String', :'expires_at' => :'String', :'favourite' => :'Boolean', :'tags' => :'Array<String>', :'inbox_type' => :'String', :'read_only' => :'Boolean', :'virtual_inbox' => :'Boolean' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 |
# File 'lib/mailslurp_client/models/inbox_dto.rb', line 257 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && user_id == o.user_id && created_at == o.created_at && name == o.name && domain_id == o.domain_id && description == o.description && email_address == o.email_address && expires_at == o.expires_at && favourite == o.favourite && == o. && inbox_type == o.inbox_type && read_only == o.read_only && virtual_inbox == o.virtual_inbox end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
318 319 320 321 322 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 |
# File 'lib/mailslurp_client/models/inbox_dto.rb', line 318 def _deserialize(type, value) case type.to_sym when :DateTime DateTime.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 MailSlurpClient.const_get(type).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
387 388 389 390 391 392 393 394 395 396 397 398 399 |
# File 'lib/mailslurp_client/models/inbox_dto.rb', line 387 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
297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 |
# File 'lib/mailslurp_client/models/inbox_dto.rb', line 297 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.openapi_types.each_pair do |key, type| if type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end |
#eql?(o) ⇒ Boolean
277 278 279 |
# File 'lib/mailslurp_client/models/inbox_dto.rb', line 277 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
283 284 285 |
# File 'lib/mailslurp_client/models/inbox_dto.rb', line 283 def hash [id, user_id, created_at, name, domain_id, description, email_address, expires_at, favourite, , inbox_type, read_only, virtual_inbox].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
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 |
# File 'lib/mailslurp_client/models/inbox_dto.rb', line 202 def list_invalid_properties invalid_properties = Array.new if @id.nil? invalid_properties.push('invalid value for "id", id cannot be nil.') end if @created_at.nil? invalid_properties.push('invalid value for "created_at", created_at cannot be nil.') end if @email_address.nil? invalid_properties.push('invalid value for "email_address", email_address cannot be nil.') end if @favourite.nil? invalid_properties.push('invalid value for "favourite", favourite cannot be nil.') end if @read_only.nil? invalid_properties.push('invalid value for "read_only", read_only cannot be nil.') end if @virtual_inbox.nil? invalid_properties.push('invalid value for "virtual_inbox", virtual_inbox cannot be nil.') end invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
363 364 365 |
# File 'lib/mailslurp_client/models/inbox_dto.rb', line 363 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
369 370 371 372 373 374 375 376 377 378 379 380 381 |
# File 'lib/mailslurp_client/models/inbox_dto.rb', line 369 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) if value.nil? is_nullable = self.class.openapi_nullable.include?(attr) next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) end hash[param] = _to_hash(value) end hash end |
#to_s ⇒ String
Returns the string representation of the object
357 358 359 |
# File 'lib/mailslurp_client/models/inbox_dto.rb', line 357 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
233 234 235 236 237 238 239 240 241 242 243 |
# File 'lib/mailslurp_client/models/inbox_dto.rb', line 233 def valid? return false if @id.nil? return false if @created_at.nil? return false if @email_address.nil? return false if @favourite.nil? inbox_type_validator = EnumAttributeValidator.new('String', ["HTTP_INBOX", "SMTP_INBOX"]) return false unless inbox_type_validator.valid?(@inbox_type) return false if @read_only.nil? return false if @virtual_inbox.nil? true end |