mailslurp_client 15.4.0 → 15.5.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (36) hide show
  1. checksums.yaml +4 -4
  2. data/lib/mailslurp_client/api/email_controller_api.rb +70 -0
  3. data/lib/mailslurp_client/api/inbox_controller_api.rb +127 -0
  4. data/lib/mailslurp_client/models/alias_projection.rb +27 -27
  5. data/lib/mailslurp_client/models/attachment_projection.rb +14 -14
  6. data/lib/mailslurp_client/models/create_inbox_dto.rb +1 -1
  7. data/lib/mailslurp_client/models/email_projection.rb +10 -10
  8. data/lib/mailslurp_client/models/imap_flag_operation_options.rb +261 -0
  9. data/lib/mailslurp_client/models/imap_smtp_access_details.rb +309 -0
  10. data/lib/mailslurp_client/models/page_alias.rb +19 -19
  11. data/lib/mailslurp_client/models/page_attachment_entity.rb +19 -19
  12. data/lib/mailslurp_client/models/page_bounced_email.rb +19 -19
  13. data/lib/mailslurp_client/models/page_bounced_recipients.rb +19 -19
  14. data/lib/mailslurp_client/models/page_contact_projection.rb +19 -19
  15. data/lib/mailslurp_client/models/page_email_preview.rb +19 -19
  16. data/lib/mailslurp_client/models/page_email_projection.rb +19 -19
  17. data/lib/mailslurp_client/models/page_expired_inbox_record_projection.rb +19 -19
  18. data/lib/mailslurp_client/models/page_group_projection.rb +19 -19
  19. data/lib/mailslurp_client/models/page_inbox_forwarder_dto.rb +19 -19
  20. data/lib/mailslurp_client/models/page_inbox_projection.rb +19 -19
  21. data/lib/mailslurp_client/models/page_inbox_ruleset_dto.rb +19 -19
  22. data/lib/mailslurp_client/models/page_missed_email_projection.rb +19 -19
  23. data/lib/mailslurp_client/models/page_organization_inbox_projection.rb +19 -19
  24. data/lib/mailslurp_client/models/page_template_projection.rb +19 -19
  25. data/lib/mailslurp_client/models/page_thread_projection.rb +19 -19
  26. data/lib/mailslurp_client/models/page_tracking_pixel_projection.rb +19 -19
  27. data/lib/mailslurp_client/models/page_unknown_missed_email_projection.rb +19 -19
  28. data/lib/mailslurp_client/models/page_webhook_projection.rb +19 -19
  29. data/lib/mailslurp_client/models/page_webhook_result.rb +19 -19
  30. data/lib/mailslurp_client/models/send_smtp_envelope_options.rb +242 -0
  31. data/lib/mailslurp_client/models/template_projection.rb +15 -15
  32. data/lib/mailslurp_client/models/thread_projection.rb +15 -15
  33. data/lib/mailslurp_client/models/tracking_pixel_projection.rb +10 -10
  34. data/lib/mailslurp_client/version.rb +1 -1
  35. data/lib/mailslurp_client.rb +3 -0
  36. metadata +5 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: bf4a01971704062a8c0fc5c66e177cc1ff525f13010caa9676b35650e7a51763
4
- data.tar.gz: 1d8c3eccf5f2950001ea6f4b2f35520703b8f630b2f3724428c03ea91ecf68c4
3
+ metadata.gz: 0025e93c1ea051a036c283ea13400f9f3264a169aaa426d57d4f6a773084ff58
4
+ data.tar.gz: f02ad0898de31664e0f98f671636c2d4ae1a3be125155b76005a44ea4203afba
5
5
  SHA512:
