aspose_email_cloud 20.3.0 → 20.12.0

data/lib/aspose-email-cloud/models/client_message_fetch_request.rb

@@ -0,0 +1,114 @@
+#  ----------------------------------------------------------------------------
+#  <copyright company="Aspose" file="client_message_fetch_request.rb">
+#    Copyright (c) 2018-2020 Aspose Pty Ltd. All rights reserved.
+#  </copyright>
+#  <summary>
+#    Permission is hereby granted, free of charge, to any person obtaining a
+#   copy  of this software and associated documentation files (the "Software"),
+#   to deal  in the Software without restriction, including without limitation
+#   the rights  to use, copy, modify, merge, publish, distribute, sublicense,
+#   and/or sell  copies of the Software, and to permit persons to whom the
+#   Software is  furnished to do so, subject to the following conditions:
+#
+#   The above copyright notice and this permission notice shall be included in
+#   all  copies or substantial portions of the Software.
+#
+#   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+#   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+#   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+#   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+#   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+#   FROM,  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+#   DEALINGS IN THE SOFTWARE.
+#  </summary>
+#  ----------------------------------------------------------------------------
+
+require_relative './email_request'
+require_relative './http_request'
+
+module AsposeEmailCloud
+  # Request model for client_message_fetch operation.
+  class ClientMessageFetchRequest < EmailRequest
+    # Message identifier
+    # @return [String]
+    attr_accessor :message_id
+    # Email account
+    # @return [String]
+    attr_accessor :account
+    # Account folder to fetch from (should be specified for some protocols such as IMAP)             
+    # @return [String]
+    attr_accessor :folder
+    # Storage name where account file located.
+    # @return [String]
+    attr_accessor :storage
+    # Folder in storage where account file located.
+    # @return [String]
+    attr_accessor :account_storage_folder
+    # MailMessageBase type. Using this property you can fetch message in different formats (as EmailDto, MapiMessageDto or a file represented as Base64 string).              Enum, available values: Dto, Mapi, Base64
+    # @return [String]
+    attr_accessor :type
+    # Base64 data format. Used only if type is set to Base64. Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft
+    # @return [String]
+    attr_accessor :format
+
+    # Fetch message from email account             
+    # @param [String] message_id Message identifier
+    # @param [String] account Email account
+    # @param [String] folder Account folder to fetch from (should be specified for some protocols such as IMAP)             
+    # @param [String] storage Storage name where account file located.
+    # @param [String] account_storage_folder Folder in storage where account file located.
+    # @param [String] type MailMessageBase type. Using this property you can fetch message in different formats (as EmailDto, MapiMessageDto or a file represented as Base64 string).              Enum, available values: Dto, Mapi, Base64
+    # @param [String] format Base64 data format. Used only if type is set to Base64. Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft
+    def initialize(message_id:, account:, folder: nil, storage: nil, account_storage_folder: nil, type: nil, format: nil)
+      self.message_id = message_id if message_id
+      self.account = account if account
+      self.folder = folder if folder
+      self.storage = storage if storage
+      self.account_storage_folder = account_storage_folder if account_storage_folder
+      self.type = type if type
+      self.format = format if format
+    end
+
+    def to_http_info(api_client)
+      # verify the required parameter 'message_id' is set
+      if api_client.config.client_side_validation && self.message_id.nil?
+        raise ArgumentError, "Missing the required parameter 'message_id' when calling ClientMessageApi.fetch"
+      end
+      # verify the required parameter 'account' is set
+      if api_client.config.client_side_validation && self.account.nil?
+        raise ArgumentError, "Missing the required parameter 'account' when calling ClientMessageApi.fetch"
+      end
+      # resource path
+      local_var_path = '/email/client/message'
+
+      # query parameters
+      query_params = {}
+      query_params[:messageId] = self.message_id
+      query_params[:account] = self.account
+      query_params[:folder] = self.folder unless self.folder.nil?
+      query_params[:storage] = self.storage unless self.storage.nil?
+      query_params[:accountStorageFolder] = self.account_storage_folder unless self.account_storage_folder.nil?
+      query_params[:type] = self.type unless self.type.nil?
+      query_params[:format] = self.format unless self.format.nil?
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      auth_names = ['JWT']
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = EmailRequest.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = form_params.any? ? 'multipart/form-data' : EmailRequest.select_header_content_type(['application/json'])
+
+      AsposeEmailCloud::HttpRequest.new(resource_path: local_var_path,
+                                        header_params: header_params,
+                                        query_params: query_params,
+                                        form_params: form_params,
+                                        auth_names: auth_names)
+    end
+  end
+end

