mailslurp_client 17.2.0 → 17.4.0

data/lib/mailslurp_client/api/inbox_controller_api.rb

@@ -3044,7 +3044,7 @@ module MailSlurpClient
     end
 
     # Get or create a plus address by full address
-    # Looks up an inbox plus address using a full email address like `inbox+alias@domain.com`. Returns an existing plus address if found, otherwise creates one.
+    # Looks up an inbox plus address using a full email address like `inbox+alias@domain.com`. Returns an existing plus address if found, otherwise creates one. Rejects the request if the full address is already assigned to a real inbox.
     # @param inbox_id [String] ID of the inbox you want to target
     # @param full_address [String] Full recipient address including +suffix. Example: `inbox+alias@domain.com`
     # @param [Hash] opts the optional parameters
@@ -3055,7 +3055,7 @@ module MailSlurpClient
     end
 
     # Get or create a plus address by full address
-    # Looks up an inbox plus address using a full email address like `inbox+alias@domain.com`. Returns an existing plus address if found, otherwise creates one.
+    # Looks up an inbox plus address using a full email address like `inbox+alias@domain.com`. Returns an existing plus address if found, otherwise creates one. Rejects the request if the full address is already assigned to a real inbox.
     # @param inbox_id [String] ID of the inbox you want to target
     # @param full_address [String] Full recipient address including +suffix. Example: `inbox+alias@domain.com`
     # @param [Hash] opts the optional parameters
@@ -3117,7 +3117,7 @@ module MailSlurpClient
     end
 
     # Get or create a plus address by full address without inbox ID
-    # Looks up an inbox plus address using a full email address like `inbox+alias@domain.com`. Resolves the base inbox from the full address for the authenticated user, then returns an existing plus address if found, otherwise creates one.
+    # Looks up an inbox plus address using a full email address like `inbox+alias@domain.com`. Resolves the base inbox from the full address for the authenticated user, then returns an existing plus address if found, otherwise creates one. Rejects the request if the full address is already assigned to a real inbox.
     # @param full_address [String] Full recipient address including +suffix. Example: `inbox+alias@domain.com`
     # @param [Hash] opts the optional parameters
     # @return [PlusAddressDto]
@@ -3127,7 +3127,7 @@ module MailSlurpClient
     end
 
     # Get or create a plus address by full address without inbox ID
-    # Looks up an inbox plus address using a full email address like `inbox+alias@domain.com`. Resolves the base inbox from the full address for the authenticated user, then returns an existing plus address if found, otherwise creates one.
+    # Looks up an inbox plus address using a full email address like `inbox+alias@domain.com`. Resolves the base inbox from the full address for the authenticated user, then returns an existing plus address if found, otherwise creates one. Rejects the request if the full address is already assigned to a real inbox.
     # @param full_address [String] Full recipient address including +suffix. Example: `inbox+alias@domain.com`
     # @param [Hash] opts the optional parameters
     # @return [Array<(PlusAddressDto, Integer, Hash)>] PlusAddressDto data, response status code and response headers