6
- metadata.gz: df6322da1dcde97c72555421e1279aafaa70d374c3afbc3a8653debaae60f4c9b2e99c020d543acb355bf47a871dd917cae33b22db983bd2def73f6ebee32546
7
- data.tar.gz: f13859837c4d6702a62e26f05123c64f19679a12a93a4caba4fd6d1180fe2021a7c6587145ca5282b2098df35ed041a976b62d953770a7d1bc69caafdeb95ab9
6
+ metadata.gz: b183d0e4ddca5829ab295f4c8e0dac034eec294800f16d3d138dbbc4093e3d0e3a14fb3ece126c168765e5b80670bc6fd075356572c93dcf86dd3fb95d8a9a9b
7
+ data.tar.gz: 0d38552fe49aa707bb209f6da41a5ba199c37f73f905086659626999677f432141e95adb8222ce6bfa128d5e6610ed01e68e50f0500bd6c9fdcc4121f9f5801a
@@ -19,6 +19,76 @@ module MailSlurpClient
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
+ # Set IMAP flags associated with a message. Only supports '\\Seen' flag.
23
+ # Apply RFC3501 section-2.3.2 IMAP flag operations on an email
24
+ # @param email_id [String]
25
+ # @param imap_flag_operation_options [ImapFlagOperationOptions]
26
+ # @param [Hash] opts the optional parameters
27
+ # @return [EmailPreview]
28
+ def apply_imap_flag_operation(email_id, imap_flag_operation_options, opts = {})
29
+ data, _status_code, _headers = apply_imap_flag_operation_with_http_info(email_id, imap_flag_operation_options, opts)
30
+ data
31
+ end
32
+
33
+ # Set IMAP flags associated with a message. Only supports '\\Seen' flag.
34
+ # Apply RFC3501 section-2.3.2 IMAP flag operations on an email
35
+ # @param email_id [String]
36
+ # @param imap_flag_operation_options [ImapFlagOperationOptions]
37
+ # @param [Hash] opts the optional parameters
38
+ # @return [Array<(EmailPreview, Integer, Hash)>] EmailPreview data, response status code and response headers
39
+ def apply_imap_flag_operation_with_http_info(email_id, imap_flag_operation_options, opts = {})
40
+ if @api_client.config.debugging
41
+ @api_client.config.logger.debug 'Calling API: EmailControllerApi.apply_imap_flag_operation ...'
42
+ end
43
+ # verify the required parameter 'email_id' is set
44
+ if @api_client.config.client_side_validation && email_id.nil?
45
+ fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.apply_imap_flag_operation"
46
+ end
47
+ # verify the required parameter 'imap_flag_operation_options' is set
48
+ if @api_client.config.client_side_validation && imap_flag_operation_options.nil?
49
+ fail ArgumentError, "Missing the required parameter 'imap_flag_operation_options' when calling EmailControllerApi.apply_imap_flag_operation"
50
+ end
51
+ # resource path
52
+ local_var_path = '/emails/{emailId}/imap-flag-operation'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s))
53
+
54
+ # query parameters
55
+ query_params = opts[:query_params] || {}
56
+
57
+ # header parameters
58
+ header_params = opts[:header_params] || {}
59
+ # HTTP header 'Accept' (if needed)
60
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
61
+ # HTTP header 'Content-Type'
62
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
63
+
64
+ # form parameters
65
+ form_params = opts[:form_params] || {}
66
+
67
+ # http body (model)
68
+ post_body = opts[:body] || @api_client.object_to_http_body(imap_flag_operation_options)
69
+
70
+ # return_type
71
+ return_type = opts[:return_type] || 'EmailPreview'
72
+
73
+ # auth_names
74
+ auth_names = opts[:auth_names] || ['API_KEY']
75
+
76
+ new_options = opts.merge(
77
+ :header_params => header_params,
78
+ :query_params => query_params,
79
+ :form_params => form_params,
80
+ :body => post_body,
81
+ :auth_names => auth_names,
82
+ :return_type => return_type
83
+ )
84
+
85
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
86
+ if @api_client.config.debugging
87
+ @api_client.config.logger.debug "API called: EmailControllerApi#apply_imap_flag_operation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
88
+ end
89
+ return data, status_code, headers
90
+ end
91
+
22
92
  # Delete all emails in all inboxes.
23
93
  # Deletes all emails in your account. Be careful as emails cannot be recovered
24
94
  # @param [Hash] opts the optional parameters
@@ -721,6 +721,63 @@ module MailSlurpClient
721
721
  return data, status_code, headers
722
722
  end
723
723
 
724
+ # Get IMAP and SMTP access usernames and passwords
725
+ # @param [Hash] opts the optional parameters
726
+ # @option opts [String] :inbox_id Inbox ID
727
+ # @return [ImapSmtpAccessDetails]
728
+ def get_imap_smtp_access(opts = {})
729
+ data, _status_code, _headers = get_imap_smtp_access_with_http_info(opts)
730
+ data
731
+ end
732
+
733
+ # Get IMAP and SMTP access usernames and passwords
734
+ # @param [Hash] opts the optional parameters
735
+ # @option opts [String] :inbox_id Inbox ID
736
+ # @return [Array<(ImapSmtpAccessDetails, Integer, Hash)>] ImapSmtpAccessDetails data, response status code and response headers
737
+ def get_imap_smtp_access_with_http_info(opts = {})
738
+ if @api_client.config.debugging
739
+ @api_client.config.logger.debug 'Calling API: InboxControllerApi.get_imap_smtp_access ...'
740
+ end
741
+ # resource path
742
+ local_var_path = '/inboxes/imap-smtp-access'
743
+
744
+ # query parameters
745
+ query_params = opts[:query_params] || {}
746
+ query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
747
+
748
+ # header parameters
749
+ header_params = opts[:header_params] || {}
750
+ # HTTP header 'Accept' (if needed)
751
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
752
+
753
+ # form parameters
754
+ form_params = opts[:form_params] || {}
755
+
756
+ # http body (model)
757
+ post_body = opts[:body]
758
+
759
+ # return_type
760
+ return_type = opts[:return_type] || 'ImapSmtpAccessDetails'
761
+
762
+ # auth_names
763
+ auth_names = opts[:auth_names] || ['API_KEY']
764
+
765
+ new_options = opts.merge(
766
+ :header_params => header_params,
767
+ :query_params => query_params,
768
+ :form_params => form_params,
769
+ :body => post_body,
770
+ :auth_names => auth_names,
771
+ :return_type => return_type
772
+ )
773
+
774
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
775
+ if @api_client.config.debugging
776
+ @api_client.config.logger.debug "API called: InboxControllerApi#get_imap_smtp_access\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
777
+ end
778
+ return data, status_code, headers
779
+ end
780
+
724
781
  # Get Inbox. Returns properties of an inbox.
725
782
  # Returns an inbox's properties, including its email address and ID.
726
783
  # @param inbox_id [String]
@@ -1697,6 +1754,76 @@ module MailSlurpClient
1697
1754
  return data, status_code, headers
1698
1755
  end
1699
1756
 