data/lib/aspose-email-cloud/models/{requests/list_email_models_request_data.rb → client_message_list_request.rb}

@@ -1,7 +1,6 @@
-
 #  ----------------------------------------------------------------------------
-#  <copyright company="Aspose" file="list_email_models_request_data.rb">
-#    Copyright (c) 2018-2019 Aspose Pty Ltd. All rights reserved.
+#  <copyright company="Aspose" file="client_message_list_request.rb">
+#    Copyright (c) 2018-2020 Aspose Pty Ltd. All rights reserved.
 #  </copyright>
 #  <summary>
 #    Permission is hereby granted, free of charge, to any person obtaining a
@@ -24,104 +23,99 @@
 #  </summary>
 #  ----------------------------------------------------------------------------
 
-
 require_relative './email_request'
 require_relative './http_request'
 
 module AsposeEmailCloud
-  # Request model for list_email_models operation.
-  class ListEmailModelsRequestData < EmailRequest
-
+  # Request model for client_message_list operation.
+  class ClientMessageListRequest < EmailRequest
     # A folder in email account
     # @return [String]
     attr_accessor :folder
-    # A MailQuery search string
-    # @return [String]
-    attr_accessor :query_string
     # Email account
     # @return [String]
-    attr_accessor :first_account
-    # Additional email account (should be specified for POP/IMAP accounts and should be SMTP account)             
+    attr_accessor :account
+    # A MailQuery search string
     # @return [String]
-    attr_accessor :second_account
-    # Storage name where account file(s) located
+    attr_accessor :query_string
+    # Storage name where account file located
     # @return [String]
     attr_accessor :storage
-    # Folder in storage where account file(s) located
+    # Folder in storage where account file located
     # @return [String]
-    attr_accessor :storage_folder
+    attr_accessor :account_storage_folder
     # Specifies that should message be searched in subfolders recursively
     # @return [BOOLEAN]
     attr_accessor :recursive
+    # MailMessageBase type. Using this property you can get messages in different formats (as EmailDto, MapiMessageDto or a file represented as Base64 string).              Enum, available values: Dto, Mapi, Base64
+    # @return [String]
+    attr_accessor :type
+    # Base64 data format. Used only if type is set to Base64. Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft
+    # @return [String]
+    attr_accessor :format
 
     # Get messages from folder, filtered by query             
     # The query string should have the following view.      The example of a simple expression:       &#39;&lt;Field name&gt;&#39; &lt;Comparison operator&gt; &#39;&lt;Field value&gt;&#39;,  where &amp;lt;Field Name&amp;gt; - the name of a message field through which filtering is made, &amp;lt;Comparison operator&amp;gt; - comparison operators, as their name implies, allow to compare message field and specified value, &amp;lt;Field value&amp;gt; - value to be compared with a message field.      The number of simple expressions can make a compound one, ex.:     (&lt;Simple expression 1&gt; &amp; &lt;Simple expression 2&gt;) | &lt;Simple expression 3     &gt;,  where \&quot;&amp;amp;\&quot; - logical-AND operator, \&quot;|\&quot; - logical-OR operator      At present the following values are allowed as a field name (&lt;Field name&gt;):  \&quot;To\&quot; - represents a TO field of message, \&quot;Text\&quot; - represents string in the header or body of the message, \&quot;Bcc\&quot; - represents a BCC field of message, \&quot;Body\&quot; - represents a string in the body of message, \&quot;Cc\&quot; - represents a CC field of message, \&quot;From\&quot; - represents a From field of message, \&quot;Subject\&quot; - represents a string in the subject of message, \&quot;InternalDate\&quot; - represents an internal date of message, \&quot;SentDate\&quot; - represents a sent date of message      Additionally, the following field names are allowed for IMAP-protocol:  \&quot;Answered\&quot; - represents an /Answered flag of message \&quot;Seen\&quot; - represents a /Seen flag of message \&quot;Flagged\&quot; - represents a /Flagged flag of message \&quot;Draft\&quot; - represents a /Draft flag of message \&quot;Deleted\&quot; - represents a Deleted/ flag of message \&quot;Recent\&quot; - represents a Deleted/ flag of message \&quot;MessageSize\&quot; - represents a size (in bytes) of message      Additionally, the following field names are allowed for Exchange:  \&quot;IsRead\&quot; - Indicates whether the message has been read \&quot;HasAttachment\&quot; - Indicates whether or not the message has attachments \&quot;IsSubmitted\&quot; - Indicates whether the message has been submitted to the Outbox \&quot;ContentClass\&quot; - represents a content class of item      Additionally, the following field names are allowed for pst/ost files:  \&quot;MessageClass\&quot; - Represents a message class \&quot;ContainerClass\&quot; - Represents a folder container class \&quot;Importance\&quot; - Represents a message importance \&quot;MessageSize\&quot; - represents a size (in bytes) of message \&quot;FolderName\&quot; - represents a folder name \&quot;ContentsCount\&quot; - represents a total number of items in the folder \&quot;UnreadContentsCount\&quot; - represents the number of unread items in the folder. \&quot;Subfolders\&quot; - Indicates whether or not the folder has subfolders \&quot;Read\&quot; - the message is marked as having been read \&quot;HasAttachment\&quot; - the message has at least one attachment \&quot;Unsent\&quot; - the message is still being composed \&quot;Unmodified\&quot; - the message has not been modified since it was first saved (if unsent) or it was delivered (if sent) \&quot;FromMe\&quot; - the user receiving the message was also the user who sent the message \&quot;Resend\&quot; - the message includes a request for a resend operation with a non-delivery report \&quot;NotifyRead\&quot; - the user who sent the message has requested notification when a recipient first reads it \&quot;NotifyUnread\&quot; - the user who sent the message has requested notification when a recipient deletes it before reading or the Message object expires \&quot;EverRead\&quot; - the message has been read at least once      The field value (&lt;Field value&gt;) can take the following values:     For text fields - any string,     For date type fields - the string of \&quot;d-MMM-yyy\&quot; format, ex. \&quot;10-Feb-2009\&quot;,     For flags (fields of boolean type) - either \&quot;True\&quot;, or \&quot;False\&quot;              
     # @param [String] folder A folder in email account