@@ -3530,6 +3530,235 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
+    # Import email into inbox from base64 MIME
+    # Imports a raw RFC822/MIME email into the specified inbox regardless of the original `To` header. V1 accepts MIME-family formats such as `.eml`, `message/rfc822`, and raw MIME bytes only. Outlook `.msg`, `mbox`, and `maildir` are not supported in V1. By default MailSlurp rewrites the MIME `Message-ID` header to avoid imported message identity clashes. Set `runPipeline=true` to run the normal inbound receive pipeline after persistence.
+    # @param inbox_id [String] 
+    # @param import_email_options [ImportEmailOptions] 
+    # @param [Hash] opts the optional parameters
+    # @return [Email]
+    def import_email_into_inbox(inbox_id, import_email_options, opts = {})
+      data, _status_code, _headers = import_email_into_inbox_with_http_info(inbox_id, import_email_options, opts)
+      data
+    end
+
+    # Import email into inbox from base64 MIME
+    # Imports a raw RFC822/MIME email into the specified inbox regardless of the original &#x60;To&#x60; header. V1 accepts MIME-family formats such as &#x60;.eml&#x60;, &#x60;message/rfc822&#x60;, and raw MIME bytes only. Outlook &#x60;.msg&#x60;, &#x60;mbox&#x60;, and &#x60;maildir&#x60; are not supported in V1. By default MailSlurp rewrites the MIME &#x60;Message-ID&#x60; header to avoid imported message identity clashes. Set &#x60;runPipeline&#x3D;true&#x60; to run the normal inbound receive pipeline after persistence.
+    # @param inbox_id [String] 
+    # @param import_email_options [ImportEmailOptions] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Email, Integer, Hash)>] Email data, response status code and response headers
+    def import_email_into_inbox_with_http_info(inbox_id, import_email_options, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InboxControllerApi.import_email_into_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.import_email_into_inbox"
+      end
+      # verify the required parameter 'import_email_options' is set
+      if @api_client.config.client_side_validation && import_email_options.nil?
+        fail ArgumentError, "Missing the required parameter 'import_email_options' when calling InboxControllerApi.import_email_into_inbox"
+      end
+      # resource path
+      local_var_path = '/inboxes/{inboxId}/emails/import'.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(import_email_options) 
+
+      # return_type
+      return_type = opts[:return_type] || 'Email' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['API_KEY']
+
+      new_options = 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, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: InboxControllerApi#import_email_into_inbox\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Import email into inbox from raw MIME bytes
+    # Imports a raw RFC822/MIME email stream into the specified inbox regardless of the original `To` header. Supports `message/rfc822` and `application/octet-stream`. V1 does not support Outlook `.msg`, `mbox`, or `maildir`. By default MailSlurp rewrites the MIME `Message-ID` header to avoid imported message identity clashes.
+    # @param inbox_id [String] 
+    # @param body [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :external_id 
+    # @option opts [Boolean] :run_pipeline  (default to false)
+    # @option opts [Boolean] :override_message_id  (default to true)
+    # @return [Email]
+    def import_email_into_inbox_bytes(inbox_id, body, opts = {})
+      data, _status_code, _headers = import_email_into_inbox_bytes_with_http_info(inbox_id, body, opts)
+      data
+    end
+
+    # Import email into inbox from raw MIME bytes
+    # Imports a raw RFC822/MIME email stream into the specified inbox regardless of the original &#x60;To&#x60; header. Supports &#x60;message/rfc822&#x60; and &#x60;application/octet-stream&#x60;. V1 does not support Outlook &#x60;.msg&#x60;, &#x60;mbox&#x60;, or &#x60;maildir&#x60;. By default MailSlurp rewrites the MIME &#x60;Message-ID&#x60; header to avoid imported message identity clashes.
+    # @param inbox_id [String] 
+    # @param body [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :external_id 
+    # @option opts [Boolean] :run_pipeline 
+    # @option opts [Boolean] :override_message_id 
+    # @return [Array<(Email, Integer, Hash)>] Email data, response status code and response headers
+    def import_email_into_inbox_bytes_with_http_info(inbox_id, body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InboxControllerApi.import_email_into_inbox_bytes ...'
+      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.import_email_into_inbox_bytes"
+      end
+      # verify the required parameter 'body' is set
+      if @api_client.config.client_side_validation && body.nil?
+        fail ArgumentError, "Missing the required parameter 'body' when calling InboxControllerApi.import_email_into_inbox_bytes"
+      end
+      # resource path
+      local_var_path = '/inboxes/{inboxId}/emails/import/raw'.sub('{' + 'inboxId' + '}', CGI.escape(inbox_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'externalId'] = opts[:'external_id'] if !opts[:'external_id'].nil?
+      query_params[:'runPipeline'] = opts[:'run_pipeline'] if !opts[:'run_pipeline'].nil?
+      query_params[:'overrideMessageId'] = opts[:'override_message_id'] if !opts[:'override_message_id'].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/octet-stream', 'message/rfc822'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(body) 
+
+      # return_type
+      return_type = opts[:return_type] || 'Email' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['API_KEY']
+
+      new_options = 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, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: InboxControllerApi#import_email_into_inbox_bytes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Import email into inbox from multipart EML upload
+    # Imports an uploaded RFC822/MIME file into the specified inbox regardless of the original `To` header. Intended for `.eml` uploads and other MIME-family raw email files. V1 does not support Outlook `.msg`, `mbox`, or `maildir`. By default MailSlurp rewrites the MIME `Message-ID` header to avoid imported message identity clashes.
+    # @param inbox_id [String] 
+    # @param file [File] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :external_id 
+    # @option opts [Boolean] :run_pipeline  (default to false)
+    # @option opts [Boolean] :override_message_id  (default to true)
+    # @return [Email]
+    def import_email_into_inbox_multipart(inbox_id, file, opts = {})
+      data, _status_code, _headers = import_email_into_inbox_multipart_with_http_info(inbox_id, file, opts)
+      data
+    end
+
+    # Import email into inbox from multipart EML upload
+    # Imports an uploaded RFC822/MIME file into the specified inbox regardless of the original &#x60;To&#x60; header. Intended for &#x60;.eml&#x60; uploads and other MIME-family raw email files. V1 does not support Outlook &#x60;.msg&#x60;, &#x60;mbox&#x60;, or &#x60;maildir&#x60;. By default MailSlurp rewrites the MIME &#x60;Message-ID&#x60; header to avoid imported message identity clashes.
+    # @param inbox_id [String] 
+    # @param file [File] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :external_id 
+    # @option opts [Boolean] :run_pipeline 
+    # @option opts [Boolean] :override_message_id 
+    # @return [Array<(Email, Integer, Hash)>] Email data, response status code and response headers
+    def import_email_into_inbox_multipart_with_http_info(inbox_id, file, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InboxControllerApi.import_email_into_inbox_multipart ...'
+      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.import_email_into_inbox_multipart"
+      end
+      # verify the required parameter 'file' is set
+      if @api_client.config.client_side_validation && file.nil?
+        fail ArgumentError, "Missing the required parameter 'file' when calling InboxControllerApi.import_email_into_inbox_multipart"
+      end
+      # resource path
+      local_var_path = '/inboxes/{inboxId}/emails/import/multipart'.sub('{' + 'inboxId' + '}', CGI.escape(inbox_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'externalId'] = opts[:'external_id'] if !opts[:'external_id'].nil?
+      query_params[:'runPipeline'] = opts[:'run_pipeline'] if !opts[:'run_pipeline'].nil?
+      query_params[:'overrideMessageId'] = opts[:'override_message_id'] if !opts[:'override_message_id'].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(['multipart/form-data'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+      form_params['file'] = file
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'Email' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['API_KEY']
+
+      new_options = 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, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: InboxControllerApi#import_email_into_inbox_multipart\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Is email address available
     # Returns whether an email address is available
     # @param email_address [String]