1757
+ # Send email using an SMTP mail envelope and message body and return sent confirmation
1758
+ # Send email using an SMTP envelope containing RCPT TO, MAIL FROM, and a SMTP BODY.
1759
+ # @param inbox_id [String] ID of the inbox you want to send the email from
1760
+ # @param send_smtp_envelope_options [SendSMTPEnvelopeOptions]
1761
+ # @param [Hash] opts the optional parameters
1762
+ # @return [SentEmailDto]
1763
+ def send_smtp_envelope(inbox_id, send_smtp_envelope_options, opts = {})
1764
+ data, _status_code, _headers = send_smtp_envelope_with_http_info(inbox_id, send_smtp_envelope_options, opts)
1765
+ data
1766
+ end
1767
+
1768
+ # Send email using an SMTP mail envelope and message body and return sent confirmation
1769
+ # Send email using an SMTP envelope containing RCPT TO, MAIL FROM, and a SMTP BODY.
1770
+ # @param inbox_id [String] ID of the inbox you want to send the email from
1771
+ # @param send_smtp_envelope_options [SendSMTPEnvelopeOptions]
1772
+ # @param [Hash] opts the optional parameters
1773
+ # @return [Array<(SentEmailDto, Integer, Hash)>] SentEmailDto data, response status code and response headers
1774
+ def send_smtp_envelope_with_http_info(inbox_id, send_smtp_envelope_options, opts = {})
1775
+ if @api_client.config.debugging
1776
+ @api_client.config.logger.debug 'Calling API: InboxControllerApi.send_smtp_envelope ...'
1777
+ end
1778
+ # verify the required parameter 'inbox_id' is set
1779
+ if @api_client.config.client_side_validation && inbox_id.nil?
1780
+ fail ArgumentError, "Missing the required parameter 'inbox_id' when calling InboxControllerApi.send_smtp_envelope"
1781
+ end
1782
+ # verify the required parameter 'send_smtp_envelope_options' is set
1783
+ if @api_client.config.client_side_validation && send_smtp_envelope_options.nil?
1784
+ fail ArgumentError, "Missing the required parameter 'send_smtp_envelope_options' when calling InboxControllerApi.send_smtp_envelope"
1785
+ end
1786
+ # resource path
1787
+ local_var_path = '/inboxes/{inboxId}/smtp-envelope'.sub('{' + 'inboxId' + '}', CGI.escape(inbox_id.to_s))
1788
+
1789
+ # query parameters
1790
+ query_params = opts[:query_params] || {}
1791
+
1792
+ # header parameters
1793
+ header_params = opts[:header_params] || {}
1794
+ # HTTP header 'Accept' (if needed)
1795
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
1796
+ # HTTP header 'Content-Type'
1797
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1798
+
1799
+ # form parameters
1800
+ form_params = opts[:form_params] || {}
1801
+
1802
+ # http body (model)
1803
+ post_body = opts[:body] || @api_client.object_to_http_body(send_smtp_envelope_options)
1804
+
1805
+ # return_type
1806
+ return_type = opts[:return_type] || 'SentEmailDto'
1807
+
1808
+ # auth_names
1809
+ auth_names = opts[:auth_names] || ['API_KEY']
1810
+
1811
+ new_options = opts.merge(
1812
+ :header_params => header_params,
1813
+ :query_params => query_params,
1814
+ :form_params => form_params,
1815
+ :body => post_body,
1816
+ :auth_names => auth_names,
1817
+ :return_type => return_type
1818
+ )
1819
+
1820
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1821
+ if @api_client.config.debugging
1822
+ @api_client.config.logger.debug "API called: InboxControllerApi#send_smtp_envelope\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1823
+ end
1824
+ return data, status_code, headers
1825
+ end
1826
+
1700
1827
  # Send a test email to inbox
1701
1828
  # Send an inbox a test email to test email receiving is working
1702
1829
  # @param inbox_id [String]
@@ -19,29 +19,29 @@ module MailSlurpClient
19
19
 
20
20
  attr_accessor :id
21
21
 
22
- attr_accessor :inbox_id
23
-
24
22
  attr_accessor :user_id
25
23
 
26
24
  attr_accessor :email_address
27
25
 
28
- attr_accessor :created_at
26
+ attr_accessor :inbox_id
29
27
 
30
- attr_accessor :use_threads
28
+ attr_accessor :created_at
31
29
 
32
30
  attr_accessor :updated_at
33
31
 
32
+ attr_accessor :use_threads
33
+
34
34
  # Attribute mapping from ruby-style variable name to JSON key.
35
35
  def self.attribute_map
36
36
  {
37
37
  :'name' => :'name',
38
38
  :'id' => :'id',
39
- :'inbox_id' => :'inboxId',
40
39
  :'user_id' => :'userId',
41
40
  :'email_address' => :'emailAddress',
41
+ :'inbox_id' => :'inboxId',
42
42
  :'created_at' => :'createdAt',
43
- :'use_threads' => :'useThreads',
44
- :'updated_at' => :'updatedAt'
43
+ :'updated_at' => :'updatedAt',
44
+ :'use_threads' => :'useThreads'
45
45
  }
46
46
  end
47
47
 
@@ -50,12 +50,12 @@ module MailSlurpClient
50
50
  {
51
51
  :'name' => :'String',
52
52
  :'id' => :'String',
53
- :'inbox_id' => :'String',
54
53
  :'user_id' => :'String',
55
54
  :'email_address' => :'String',
55
+ :'inbox_id' => :'String',
56
56
  :'created_at' => :'DateTime',
57
- :'use_threads' => :'Boolean',
58
- :'updated_at' => :'DateTime'
57
+ :'updated_at' => :'DateTime',
58
+ :'use_threads' => :'Boolean'
59
59
  }