+    # @param [String] account Email account
     # @param [String] query_string A MailQuery search string
-    # @param [String] first_account Email account
-    # @param [String] second_account Additional email account (should be specified for POP/IMAP accounts and should be SMTP account)             
-    # @param [String] storage Storage name where account file(s) located
-    # @param [String] storage_folder Folder in storage where account file(s) located
+    # @param [String] storage Storage name where account file located
+    # @param [String] account_storage_folder Folder in storage where account file located
     # @param [BOOLEAN] recursive Specifies that should message be searched in subfolders recursively
-    def initialize(folder, query_string, first_account, second_account = nil, storage = nil, storage_folder = nil, recursive = nil)
+    # @param [String] type MailMessageBase type. Using this property you can get messages in different formats (as EmailDto, MapiMessageDto or a file represented as Base64 string).              Enum, available values: Dto, Mapi, Base64
+    # @param [String] format Base64 data format. Used only if type is set to Base64. Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft
+    def initialize(folder:, account:, query_string: nil, storage: nil, account_storage_folder: nil, recursive: nil, type: nil, format: nil)
       self.folder = folder if folder
+      self.account = account if account
       self.query_string = query_string if query_string
-      self.first_account = first_account if first_account
-      self.second_account = second_account if second_account
       self.storage = storage if storage
-      self.storage_folder = storage_folder if storage_folder
+      self.account_storage_folder = account_storage_folder if account_storage_folder
       self.recursive = recursive if recursive
+      self.type = type if type
+      self.format = format if format
     end
 
     def to_http_info(api_client)
       # verify the required parameter 'folder' is set
       if api_client.config.client_side_validation && self.folder.nil?
-        raise ArgumentError, "Missing the required parameter 'folder' when calling EmailApi.list_email_models"
+        raise ArgumentError, "Missing the required parameter 'folder' when calling ClientMessageApi.list"
       end
-
-      # verify the required parameter 'query_string' is set
-      if api_client.config.client_side_validation && self.query_string.nil?
-        raise ArgumentError, "Missing the required parameter 'query_string' when calling EmailApi.list_email_models"
+      # verify the required parameter 'account' is set
+      if api_client.config.client_side_validation && self.account.nil?
+        raise ArgumentError, "Missing the required parameter 'account' when calling ClientMessageApi.list"
       end
-
-      # verify the required parameter 'first_account' is set
-      if api_client.config.client_side_validation && self.first_account.nil?
-        raise ArgumentError, "Missing the required parameter 'first_account' when calling EmailApi.list_email_models"
-      end
-
       # resource path
-      local_var_path = '/email/client/ListMessagesModel'
+      local_var_path = '/email/client/message/list'
 
       # query parameters
       query_params = {}
       query_params[:folder] = self.folder
-      query_params[:queryString] = self.query_string
-      query_params[:firstAccount] = self.first_account
-      query_params[:secondAccount] = self.second_account unless self.second_account.nil?
+      query_params[:account] = self.account
+      query_params[:queryString] = self.query_string unless self.query_string.nil?
       query_params[:storage] = self.storage unless self.storage.nil?
