Class: AsposeEmailCloud::EmailConfigDiscoverRequest

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

Overview

Request model for email_config_discover operation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from EmailRequest

select_header_accept, select_header_content_type

Constructor Details

#initialize(address:, fast_processing: nil) ⇒ EmailConfigDiscoverRequest

Discover email accounts by email address. Does not validate discovered accounts.

Parameters:

  • address (String) —

    Email address.

  • fast_processing (BOOLEAN) (defaults to: nil) —

    Turns on fast processing. All discover systems will run in parallel. First discovered result will be returned.



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

def initialize(address:, fast_processing: nil)
  self.address = address if address
  self.fast_processing = fast_processing if fast_processing
end

Instance Attribute Details

#address ⇒ String

Email address.

Returns:

  • (String) 


34
35
36
 
# File 'lib/aspose-email-cloud/models/email_config_discover_request.rb', line 34

def address
  @address
end

#fast_processing ⇒ BOOLEAN

Turns on fast processing. All discover systems will run in parallel. First discovered result will be returned.

Returns:

  • (BOOLEAN) 


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

def fast_processing
  @fast_processing
end

Instance Method Details

#to_http_info(api_client) ⇒ Object 



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/aspose-email-cloud/models/email_config_discover_request.rb', line 47

def to_http_info(api_client)
  # verify the required parameter 'address' is set
  if api_client.config.client_side_validation && self.address.nil?
    raise ArgumentError, "Missing the required parameter 'address' when calling EmailConfigApi.discover"
  end
  # resource path
  local_var_path = '/email/config/discover'

  # query parameters
  query_params = {}
  query_params[:address] = self.address
  query_params[:fastProcessing] = self.fast_processing unless self.fast_processing.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