Class: MailSlurpClient::InboxControllerApi
- Inherits:
-
Object
- Object
- MailSlurpClient::InboxControllerApi
- Defined in:
- lib/mailslurp_client/api/inbox_controller_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#cancel_scheduled_job(job_id, opts = {}) ⇒ ScheduledJobDto
Cancel a scheduled email job Get a scheduled email job and cancel it.
-
#cancel_scheduled_job_with_http_info(job_id, opts = {}) ⇒ Array<(ScheduledJobDto, Integer, Hash)>
Cancel a scheduled email job Get a scheduled email job and cancel it.
-
#create_inbox(opts = {}) ⇒ InboxDto
Create an inbox email address.
-
#create_inbox_ruleset(inbox_id, create_inbox_ruleset_options, opts = {}) ⇒ InboxRulesetDto
Create an inbox ruleset Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving.
-
#create_inbox_ruleset_with_http_info(inbox_id, create_inbox_ruleset_options, opts = {}) ⇒ Array<(InboxRulesetDto, Integer, Hash)>
Create an inbox ruleset Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving.
-
#create_inbox_with_defaults(opts = {}) ⇒ InboxDto
Create an inbox with default options.
-
#create_inbox_with_defaults_with_http_info(opts = {}) ⇒ Array<(InboxDto, Integer, Hash)>
Create an inbox with default options.
-
#create_inbox_with_http_info(opts = {}) ⇒ Array<(InboxDto, Integer, Hash)>
Create an inbox email address.
-
#create_inbox_with_options(create_inbox_dto, opts = {}) ⇒ InboxDto
Create an inbox with options.
-
#create_inbox_with_options_with_http_info(create_inbox_dto, opts = {}) ⇒ Array<(InboxDto, Integer, Hash)>
Create an inbox with options.
-
#delete_all_inbox_emails(inbox_id, opts = {}) ⇒ nil
Delete all emails in a given inboxes.
-
#delete_all_inbox_emails_with_http_info(inbox_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete all emails in a given inboxes.
-
#delete_all_inboxes(opts = {}) ⇒ nil
Delete all inboxes Permanently delete all inboxes and associated email addresses.
-
#delete_all_inboxes_by_description(description, opts = {}) ⇒ nil
Delete inboxes by description Permanently delete all inboxes by description.
-
#delete_all_inboxes_by_description_with_http_info(description, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete inboxes by description Permanently delete all inboxes by description.
-
#delete_all_inboxes_by_name(name, opts = {}) ⇒ nil
Delete inboxes by name Permanently delete all inboxes by name.
-
#delete_all_inboxes_by_name_with_http_info(name, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete inboxes by name Permanently delete all inboxes by name.
-
#delete_all_inboxes_by_tag(tag, opts = {}) ⇒ nil
Delete inboxes by tag Permanently delete all inboxes by tag.
-
#delete_all_inboxes_by_tag_with_http_info(tag, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete inboxes by tag Permanently delete all inboxes by tag.
-
#delete_all_inboxes_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete all inboxes Permanently delete all inboxes and associated email addresses.
-
#delete_inbox(inbox_id, opts = {}) ⇒ nil
Delete inbox Permanently delete an inbox and associated email address as well as all emails within the given inbox.
-
#delete_inbox_with_http_info(inbox_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete inbox Permanently delete an inbox and associated email address as well as all emails within the given inbox.
-
#does_inbox_exist(email_address, opts = {}) ⇒ InboxExistsDto
Does inbox exist Check if inboxes exist by email address.
-
#does_inbox_exist_with_http_info(email_address, opts = {}) ⇒ Array<(InboxExistsDto, Integer, Hash)>
Does inbox exist Check if inboxes exist by email address.
-
#flush_expired(opts = {}) ⇒ FlushExpiredInboxesResult
Remove expired inboxes Remove any expired inboxes for your account (instead of waiting for scheduled removal on server).
-
#flush_expired_with_http_info(opts = {}) ⇒ Array<(FlushExpiredInboxesResult, Integer, Hash)>
Remove expired inboxes Remove any expired inboxes for your account (instead of waiting for scheduled removal on server).
-
#get_all_inboxes(opts = {}) ⇒ PageInboxProjection
List All Inboxes Paginated List inboxes in paginated form.
-
#get_all_inboxes_with_http_info(opts = {}) ⇒ Array<(PageInboxProjection, Integer, Hash)>
List All Inboxes Paginated List inboxes in paginated form.
-
#get_all_scheduled_jobs(opts = {}) ⇒ PageScheduledJobs
Get all scheduled email sending jobs for account Schedule sending of emails using scheduled jobs.
-
#get_all_scheduled_jobs_with_http_info(opts = {}) ⇒ Array<(PageScheduledJobs, Integer, Hash)>
Get all scheduled email sending jobs for account Schedule sending of emails using scheduled jobs.
-
#get_delivery_statuses_by_inbox_id(inbox_id, opts = {}) ⇒ PageDeliveryStatus
Get all email delivery statuses for an inbox.
-
#get_delivery_statuses_by_inbox_id_with_http_info(inbox_id, opts = {}) ⇒ Array<(PageDeliveryStatus, Integer, Hash)>
Get all email delivery statuses for an inbox.
-
#get_emails(inbox_id, opts = {}) ⇒ Array<EmailPreview>
Get emails in an Inbox.
-
#get_emails_with_http_info(inbox_id, opts = {}) ⇒ Array<(Array<EmailPreview>, Integer, Hash)>
Get emails in an Inbox.
-
#get_imap_smtp_access(opts = {}) ⇒ ImapSmtpAccessDetails
Get IMAP and SMTP access usernames and passwords.
-
#get_imap_smtp_access_with_http_info(opts = {}) ⇒ Array<(ImapSmtpAccessDetails, Integer, Hash)>
Get IMAP and SMTP access usernames and passwords.
-
#get_inbox(inbox_id, opts = {}) ⇒ InboxDto
Get Inbox.
-
#get_inbox_by_email_address(email_address, opts = {}) ⇒ InboxByEmailAddressResult
Search for an inbox with the provided email address Get a inbox result by email address.
-
#get_inbox_by_email_address_with_http_info(email_address, opts = {}) ⇒ Array<(InboxByEmailAddressResult, Integer, Hash)>
Search for an inbox with the provided email address Get a inbox result by email address.
-
#get_inbox_by_name(name, opts = {}) ⇒ InboxByNameResult
Search for an inbox with the given name Get a inbox result by name.
-
#get_inbox_by_name_with_http_info(name, opts = {}) ⇒ Array<(InboxByNameResult, Integer, Hash)>
Search for an inbox with the given name Get a inbox result by name.
-
#get_inbox_count(opts = {}) ⇒ CountDto
Get total inbox count.
-
#get_inbox_count_with_http_info(opts = {}) ⇒ Array<(CountDto, Integer, Hash)>
Get total inbox count.
-
#get_inbox_email_count(inbox_id, opts = {}) ⇒ CountDto
Get email count in inbox.
-
#get_inbox_email_count_with_http_info(inbox_id, opts = {}) ⇒ Array<(CountDto, Integer, Hash)>
Get email count in inbox.
-
#get_inbox_emails_paginated(inbox_id, opts = {}) ⇒ PageEmailPreview
Get inbox emails paginated Get a paginated list of emails in an inbox.
-
#get_inbox_emails_paginated_with_http_info(inbox_id, opts = {}) ⇒ Array<(PageEmailPreview, Integer, Hash)>
Get inbox emails paginated Get a paginated list of emails in an inbox.
-
#get_inbox_ids(opts = {}) ⇒ InboxIdsResult
Get all inbox IDs Get list of inbox IDs.
-
#get_inbox_ids_with_http_info(opts = {}) ⇒ Array<(InboxIdsResult, Integer, Hash)>
Get all inbox IDs Get list of inbox IDs.
-
#get_inbox_sent_emails(inbox_id, opts = {}) ⇒ PageSentEmailProjection
Get Inbox Sent Emails Returns an inbox's sent email receipts.
-
#get_inbox_sent_emails_with_http_info(inbox_id, opts = {}) ⇒ Array<(PageSentEmailProjection, Integer, Hash)>
Get Inbox Sent Emails Returns an inbox's sent email receipts.
-
#get_inbox_tags(opts = {}) ⇒ Array<String>
Get inbox tags Get all inbox tags.
-
#get_inbox_tags_with_http_info(opts = {}) ⇒ Array<(Array<String>, Integer, Hash)>
Get inbox tags Get all inbox tags.
-
#get_inbox_with_http_info(inbox_id, opts = {}) ⇒ Array<(InboxDto, Integer, Hash)>
Get Inbox.
-
#get_inboxes(opts = {}) ⇒ Array<InboxDto>
List Inboxes and email addresses List the inboxes you have created.
-
#get_inboxes_with_http_info(opts = {}) ⇒ Array<(Array<InboxDto>, Integer, Hash)>
List Inboxes and email addresses List the inboxes you have created.
-
#get_latest_email_in_inbox(inbox_id, timeout_millis, opts = {}) ⇒ Email
Get latest email in an inbox.
-
#get_latest_email_in_inbox_with_http_info(inbox_id, timeout_millis, opts = {}) ⇒ Array<(Email, Integer, Hash)>
Get latest email in an inbox.
-
#get_organization_inboxes(opts = {}) ⇒ PageOrganizationInboxProjection
List Organization Inboxes Paginated List organization inboxes in paginated form.
-
#get_organization_inboxes_with_http_info(opts = {}) ⇒ Array<(PageOrganizationInboxProjection, Integer, Hash)>
List Organization Inboxes Paginated List organization inboxes in paginated form.
-
#get_scheduled_job(job_id, opts = {}) ⇒ ScheduledJobDto
Get a scheduled email job Get a scheduled email job details.
-
#get_scheduled_job_with_http_info(job_id, opts = {}) ⇒ Array<(ScheduledJobDto, Integer, Hash)>
Get a scheduled email job Get a scheduled email job details.
-
#get_scheduled_jobs_by_inbox_id(inbox_id, opts = {}) ⇒ PageScheduledJobs
Get all scheduled email sending jobs for the inbox Schedule sending of emails using scheduled jobs.
-
#get_scheduled_jobs_by_inbox_id_with_http_info(inbox_id, opts = {}) ⇒ Array<(PageScheduledJobs, Integer, Hash)>
Get all scheduled email sending jobs for the inbox Schedule sending of emails using scheduled jobs.
-
#initialize(api_client = ApiClient.default) ⇒ InboxControllerApi
constructor
A new instance of InboxControllerApi.
-
#list_inbox_rulesets(inbox_id, opts = {}) ⇒ PageInboxRulesetDto
List inbox rulesets List all rulesets attached to an inbox.
-
#list_inbox_rulesets_with_http_info(inbox_id, opts = {}) ⇒ Array<(PageInboxRulesetDto, Integer, Hash)>
List inbox rulesets List all rulesets attached to an inbox.
-
#list_inbox_tracking_pixels(inbox_id, opts = {}) ⇒ PageTrackingPixelProjection
List inbox tracking pixels List all tracking pixels sent from an inbox.
-
#list_inbox_tracking_pixels_with_http_info(inbox_id, opts = {}) ⇒ Array<(PageTrackingPixelProjection, Integer, Hash)>
List inbox tracking pixels List all tracking pixels sent from an inbox.
-
#send_email(inbox_id, send_email_options, opts = {}) ⇒ nil
Send Email Send an email from an inbox's email address.
-
#send_email_and_confirm(inbox_id, send_email_options, opts = {}) ⇒ SentEmailDto
Send email and return sent confirmation Sister method for standard `sendEmail` method with the benefit of returning a `SentEmail` entity confirming the successful sending of the email with a link to the sent object created for it.
-
#send_email_and_confirm_with_http_info(inbox_id, send_email_options, opts = {}) ⇒ Array<(SentEmailDto, Integer, Hash)>
Send email and return sent confirmation Sister method for standard `sendEmail` method with the benefit of returning a `SentEmail` entity confirming the successful sending of the email with a link to the sent object created for it.
-
#send_email_with_http_info(inbox_id, send_email_options, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Send Email Send an email from an inbox's email address.
-
#send_email_with_queue(inbox_id, validate_before_enqueue, send_email_options, opts = {}) ⇒ nil
Send email with queue Send an email using a queue.
-
#send_email_with_queue_with_http_info(inbox_id, validate_before_enqueue, send_email_options, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Send email with queue Send an email using a queue.
-
#send_smtp_envelope(inbox_id, send_smtp_envelope_options, opts = {}) ⇒ SentEmailDto
Send email using an SMTP mail envelope and message body and return sent confirmation Send email using an SMTP envelope containing RCPT TO, MAIL FROM, and a SMTP BODY.
-
#send_smtp_envelope_with_http_info(inbox_id, send_smtp_envelope_options, opts = {}) ⇒ Array<(SentEmailDto, Integer, Hash)>
Send email using an SMTP mail envelope and message body and return sent confirmation Send email using an SMTP envelope containing RCPT TO, MAIL FROM, and a SMTP BODY.
-
#send_test_email(inbox_id, opts = {}) ⇒ nil
Send a test email to inbox Send an inbox a test email to test email receiving is working.
-
#send_test_email_with_http_info(inbox_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Send a test email to inbox Send an inbox a test email to test email receiving is working.
-
#send_with_schedule(inbox_id, send_email_options, opts = {}) ⇒ ScheduledJobDto
Send email with with delay or schedule Send an email using a delay.
-
#send_with_schedule_with_http_info(inbox_id, send_email_options, opts = {}) ⇒ Array<(ScheduledJobDto, Integer, Hash)>
Send email with with delay or schedule Send an email using a delay.
-
#set_inbox_favourited(inbox_id, set_inbox_favourited_options, opts = {}) ⇒ InboxDto
Set inbox favourited state Set and return new favourite state for an inbox.
-
#set_inbox_favourited_with_http_info(inbox_id, set_inbox_favourited_options, opts = {}) ⇒ Array<(InboxDto, Integer, Hash)>
Set inbox favourited state Set and return new favourite state for an inbox.
-
#update_inbox(inbox_id, update_inbox_options, opts = {}) ⇒ InboxDto
Update Inbox.
-
#update_inbox_with_http_info(inbox_id, update_inbox_options, opts = {}) ⇒ Array<(InboxDto, Integer, Hash)>
Update Inbox.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ InboxControllerApi
Returns a new instance of InboxControllerApi.
19 20 21 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
17 18 19 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#cancel_scheduled_job(job_id, opts = {}) ⇒ ScheduledJobDto
Cancel a scheduled email job Get a scheduled email job and cancel it. Will fail if status of job is already cancelled, failed, or complete.
27 28 29 30 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 27 def cancel_scheduled_job(job_id, opts = {}) data, _status_code, _headers = cancel_scheduled_job_with_http_info(job_id, opts) data end |
#cancel_scheduled_job_with_http_info(job_id, opts = {}) ⇒ Array<(ScheduledJobDto, Integer, Hash)>
Cancel a scheduled email job Get a scheduled email job and cancel it. Will fail if status of job is already cancelled, failed, or complete.
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 37 def cancel_scheduled_job_with_http_info(job_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: InboxControllerApi.cancel_scheduled_job ...' end # verify the required parameter 'job_id' is set if @api_client.config.client_side_validation && job_id.nil? fail ArgumentError, "Missing the required parameter 'job_id' when calling InboxControllerApi.cancel_scheduled_job" end # resource path local_var_path = '/inboxes/scheduled-jobs/{jobId}'.sub('{' + 'jobId' + '}', CGI.escape(job_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['*/*']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'ScheduledJobDto' # auth_names auth_names = opts[:auth_names] || ['API_KEY'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: InboxControllerApi#cancel_scheduled_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create_inbox(opts = {}) ⇒ InboxDto
Create an inbox email address. An inbox has a real email address and can send and receive emails. Inboxes can be either `SMTP` or `HTTP` inboxes. Create a new inbox and with a randomized email address to send and receive from. Pass emailAddress parameter if you wish to use a specific email address. Creating an inbox is required before sending or receiving emails. If writing tests it is recommended that you create a new inbox during each test method so that it is unique and empty.
102 103 104 105 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 102 def create_inbox(opts = {}) data, _status_code, _headers = create_inbox_with_http_info(opts) data end |
#create_inbox_ruleset(inbox_id, create_inbox_ruleset_options, opts = {}) ⇒ InboxRulesetDto
Create an inbox ruleset Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving
192 193 194 195 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 192 def create_inbox_ruleset(inbox_id, , opts = {}) data, _status_code, _headers = create_inbox_ruleset_with_http_info(inbox_id, , opts) data end |
#create_inbox_ruleset_with_http_info(inbox_id, create_inbox_ruleset_options, opts = {}) ⇒ Array<(InboxRulesetDto, Integer, Hash)>
Create an inbox ruleset Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving
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 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 203 def create_inbox_ruleset_with_http_info(inbox_id, , opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: InboxControllerApi.create_inbox_ruleset ...' end # verify the required parameter 'inbox_id' is set if @api_client.config.client_side_validation && inbox_id.nil? fail ArgumentError, "Missing the required parameter 'inbox_id' when calling InboxControllerApi.create_inbox_ruleset" end # verify the required parameter 'create_inbox_ruleset_options' is set if @api_client.config.client_side_validation && .nil? fail ArgumentError, "Missing the required parameter 'create_inbox_ruleset_options' when calling InboxControllerApi.create_inbox_ruleset" end # resource path local_var_path = '/inboxes/{inboxId}/rulesets'.sub('{' + 'inboxId' + '}', CGI.escape(inbox_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['*/*']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body() # return_type return_type = opts[:return_type] || 'InboxRulesetDto' # auth_names auth_names = opts[:auth_names] || ['API_KEY'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: InboxControllerApi#create_inbox_ruleset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create_inbox_with_defaults(opts = {}) ⇒ InboxDto
Create an inbox with default options. Uses MailSlurp domain pool address and is private.
259 260 261 262 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 259 def create_inbox_with_defaults(opts = {}) data, _status_code, _headers = create_inbox_with_defaults_with_http_info(opts) data end |
#create_inbox_with_defaults_with_http_info(opts = {}) ⇒ Array<(InboxDto, Integer, Hash)>
Create an inbox with default options. Uses MailSlurp domain pool address and is private.
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 296 297 298 299 300 301 302 303 304 305 306 307 308 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 267 def create_inbox_with_defaults_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: InboxControllerApi.create_inbox_with_defaults ...' end # resource path local_var_path = '/inboxes/withDefaults' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['*/*']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'InboxDto' # auth_names auth_names = opts[:auth_names] || ['API_KEY'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: InboxControllerApi#create_inbox_with_defaults\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create_inbox_with_http_info(opts = {}) ⇒ Array<(InboxDto, Integer, Hash)>
Create an inbox email address. An inbox has a real email address and can send and receive emails. Inboxes can be either `SMTP` or `HTTP` inboxes. Create a new inbox and with a randomized email address to send and receive from. Pass emailAddress parameter if you wish to use a specific email address. Creating an inbox is required before sending or receiving emails. If writing tests it is recommended that you create a new inbox during each test method so that it is unique and empty.
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 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 125 def create_inbox_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: InboxControllerApi.create_inbox ...' end allowable_values = ["HTTP_INBOX", "SMTP_INBOX"] if @api_client.config.client_side_validation && opts[:'inbox_type'] && !allowable_values.include?(opts[:'inbox_type']) fail ArgumentError, "invalid value for \"inbox_type\", must be one of #{allowable_values}" end # resource path local_var_path = '/inboxes' # query parameters query_params = opts[:query_params] || {} query_params[:'emailAddress'] = opts[:'email_address'] if !opts[:'email_address'].nil? query_params[:'tags'] = @api_client.build_collection_param(opts[:'tags'], :multi) if !opts[:'tags'].nil? query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil? query_params[:'description'] = opts[:'description'] if !opts[:'description'].nil? query_params[:'useDomainPool'] = opts[:'use_domain_pool'] if !opts[:'use_domain_pool'].nil? query_params[:'favourite'] = opts[:'favourite'] if !opts[:'favourite'].nil? query_params[:'expiresAt'] = opts[:'expires_at'] if !opts[:'expires_at'].nil? query_params[:'expiresIn'] = opts[:'expires_in'] if !opts[:'expires_in'].nil? query_params[:'allowTeamAccess'] = opts[:'allow_team_access'] if !opts[:'allow_team_access'].nil? query_params[:'inboxType'] = opts[:'inbox_type'] if !opts[:'inbox_type'].nil? query_params[:'virtualInbox'] = opts[:'virtual_inbox'] if !opts[:'virtual_inbox'].nil? query_params[:'useShortAddress'] = opts[:'use_short_address'] if !opts[:'use_short_address'].nil? query_params[:'domainId'] = opts[:'domain_id'] if !opts[:'domain_id'].nil? query_params[:'domainName'] = opts[:'domain_name'] if !opts[:'domain_name'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['*/*']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'InboxDto' # auth_names auth_names = opts[:auth_names] || ['API_KEY'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: InboxControllerApi#create_inbox\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create_inbox_with_options(create_inbox_dto, opts = {}) ⇒ InboxDto
Create an inbox with options. Extended options for inbox creation. Additional endpoint that allows inbox creation with request body options. Can be more flexible that other methods for some clients.
315 316 317 318 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 315 def (create_inbox_dto, opts = {}) data, _status_code, _headers = (create_inbox_dto, opts) data end |
#create_inbox_with_options_with_http_info(create_inbox_dto, opts = {}) ⇒ Array<(InboxDto, Integer, Hash)>
Create an inbox with options. Extended options for inbox creation. Additional endpoint that allows inbox creation with request body options. Can be more flexible that other methods for some clients.
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 361 362 363 364 365 366 367 368 369 370 371 372 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 325 def (create_inbox_dto, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: InboxControllerApi.create_inbox_with_options ...' end # verify the required parameter 'create_inbox_dto' is set if @api_client.config.client_side_validation && create_inbox_dto.nil? fail ArgumentError, "Missing the required parameter 'create_inbox_dto' when calling InboxControllerApi.create_inbox_with_options" end # resource path local_var_path = '/inboxes/withOptions' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['*/*']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(create_inbox_dto) # return_type return_type = opts[:return_type] || 'InboxDto' # auth_names auth_names = opts[:auth_names] || ['API_KEY'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: InboxControllerApi#create_inbox_with_options\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_all_inbox_emails(inbox_id, opts = {}) ⇒ nil
Delete all emails in a given inboxes. Deletes all emails in an inbox. Be careful as emails cannot be recovered
379 380 381 382 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 379 def delete_all_inbox_emails(inbox_id, opts = {}) delete_all_inbox_emails_with_http_info(inbox_id, opts) nil end |
#delete_all_inbox_emails_with_http_info(inbox_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete all emails in a given inboxes. Deletes all emails in an inbox. Be careful as emails cannot be recovered
389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 389 def delete_all_inbox_emails_with_http_info(inbox_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: InboxControllerApi.delete_all_inbox_emails ...' end # verify the required parameter 'inbox_id' is set if @api_client.config.client_side_validation && inbox_id.nil? fail ArgumentError, "Missing the required parameter 'inbox_id' when calling InboxControllerApi.delete_all_inbox_emails" end # resource path local_var_path = '/inboxes/{inboxId}/deleteAllInboxEmails'.sub('{' + 'inboxId' + '}', CGI.escape(inbox_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] # auth_names auth_names = opts[:auth_names] || ['API_KEY'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: InboxControllerApi#delete_all_inbox_emails\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_all_inboxes(opts = {}) ⇒ nil
Delete all inboxes Permanently delete all inboxes and associated email addresses. This will also delete all emails within the inboxes. Be careful as inboxes cannot be recovered once deleted. Note: deleting inboxes will not impact your usage limits. Monthly inbox creation limits are based on how many inboxes were created in the last 30 days, not how many inboxes you currently have.
438 439 440 441 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 438 def delete_all_inboxes(opts = {}) delete_all_inboxes_with_http_info(opts) nil end |
#delete_all_inboxes_by_description(description, opts = {}) ⇒ nil
Delete inboxes by description Permanently delete all inboxes by description
493 494 495 496 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 493 def delete_all_inboxes_by_description(description, opts = {}) delete_all_inboxes_by_description_with_http_info(description, opts) nil end |
#delete_all_inboxes_by_description_with_http_info(description, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete inboxes by description Permanently delete all inboxes by description
503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 503 def delete_all_inboxes_by_description_with_http_info(description, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: InboxControllerApi.delete_all_inboxes_by_description ...' end # verify the required parameter 'description' is set if @api_client.config.client_side_validation && description.nil? fail ArgumentError, "Missing the required parameter 'description' when calling InboxControllerApi.delete_all_inboxes_by_description" end # resource path local_var_path = '/inboxes/by-description' # query parameters query_params = opts[:query_params] || {} query_params[:'description'] = description # header parameters header_params = opts[:header_params] || {} # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] # auth_names auth_names = opts[:auth_names] || ['API_KEY'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: InboxControllerApi#delete_all_inboxes_by_description\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_all_inboxes_by_name(name, opts = {}) ⇒ nil
Delete inboxes by name Permanently delete all inboxes by name
554 555 556 557 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 554 def delete_all_inboxes_by_name(name, opts = {}) delete_all_inboxes_by_name_with_http_info(name, opts) nil end |
#delete_all_inboxes_by_name_with_http_info(name, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete inboxes by name Permanently delete all inboxes by name
564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 564 def delete_all_inboxes_by_name_with_http_info(name, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: InboxControllerApi.delete_all_inboxes_by_name ...' end # verify the required parameter 'name' is set if @api_client.config.client_side_validation && name.nil? fail ArgumentError, "Missing the required parameter 'name' when calling InboxControllerApi.delete_all_inboxes_by_name" end # resource path local_var_path = '/inboxes/by-name' # query parameters query_params = opts[:query_params] || {} query_params[:'name'] = name # header parameters header_params = opts[:header_params] || {} # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] # auth_names auth_names = opts[:auth_names] || ['API_KEY'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: InboxControllerApi#delete_all_inboxes_by_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_all_inboxes_by_tag(tag, opts = {}) ⇒ nil
Delete inboxes by tag Permanently delete all inboxes by tag
615 616 617 618 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 615 def delete_all_inboxes_by_tag(tag, opts = {}) delete_all_inboxes_by_tag_with_http_info(tag, opts) nil end |
#delete_all_inboxes_by_tag_with_http_info(tag, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete inboxes by tag Permanently delete all inboxes by tag
625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 625 def delete_all_inboxes_by_tag_with_http_info(tag, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: InboxControllerApi.delete_all_inboxes_by_tag ...' end # verify the required parameter 'tag' is set if @api_client.config.client_side_validation && tag.nil? fail ArgumentError, "Missing the required parameter 'tag' when calling InboxControllerApi.delete_all_inboxes_by_tag" end # resource path local_var_path = '/inboxes/by-tag' # query parameters query_params = opts[:query_params] || {} query_params[:'tag'] = tag # header parameters header_params = opts[:header_params] || {} # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] # auth_names auth_names = opts[:auth_names] || ['API_KEY'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: InboxControllerApi#delete_all_inboxes_by_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_all_inboxes_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete all inboxes Permanently delete all inboxes and associated email addresses. This will also delete all emails within the inboxes. Be careful as inboxes cannot be recovered once deleted. Note: deleting inboxes will not impact your usage limits. Monthly inbox creation limits are based on how many inboxes were created in the last 30 days, not how many inboxes you currently have.
447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 447 def delete_all_inboxes_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: InboxControllerApi.delete_all_inboxes ...' end # resource path local_var_path = '/inboxes' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] # auth_names auth_names = opts[:auth_names] || ['API_KEY'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: InboxControllerApi#delete_all_inboxes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_inbox(inbox_id, opts = {}) ⇒ nil
Delete inbox Permanently delete an inbox and associated email address as well as all emails within the given inbox. This action cannot be undone. Note: deleting an inbox will not affect your account usage. Monthly inbox usage is based on how many inboxes you create within 30 days, not how many exist at time of request.
676 677 678 679 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 676 def delete_inbox(inbox_id, opts = {}) delete_inbox_with_http_info(inbox_id, opts) nil end |
#delete_inbox_with_http_info(inbox_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete inbox Permanently delete an inbox and associated email address as well as all emails within the given inbox. This action cannot be undone. Note: deleting an inbox will not affect your account usage. Monthly inbox usage is based on how many inboxes you create within 30 days, not how many exist at time of request.
686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 686 def delete_inbox_with_http_info(inbox_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: InboxControllerApi.delete_inbox ...' end # verify the required parameter 'inbox_id' is set if @api_client.config.client_side_validation && inbox_id.nil? fail ArgumentError, "Missing the required parameter 'inbox_id' when calling InboxControllerApi.delete_inbox" end # resource path local_var_path = '/inboxes/{inboxId}'.sub('{' + 'inboxId' + '}', CGI.escape(inbox_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] # auth_names auth_names = opts[:auth_names] || ['API_KEY'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: InboxControllerApi#delete_inbox\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#does_inbox_exist(email_address, opts = {}) ⇒ InboxExistsDto
Does inbox exist Check if inboxes exist by email address. Useful if you are sending emails to mailslurp addresses
737 738 739 740 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 737 def does_inbox_exist(email_address, opts = {}) data, _status_code, _headers = does_inbox_exist_with_http_info(email_address, opts) data end |
#does_inbox_exist_with_http_info(email_address, opts = {}) ⇒ Array<(InboxExistsDto, Integer, Hash)>
Does inbox exist Check if inboxes exist by email address. Useful if you are sending emails to mailslurp addresses
748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 748 def does_inbox_exist_with_http_info(email_address, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: InboxControllerApi.does_inbox_exist ...' end # verify the required parameter 'email_address' is set if @api_client.config.client_side_validation && email_address.nil? fail ArgumentError, "Missing the required parameter 'email_address' when calling InboxControllerApi.does_inbox_exist" end # resource path local_var_path = '/inboxes/exists' # query parameters query_params = opts[:query_params] || {} query_params[:'emailAddress'] = email_address query_params[:'allowCatchAll'] = opts[:'allow_catch_all'] if !opts[:'allow_catch_all'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['*/*']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'InboxExistsDto' # auth_names auth_names = opts[:auth_names] || ['API_KEY'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: InboxControllerApi#does_inbox_exist\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#flush_expired(opts = {}) ⇒ FlushExpiredInboxesResult
Remove expired inboxes Remove any expired inboxes for your account (instead of waiting for scheduled removal on server)
802 803 804 805 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 802 def flush_expired(opts = {}) data, _status_code, _headers = flush_expired_with_http_info(opts) data end |
#flush_expired_with_http_info(opts = {}) ⇒ Array<(FlushExpiredInboxesResult, Integer, Hash)>
Remove expired inboxes Remove any expired inboxes for your account (instead of waiting for scheduled removal on server)
812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 812 def flush_expired_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: InboxControllerApi.flush_expired ...' end # resource path local_var_path = '/inboxes/expired' # query parameters query_params = opts[:query_params] || {} query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['*/*']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'FlushExpiredInboxesResult' # auth_names auth_names = opts[:auth_names] || ['API_KEY'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: InboxControllerApi#flush_expired\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_all_inboxes(opts = {}) ⇒ PageInboxProjection
List All Inboxes Paginated List inboxes in paginated form. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative `getInboxes` method returns a full list of inboxes but is limited to 100 results.
871 872 873 874 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 871 def get_all_inboxes(opts = {}) data, _status_code, _headers = get_all_inboxes_with_http_info(opts) data end |
#get_all_inboxes_with_http_info(opts = {}) ⇒ Array<(PageInboxProjection, Integer, Hash)>
List All Inboxes Paginated List inboxes in paginated form. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative `getInboxes` method returns a full list of inboxes but is limited to 100 results.
891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 891 def get_all_inboxes_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: InboxControllerApi.get_all_inboxes ...' end allowable_values = ["ASC", "DESC"] if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort']) fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}" end allowable_values = ["HTTP_INBOX", "SMTP_INBOX"] if @api_client.config.client_side_validation && opts[:'inbox_type'] && !allowable_values.include?(opts[:'inbox_type']) fail ArgumentError, "invalid value for \"inbox_type\", must be one of #{allowable_values}" end # resource path local_var_path = '/inboxes/paginated' # query parameters query_params = opts[:query_params] || {} query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? query_params[:'favourite'] = opts[:'favourite'] if !opts[:'favourite'].nil? query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil? query_params[:'tag'] = opts[:'tag'] if !opts[:'tag'].nil? query_params[:'teamAccess'] = opts[:'team_access'] if !opts[:'team_access'].nil? query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil? query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil? query_params[:'inboxType'] = opts[:'inbox_type'] if !opts[:'inbox_type'].nil? query_params[:'domainId'] = opts[:'domain_id'] if !opts[:'domain_id'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['*/*']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'PageInboxProjection' # auth_names auth_names = opts[:auth_names] || ['API_KEY'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: InboxControllerApi#get_all_inboxes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_all_scheduled_jobs(opts = {}) ⇒ PageScheduledJobs
Get all scheduled email sending jobs for account Schedule sending of emails using scheduled jobs. These can be inbox or account level.
962 963 964 965 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 962 def get_all_scheduled_jobs(opts = {}) data, _status_code, _headers = get_all_scheduled_jobs_with_http_info(opts) data end |
#get_all_scheduled_jobs_with_http_info(opts = {}) ⇒ Array<(PageScheduledJobs, Integer, Hash)>
Get all scheduled email sending jobs for account Schedule sending of emails using scheduled jobs. These can be inbox or account level.
976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 976 def get_all_scheduled_jobs_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: InboxControllerApi.get_all_scheduled_jobs ...' end allowable_values = ["ASC", "DESC"] if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort']) fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}" end # resource path local_var_path = '/inboxes/scheduled-jobs' # query parameters query_params = opts[:query_params] || {} query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil? query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['*/*']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'PageScheduledJobs' # auth_names auth_names = opts[:auth_names] || ['API_KEY'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: InboxControllerApi#get_all_scheduled_jobs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_delivery_statuses_by_inbox_id(inbox_id, opts = {}) ⇒ PageDeliveryStatus
Get all email delivery statuses for an inbox
1037 1038 1039 1040 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 1037 def get_delivery_statuses_by_inbox_id(inbox_id, opts = {}) data, _status_code, _headers = get_delivery_statuses_by_inbox_id_with_http_info(inbox_id, opts) data end |
#get_delivery_statuses_by_inbox_id_with_http_info(inbox_id, opts = {}) ⇒ Array<(PageDeliveryStatus, Integer, Hash)>
Get all email delivery statuses for an inbox
1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 1051 def get_delivery_statuses_by_inbox_id_with_http_info(inbox_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: InboxControllerApi.get_delivery_statuses_by_inbox_id ...' end # verify the required parameter 'inbox_id' is set if @api_client.config.client_side_validation && inbox_id.nil? fail ArgumentError, "Missing the required parameter 'inbox_id' when calling InboxControllerApi.get_delivery_statuses_by_inbox_id" end allowable_values = ["ASC", "DESC"] if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort']) fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}" end # resource path local_var_path = '/inboxes/{inboxId}/delivery-status'.sub('{' + 'inboxId' + '}', CGI.escape(inbox_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil? query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['*/*']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'PageDeliveryStatus' # auth_names auth_names = opts[:auth_names] || ['API_KEY'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: InboxControllerApi#get_delivery_statuses_by_inbox_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_emails(inbox_id, opts = {}) ⇒ Array<EmailPreview>
Get emails in an Inbox. This method is not idempotent as it allows retries and waits if you want certain conditions to be met before returning. For simple listing and sorting of known emails use the email controller instead. List emails that an inbox has received. Only emails that are sent to the inbox's email address will appear in the inbox. It may take several seconds for any email you send to an inbox's email address to appear in the inbox. To make this endpoint wait for a minimum number of emails use the `minCount` parameter. The server will retry the inbox database until the `minCount` is satisfied or the `retryTimeout` is reached
1121 1122 1123 1124 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 1121 def get_emails(inbox_id, opts = {}) data, _status_code, _headers = get_emails_with_http_info(inbox_id, opts) data end |
#get_emails_with_http_info(inbox_id, opts = {}) ⇒ Array<(Array<EmailPreview>, Integer, Hash)>
Get emails in an Inbox. This method is not idempotent as it allows retries and waits if you want certain conditions to be met before returning. For simple listing and sorting of known emails use the email controller instead. List emails that an inbox has received. Only emails that are sent to the inbox's email address will appear in the inbox. It may take several seconds for any email you send to an inbox's email address to appear in the inbox. To make this endpoint wait for a minimum number of emails use the `minCount` parameter. The server will retry the inbox database until the `minCount` is satisfied or the `retryTimeout` is reached
1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 1140 def get_emails_with_http_info(inbox_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: InboxControllerApi.get_emails ...' end # verify the required parameter 'inbox_id' is set if @api_client.config.client_side_validation && inbox_id.nil? fail ArgumentError, "Missing the required parameter 'inbox_id' when calling InboxControllerApi.get_emails" end if @api_client.config.client_side_validation && !opts[:'size'].nil? && opts[:'size'] > 100 fail ArgumentError, 'invalid value for "opts[:"size"]" when calling InboxControllerApi.get_emails, must be smaller than or equal to 100.' end if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100 fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling InboxControllerApi.get_emails, must be smaller than or equal to 100.' end allowable_values = ["ASC", "DESC"] if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort']) fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}" end # resource path local_var_path = '/inboxes/{inboxId}/emails'.sub('{' + 'inboxId' + '}', CGI.escape(inbox_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil? query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? query_params[:'retryTimeout'] = opts[:'retry_timeout'] if !opts[:'retry_timeout'].nil? query_params[:'delayTimeout'] = opts[:'delay_timeout'] if !opts[:'delay_timeout'].nil? query_params[:'minCount'] = opts[:'min_count'] if !opts[:'min_count'].nil? query_params[:'unreadOnly'] = opts[:'unread_only'] if !opts[:'unread_only'].nil? query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil? query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['*/*']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'Array<EmailPreview>' # auth_names auth_names = opts[:auth_names] || ['API_KEY'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: InboxControllerApi#get_emails\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_imap_smtp_access(opts = {}) ⇒ ImapSmtpAccessDetails
Get IMAP and SMTP access usernames and passwords
1212 1213 1214 1215 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 1212 def get_imap_smtp_access(opts = {}) data, _status_code, _headers = get_imap_smtp_access_with_http_info(opts) data end |
#get_imap_smtp_access_with_http_info(opts = {}) ⇒ Array<(ImapSmtpAccessDetails, Integer, Hash)>
Get IMAP and SMTP access usernames and passwords
1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 1221 def get_imap_smtp_access_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: InboxControllerApi.get_imap_smtp_access ...' end # resource path local_var_path = '/inboxes/imap-smtp-access' # query parameters query_params = opts[:query_params] || {} query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['*/*']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'ImapSmtpAccessDetails' # auth_names auth_names = opts[:auth_names] || ['API_KEY'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: InboxControllerApi#get_imap_smtp_access\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_inbox(inbox_id, opts = {}) ⇒ InboxDto
Get Inbox. Returns properties of an inbox. Returns an inbox's properties, including its email address and ID.
1270 1271 1272 1273 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 1270 def get_inbox(inbox_id, opts = {}) data, _status_code, _headers = get_inbox_with_http_info(inbox_id, opts) data end |
#get_inbox_by_email_address(email_address, opts = {}) ⇒ InboxByEmailAddressResult
Search for an inbox with the provided email address Get a inbox result by email address
1332 1333 1334 1335 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 1332 def get_inbox_by_email_address(email_address, opts = {}) data, _status_code, _headers = get_inbox_by_email_address_with_http_info(email_address, opts) data end |
#get_inbox_by_email_address_with_http_info(email_address, opts = {}) ⇒ Array<(InboxByEmailAddressResult, Integer, Hash)>
Search for an inbox with the provided email address Get a inbox result by email address
1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 1342 def get_inbox_by_email_address_with_http_info(email_address, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: InboxControllerApi.get_inbox_by_email_address ...' end # verify the required parameter 'email_address' is set if @api_client.config.client_side_validation && email_address.nil? fail ArgumentError, "Missing the required parameter 'email_address' when calling InboxControllerApi.get_inbox_by_email_address" end # resource path local_var_path = '/inboxes/byEmailAddress' # query parameters query_params = opts[:query_params] || {} query_params[:'emailAddress'] = email_address # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['*/*']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'InboxByEmailAddressResult' # auth_names auth_names = opts[:auth_names] || ['API_KEY'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: InboxControllerApi#get_inbox_by_email_address\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_inbox_by_name(name, opts = {}) ⇒ InboxByNameResult
Search for an inbox with the given name Get a inbox result by name
1395 1396 1397 1398 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 1395 def get_inbox_by_name(name, opts = {}) data, _status_code, _headers = get_inbox_by_name_with_http_info(name, opts) data end |
#get_inbox_by_name_with_http_info(name, opts = {}) ⇒ Array<(InboxByNameResult, Integer, Hash)>
Search for an inbox with the given name Get a inbox result by name
1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 1405 def get_inbox_by_name_with_http_info(name, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: InboxControllerApi.get_inbox_by_name ...' end # verify the required parameter 'name' is set if @api_client.config.client_side_validation && name.nil? fail ArgumentError, "Missing the required parameter 'name' when calling InboxControllerApi.get_inbox_by_name" end # resource path local_var_path = '/inboxes/byName' # query parameters query_params = opts[:query_params] || {} query_params[:'name'] = name # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['*/*']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'InboxByNameResult' # auth_names auth_names = opts[:auth_names] || ['API_KEY'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: InboxControllerApi#get_inbox_by_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_inbox_count(opts = {}) ⇒ CountDto
Get total inbox count
1456 1457 1458 1459 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 1456 def get_inbox_count(opts = {}) data, _status_code, _headers = get_inbox_count_with_http_info(opts) data end |
#get_inbox_count_with_http_info(opts = {}) ⇒ Array<(CountDto, Integer, Hash)>
Get total inbox count
1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 1464 def get_inbox_count_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: InboxControllerApi.get_inbox_count ...' end # resource path local_var_path = '/inboxes/count' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['*/*']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'CountDto' # auth_names auth_names = opts[:auth_names] || ['API_KEY'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: InboxControllerApi#get_inbox_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_inbox_email_count(inbox_id, opts = {}) ⇒ CountDto
Get email count in inbox
1511 1512 1513 1514 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 1511 def get_inbox_email_count(inbox_id, opts = {}) data, _status_code, _headers = get_inbox_email_count_with_http_info(inbox_id, opts) data end |
#get_inbox_email_count_with_http_info(inbox_id, opts = {}) ⇒ Array<(CountDto, Integer, Hash)>
Get email count in inbox
1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 1520 def get_inbox_email_count_with_http_info(inbox_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: InboxControllerApi.get_inbox_email_count ...' end # verify the required parameter 'inbox_id' is set if @api_client.config.client_side_validation && inbox_id.nil? fail ArgumentError, "Missing the required parameter 'inbox_id' when calling InboxControllerApi.get_inbox_email_count" end # resource path local_var_path = '/inboxes/{inboxId}/emails/count'.sub('{' + 'inboxId' + '}', CGI.escape(inbox_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['*/*']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'CountDto' # auth_names auth_names = opts[:auth_names] || ['API_KEY'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: InboxControllerApi#get_inbox_email_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_inbox_emails_paginated(inbox_id, opts = {}) ⇒ PageEmailPreview
Get inbox emails paginated Get a paginated list of emails in an inbox. Does not hold connections open.
1577 1578 1579 1580 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 1577 def get_inbox_emails_paginated(inbox_id, opts = {}) data, _status_code, _headers = get_inbox_emails_paginated_with_http_info(inbox_id, opts) data end |
#get_inbox_emails_paginated_with_http_info(inbox_id, opts = {}) ⇒ Array<(PageEmailPreview, Integer, Hash)>
Get inbox emails paginated Get a paginated list of emails in an inbox. Does not hold connections open.
1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 1592 def get_inbox_emails_paginated_with_http_info(inbox_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: InboxControllerApi.get_inbox_emails_paginated ...' end # verify the required parameter 'inbox_id' is set if @api_client.config.client_side_validation && inbox_id.nil? fail ArgumentError, "Missing the required parameter 'inbox_id' when calling InboxControllerApi.get_inbox_emails_paginated" end allowable_values = ["ASC", "DESC"] if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort']) fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}" end # resource path local_var_path = '/inboxes/{inboxId}/emails/paginated'.sub('{' + 'inboxId' + '}', CGI.escape(inbox_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil? query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['*/*']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'PageEmailPreview' # auth_names auth_names = opts[:auth_names] || ['API_KEY'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: InboxControllerApi#get_inbox_emails_paginated\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_inbox_ids(opts = {}) ⇒ InboxIdsResult
Get all inbox IDs Get list of inbox IDs
1652 1653 1654 1655 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 1652 def get_inbox_ids(opts = {}) data, _status_code, _headers = get_inbox_ids_with_http_info(opts) data end |
#get_inbox_ids_with_http_info(opts = {}) ⇒ Array<(InboxIdsResult, Integer, Hash)>
Get all inbox IDs Get list of inbox IDs
1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 1661 def get_inbox_ids_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: InboxControllerApi.get_inbox_ids ...' end # resource path local_var_path = '/inboxes/ids' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['*/*']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'InboxIdsResult' # auth_names auth_names = opts[:auth_names] || ['API_KEY'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: InboxControllerApi#get_inbox_ids\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_inbox_sent_emails(inbox_id, opts = {}) ⇒ PageSentEmailProjection
Get Inbox Sent Emails Returns an inbox's sent email receipts. Call individual sent email endpoints for more details. Note for privacy reasons the full body of sent emails is never stored. An MD5 hash hex is available for comparison instead.
1715 1716 1717 1718 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 1715 def get_inbox_sent_emails(inbox_id, opts = {}) data, _status_code, _headers = get_inbox_sent_emails_with_http_info(inbox_id, opts) data end |
#get_inbox_sent_emails_with_http_info(inbox_id, opts = {}) ⇒ Array<(PageSentEmailProjection, Integer, Hash)>
Get Inbox Sent Emails Returns an inbox's sent email receipts. Call individual sent email endpoints for more details. Note for privacy reasons the full body of sent emails is never stored. An MD5 hash hex is available for comparison instead.
1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 1731 def get_inbox_sent_emails_with_http_info(inbox_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: InboxControllerApi.get_inbox_sent_emails ...' end # verify the required parameter 'inbox_id' is set if @api_client.config.client_side_validation && inbox_id.nil? fail ArgumentError, "Missing the required parameter 'inbox_id' when calling InboxControllerApi.get_inbox_sent_emails" end allowable_values = ["ASC", "DESC"] if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort']) fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}" end # resource path local_var_path = '/inboxes/{inboxId}/sent'.sub('{' + 'inboxId' + '}', CGI.escape(inbox_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil? query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil? query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['*/*']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'PageSentEmailProjection' # auth_names auth_names = opts[:auth_names] || ['API_KEY'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: InboxControllerApi#get_inbox_sent_emails\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_inbox_tags(opts = {}) ⇒ Array<String>
Get inbox tags Get all inbox tags
1792 1793 1794 1795 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 1792 def (opts = {}) data, _status_code, _headers = (opts) data end |
#get_inbox_tags_with_http_info(opts = {}) ⇒ Array<(Array<String>, Integer, Hash)>
Get inbox tags Get all inbox tags
1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 1801 def (opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: InboxControllerApi.get_inbox_tags ...' end # resource path local_var_path = '/inboxes/tags' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['*/*']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'Array<String>' # auth_names auth_names = opts[:auth_names] || ['API_KEY'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: InboxControllerApi#get_inbox_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_inbox_with_http_info(inbox_id, opts = {}) ⇒ Array<(InboxDto, Integer, Hash)>
Get Inbox. Returns properties of an inbox. Returns an inbox's properties, including its email address and ID.
1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 1280 def get_inbox_with_http_info(inbox_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: InboxControllerApi.get_inbox ...' end # verify the required parameter 'inbox_id' is set if @api_client.config.client_side_validation && inbox_id.nil? fail ArgumentError, "Missing the required parameter 'inbox_id' when calling InboxControllerApi.get_inbox" end # resource path local_var_path = '/inboxes/{inboxId}'.sub('{' + 'inboxId' + '}', CGI.escape(inbox_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['*/*']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'InboxDto' # auth_names auth_names = opts[:auth_names] || ['API_KEY'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: InboxControllerApi#get_inbox\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_inboxes(opts = {}) ⇒ Array<InboxDto>
List Inboxes and email addresses List the inboxes you have created. Note use of the more advanced `getAllInboxes` is recommended and allows paginated access using a limit and sort parameter.
1853 1854 1855 1856 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 1853 def get_inboxes(opts = {}) data, _status_code, _headers = get_inboxes_with_http_info(opts) data end |
#get_inboxes_with_http_info(opts = {}) ⇒ Array<(Array<InboxDto>, Integer, Hash)>
List Inboxes and email addresses List the inboxes you have created. Note use of the more advanced `getAllInboxes` is recommended and allows paginated access using a limit and sort parameter.
1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 1867 def get_inboxes_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: InboxControllerApi.get_inboxes ...' end if @api_client.config.client_side_validation && !opts[:'size'].nil? && opts[:'size'] > 100 fail ArgumentError, 'invalid value for "opts[:"size"]" when calling InboxControllerApi.get_inboxes, must be smaller than or equal to 100.' end allowable_values = ["ASC", "DESC"] if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort']) fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}" end # resource path local_var_path = '/inboxes' # query parameters query_params = opts[:query_params] || {} query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil? query_params[:'excludeCatchAllInboxes'] = opts[:'exclude_catch_all_inboxes'] if !opts[:'exclude_catch_all_inboxes'].nil? query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['*/*']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'Array<InboxDto>' # auth_names auth_names = opts[:auth_names] || ['API_KEY'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: InboxControllerApi#get_inboxes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_latest_email_in_inbox(inbox_id, timeout_millis, opts = {}) ⇒ Email
Get latest email in an inbox. Use `WaitForController` to get emails that may not have arrived yet. Get the newest email in an inbox or wait for one to arrive
1929 1930 1931 1932 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 1929 def get_latest_email_in_inbox(inbox_id, timeout_millis, opts = {}) data, _status_code, _headers = get_latest_email_in_inbox_with_http_info(inbox_id, timeout_millis, opts) data end |
#get_latest_email_in_inbox_with_http_info(inbox_id, timeout_millis, opts = {}) ⇒ Array<(Email, Integer, Hash)>
Get latest email in an inbox. Use `WaitForController` to get emails that may not have arrived yet. Get the newest email in an inbox or wait for one to arrive
1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 1940 def get_latest_email_in_inbox_with_http_info(inbox_id, timeout_millis, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: InboxControllerApi.get_latest_email_in_inbox ...' end # verify the required parameter 'inbox_id' is set if @api_client.config.client_side_validation && inbox_id.nil? fail ArgumentError, "Missing the required parameter 'inbox_id' when calling InboxControllerApi.get_latest_email_in_inbox" end # verify the required parameter 'timeout_millis' is set if @api_client.config.client_side_validation && timeout_millis.nil? fail ArgumentError, "Missing the required parameter 'timeout_millis' when calling InboxControllerApi.get_latest_email_in_inbox" end # resource path local_var_path = '/inboxes/getLatestEmail' # query parameters query_params = opts[:query_params] || {} query_params[:'inboxId'] = inbox_id query_params[:'timeoutMillis'] = timeout_millis # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['*/*']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'Email' # auth_names auth_names = opts[:auth_names] || ['API_KEY'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: InboxControllerApi#get_latest_email_in_inbox\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_organization_inboxes(opts = {}) ⇒ PageOrganizationInboxProjection
List Organization Inboxes Paginated List organization inboxes in paginated form. These are inboxes created with `allowTeamAccess` flag enabled. Organization inboxes are `readOnly` for non-admin users. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time).
2003 2004 2005 2006 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 2003 def get_organization_inboxes(opts = {}) data, _status_code, _headers = get_organization_inboxes_with_http_info(opts) data end |
#get_organization_inboxes_with_http_info(opts = {}) ⇒ Array<(PageOrganizationInboxProjection, Integer, Hash)>
List Organization Inboxes Paginated List organization inboxes in paginated form. These are inboxes created with `allowTeamAccess` flag enabled. Organization inboxes are `readOnly` for non-admin users. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time).
2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 2018 def get_organization_inboxes_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: InboxControllerApi.get_organization_inboxes ...' end allowable_values = ["ASC", "DESC"] if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort']) fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}" end # resource path local_var_path = '/inboxes/organization' # query parameters query_params = opts[:query_params] || {} query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil? query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil? query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['*/*']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'PageOrganizationInboxProjection' # auth_names auth_names = opts[:auth_names] || ['API_KEY'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: InboxControllerApi#get_organization_inboxes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_scheduled_job(job_id, opts = {}) ⇒ ScheduledJobDto
Get a scheduled email job Get a scheduled email job details.
2076 2077 2078 2079 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 2076 def get_scheduled_job(job_id, opts = {}) data, _status_code, _headers = get_scheduled_job_with_http_info(job_id, opts) data end |
#get_scheduled_job_with_http_info(job_id, opts = {}) ⇒ Array<(ScheduledJobDto, Integer, Hash)>
Get a scheduled email job Get a scheduled email job details.
2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 2086 def get_scheduled_job_with_http_info(job_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: InboxControllerApi.get_scheduled_job ...' end # verify the required parameter 'job_id' is set if @api_client.config.client_side_validation && job_id.nil? fail ArgumentError, "Missing the required parameter 'job_id' when calling InboxControllerApi.get_scheduled_job" end # resource path local_var_path = '/inboxes/scheduled-jobs/{jobId}'.sub('{' + 'jobId' + '}', CGI.escape(job_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['*/*']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'ScheduledJobDto' # auth_names auth_names = opts[:auth_names] || ['API_KEY'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: InboxControllerApi#get_scheduled_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_scheduled_jobs_by_inbox_id(inbox_id, opts = {}) ⇒ PageScheduledJobs
Get all scheduled email sending jobs for the inbox Schedule sending of emails using scheduled jobs.
2143 2144 2145 2146 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 2143 def get_scheduled_jobs_by_inbox_id(inbox_id, opts = {}) data, _status_code, _headers = get_scheduled_jobs_by_inbox_id_with_http_info(inbox_id, opts) data end |
#get_scheduled_jobs_by_inbox_id_with_http_info(inbox_id, opts = {}) ⇒ Array<(PageScheduledJobs, Integer, Hash)>
Get all scheduled email sending jobs for the inbox Schedule sending of emails using scheduled jobs.
2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 2158 def get_scheduled_jobs_by_inbox_id_with_http_info(inbox_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: InboxControllerApi.get_scheduled_jobs_by_inbox_id ...' end # verify the required parameter 'inbox_id' is set if @api_client.config.client_side_validation && inbox_id.nil? fail ArgumentError, "Missing the required parameter 'inbox_id' when calling InboxControllerApi.get_scheduled_jobs_by_inbox_id" end allowable_values = ["ASC", "DESC"] if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort']) fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}" end # resource path local_var_path = '/inboxes/{inboxId}/scheduled-jobs'.sub('{' + 'inboxId' + '}', CGI.escape(inbox_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil? query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['*/*']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'PageScheduledJobs' # auth_names auth_names = opts[:auth_names] || ['API_KEY'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: InboxControllerApi#get_scheduled_jobs_by_inbox_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_inbox_rulesets(inbox_id, opts = {}) ⇒ PageInboxRulesetDto
List inbox rulesets List all rulesets attached to an inbox
2225 2226 2227 2228 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 2225 def list_inbox_rulesets(inbox_id, opts = {}) data, _status_code, _headers = list_inbox_rulesets_with_http_info(inbox_id, opts) data end |
#list_inbox_rulesets_with_http_info(inbox_id, opts = {}) ⇒ Array<(PageInboxRulesetDto, Integer, Hash)>
List inbox rulesets List all rulesets attached to an inbox
2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 2241 def list_inbox_rulesets_with_http_info(inbox_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: InboxControllerApi.list_inbox_rulesets ...' end # verify the required parameter 'inbox_id' is set if @api_client.config.client_side_validation && inbox_id.nil? fail ArgumentError, "Missing the required parameter 'inbox_id' when calling InboxControllerApi.list_inbox_rulesets" end allowable_values = ["ASC", "DESC"] if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort']) fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}" end # resource path local_var_path = '/inboxes/{inboxId}/rulesets'.sub('{' + 'inboxId' + '}', CGI.escape(inbox_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil? query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil? query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['*/*']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'PageInboxRulesetDto' # auth_names auth_names = opts[:auth_names] || ['API_KEY'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: InboxControllerApi#list_inbox_rulesets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_inbox_tracking_pixels(inbox_id, opts = {}) ⇒ PageTrackingPixelProjection
List inbox tracking pixels List all tracking pixels sent from an inbox
2309 2310 2311 2312 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 2309 def list_inbox_tracking_pixels(inbox_id, opts = {}) data, _status_code, _headers = list_inbox_tracking_pixels_with_http_info(inbox_id, opts) data end |
#list_inbox_tracking_pixels_with_http_info(inbox_id, opts = {}) ⇒ Array<(PageTrackingPixelProjection, Integer, Hash)>
List inbox tracking pixels List all tracking pixels sent from an inbox
2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 2325 def list_inbox_tracking_pixels_with_http_info(inbox_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: InboxControllerApi.list_inbox_tracking_pixels ...' end # verify the required parameter 'inbox_id' is set if @api_client.config.client_side_validation && inbox_id.nil? fail ArgumentError, "Missing the required parameter 'inbox_id' when calling InboxControllerApi.list_inbox_tracking_pixels" end allowable_values = ["ASC", "DESC"] if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort']) fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}" end # resource path local_var_path = '/inboxes/{inboxId}/tracking-pixels'.sub('{' + 'inboxId' + '}', CGI.escape(inbox_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil? query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil? query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['*/*']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'PageTrackingPixelProjection' # auth_names auth_names = opts[:auth_names] || ['API_KEY'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: InboxControllerApi#list_inbox_tracking_pixels\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#send_email(inbox_id, send_email_options, opts = {}) ⇒ nil
Send Email Send an email from an inbox's email address. The request body should contain the `SendEmailOptions` that include recipients, attachments, body etc. See `SendEmailOptions` for all available properties. Note the `inboxId` refers to the inbox's id not the inbox's email address. See www.mailslurp.com/guides/ for more information on how to send emails. This method does not return a sent email entity due to legacy reasons. To send and get a sent email as returned response use the sister method `sendEmailAndConfirm`.
2388 2389 2390 2391 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 2388 def send_email(inbox_id, , opts = {}) send_email_with_http_info(inbox_id, , opts) nil end |
#send_email_and_confirm(inbox_id, send_email_options, opts = {}) ⇒ SentEmailDto
Send email and return sent confirmation Sister method for standard `sendEmail` method with the benefit of returning a `SentEmail` entity confirming the successful sending of the email with a link to the sent object created for it.
2456 2457 2458 2459 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 2456 def send_email_and_confirm(inbox_id, , opts = {}) data, _status_code, _headers = send_email_and_confirm_with_http_info(inbox_id, , opts) data end |
#send_email_and_confirm_with_http_info(inbox_id, send_email_options, opts = {}) ⇒ Array<(SentEmailDto, Integer, Hash)>
Send email and return sent confirmation Sister method for standard `sendEmail` method with the benefit of returning a `SentEmail` entity confirming the successful sending of the email with a link to the sent object created for it.
2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 2467 def send_email_and_confirm_with_http_info(inbox_id, , opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: InboxControllerApi.send_email_and_confirm ...' end # verify the required parameter 'inbox_id' is set if @api_client.config.client_side_validation && inbox_id.nil? fail ArgumentError, "Missing the required parameter 'inbox_id' when calling InboxControllerApi.send_email_and_confirm" end # verify the required parameter 'send_email_options' is set if @api_client.config.client_side_validation && .nil? fail ArgumentError, "Missing the required parameter 'send_email_options' when calling InboxControllerApi.send_email_and_confirm" end # resource path local_var_path = '/inboxes/{inboxId}/confirm'.sub('{' + 'inboxId' + '}', CGI.escape(inbox_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['*/*']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body() # return_type return_type = opts[:return_type] || 'SentEmailDto' # auth_names auth_names = opts[:auth_names] || ['API_KEY'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: InboxControllerApi#send_email_and_confirm\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#send_email_with_http_info(inbox_id, send_email_options, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Send Email Send an email from an inbox's email address. The request body should contain the `SendEmailOptions` that include recipients, attachments, body etc. See `SendEmailOptions` for all available properties. Note the `inboxId` refers to the inbox's id not the inbox's email address. See www.mailslurp.com/guides/ for more information on how to send emails. This method does not return a sent email entity due to legacy reasons. To send and get a sent email as returned response use the sister method `sendEmailAndConfirm`.
2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 2399 def send_email_with_http_info(inbox_id, , opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: InboxControllerApi.send_email ...' end # verify the required parameter 'inbox_id' is set if @api_client.config.client_side_validation && inbox_id.nil? fail ArgumentError, "Missing the required parameter 'inbox_id' when calling InboxControllerApi.send_email" end # verify the required parameter 'send_email_options' is set if @api_client.config.client_side_validation && .nil? fail ArgumentError, "Missing the required parameter 'send_email_options' when calling InboxControllerApi.send_email" end # resource path local_var_path = '/inboxes/{inboxId}'.sub('{' + 'inboxId' + '}', CGI.escape(inbox_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body() # return_type return_type = opts[:return_type] # auth_names auth_names = opts[:auth_names] || ['API_KEY'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: InboxControllerApi#send_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#send_email_with_queue(inbox_id, validate_before_enqueue, send_email_options, opts = {}) ⇒ nil
Send email with queue Send an email using a queue. Will place the email onto a queue that will then be processed and sent. Use this queue method to enable any failed email sending to be recovered. This will prevent lost emails when sending if your account encounters a block or payment issue.
2527 2528 2529 2530 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 2527 def send_email_with_queue(inbox_id, validate_before_enqueue, , opts = {}) send_email_with_queue_with_http_info(inbox_id, validate_before_enqueue, , opts) nil end |
#send_email_with_queue_with_http_info(inbox_id, validate_before_enqueue, send_email_options, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Send email with queue Send an email using a queue. Will place the email onto a queue that will then be processed and sent. Use this queue method to enable any failed email sending to be recovered. This will prevent lost emails when sending if your account encounters a block or payment issue.
2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 2539 def send_email_with_queue_with_http_info(inbox_id, validate_before_enqueue, , opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: InboxControllerApi.send_email_with_queue ...' end # verify the required parameter 'inbox_id' is set if @api_client.config.client_side_validation && inbox_id.nil? fail ArgumentError, "Missing the required parameter 'inbox_id' when calling InboxControllerApi.send_email_with_queue" end # verify the required parameter 'validate_before_enqueue' is set if @api_client.config.client_side_validation && validate_before_enqueue.nil? fail ArgumentError, "Missing the required parameter 'validate_before_enqueue' when calling InboxControllerApi.send_email_with_queue" end # verify the required parameter 'send_email_options' is set if @api_client.config.client_side_validation && .nil? fail ArgumentError, "Missing the required parameter 'send_email_options' when calling InboxControllerApi.send_email_with_queue" end # resource path local_var_path = '/inboxes/{inboxId}/with-queue'.sub('{' + 'inboxId' + '}', CGI.escape(inbox_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'validateBeforeEnqueue'] = validate_before_enqueue # header parameters header_params = opts[:header_params] || {} # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body() # return_type return_type = opts[:return_type] # auth_names auth_names = opts[:auth_names] || ['API_KEY'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: InboxControllerApi#send_email_with_queue\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#send_smtp_envelope(inbox_id, send_smtp_envelope_options, opts = {}) ⇒ SentEmailDto
Send email using an SMTP mail envelope and message body and return sent confirmation Send email using an SMTP envelope containing RCPT TO, MAIL FROM, and a SMTP BODY.
2601 2602 2603 2604 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 2601 def send_smtp_envelope(inbox_id, , opts = {}) data, _status_code, _headers = send_smtp_envelope_with_http_info(inbox_id, , opts) data end |
#send_smtp_envelope_with_http_info(inbox_id, send_smtp_envelope_options, opts = {}) ⇒ Array<(SentEmailDto, Integer, Hash)>
Send email using an SMTP mail envelope and message body and return sent confirmation Send email using an SMTP envelope containing RCPT TO, MAIL FROM, and a SMTP BODY.
2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 2612 def send_smtp_envelope_with_http_info(inbox_id, , opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: InboxControllerApi.send_smtp_envelope ...' end # verify the required parameter 'inbox_id' is set if @api_client.config.client_side_validation && inbox_id.nil? fail ArgumentError, "Missing the required parameter 'inbox_id' when calling InboxControllerApi.send_smtp_envelope" end # verify the required parameter 'send_smtp_envelope_options' is set if @api_client.config.client_side_validation && .nil? fail ArgumentError, "Missing the required parameter 'send_smtp_envelope_options' when calling InboxControllerApi.send_smtp_envelope" end # resource path local_var_path = '/inboxes/{inboxId}/smtp-envelope'.sub('{' + 'inboxId' + '}', CGI.escape(inbox_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['*/*']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body() # return_type return_type = opts[:return_type] || 'SentEmailDto' # auth_names auth_names = opts[:auth_names] || ['API_KEY'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: InboxControllerApi#send_smtp_envelope\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#send_test_email(inbox_id, opts = {}) ⇒ nil
Send a test email to inbox Send an inbox a test email to test email receiving is working
2670 2671 2672 2673 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 2670 def send_test_email(inbox_id, opts = {}) send_test_email_with_http_info(inbox_id, opts) nil end |
#send_test_email_with_http_info(inbox_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Send a test email to inbox Send an inbox a test email to test email receiving is working
2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 2680 def send_test_email_with_http_info(inbox_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: InboxControllerApi.send_test_email ...' end # verify the required parameter 'inbox_id' is set if @api_client.config.client_side_validation && inbox_id.nil? fail ArgumentError, "Missing the required parameter 'inbox_id' when calling InboxControllerApi.send_test_email" end # resource path local_var_path = '/inboxes/{inboxId}/send-test-email'.sub('{' + 'inboxId' + '}', CGI.escape(inbox_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] # auth_names auth_names = opts[:auth_names] || ['API_KEY'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: InboxControllerApi#send_test_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#send_with_schedule(inbox_id, send_email_options, opts = {}) ⇒ ScheduledJobDto
Send email with with delay or schedule Send an email using a delay. Will place the email onto a scheduler that will then be processed and sent. Use delays to schedule email sending.
2734 2735 2736 2737 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 2734 def send_with_schedule(inbox_id, , opts = {}) data, _status_code, _headers = send_with_schedule_with_http_info(inbox_id, , opts) data end |
#send_with_schedule_with_http_info(inbox_id, send_email_options, opts = {}) ⇒ Array<(ScheduledJobDto, Integer, Hash)>
Send email with with delay or schedule Send an email using a delay. Will place the email onto a scheduler that will then be processed and sent. Use delays to schedule email sending.
2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 2748 def send_with_schedule_with_http_info(inbox_id, , opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: InboxControllerApi.send_with_schedule ...' end # verify the required parameter 'inbox_id' is set if @api_client.config.client_side_validation && inbox_id.nil? fail ArgumentError, "Missing the required parameter 'inbox_id' when calling InboxControllerApi.send_with_schedule" end # verify the required parameter 'send_email_options' is set if @api_client.config.client_side_validation && .nil? fail ArgumentError, "Missing the required parameter 'send_email_options' when calling InboxControllerApi.send_with_schedule" end # resource path local_var_path = '/inboxes/{inboxId}/with-schedule'.sub('{' + 'inboxId' + '}', CGI.escape(inbox_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'sendAtTimestamp'] = opts[:'send_at_timestamp'] if !opts[:'send_at_timestamp'].nil? query_params[:'sendAtNowPlusSeconds'] = opts[:'send_at_now_plus_seconds'] if !opts[:'send_at_now_plus_seconds'].nil? query_params[:'validateBeforeEnqueue'] = opts[:'validate_before_enqueue'] if !opts[:'validate_before_enqueue'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['*/*']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body() # return_type return_type = opts[:return_type] || 'ScheduledJobDto' # auth_names auth_names = opts[:auth_names] || ['API_KEY'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: InboxControllerApi#send_with_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#set_inbox_favourited(inbox_id, set_inbox_favourited_options, opts = {}) ⇒ InboxDto
Set inbox favourited state Set and return new favourite state for an inbox
2810 2811 2812 2813 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 2810 def set_inbox_favourited(inbox_id, , opts = {}) data, _status_code, _headers = set_inbox_favourited_with_http_info(inbox_id, , opts) data end |
#set_inbox_favourited_with_http_info(inbox_id, set_inbox_favourited_options, opts = {}) ⇒ Array<(InboxDto, Integer, Hash)>
Set inbox favourited state Set and return new favourite state for an inbox
2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 2821 def set_inbox_favourited_with_http_info(inbox_id, , opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: InboxControllerApi.set_inbox_favourited ...' end # verify the required parameter 'inbox_id' is set if @api_client.config.client_side_validation && inbox_id.nil? fail ArgumentError, "Missing the required parameter 'inbox_id' when calling InboxControllerApi.set_inbox_favourited" end # verify the required parameter 'set_inbox_favourited_options' is set if @api_client.config.client_side_validation && .nil? fail ArgumentError, "Missing the required parameter 'set_inbox_favourited_options' when calling InboxControllerApi.set_inbox_favourited" end # resource path local_var_path = '/inboxes/{inboxId}/favourite'.sub('{' + 'inboxId' + '}', CGI.escape(inbox_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['*/*']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body() # return_type return_type = opts[:return_type] || 'InboxDto' # auth_names auth_names = opts[:auth_names] || ['API_KEY'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:PUT, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: InboxControllerApi#set_inbox_favourited\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_inbox(inbox_id, update_inbox_options, opts = {}) ⇒ InboxDto
Update Inbox. Change name and description. Email address is not editable. Update editable fields on an inbox
2880 2881 2882 2883 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 2880 def update_inbox(inbox_id, , opts = {}) data, _status_code, _headers = update_inbox_with_http_info(inbox_id, , opts) data end |
#update_inbox_with_http_info(inbox_id, update_inbox_options, opts = {}) ⇒ Array<(InboxDto, Integer, Hash)>
Update Inbox. Change name and description. Email address is not editable. Update editable fields on an inbox
2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 |
# File 'lib/mailslurp_client/api/inbox_controller_api.rb', line 2891 def update_inbox_with_http_info(inbox_id, , opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: InboxControllerApi.update_inbox ...' end # verify the required parameter 'inbox_id' is set if @api_client.config.client_side_validation && inbox_id.nil? fail ArgumentError, "Missing the required parameter 'inbox_id' when calling InboxControllerApi.update_inbox" end # verify the required parameter 'update_inbox_options' is set if @api_client.config.client_side_validation && .nil? fail ArgumentError, "Missing the required parameter 'update_inbox_options' when calling InboxControllerApi.update_inbox" end # resource path local_var_path = '/inboxes/{inboxId}'.sub('{' + 'inboxId' + '}', CGI.escape(inbox_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['*/*']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body() # return_type return_type = opts[:return_type] || 'InboxDto' # auth_names auth_names = opts[:auth_names] || ['API_KEY'] = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: InboxControllerApi#update_inbox\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |