aspose_email_cloud 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f6617d7348582e8a7b024461472cc9d273a358bd
+  data.tar.gz: c3a01adb46dcaa7487c7a110fe53b061746e4f7e
+SHA512:
+  metadata.gz: 88f51cd23a71e8a822ce50844fcb5780bef752f55bdc3ba96c9458bffa0fd2e1ff1d67578f2b1e34d5958aec653758b23237bffb89b29f797f3219c146ceda03
+  data.tar.gz: eb14de8cf9881d5e6f1b32164d0de68c992510cf95809d8ef11ed44f7c586c8fb11aee431d585f7629f42b10fc09cb87b2475936a9ccf99acdfdb852e9ef9c21

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2001-2016 Aspose Pty Ltd
+
+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.
+

data/README.md

@@ -0,0 +1,48 @@
+# Aspose.Email Cloud SDK For Ruby
+This SDK lets you use [Aspose Cloud Email APIs](http://www.aspose.com/cloud/email-api.aspx) in your Ruby web apps.
+
+## Installing
+You can simply install Aspose Email Cloud SDK with gem:
+
+`gem install aspose_email_cloud`
+
+## Usage
+APIs of this SDK can be called as follows:
+
+```ruby
+require 'aspose_email_cloud'
+
+class EmailUsage
+  
+  include AsposeEmailCloud
+  include AsposeStorageCloud
+	
+  def initialize
+    #Get App key and App SID from https://cloud.aspose.com
+    AsposeApp.app_key_and_sid("APP_KEY", "APP_SID")
+    @email_api = EmailApi.new  
+  end
+
+  def upload_file(file_name)
+    @storage_api = StorageApi.new
+    response = @storage_api.put_create(file_name, File.open("data/" << file_name,"r") { |io| io.read } )
+  end
+  
+  def get_document_with_format
+    #Get mail in specified format
+    file_name = "email_test.eml"
+    upload_file(file_name)
+    
+    response = @email_api.get_document_with_format(file_name, "msg")
+  end
+  
+end
+```
+## Unit Tests
+Aspose Email SDK includes a suite of unit tests within the [test](https://github.com/asposeemail/Aspose_Email_Cloud/blob/master/SDKs/Aspose.Email_Cloud_SDK_for_Ruby/test/email_tests.rb) subdirectory. These Unit Tests also serves as examples of how to use the Aspose Email SDK.
+
+## Contact
+Your feedback is very important to us. Please email us all your queries and feedback at marketplace@aspose.com.
+
+## License
+Aspose Email SDK is available under the MIT license. See the [LICENSE](https://github.com/asposeemail/Aspose_Email_Cloud/blob/master/SDKs/Aspose.Email_Cloud_SDK_for_Ruby/LICENSE) file for more info.

data/aspose_email_cloud.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "aspose_email_cloud/version"
+
+Gem::Specification.new do |s|
+  s.name        = "aspose_email_cloud"
+  s.version     = AsposeEmailCloud::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["M. Sohail Ismail"]
+  s.email       = ["muhammad.sohail@aspose.com"]
+  s.homepage    = "http://www.aspose.com/cloud/email-api.aspx"
+  s.summary     = %q{Aspose.Email for Cloud}
+  s.description = %q{Aspose.Email for Cloud is a REST API for creating email archiving applications that work with common email file formats. It lets developers manipulate message formats such as MSG, EML, and MHT files. The API supports many common tasks, for example accessing messages, reading message properties such as sender, receiver, message sent date, and message details. It also supports converting messages back and forth between EML, MSG and MHT formats. With Aspose.Email for Cloud, it is further possible to access messages and retrieve attachments that can then be saved to a local disc. The robust API saves developers time and effort when programming with emails in the cloud.}
+  s.license     = "MIT"
+
+  s.add_runtime_dependency 'typhoeus', '~> 0.8'
+  s.add_runtime_dependency 'json', '~> 1.7'
+  s.add_runtime_dependency 'aspose_storage_cloud', '~> 1.0', '>= 1.0.0'
+
+  s.add_development_dependency 'minitest', '~> 5.8'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- test/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/lib/aspose_email_cloud.rb

@@ -0,0 +1,38 @@
+require 'aspose_storage_cloud'
+
+# Common files
+require_relative 'aspose_email_cloud/api_client'
+require_relative 'aspose_email_cloud/api_error'
+require_relative 'aspose_email_cloud/version'
+require_relative 'aspose_email_cloud/configuration'
+
+# Models
+require_relative 'aspose_email_cloud/models/base_object'
+require_relative 'aspose_email_cloud/models/email_document'
+require_relative 'aspose_email_cloud/models/email_properties'
+require_relative 'aspose_email_cloud/models/stream'
+require_relative 'aspose_email_cloud/models/email_property'
+require_relative 'aspose_email_cloud/models/email_document_response'
+require_relative 'aspose_email_cloud/models/email_property_response'
+require_relative 'aspose_email_cloud/models/link'
+
+# APIs
+require_relative 'aspose_email_cloud/api/email_api'
+
+module AsposeEmailCloud
+  class << self
+    # Configure sdk using block.
+    # AsposeEmailCloud.configure do |config|
+    #   config.username = "xxx"
+    #   config.password = "xxx"
+    # end
+    # If no block given, return the configuration singleton instance.
+    def configure
+      if block_given?
+        yield Configuration.instance
+      else
+        Configuration.instance
+      end
+    end
+  end
+end

data/lib/aspose_email_cloud/api/email_api.rb

@@ -0,0 +1,431 @@
+require "uri"
+
+module AsposeEmailCloud
+  class EmailApi
+    attr_accessor :api_client
+
+    def initialize(api_client = nil)
+      @api_client = api_client || Configuration.api_client
+    end
+    
+    # Get mail common info.
+    #
+    # @param name File name.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :storage The document storage.
+    # @option opts [String] :folder Folder path.
+    # @return [File]
+    def get_document(name, opts = {})
+        if Configuration.debugging
+            Configuration.logger.debug "Calling API: EmailApi#get_document ..."
+        end
+        
+        # verify the required parameter 'name' is set
+        fail "Missing the required parameter 'name' when calling get_document" if name.nil?
+        
+        # resource path
+        path = "/email/{name}".sub('{format}','json').sub('{' + 'name' + '}', name.to_s)
+        
+        # query parameters
+        query_params = {}
+        query_params[:'storage'] = opts[:'storage'] if opts[:'storage']
+        query_params[:'folder'] = opts[:'folder'] if opts[:'folder']
+        
+        # header parameters
+        header_params = {}
+        
+        # HTTP header 'Accept' (if needed)
+        _header_accept = []
+        _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+        
+        # HTTP header 'Content-Type'
+        _header_content_type = ['application/json']
+        header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+        
+        # form parameters
+        form_params = {}
+        
+        # http body (model)
+        post_body = nil
+        
+        
+        auth_names = []
+        result = @api_client.call_api(:GET, path,
+                                      :header_params => header_params,
+                                      :query_params => query_params,
+                                      :form_params => form_params,
+                                      :body => post_body,
+                                      :auth_names => auth_names,
+                                      :return_type => 'File')
+                                      if Configuration.debugging
+                                          Configuration.logger.debug "API called: EmailApi#get_document. Result: #{result.inspect}"
+                                      end
+                                      return result
+    end
+    
+    # Get mail in specified format
+    # 
+    # @param name File name.
+    # @param format 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :out_path 
+    # @option opts [String] :storage The document storage.
+    # @option opts [String] :folder Folder path.
+    # @return [File]
+    def get_document_with_format(name, format, opts = {})
+      if Configuration.debugging
+        Configuration.logger.debug "Calling API: EmailApi#get_document_with_format ..."
+      end
+      
+      # verify the required parameter 'name' is set
+      fail "Missing the required parameter 'name' when calling get_document_with_format" if name.nil?
+      
+      # verify the required parameter 'format' is set
+      fail "Missing the required parameter 'format' when calling get_document_with_format" if format.nil?
+      
+      # resource path
+      path = "/email/{name}".sub('{format}','json').sub('{' + 'name' + '}', name.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'format'] = format
+      query_params[:'outPath'] = opts[:'out_path'] if opts[:'out_path']
+      query_params[:'storage'] = opts[:'storage'] if opts[:'storage']
+      query_params[:'folder'] = opts[:'folder'] if opts[:'folder']
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = []
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      
+
+      auth_names = []
+      result = @api_client.call_api(:GET, path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'File')
+      if Configuration.debugging
+        Configuration.logger.debug "API called: EmailApi#get_document_with_format. Result: #{result.inspect}"
+      end
+      return result
+    end
+
+    # Add new email.
+    # 
+    # @param name The email name.
+    # @param email Email data.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :storage The document storage.
+    # @option opts [String] :folder The email folder.
+    # @return [EmailDocumentResponse]
+    def put_create_new_email(name, email, opts = {})
+      if Configuration.debugging
+        Configuration.logger.debug "Calling API: EmailApi#put_create_new_email ..."
+      end
+      
+      # verify the required parameter 'name' is set
+      fail "Missing the required parameter 'name' when calling put_create_new_email" if name.nil?
+      
+      # verify the required parameter 'email' is set
+      fail "Missing the required parameter 'email' when calling put_create_new_email" if email.nil?
+      
+      # resource path
+      path = "/email/{name}".sub('{format}','json').sub('{' + 'name' + '}', name.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'storage'] = opts[:'storage'] if opts[:'storage']
+      query_params[:'folder'] = opts[:'folder'] if opts[:'folder']
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = ['application/json', 'text/json', 'application/xml', 'text/xml', 'text/javascript']
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = ['application/json', 'text/json', 'application/xml', 'text/xml', 'text/javascript', 'application/x-www-form-urlencoded']
+      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(email)
+      
+
+      auth_names = []
+      result = @api_client.call_api(:PUT, path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'EmailDocumentResponse')
+      if Configuration.debugging
+        Configuration.logger.debug "API called: EmailApi#put_create_new_email. Result: #{result.inspect}"
+      end
+      return result
+    end
+
+    # Get email attachment by name.
+    # 
+    # @param name The email message name.
+    # @param attach_name Attachment name.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :storage Message storage.
+    # @option opts [String] :folder Message folder.
+    # @return [File]
+    def get_email_attachment(name, attach_name, opts = {})
+      if Configuration.debugging
+        Configuration.logger.debug "Calling API: EmailApi#get_email_attachment ..."
+      end
+      
+      # verify the required parameter 'name' is set
+      fail "Missing the required parameter 'name' when calling get_email_attachment" if name.nil?
+      
+      # verify the required parameter 'attach_name' is set
+      fail "Missing the required parameter 'attach_name' when calling get_email_attachment" if attach_name.nil?
+      
+      # resource path
+      path = "/email/{name}/attachments/{attachName}".sub('{format}','json').sub('{' + 'name' + '}', name.to_s).sub('{' + 'attachName' + '}', attach_name.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'storage'] = opts[:'storage'] if opts[:'storage']
+      query_params[:'folder'] = opts[:'folder'] if opts[:'folder']
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = []
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = []
+      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      
+
+      auth_names = []
+      result = @api_client.call_api(:GET, path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'File')
+      if Configuration.debugging
+        Configuration.logger.debug "API called: EmailApi#get_email_attachment. Result: #{result.inspect}"
+      end
+      return result
+    end
+
+    # Add email attachment.
+    # 
+    # @param name Email name.
+    # @param attach_name Attachment path.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :storage Email's storage.
+    # @option opts [String] :folder Email's folder.
+    # @return [EmailDocumentResponse]
+    def post_add_email_attachment(name, attach_name, opts = {})
+      if Configuration.debugging
+        Configuration.logger.debug "Calling API: EmailApi#post_add_email_attachment ..."
+      end
+      
+      # verify the required parameter 'name' is set
+      fail "Missing the required parameter 'name' when calling post_add_email_attachment" if name.nil?
+      
+      # verify the required parameter 'attach_name' is set
+      fail "Missing the required parameter 'attach_name' when calling post_add_email_attachment" if attach_name.nil?
+      
+      # resource path
+      path = "/email/{name}/attachments/{attachName}".sub('{format}','json').sub('{' + 'name' + '}', name.to_s).sub('{' + 'attachName' + '}', attach_name.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'storage'] = opts[:'storage'] if opts[:'storage']
+      query_params[:'folder'] = opts[:'folder'] if opts[:'folder']
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = ['application/json', 'text/json', 'application/xml', 'text/xml', 'text/javascript']
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = []
+      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      
+
+      auth_names = []
+      result = @api_client.call_api(:POST, path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'EmailDocumentResponse')
+      if Configuration.debugging
+        Configuration.logger.debug "API called: EmailApi#post_add_email_attachment. Result: #{result.inspect}"
+      end
+      return result
+    end
+
+    # Read document property by name.
+    # 
+    # @param property_name Name of document property
+    # @param name File name
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :storage The document storage.
+    # @option opts [String] :folder Folder path
+    # @return [EmailPropertyResponse]
+    def get_email_property(property_name, name, opts = {})
+      if Configuration.debugging
+        Configuration.logger.debug "Calling API: EmailApi#get_email_property ..."
+      end
+      
+      # verify the required parameter 'property_name' is set
+      fail "Missing the required parameter 'property_name' when calling get_email_property" if property_name.nil?
+      
+      # verify the required parameter 'name' is set
+      fail "Missing the required parameter 'name' when calling get_email_property" if name.nil?
+      
+      # resource path
+      path = "/email/{name}/properties/{propertyName}".sub('{format}','json').sub('{' + 'propertyName' + '}', property_name.to_s).sub('{' + 'name' + '}', name.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'storage'] = opts[:'storage'] if opts[:'storage']
+      query_params[:'folder'] = opts[:'folder'] if opts[:'folder']
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = ['application/json']
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = []
+      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      
+
+      auth_names = []
+      result = @api_client.call_api(:GET, path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'EmailPropertyResponse')
+      if Configuration.debugging
+        Configuration.logger.debug "API called: EmailApi#get_email_property. Result: #{result.inspect}"
+      end
+      return result
+    end
+
+    # Set document property.
+    # 
+    # @param name 
+    # @param property_name 
+    # @param property 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :storage 
+    # @option opts [String] :folder 
+    # @return [EmailPropertyResponse]
+    def put_set_email_property(name, property_name, property, opts = {})
+      if Configuration.debugging
+        Configuration.logger.debug "Calling API: EmailApi#put_set_email_property ..."
+      end
+      
+      # verify the required parameter 'name' is set
+      fail "Missing the required parameter 'name' when calling put_set_email_property" if name.nil?
+      
+      # verify the required parameter 'property_name' is set
+      fail "Missing the required parameter 'property_name' when calling put_set_email_property" if property_name.nil?
+      
+      # verify the required parameter 'property' is set
+      fail "Missing the required parameter 'property' when calling put_set_email_property" if property.nil?
+      
+      # resource path
+      path = "/email/{name}/properties/{propertyName}".sub('{format}','json').sub('{' + 'name' + '}', name.to_s).sub('{' + 'propertyName' + '}', property_name.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'storage'] = opts[:'storage'] if opts[:'storage']
+      query_params[:'folder'] = opts[:'folder'] if opts[:'folder']
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = ['application/json', 'text/json', 'application/xml', 'text/xml', 'text/javascript']
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = ['application/json', 'text/json', 'application/xml', 'text/xml', 'text/javascript', 'application/x-www-form-urlencoded']
+      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(property)
+      
+
+      auth_names = []
+      result = @api_client.call_api(:PUT, path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'EmailPropertyResponse')
+      if Configuration.debugging
+        Configuration.logger.debug "API called: EmailApi#put_set_email_property. Result: #{result.inspect}"
+      end
+      return result
+    end
+  end
+end
+
+
+
+