mailslurp_client 5.0.0 → 7.0.7

data/docs/Email.md

@@ -1,24 +1,49 @@
 # MailSlurpClient::Email
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **analysis** | [**EmailAnalysis**](EmailAnalysis.md) |  | [optional] 
-**attachments** | **Array<String>** |  | [optional] 
-**bcc** | **Array<String>** |  | [optional] 
-**body** | **String** |  | [optional] 
-**cc** | **Array<String>** |  | [optional] 
-**charset** | **String** |  | [optional] 
-**created_at** | **DateTime** |  | 
-**from** | **String** |  | [optional] 
+**attachments** | **Array<String>** | List of IDs of attachments found in the email. Use these IDs with the Inbox and Email Controllers to download attachments and attachment meta data such as filesize, name, extension. | [optional] 
+**bcc** | **Array<String>** | List of `BCC` recipients email was addressed to | [optional] 
+**body** | **String** | The body of the email message | [optional] 
+**cc** | **Array<String>** | List of `CC` recipients email was addressed to | [optional] 
+**charset** | **String** | Detected character set of the email body such as UTF-8 | [optional] 
+**created_at** | **DateTime** | When was the email received by MailSlurp | [optional] 
+**from** | **String** | Who the email was sent from | [optional] 
 **headers** | **Hash<String, String>** |  | [optional] 
-**html** | **BOOLEAN** |  | [optional] 
-**id** | **String** |  | 
-**inbox_id** | **String** |  | 
-**raw_url** | **String** |  | [optional] 
-**subject** | **String** |  | [optional] 
-**to** | **Array<String>** |  | 
-**updated_at** | **DateTime** |  | 
-**user_id** | **String** |  | 
+**id** | **String** | ID of the email | [optional] 
+**inbox_id** | **String** | ID of the inbox that received the email | [optional] 
+**is_html** | **Boolean** | Was HTML sent in the email body | [optional] 
+**read** | **Boolean** | Has the email been viewed ever | [optional] 
+**subject** | **String** | The subject line of the email message | [optional] 
+**to** | **Array<String>** | List of `To` recipients email was addressed to | [optional] 
+**updated_at** | **DateTime** | When was the email last updated | [optional] 
+**user_id** | **String** | ID of user that email belongs | [optional] 
+
+## Code Sample
+
+```ruby
+require 'MailSlurpClient'
+
+instance = MailSlurpClient::Email.new(analysis: null,
+                                 attachments: null,
+                                 bcc: null,
+                                 body: null,
+                                 cc: null,
+                                 charset: null,
+                                 created_at: null,
+                                 from: null,
+                                 headers: null,
+                                 id: null,
+                                 inbox_id: null,
+                                 is_html: null,
+                                 read: null,
+                                 subject: null,
+                                 to: null,
+                                 updated_at: null,
+                                 user_id: null)
+```
 
 

data/docs/EmailAnalysis.md

