class AsposeEmailCloud::EmailApi

EmailApi operations.

Attributes

api_invoker[R]

Public Class Methods

new(api_invoker) click to toggle source

Initializes a new instance of the EmailApi class. @param [ApiInvoker] api_invoker

# File lib/aspose-email-cloud/api/email_api.rb, line 45
def initialize(api_invoker)
  @api_invoker = api_invoker
end

Public Instance Methods

as_file(request) click to toggle source

Converts Email model to a specified format and returns as a file.

@param [EmailAsFileRequest] request Email model and format to convert. @return [File]

# File lib/aspose-email-cloud/api/email_api.rb, line 52
def as_file(request)
  # verify the required parameter 'request' is set
  if @api_invoker.api_client.config.client_side_validation && request.nil?
    raise ArgumentError, "Missing the required parameter 'request' when calling EmailApi.as_file"
  end

  local_var_path = '/email/as-file'
  post_body = @api_invoker.api_client.object_to_http_body(request)
  auth_names = ['JWT']

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = EmailRequest.select_header_accept(['multipart/form-data'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = EmailRequest.select_header_content_type(['application/json'])
  http_request = AsposeEmailCloud::HttpRequest.new(resource_path: local_var_path,
                                                   header_params: header_params,
                                                   body: post_body,
                                                   auth_names: auth_names)

  @api_invoker.make_request(http_request, :PUT, 'File')
end
as_mapi(email_dto) click to toggle source

Converts EmailDto to MapiMessageDto.

@param [EmailDto] email_dto Email model to convert @return [MapiMessageDto]

# File lib/aspose-email-cloud/api/email_api.rb, line 79
def as_mapi(email_dto)
  # verify the required parameter 'email_dto' is set
  if @api_invoker.api_client.config.client_side_validation && email_dto.nil?
    raise ArgumentError, "Missing the required parameter 'email_dto' when calling EmailApi.as_mapi"
  end

  local_var_path = '/email/as-mapi'
  post_body = @api_invoker.api_client.object_to_http_body(email_dto)
  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'] = EmailRequest.select_header_content_type(['application/json'])
  http_request = AsposeEmailCloud::HttpRequest.new(resource_path: local_var_path,
                                                   header_params: header_params,
                                                   body: post_body,
                                                   auth_names: auth_names)

  @api_invoker.make_request(http_request, :PUT, 'MapiMessageDto')
end
convert(request) click to toggle source

Converts email document to specified format and returns as file

@param [EmailConvertRequest] request Request object. @return [File]

# File lib/aspose-email-cloud/api/email_api.rb, line 106
def convert(request)
  http_request = request.to_http_info(@api_invoker.api_client)
  @api_invoker.make_request(http_request, :PUT, 'File')
end
from_file(request) click to toggle source

Converts email document to a model representation

@param [EmailFromFileRequest] request Request object. @return [EmailDto]

# File lib/aspose-email-cloud/api/email_api.rb, line 114
def from_file(request)
  http_request = request.to_http_info(@api_invoker.api_client)
  @api_invoker.make_request(http_request, :PUT, 'EmailDto')
end
get(request) click to toggle source

Get email document from storage.

@param [EmailGetRequest] request Request object. @return [EmailDto]

# File lib/aspose-email-cloud/api/email_api.rb, line 122
def get(request)
  http_request = request.to_http_info(@api_invoker.api_client)
  @api_invoker.make_request(http_request, :GET, 'EmailDto')
end
get_as_file(request) click to toggle source

Converts email document from storage to specified format and returns as file

@param [EmailGetAsFileRequest] request Request object. @return [File]

# File lib/aspose-email-cloud/api/email_api.rb, line 130
def get_as_file(request)
  http_request = request.to_http_info(@api_invoker.api_client)
  @api_invoker.make_request(http_request, :GET, 'File')
end
get_list(request) click to toggle source

Get email list from storage folder.

@param [EmailGetListRequest] request Request object. @return [EmailStorageList]

# File lib/aspose-email-cloud/api/email_api.rb, line 138
def get_list(request)
  http_request = request.to_http_info(@api_invoker.api_client)
  @api_invoker.make_request(http_request, :GET, 'EmailStorageList')
end
save(request) click to toggle source

Save email document to storage.

@param [EmailSaveRequest] request Email document create/update request. @return [nil]

# File lib/aspose-email-cloud/api/email_api.rb, line 146
def save(request)
  # verify the required parameter 'request' is set
  if @api_invoker.api_client.config.client_side_validation && request.nil?
    raise ArgumentError, "Missing the required parameter 'request' when calling EmailApi.save"
  end

  local_var_path = '/email'
  post_body = @api_invoker.api_client.object_to_http_body(request)
  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'] = EmailRequest.select_header_content_type(['application/json'])
  http_request = AsposeEmailCloud::HttpRequest.new(resource_path: local_var_path,
                                                   header_params: header_params,
                                                   body: post_body,
                                                   auth_names: auth_names)

  @api_invoker.make_request(http_request, :PUT, nil)
  nil
end