Class: AsposeEmailCloud::GetEmailPropertyRequestData

Inherits:
EmailRequest
  • Object
show all
Defined in:
lib/aspose-email-cloud/models/requests/get_email_property_request_data.rb

Overview

Request model for get_email_property operation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(property_name, file_name, storage = nil, folder = nil) ⇒ GetEmailPropertyRequestData

Get an email document property by its name

Parameters:

  • property_name (String) —

    A property name

  • file_name (String) —

    Email document file name

  • storage (String) (defaults to: nil) —

    Storage name

  • folder (String) (defaults to: nil) —

    Path to folder in storage



53
54
55
56
57
58
 
# File 'lib/aspose-email-cloud/models/requests/get_email_property_request_data.rb', line 53

def initialize(property_name, file_name, storage = nil, folder = nil)
  self.property_name = property_name if property_name
  self.file_name = file_name if file_name
  self.storage = storage if storage
  self.folder = folder if folder
end

Instance Attribute Details

#file_name ⇒ String

Email document file name

Returns:

  • (String) 


40
41
42
 
# File 'lib/aspose-email-cloud/models/requests/get_email_property_request_data.rb', line 40

def file_name
  @file_name
end

#folder ⇒ String

Path to folder in storage

Returns:

  • (String) 


46
47
48
 
# File 'lib/aspose-email-cloud/models/requests/get_email_property_request_data.rb', line 46

def folder
  @folder
end

#property_name ⇒ String

A property name

Returns:

  • (String) 


37
38
39
 
# File 'lib/aspose-email-cloud/models/requests/get_email_property_request_data.rb', line 37

def property_name
  @property_name
end

#storage ⇒ String

Storage name

Returns:

  • (String) 


43
44
45
 
# File 'lib/aspose-email-cloud/models/requests/get_email_property_request_data.rb', line 43

def storage
  @storage
end

Instance Method Details

#to_http_info(api_client) ⇒ Object 



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/aspose-email-cloud/models/requests/get_email_property_request_data.rb', line 60

def to_http_info(api_client)
  # verify the required parameter 'property_name' is set
  if api_client.config.client_side_validation && self.property_name.nil?
    raise ArgumentError, "Missing the required parameter 'property_name' when calling EmailApi.get_email_property"
  end

  # verify the required parameter 'file_name' is set
  if api_client.config.client_side_validation && self.file_name.nil?
    raise ArgumentError, "Missing the required parameter 'file_name' when calling EmailApi.get_email_property"
  end

  # resource path
  local_var_path = '/email/{fileName}/properties/{propertyName}'.sub('{' + 'propertyName' + '}', self.property_name.to_s).sub('{' + 'fileName' + '}', self.file_name.to_s)

  # query parameters
  query_params = {}
  query_params[:storage] = self.storage unless self.storage.nil?
  query_params[:folder] = self.folder unless self.folder.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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = form_params.any? ? 'multipart/form-data' : select_header_content_type(['application/json'])

  AsposeEmailCloud::HttpRequest.new(local_var_path,
                                  header_params,
                                  query_params,
                                  form_params,
                                  post_body,
                                  auth_names)
end