-      query_params[:storageFolder] = self.storage_folder unless self.storage_folder.nil?
+      query_params[:accountStorageFolder] = self.account_storage_folder unless self.account_storage_folder.nil?
       query_params[:recursive] = self.recursive unless self.recursive.nil?
+      query_params[:type] = self.type unless self.type.nil?
+      query_params[:format] = self.format unless self.format.nil?
 
       # form parameters
       form_params = {}
 
       # http body (model)
-      post_body = nil
       auth_names = ['JWT']
 
       # header parameters
       header_params = {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = select_header_accept(['application/json'])
+      header_params['Accept'] = EmailRequest.select_header_accept(['application/json'])
       # HTTP header 'Content-Type'
-      header_params['Content-Type'] = form_params.any? ? 'multipart/form-data' : select_header_content_type(['application/json'])
+      header_params['Content-Type'] = form_params.any? ? 'multipart/form-data' : EmailRequest.select_header_content_type(['application/json'])
 
-      AsposeEmailCloud::HttpRequest.new(local_var_path,
-                                      header_params,
-                                      query_params,
-                                      form_params,
-                                      post_body,
-                                      auth_names)
+      AsposeEmailCloud::HttpRequest.new(resource_path: local_var_path,
+                                        header_params: header_params,
+                                        query_params: query_params,
+                                        form_params: form_params,
+                                        auth_names: auth_names)
     end
   end
 end

data/lib/aspose-email-cloud/models/{set_message_read_flag_account_base_request.rb → client_message_move_request.rb}

@@ -1,6 +1,6 @@
 #  ----------------------------------------------------------------------------
-#  <copyright company="Aspose" file="SetMessageReadFlagAccountBaseRequest.rb">
-#    Copyright (c) 2018-2019 Aspose Pty Ltd. All rights reserved.
+#  <copyright company="Aspose" file="ClientMessageMoveRequest.rb">
+#    Copyright (c) 2018-2020 Aspose Pty Ltd. All rights reserved.
 #  </copyright>
 #  <summary>
 #    Permission is hereby granted, free of charge, to any person obtaining a
@@ -23,107 +23,65 @@
 #  </summary>
 #  ----------------------------------------------------------------------------
 
-
 require 'date'
 
 module AsposeEmailCloud
-  # Set message is read request             
-  class SetMessageReadFlagAccountBaseRequest
-    # First account storage file name for receiving emails (or universal one)             
+  # Email client move message request.             
+  class ClientMessageMoveRequest < ClientMessageBaseRequest
+    # Email client account configuration location on storage.             
+    # @return [StorageFileLocation]
+    attr_accessor :account_location
+    # Message identifier.             
     # @return [String]
-    attr_accessor :first_account
-
-    # Second account storage file name for sending emails (ignored if first is universal)             
+    attr_accessor :message_id
+    # Folder to move message from.             
     # @return [String]
-    attr_accessor :second_account
-
-    # Storage folder location of account files             
-    # @return [StorageFolderLocation]
-    attr_accessor :storage_folder
-
-    # Message identifier             
+    attr_accessor :source_folder
+    # Folder to move message to.             
     # @return [String]
-    attr_accessor :message_id
-
-    # Specifies that message should be marked read or unread             
-    # @return [BOOLEAN]
-    attr_accessor :is_read
-
+    attr_accessor :destination_folder
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'first_account' => :'firstAccount',
-        :'second_account' => :'secondAccount',
-        :'storage_folder' => :'storageFolder',
+        :'account_location' => :'accountLocation',
         :'message_id' => :'messageId',
-        :'is_read' => :'isRead'
+        :'source_folder' => :'sourceFolder',
+        :'destination_folder' => :'destinationFolder'
       }
     end
 
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'first_account' => :'String',
-        :'second_account' => :'String',
-        :'storage_folder' => :'StorageFolderLocation',
+        :'account_location' => :'StorageFileLocation',
         :'message_id' => :'String',
-        :'is_read' => :'BOOLEAN'
+        :'source_folder' => :'String',
+        :'destination_folder' => :'String'
       }
     end
 
     # Initializes the object