60
60
  end
61
61
 
@@ -88,10 +88,6 @@ module MailSlurpClient
88
88
  self.id = attributes[:'id']
89
89
  end
90
90
 
91
- if attributes.key?(:'inbox_id')
92
- self.inbox_id = attributes[:'inbox_id']
93
- end
94
-
95
91
  if attributes.key?(:'user_id')
96
92
  self.user_id = attributes[:'user_id']
97
93
  end
@@ -100,17 +96,21 @@ module MailSlurpClient
100
96
  self.email_address = attributes[:'email_address']
101
97
  end
102
98
 
103
- if attributes.key?(:'created_at')
104
- self.created_at = attributes[:'created_at']
99
+ if attributes.key?(:'inbox_id')
100
+ self.inbox_id = attributes[:'inbox_id']
105
101
  end
106
102
 
107
- if attributes.key?(:'use_threads')
108
- self.use_threads = attributes[:'use_threads']
103
+ if attributes.key?(:'created_at')
104
+ self.created_at = attributes[:'created_at']
109
105
  end
110
106
 
111
107
  if attributes.key?(:'updated_at')
112
108
  self.updated_at = attributes[:'updated_at']
113
109
  end
110
+
111
+ if attributes.key?(:'use_threads')
112
+ self.use_threads = attributes[:'use_threads']
113
+ end
114
114
  end
115
115
 
116
116
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -121,10 +121,6 @@ module MailSlurpClient
121
121
  invalid_properties.push('invalid value for "id", id cannot be nil.')
122
122
  end
123
123
 
124
- if @inbox_id.nil?
125
- invalid_properties.push('invalid value for "inbox_id", inbox_id cannot be nil.')
126
- end
127
-
128
124
  if @user_id.nil?
129
125
  invalid_properties.push('invalid value for "user_id", user_id cannot be nil.')
130
126
  end
@@ -133,6 +129,10 @@ module MailSlurpClient
133
129
  invalid_properties.push('invalid value for "email_address", email_address cannot be nil.')
134
130
  end
135
131
 
132
+ if @inbox_id.nil?
133
+ invalid_properties.push('invalid value for "inbox_id", inbox_id cannot be nil.')
134
+ end
135
+
136
136
  if @created_at.nil?
137
137
  invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
138
138
  end
@@ -148,9 +148,9 @@ module MailSlurpClient
148
148
  # @return true if the model is valid
149
149
  def valid?
150
150
  return false if @id.nil?
151
- return false if @inbox_id.nil?
152
151
  return false if @user_id.nil?
153
152
  return false if @email_address.nil?
153
+ return false if @inbox_id.nil?
154
154
  return false if @created_at.nil?
155
155
  return false if @updated_at.nil?
156
156
  true
@@ -163,12 +163,12 @@ module MailSlurpClient
163
163
  self.class == o.class &&
164
164
  name == o.name &&
165
165
  id == o.id &&
166
- inbox_id == o.inbox_id &&
167
166
  user_id == o.user_id &&
168
167
  email_address == o.email_address &&
168
+ inbox_id == o.inbox_id &&
169
169
  created_at == o.created_at &&
170
- use_threads == o.use_threads &&
171
- updated_at == o.updated_at
170
+ updated_at == o.updated_at &&
171
+ use_threads == o.use_threads
172
172
  end
173
173
 
174
174
  # @see the `==` method
@@ -180,7 +180,7 @@ module MailSlurpClient
180
180
  # Calculates hash code according to all attributes.
181
181
  # @return [Integer] Hash code
182
182
  def hash
183
- [name, id, inbox_id, user_id, email_address, created_at, use_threads, updated_at].hash
183
+ [name, id, user_id, email_address, inbox_id, created_at, updated_at, use_threads].hash
184
184
  end
185
185
 
186
186
  # Builds the object from hash
@@ -19,6 +19,9 @@ module MailSlurpClient
19
19
  # Content length of attachment in bytes
20
20
  attr_accessor :content_length