@@ -1,12 +1,25 @@
 # MailSlurpClient::EmailAnalysis
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**dkim_verdict** | **String** |  | 
-**dmarc_verdict** | **String** |  | 
-**spam_verdict** | **String** |  | 
-**spf_verdict** | **String** |  | 
-**virus_verdict** | **String** |  | 
+**dkim_verdict** | **String** |  | [optional] 
+**dmarc_verdict** | **String** |  | [optional] 
+**spam_verdict** | **String** |  | [optional] 
+**spf_verdict** | **String** |  | [optional] 
+**virus_verdict** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'MailSlurpClient'
+
+instance = MailSlurpClient::EmailAnalysis.new(dkim_verdict: null,
+                                 dmarc_verdict: null,
+                                 spam_verdict: null,
+                                 spf_verdict: null,
+                                 virus_verdict: null)
+```
 
 

data/docs/EmailControllerApi.md

@@ -0,0 +1,740 @@
+# MailSlurpClient::EmailControllerApi
+
+All URIs are relative to *https://api.mailslurp.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete_all_emails**](EmailControllerApi.md#delete_all_emails) | **DELETE** /emails | Delete all emails
+[**delete_email**](EmailControllerApi.md#delete_email) | **DELETE** /emails/{emailId} | Delete an email
+[**download_attachment**](EmailControllerApi.md#download_attachment) | **GET** /emails/{emailId}/attachments/{attachmentId} | Get email attachment bytes
+[**forward_email**](EmailControllerApi.md#forward_email) | **POST** /emails/{emailId}/forward | Forward email
+[**get_attachment_meta_data**](EmailControllerApi.md#get_attachment_meta_data) | **GET** /emails/{emailId}/attachments/{attachmentId}/metadata | Get email attachment metadata
+[**get_attachments**](EmailControllerApi.md#get_attachments) | **GET** /emails/{emailId}/attachments | Get all email attachment metadata
+[**get_email**](EmailControllerApi.md#get_email) | **GET** /emails/{emailId} | Get email content
+[**get_email_html**](EmailControllerApi.md#get_email_html) | **GET** /emails/{emailId}/html | Get email content as HTML
+[**get_emails_paginated**](EmailControllerApi.md#get_emails_paginated) | **GET** /emails | Get all emails
+[**get_raw_email_contents**](EmailControllerApi.md#get_raw_email_contents) | **GET** /emails/{emailId}/raw | Get raw email string
+[**get_raw_email_json**](EmailControllerApi.md#get_raw_email_json) | **GET** /emails/{emailId}/raw/json | Get raw email in JSON
+[**get_unread_email_count**](EmailControllerApi.md#get_unread_email_count) | **GET** /emails/unreadCount | Get unread email count
+[**validate_email**](EmailControllerApi.md#validate_email) | **POST** /emails/{emailId}/validate | Validate email
+
+
+
+## delete_all_emails
+
+> delete_all_emails
+
+Delete all emails
+
+Deletes all emails in your account. Be careful as emails cannot be recovered
+
+### Example
+
+```ruby
+# load the gem
+require 'mailslurp_client'
+# setup authorization
+MailSlurpClient.configure do |config|
+  # Configure API key authorization: API_KEY
+  config.api_key['x-api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['x-api-key'] = 'Bearer'
+end
+
+api_instance = MailSlurpClient::EmailControllerApi.new
+
+begin
+  #Delete all emails
+  api_instance.delete_all_emails
+rescue MailSlurpClient::ApiError => e
+  puts "Exception when calling EmailControllerApi->delete_all_emails: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[API_KEY](../README.md#API_KEY)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## delete_email
+
+> delete_email(email_id)
+
+Delete an email
+
+Deletes an email and removes it from the inbox. Deleted emails cannot be recovered.
+
+### Example
+
+```ruby
+# load the gem
+require 'mailslurp_client'
+# setup authorization
+MailSlurpClient.configure do |config|
+  # Configure API key authorization: API_KEY
+  config.api_key['x-api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['x-api-key'] = 'Bearer'
+end
+
+api_instance = MailSlurpClient::EmailControllerApi.new
+email_id = 'email_id_example' # String | emailId
+
+begin
+  #Delete an email
+  api_instance.delete_email(email_id)
+rescue MailSlurpClient::ApiError => e
+  puts "Exception when calling EmailControllerApi->delete_email: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **email_id** | [**String**](.md)| emailId | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[API_KEY](../README.md#API_KEY)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## download_attachment
+
+> String download_attachment(attachment_id, email_id, opts)
+
+Get email attachment bytes
+
+Returns the specified attachment for a given email as a byte stream (file download). You can find attachment ids in email responses endpoint responses. The response type is application/octet-stream.
+
+### Example
+
+```ruby
+# load the gem
+require 'mailslurp_client'
+# setup authorization
+MailSlurpClient.configure do |config|
+  # Configure API key authorization: API_KEY
+  config.api_key['x-api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['x-api-key'] = 'Bearer'
+end
+
+api_instance = MailSlurpClient::EmailControllerApi.new
+attachment_id = 'attachment_id_example' # String | attachmentId
+email_id = 'email_id_example' # String | emailId
+opts = {
+  api_key: 'api_key_example' # String | Can pass apiKey in url for this request if you wish to download the file in a browser
+}
+
+begin
+  #Get email attachment bytes
+  result = api_instance.download_attachment(attachment_id, email_id, opts)
+  p result
+rescue MailSlurpClient::ApiError => e
+  puts "Exception when calling EmailControllerApi->download_attachment: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **attachment_id** | **String**| attachmentId | 
+ **email_id** | [**String**](.md)| emailId | 
+ **api_key** | **String**| Can pass apiKey in url for this request if you wish to download the file in a browser | [optional] 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[API_KEY](../README.md#API_KEY)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/octet-stream
+
+
+## forward_email
+
+> forward_email(email_id, forward_email_options)
+
+Forward email
+
+Forward an existing email to new recipients.
+
+### Example
+
+```ruby
+# load the gem
+require 'mailslurp_client'
+# setup authorization
+MailSlurpClient.configure do |config|
+  # Configure API key authorization: API_KEY
+  config.api_key['x-api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['x-api-key'] = 'Bearer'
+end
+
+api_instance = MailSlurpClient::EmailControllerApi.new
+email_id = 'email_id_example' # String | emailId
+forward_email_options = MailSlurpClient::ForwardEmailOptions.new # ForwardEmailOptions | forwardEmailOptions
+
+begin
+  #Forward email
+  api_instance.forward_email(email_id, forward_email_options)
+rescue MailSlurpClient::ApiError => e
+  puts "Exception when calling EmailControllerApi->forward_email: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **email_id** | [**String**](.md)| emailId | 
+ **forward_email_options** | [**ForwardEmailOptions**](ForwardEmailOptions.md)| forwardEmailOptions | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[API_KEY](../README.md#API_KEY)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: Not defined
+
+
+## get_attachment_meta_data
+
+> AttachmentMetaData get_attachment_meta_data(attachment_id, email_id)
+
+Get email attachment metadata
+
+Returns the metadata such as name and content-type for a given attachment and email.
+
+### Example
+
+```ruby
+# load the gem
+require 'mailslurp_client'
+# setup authorization
+MailSlurpClient.configure do |config|
+  # Configure API key authorization: API_KEY
+  config.api_key['x-api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['x-api-key'] = 'Bearer'
+end
+
+api_instance = MailSlurpClient::EmailControllerApi.new
+attachment_id = 'attachment_id_example' # String | attachmentId
+email_id = 'email_id_example' # String | emailId
+
+begin
+  #Get email attachment metadata
+  result = api_instance.get_attachment_meta_data(attachment_id, email_id)
+  p result
+rescue MailSlurpClient::ApiError => e
+  puts "Exception when calling EmailControllerApi->get_attachment_meta_data: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **attachment_id** | **String**| attachmentId | 
+ **email_id** | [**String**](.md)| emailId | 
+
+### Return type
+
+[**AttachmentMetaData**](AttachmentMetaData.md)
+
+### Authorization
+
+[API_KEY](../README.md#API_KEY)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_attachments
+
+> Array<AttachmentMetaData> get_attachments(email_id)
+
+Get all email attachment metadata
+
+Returns an array of attachment metadata such as name and content-type for a given email if present.
+
+### Example
+
+```ruby
+# load the gem
+require 'mailslurp_client'
+# setup authorization
+MailSlurpClient.configure do |config|
+  # Configure API key authorization: API_KEY
+  config.api_key['x-api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['x-api-key'] = 'Bearer'
+end
+
+api_instance = MailSlurpClient::EmailControllerApi.new
+email_id = 'email_id_example' # String | emailId
+
+begin
+  #Get all email attachment metadata
+  result = api_instance.get_attachments(email_id)
+  p result
+rescue MailSlurpClient::ApiError => e
+  puts "Exception when calling EmailControllerApi->get_attachments: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **email_id** | [**String**](.md)| emailId | 
+
+### Return type
+
+[**Array<AttachmentMetaData>**](AttachmentMetaData.md)
+
+### Authorization
+
+[API_KEY](../README.md#API_KEY)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_email
+
+> Email get_email(email_id, opts)
+
+Get email content
+
+Returns a email summary object with headers and content. To retrieve the raw unparsed email use the getRawEmail endpoints
+
+### Example
+
+```ruby
+# load the gem
+require 'mailslurp_client'
+# setup authorization
+MailSlurpClient.configure do |config|
+  # Configure API key authorization: API_KEY
+  config.api_key['x-api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['x-api-key'] = 'Bearer'
+end
+
+api_instance = MailSlurpClient::EmailControllerApi.new
+email_id = 'email_id_example' # String | emailId
+opts = {
+  decode: false # Boolean | Decode email body quoted-printable encoding to plain text. SMTP servers often encode text using quoted-printable format (for instance `=D7`). This can be a pain for testing
+}
+
+begin
+  #Get email content
+  result = api_instance.get_email(email_id, opts)
+  p result
+rescue MailSlurpClient::ApiError => e
+  puts "Exception when calling EmailControllerApi->get_email: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **email_id** | [**String**](.md)| emailId | 
+ **decode** | **Boolean**| Decode email body quoted-printable encoding to plain text. SMTP servers often encode text using quoted-printable format (for instance `=D7`). This can be a pain for testing | [optional] [default to false]
+
+### Return type
+
+[**Email**](Email.md)
+
+### Authorization
+
+[API_KEY](../README.md#API_KEY)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_email_html
+
+> String get_email_html(email_id, opts)
+
+Get email content as HTML
+
+Retrieve email content as HTML response for viewing in browsers. Decodes quoted-printable entities and converts charset to UTF-8. Pass your API KEY as a request parameter when viewing in a browser: `?apiKey=xxx`
+
+### Example
+
+```ruby
+# load the gem
+require 'mailslurp_client'
+# setup authorization
+MailSlurpClient.configure do |config|
+  # Configure API key authorization: API_KEY
+  config.api_key['x-api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['x-api-key'] = 'Bearer'
+end
+
+api_instance = MailSlurpClient::EmailControllerApi.new
+email_id = 'email_id_example' # String | emailId
+opts = {
+  decode: false # Boolean | decode
+}
+
+begin
+  #Get email content as HTML
+  result = api_instance.get_email_html(email_id, opts)
+  p result
+rescue MailSlurpClient::ApiError => e
+  puts "Exception when calling EmailControllerApi->get_email_html: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **email_id** | [**String**](.md)| emailId | 
+ **decode** | **Boolean**| decode | [optional] [default to false]
+
+### Return type
+
+**String**
+
+### Authorization
+
+[API_KEY](../README.md#API_KEY)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: text/html
+
+
+## get_emails_paginated
+
+> PageEmailProjection get_emails_paginated(opts)
+
+Get all emails
+
+By default returns all emails across all inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages
+
+### Example
+
+```ruby
+# load the gem
+require 'mailslurp_client'
+# setup authorization
+MailSlurpClient.configure do |config|
+  # Configure API key authorization: API_KEY
+  config.api_key['x-api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['x-api-key'] = 'Bearer'
+end
+
+api_instance = MailSlurpClient::EmailControllerApi.new
+opts = {
+  inbox_id: ['inbox_id_example'], # Array<String> | Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account.
+  page: 0, # Integer | Optional page index in email list pagination
+  size: 20, # Integer | Optional page size in email list pagination
+  sort: 'ASC', # String | Optional createdAt sort direction ASC or DESC
+  unread_only: false # Boolean | Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly
+}
+
+begin
+  #Get all emails
+  result = api_instance.get_emails_paginated(opts)
+  p result
+rescue MailSlurpClient::ApiError => e
+  puts "Exception when calling EmailControllerApi->get_emails_paginated: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **inbox_id** | [**Array&lt;String&gt;**](String.md)| Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. | [optional] 
+ **page** | **Integer**| Optional page index in email list pagination | [optional] [default to 0]
+ **size** | **Integer**| Optional page size in email list pagination | [optional] [default to 20]
+ **sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to &#39;ASC&#39;]
+ **unread_only** | **Boolean**| Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly | [optional] [default to false]
+
+### Return type
+
+[**PageEmailProjection**](PageEmailProjection.md)
+
+### Authorization
+
+[API_KEY](../README.md#API_KEY)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_raw_email_contents
+
+> String get_raw_email_contents(email_id)
+
+Get raw email string
+
+Returns a raw, unparsed, and unprocessed email. If your client has issues processing the response it is likely due to the response content-type which is text/plain. If you need a JSON response content-type use the getRawEmailJson endpoint
+
+### Example
+
+```ruby
+# load the gem
+require 'mailslurp_client'
+# setup authorization
+MailSlurpClient.configure do |config|
+  # Configure API key authorization: API_KEY
+  config.api_key['x-api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['x-api-key'] = 'Bearer'
+end
+
+api_instance = MailSlurpClient::EmailControllerApi.new
+email_id = 'email_id_example' # String | emailId
+
+begin
+  #Get raw email string
+  result = api_instance.get_raw_email_contents(email_id)
+  p result
+rescue MailSlurpClient::ApiError => e
+  puts "Exception when calling EmailControllerApi->get_raw_email_contents: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **email_id** | [**String**](.md)| emailId | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[API_KEY](../README.md#API_KEY)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: text/plain
+
+
+## get_raw_email_json
+
+> RawEmailJson get_raw_email_json(email_id)
+
+Get raw email in JSON
+
+Returns a raw, unparsed, and unprocessed email wrapped in a JSON response object for easier handling when compared with the getRawEmail text/plain response
+
+### Example
+
+```ruby
+# load the gem
+require 'mailslurp_client'
+# setup authorization
+MailSlurpClient.configure do |config|
+  # Configure API key authorization: API_KEY
+  config.api_key['x-api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['x-api-key'] = 'Bearer'
+end
+
+api_instance = MailSlurpClient::EmailControllerApi.new
+email_id = 'email_id_example' # String | emailId
+
+begin
+  #Get raw email in JSON
+  result = api_instance.get_raw_email_json(email_id)
+  p result
+rescue MailSlurpClient::ApiError => e
+  puts "Exception when calling EmailControllerApi->get_raw_email_json: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **email_id** | [**String**](.md)| emailId | 
+
+### Return type
+
+[**RawEmailJson**](RawEmailJson.md)
+
+### Authorization
+
+[API_KEY](../README.md#API_KEY)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_unread_email_count
+
+> UnreadCount get_unread_email_count
+
+Get unread email count
+
+Get number of emails unread
+
+### Example
+
+```ruby
+# load the gem
+require 'mailslurp_client'
+# setup authorization
+MailSlurpClient.configure do |config|
+  # Configure API key authorization: API_KEY
+  config.api_key['x-api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['x-api-key'] = 'Bearer'
+end
+
+api_instance = MailSlurpClient::EmailControllerApi.new
+
+begin
+  #Get unread email count
+  result = api_instance.get_unread_email_count
+  p result
+rescue MailSlurpClient::ApiError => e
+  puts "Exception when calling EmailControllerApi->get_unread_email_count: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**UnreadCount**](UnreadCount.md)
+
+### Authorization
+
+[API_KEY](../README.md#API_KEY)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## validate_email
+
+> ValidationDto validate_email(email_id)
+
+Validate email
+
+Validate the HTML content of email if HTML is found. Considered valid if no HTML.
+
+### Example
+
+```ruby
+# load the gem
+require 'mailslurp_client'
+# setup authorization
+MailSlurpClient.configure do |config|
+  # Configure API key authorization: API_KEY
+  config.api_key['x-api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['x-api-key'] = 'Bearer'
+end
+
+api_instance = MailSlurpClient::EmailControllerApi.new
+email_id = 'email_id_example' # String | emailId
+
+begin
+  #Validate email
+  result = api_instance.validate_email(email_id)
+  p result
+rescue MailSlurpClient::ApiError => e
+  puts "Exception when calling EmailControllerApi->validate_email: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **email_id** | [**String**](.md)| emailId | 
+
+### Return type
+
+[**ValidationDto**](ValidationDto.md)
+
+### Authorization
+
+[API_KEY](../README.md#API_KEY)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+