Class: CloudmersiveValidateApiClient::EmailApi
- Inherits:
-
Object
- Object
- CloudmersiveValidateApiClient::EmailApi
- Defined in:
- lib/cloudmersive-validate-api-client/api/email_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#email_address_get_servers(email, opts = {}) ⇒ AddressGetServersResponse
Partially check whether an email address is valid Validate an email address by identifying whether its parent domain has email servers defined.
-
#email_address_get_servers_with_http_info(email, opts = {}) ⇒ Array<(AddressGetServersResponse, Fixnum, Hash)>
Partially check whether an email address is valid Validate an email address by identifying whether its parent domain has email servers defined.
-
#email_full_validation(email, opts = {}) ⇒ FullEmailValidationResponse
Fully validate an email address Performs a full validation of the email address.
-
#email_full_validation_with_http_info(email, opts = {}) ⇒ Array<(FullEmailValidationResponse, Fixnum, Hash)>
Fully validate an email address Performs a full validation of the email address.
-
#email_post(value, opts = {}) ⇒ AddressVerifySyntaxOnlyResponse
Validate email adddress for syntactic correctness only Validate whether a given email address is syntactically correct via a limited local-only check.
-
#email_post_with_http_info(value, opts = {}) ⇒ Array<(AddressVerifySyntaxOnlyResponse, Fixnum, Hash)>
Validate email adddress for syntactic correctness only Validate whether a given email address is syntactically correct via a limited local-only check.
-
#initialize(api_client = ApiClient.default) ⇒ EmailApi
constructor
A new instance of EmailApi.
Constructor Details
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
17 18 19 |
# File 'lib/cloudmersive-validate-api-client/api/email_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#email_address_get_servers(email, opts = {}) ⇒ AddressGetServersResponse
Partially check whether an email address is valid Validate an email address by identifying whether its parent domain has email servers defined. This call is less limited than syntaxOnly but not as comprehensive as address/full.
27 28 29 30 |
# File 'lib/cloudmersive-validate-api-client/api/email_api.rb', line 27 def email_address_get_servers(email, opts = {}) data, _status_code, _headers = email_address_get_servers_with_http_info(email, opts) data end |
#email_address_get_servers_with_http_info(email, opts = {}) ⇒ Array<(AddressGetServersResponse, Fixnum, Hash)>
Partially check whether an email address is valid Validate an email address by identifying whether its parent domain has email servers defined. This call is less limited than syntaxOnly but not as comprehensive as address/full.
37 38 39 40 41 42 43 44 45 46 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 |
# File 'lib/cloudmersive-validate-api-client/api/email_api.rb', line 37 def email_address_get_servers_with_http_info(email, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: EmailApi.email_address_get_servers ...' end # verify the required parameter 'email' is set if @api_client.config.client_side_validation && email.nil? fail ArgumentError, "Missing the required parameter 'email' when calling EmailApi.email_address_get_servers" end # resource path local_var_path = '/validate/email/address/servers' # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(email) auth_names = ['Apikey'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'AddressGetServersResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: EmailApi#email_address_get_servers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#email_full_validation(email, opts = {}) ⇒ FullEmailValidationResponse
Fully validate an email address Performs a full validation of the email address. Checks for syntactic correctness, identifies the mail server in question if any, and then contacts the email server to validate the existence of the account - without sending any emails.
81 82 83 84 |
# File 'lib/cloudmersive-validate-api-client/api/email_api.rb', line 81 def email_full_validation(email, opts = {}) data, _status_code, _headers = email_full_validation_with_http_info(email, opts) data end |
#email_full_validation_with_http_info(email, opts = {}) ⇒ Array<(FullEmailValidationResponse, Fixnum, Hash)>
Fully validate an email address Performs a full validation of the email address. Checks for syntactic correctness, identifies the mail server in question if any, and then contacts the email server to validate the existence of the account - without sending any emails.
91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 |
# File 'lib/cloudmersive-validate-api-client/api/email_api.rb', line 91 def email_full_validation_with_http_info(email, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: EmailApi.email_full_validation ...' end # verify the required parameter 'email' is set if @api_client.config.client_side_validation && email.nil? fail ArgumentError, "Missing the required parameter 'email' when calling EmailApi.email_full_validation" end # resource path local_var_path = '/validate/email/address/full' # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(email) auth_names = ['Apikey'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'FullEmailValidationResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: EmailApi#email_full_validation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#email_post(value, opts = {}) ⇒ AddressVerifySyntaxOnlyResponse
Validate email adddress for syntactic correctness only Validate whether a given email address is syntactically correct via a limited local-only check. Use the address/full API to do a full validation.
135 136 137 138 |
# File 'lib/cloudmersive-validate-api-client/api/email_api.rb', line 135 def email_post(value, opts = {}) data, _status_code, _headers = email_post_with_http_info(value, opts) data end |
#email_post_with_http_info(value, opts = {}) ⇒ Array<(AddressVerifySyntaxOnlyResponse, Fixnum, Hash)>
Validate email adddress for syntactic correctness only Validate whether a given email address is syntactically correct via a limited local-only check. Use the address/full API to do a full validation.
145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 |
# File 'lib/cloudmersive-validate-api-client/api/email_api.rb', line 145 def email_post_with_http_info(value, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: EmailApi.email_post ...' end # verify the required parameter 'value' is set if @api_client.config.client_side_validation && value.nil? fail ArgumentError, "Missing the required parameter 'value' when calling EmailApi.email_post" end # resource path local_var_path = '/validate/email/address/syntaxOnly' # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(value) auth_names = ['Apikey'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'AddressVerifySyntaxOnlyResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: EmailApi#email_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |