class AsposeEmailCloud::EmailConfigApi

EmailConfigApi operations.

Attributes

api_invoker[R]

Public Class Methods

new(api_invoker) click to toggle source

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

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

Public Instance Methods

discover(request) click to toggle source

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

@param [EmailConfigDiscoverRequest] request Request object. @return [EmailAccountConfigList]

# File lib/aspose-email-cloud/api/email_config_api.rb, line 52
def discover(request)
  http_request = request.to_http_info(@api_invoker.api_client)
  @api_invoker.make_request(http_request, :GET, 'EmailAccountConfigList')
end
discover_oauth(request) click to toggle source

Discover email accounts by email address. Validates discovered accounts using OAuth 2.0.

@param [EmailConfigDiscoverOauthRequest] request Discover email configuration request. @return [EmailAccountConfigList]

# File lib/aspose-email-cloud/api/email_config_api.rb, line 60
def discover_oauth(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 EmailConfigApi.discover_oauth"
  end

  local_var_path = '/email/config/discover/oauth'
  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, 'EmailAccountConfigList')
end
discover_password(request) click to toggle source

Discover email accounts by email address. Validates discovered accounts using login and password.

@param [EmailConfigDiscoverPasswordRequest] request Discover email configuration request. @return [EmailAccountConfigList]

# File lib/aspose-email-cloud/api/email_config_api.rb, line 87
def discover_password(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 EmailConfigApi.discover_password"
  end

  local_var_path = '/email/config/discover/password'
  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, 'EmailAccountConfigList')
end