21
21
 
22
+ # Content type of attachment.
23
+ attr_accessor :content_type
24
+
22
25
  attr_accessor :user_id
23
26
 
24
27
  # Attachment ID
@@ -28,19 +31,16 @@ module MailSlurpClient
28
31
 
29
32
  attr_accessor :updated_at
30
33
 
31
- # Content type of attachment.
32
- attr_accessor :content_type
33
-
34
34
  # Attribute mapping from ruby-style variable name to JSON key.
35
35
  def self.attribute_map
36
36
  {
37
37
  :'name' => :'name',
38
38
  :'content_length' => :'contentLength',
39
+ :'content_type' => :'contentType',
39
40
  :'user_id' => :'userId',
40
41
  :'attachment_id' => :'attachmentId',
41
42
  :'created_at' => :'createdAt',
42
- :'updated_at' => :'updatedAt',
43
- :'content_type' => :'contentType'
43
+ :'updated_at' => :'updatedAt'
44
44
  }
45
45
  end
46
46
 
@@ -49,11 +49,11 @@ module MailSlurpClient
49
49
  {
50
50
  :'name' => :'String',
51
51
  :'content_length' => :'Integer',
52
+ :'content_type' => :'String',
52
53
  :'user_id' => :'String',
53
54
  :'attachment_id' => :'String',
54
55
  :'created_at' => :'DateTime',
55
- :'updated_at' => :'DateTime',
56
- :'content_type' => :'String'
56
+ :'updated_at' => :'DateTime'
57
57
  }
58
58
  end
59
59
 
@@ -86,6 +86,10 @@ module MailSlurpClient
86
86
  self.content_length = attributes[:'content_length']
87
87
  end
88
88
 
89
+ if attributes.key?(:'content_type')
90
+ self.content_type = attributes[:'content_type']
91
+ end
92
+
89
93
  if attributes.key?(:'user_id')
90
94
  self.user_id = attributes[:'user_id']
91
95
  end
@@ -101,10 +105,6 @@ module MailSlurpClient
101
105
  if attributes.key?(:'updated_at')
102
106
  self.updated_at = attributes[:'updated_at']
103
107
  end
104
-
105
- if attributes.key?(:'content_type')
106
- self.content_type = attributes[:'content_type']
107
- end
108
108
  end
109
109
 
110
110
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -147,11 +147,11 @@ module MailSlurpClient
147
147
  self.class == o.class &&
148
148
  name == o.name &&
149
149
  content_length == o.content_length &&
150
+ content_type == o.content_type &&
150
151
  user_id == o.user_id &&
151
152
  attachment_id == o.attachment_id &&
152
153
  created_at == o.created_at &&
153
- updated_at == o.updated_at &&
154
- content_type == o.content_type
154
+ updated_at == o.updated_at
155
155
  end
156
156
 
157
157
  # @see the `==` method
@@ -163,7 +163,7 @@ module MailSlurpClient
163
163
  # Calculates hash code according to all attributes.
164
164
  # @return [Integer] Hash code
165
165
  def hash
166
- [name, content_length, user_id, attachment_id, created_at, updated_at, content_type].hash
166
+ [name, content_length, content_type, user_id, attachment_id, created_at, updated_at].hash
167
167
  end
168
168
 
169
169
  # Builds the object from hash
@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.3.1
13
13
  require 'date'
14
14
 
15
15
  module MailSlurpClient
16
- # Options for creating an inbox. An inbox has a real email address that can send and receive emails. Inboxes can be permanent or expire at a given time. Inboxes are either `SMTP` or `HTTP` mailboxes. `SMTP` inboxes are receive only and processed by a mail server running at `mx.mailslurp.com` while `HTTP` inboxes can send and receive and are processed by AWS SES. Inboxes can use a custom email address (by verifying your own domain) or a randomly assigned email ending in either `mailslurp.com` or (if `useDomainPool` is enabled) ending in a similar domain such as `mailslurp.xyz` (selected at random).
16
+ # Options for creating an inbox. An inbox has a real email address that can send and receive emails. Inboxes can be permanent or expire at a given time. Inboxes are either `SMTP` or `HTTP` mailboxes. `SMTP` inboxes are processed by a mail server running at `mx.mailslurp.com` while `HTTP` inboxes are processed by AWS SES. Inboxes can use a custom email address (by verifying your own domain) or a randomly assigned email ending in either `mailslurp.com` or (if `useDomainPool` is enabled) ending in a similar domain such as `mailslurp.xyz` (selected at random).
17
17
  class CreateInboxDto