-    # @param [Hash] attributes Model attributes in the form of hash
-    def initialize(attributes = {})
-      return unless attributes.is_a?(Hash)
-
-      # convert string to symbol for hash key
-      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
-
-      if attributes.has_key?(:'firstAccount')
-        self.first_account = attributes[:'firstAccount']
-      end
-
-      if attributes.has_key?(:'secondAccount')
-        self.second_account = attributes[:'secondAccount']
-      end
-
-      if attributes.has_key?(:'storageFolder')
-        self.storage_folder = attributes[:'storageFolder']
-      end
-
-      if attributes.has_key?(:'messageId')
-        self.message_id = attributes[:'messageId']
-      end
-
-      if attributes.has_key?(:'isRead')
-        self.is_read = attributes[:'isRead']
-      end
-    end
-
-    # Initializes the object
-    # @param [String] first_account First account storage file name for receiving emails (or universal one)             
-    # @param [String] second_account Second account storage file name for sending emails (ignored if first is universal)             
-    # @param [StorageFolderLocation] storage_folder Storage folder location of account files             
-    # @param [String] message_id Message identifier             
-    # @param [BOOLEAN] is_read Specifies that message should be marked read or unread             
-    def initialize(first_account=nil, second_account=nil, storage_folder=nil, message_id=nil, is_read=nil)
-      self.first_account = first_account if first_account
-      self.second_account = second_account if second_account
-      self.storage_folder = storage_folder if storage_folder
+    # @param [StorageFileLocation] account_location Email client account configuration location on storage.             
+    # @param [String] message_id Message identifier.             
+    # @param [String] source_folder Folder to move message from.             
+    # @param [String] destination_folder Folder to move message to.             
+    def initialize(
+      account_location: nil,
+      message_id: nil,
+      source_folder: nil,
+      destination_folder: nil)
+      self.account_location = account_location if account_location
       self.message_id = message_id if message_id
-      self.is_read = is_read if is_read
+      self.source_folder = source_folder if source_folder
+      self.destination_folder = destination_folder if destination_folder
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @first_account.nil?
-        invalid_properties.push('invalid value for "first_account", first_account cannot be nil.')
-      end
-
-      if @first_account.to_s.length < 1
-        invalid_properties.push('invalid value for "first_account", the character length must be great than or equal to 1.')
+      if @account_location.nil?
+        invalid_properties.push('invalid value for "account_location", account_location cannot be nil.')
       end
 
       if @message_id.nil?
@@ -134,8 +92,12 @@ module AsposeEmailCloud
         invalid_properties.push('invalid value for "message_id", the character length must be great than or equal to 1.')
       end
 
-      if @is_read.nil?
-        invalid_properties.push('invalid value for "is_read", is_read cannot be nil.')
+      if @destination_folder.nil?
+        invalid_properties.push('invalid value for "destination_folder", destination_folder cannot be nil.')
+      end
+
+      if @destination_folder.to_s.length < 1
+        invalid_properties.push('invalid value for "destination_folder", the character length must be great than or equal to 1.')
       end
 
       invalid_properties
@@ -144,28 +106,14 @@ module AsposeEmailCloud
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      return false if @first_account.nil?
-      return false if @first_account.to_s.length < 1
+      return false if @account_location.nil?
       return false if @message_id.nil?
       return false if @message_id.to_s.length < 1
-      return false if @is_read.nil?
+      return false if @destination_folder.nil?
+      return false if @destination_folder.to_s.length < 1
       true
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] first_account Value to be assigned
-    def first_account=(first_account)
-      if first_account.nil?
-        fail ArgumentError, 'first_account cannot be nil'
-      end
-
-      if first_account.to_s.length < 1
-        fail ArgumentError, 'invalid value for "first_account", the character length must be great than or equal to 1.'
-      end
-
-      @first_account = first_account
-    end
-
     # Custom attribute writer method with validation
     # @param [Object] message_id Value to be assigned
     def message_id=(message_id)
@@ -180,16 +128,29 @@ module AsposeEmailCloud
       @message_id = message_id
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] destination_folder Value to be assigned
+    def destination_folder=(destination_folder)
+      if destination_folder.nil?
+        fail ArgumentError, 'destination_folder cannot be nil'
+      end
+
+      if destination_folder.to_s.length < 1
+        fail ArgumentError, 'invalid value for "destination_folder", the character length must be great than or equal to 1.'
+      end
+
+      @destination_folder = destination_folder
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          first_account == o.first_account &&
-          second_account == o.second_account &&
-          storage_folder == o.storage_folder &&
+          account_location == o.account_location &&
           message_id == o.message_id &&
-          is_read == o.is_read
+          source_folder == o.source_folder &&
+          destination_folder == o.destination_folder
     end
 
     # @see the `==` method
@@ -201,7 +162,7 @@ module AsposeEmailCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [first_account, second_account, storage_folder, message_id, is_read].hash
+      [account_location, message_id, source_folder, destination_folder].hash
     end
 
     # Builds the object from hash