18
18
  # A custom email address to use with the inbox. Defaults to null. When null MailSlurp will assign a random email address to the inbox such as `123@mailslurp.com`. If you use the `useDomainPool` option when the email address is null it will generate an email address with a more varied domain ending such as `123@mailslurp.info` or `123@mailslurp.biz`. When a custom email address is provided the address is split into a domain and the domain is queried against your user. If you have created the domain in the MailSlurp dashboard and verified it you can use any email address that ends with the domain. Note domain types must match the inbox type - so `SMTP` inboxes will only work with `SMTP` type domains. Avoid `SMTP` inboxes if you need to send emails as they can only receive. Send an email to this address and the inbox will receive and store it for you. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID.
19
19
  attr_accessor :email_address
@@ -19,10 +19,10 @@ module MailSlurpClient
19
19
 
20
20
  attr_accessor :from
21
21
 
22
- attr_accessor :inbox_id
23
-
24
22
  attr_accessor :subject
25
23
 
24
+ attr_accessor :inbox_id
25
+
26
26
  attr_accessor :to
27
27
 
28
28
  attr_accessor :attachments
@@ -46,8 +46,8 @@ module MailSlurpClient
46
46
  {
47
47
  :'id' => :'id',
48
48
  :'from' => :'from',
49
- :'inbox_id' => :'inboxId',
50
49
  :'subject' => :'subject',
50
+ :'inbox_id' => :'inboxId',
51
51
  :'to' => :'to',
52
52
  :'attachments' => :'attachments',
53
53
  :'bcc' => :'bcc',
@@ -65,8 +65,8 @@ module MailSlurpClient
65
65
  {
66
66
  :'id' => :'String',
67
67
  :'from' => :'String',
68
- :'inbox_id' => :'String',
69
68
  :'subject' => :'String',
69
+ :'inbox_id' => :'String',
70
70
  :'to' => :'Array<String>',
71
71
  :'attachments' => :'Array<String>',
72
72
  :'bcc' => :'Array<String>',
@@ -108,14 +108,14 @@ module MailSlurpClient
108
108
  self.from = attributes[:'from']
109
109
  end
110
110
 
111
- if attributes.key?(:'inbox_id')
112
- self.inbox_id = attributes[:'inbox_id']
113
- end
114
-
115
111
  if attributes.key?(:'subject')
116
112
  self.subject = attributes[:'subject']
117
113
  end
118
114
 
115
+ if attributes.key?(:'inbox_id')
116
+ self.inbox_id = attributes[:'inbox_id']
117
+ end
118
+
119
119
  if attributes.key?(:'to')
120
120
  if (value = attributes[:'to']).is_a?(Array)
121
121
  self.to = value
@@ -201,8 +201,8 @@ module MailSlurpClient
201
201
  self.class == o.class &&
202
202
  id == o.id &&
203
203
  from == o.from &&
204
- inbox_id == o.inbox_id &&
205
204
  subject == o.subject &&
205
+ inbox_id == o.inbox_id &&
206
206
  to == o.to &&
207
207
  attachments == o.attachments &&
208
208
  bcc == o.bcc &&
@@ -223,7 +223,7 @@ module MailSlurpClient
223
223
  # Calculates hash code according to all attributes.
224
224
  # @return [Integer] Hash code
225
225
  def hash
226
- [id, from, inbox_id, subject, to, attachments, bcc, cc, created_at, team_access, read, body_md5_hash, body_excerpt].hash
226
+ [id, from, subject, inbox_id, to, attachments, bcc, cc, created_at, team_access, read, body_md5_hash, body_excerpt].hash
227
227
  end
228
228
 
229
229
  # Builds the object from hash