# mailslurp.Api.EmailControllerApi
All URIs are relative to https://api.mailslurp.com
Method | HTTP request | Description |
---|---|---|
DeleteAllEmails | DELETE /emails | Delete all emails |
DeleteEmail | DELETE /emails/{emailId} | Delete an email |
DownloadAttachment | GET /emails/{emailId}/attachments/{attachmentId} | Get email attachment bytes. If you have trouble with byte responses try the `downloadAttachmentBase64` response endpoints. |
DownloadAttachmentBase64 | GET /emails/{emailId}/attachments/{attachmentId}/base64 | Get email attachment as base64 encoded string (alternative to binary responses) |
ForwardEmail | POST /emails/{emailId}/forward | Forward email |
GetAttachmentMetaData | GET /emails/{emailId}/attachments/{attachmentId}/metadata | Get email attachment metadata |
GetAttachments | GET /emails/{emailId}/attachments | Get all email attachment metadata |
GetEmail | GET /emails/{emailId} | Get email content |
GetEmailContentMatch | POST /emails/{emailId}/contentMatch | Get email content regex pattern match results. Runs regex against email body and returns match groups. |
GetEmailHTML | GET /emails/{emailId}/html | Get email content as HTML |
GetEmailHTMLQuery | GET /emails/{emailId}/htmlQuery | Parse and return text from an email, stripping HTML and decoding encoded characters |
GetEmailTextLines | GET /emails/{emailId}/textLines | Parse and return text from an email, stripping HTML and decoding encoded characters |
GetEmailsPaginated | GET /emails | Get all emails |
GetLatestEmail | GET /emails/latest | Get latest email |
GetLatestEmailInInbox | GET /emails/latestIn | Get latest email |
GetRawEmailContents | GET /emails/{emailId}/raw | Get raw email string |
GetRawEmailJson | GET /emails/{emailId}/raw/json | Get raw email in JSON |
GetUnreadEmailCount | GET /emails/unreadCount | Get unread email count |
ReplyToEmail | PUT /emails/{emailId} | Reply to an email |
ValidateEmail | POST /emails/{emailId}/validate | Validate email |
# DeleteAllEmails
void DeleteAllEmails ()
Delete all emails
Deletes all emails in your account. Be careful as emails cannot be recovered
# Example
using System.Collections.Generic;
using System.Diagnostics;
using mailslurp.Api;
using mailslurp.Client;
using mailslurp.Model;
namespace Example
{
public class DeleteAllEmailsExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://api.mailslurp.com";
// Configure API key authorization: API_KEY
config.AddApiKey("x-api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("x-api-key", "Bearer");
var apiInstance = new EmailControllerApi(config);
try
{
// Delete all emails
apiInstance.DeleteAllEmails();
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.DeleteAllEmails: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
# Parameters
This endpoint does not need any parameter.
# Return type
void (empty response body)
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
# HTTP response details
Status code | Description | Response headers |
---|---|---|
204 | No Content | - |
401 | Unauthorized | - |
403 | Forbidden | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# DeleteEmail
void DeleteEmail (Guid emailId)
Delete an email
Deletes an email and removes it from the inbox. Deleted emails cannot be recovered.
# Example
using System.Collections.Generic;
using System.Diagnostics;
using mailslurp.Api;
using mailslurp.Client;
using mailslurp.Model;
namespace Example
{
public class DeleteEmailExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://api.mailslurp.com";
// Configure API key authorization: API_KEY
config.AddApiKey("x-api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("x-api-key", "Bearer");
var apiInstance = new EmailControllerApi(config);
var emailId = new Guid(); // Guid | ID of email to delete
try
{
// Delete an email
apiInstance.DeleteEmail(emailId);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.DeleteEmail: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
emailId | Guid | ID of email to delete |
# Return type
void (empty response body)
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
# HTTP response details
Status code | Description | Response headers |
---|---|---|
204 | No Content | - |
401 | Unauthorized | - |
403 | Forbidden | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# DownloadAttachment
byte[] DownloadAttachment (string attachmentId, Guid emailId, string apiKey = null)
Get email attachment bytes. If you have trouble with byte responses try the downloadAttachmentBase64
response endpoints.
Returns the specified attachment for a given email as a stream / array of bytes. You can find attachment ids in email responses endpoint responses. The response type is application/octet-stream.
# Example
using System.Collections.Generic;
using System.Diagnostics;
using mailslurp.Api;
using mailslurp.Client;
using mailslurp.Model;
namespace Example
{
public class DownloadAttachmentExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://api.mailslurp.com";
// Configure API key authorization: API_KEY
config.AddApiKey("x-api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("x-api-key", "Bearer");
var apiInstance = new EmailControllerApi(config);
var attachmentId = attachmentId_example; // string | ID of attachment
var emailId = new Guid(); // Guid | ID of email
var apiKey = apiKey_example; // string | Can pass apiKey in url for this request if you wish to download the file in a browser. Content type will be set to original content type of the attachment file. This is so that browsers can download the file correctly. (optional)
try
{
// Get email attachment bytes. If you have trouble with byte responses try the `downloadAttachmentBase64` response endpoints.
byte[] result = apiInstance.DownloadAttachment(attachmentId, emailId, apiKey);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.DownloadAttachment: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
attachmentId | string | ID of attachment | |
emailId | Guid | ID of email | |
apiKey | string | Can pass apiKey in url for this request if you wish to download the file in a browser. Content type will be set to original content type of the attachment file. This is so that browsers can download the file correctly. | [optional] |
# Return type
byte[]
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: application/octet-stream
# HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
401 | Unauthorized | - |
403 | Forbidden | - |
404 | Not Found | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# DownloadAttachmentBase64
DownloadAttachmentDto DownloadAttachmentBase64 (string attachmentId, Guid emailId)
Get email attachment as base64 encoded string (alternative to binary responses)
Returns the specified attachment for a given email as a base 64 encoded string. The response type is application/json. This method is similar to the downloadAttachment
method but allows some clients to get around issues with binary responses.
# Example
using System.Collections.Generic;
using System.Diagnostics;
using mailslurp.Api;
using mailslurp.Client;
using mailslurp.Model;
namespace Example
{
public class DownloadAttachmentBase64Example
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://api.mailslurp.com";
// Configure API key authorization: API_KEY
config.AddApiKey("x-api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("x-api-key", "Bearer");
var apiInstance = new EmailControllerApi(config);
var attachmentId = attachmentId_example; // string | ID of attachment
var emailId = new Guid(); // Guid | ID of email
try
{
// Get email attachment as base64 encoded string (alternative to binary responses)
DownloadAttachmentDto result = apiInstance.DownloadAttachmentBase64(attachmentId, emailId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.DownloadAttachmentBase64: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
attachmentId | string | ID of attachment | |
emailId | Guid | ID of email |
# Return type
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
# HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
401 | Unauthorized | - |
403 | Forbidden | - |
404 | Not Found | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# ForwardEmail
void ForwardEmail (Guid emailId, ForwardEmailOptions forwardEmailOptions)
Forward email
Forward an existing email to new recipients.
# Example
using System.Collections.Generic;
using System.Diagnostics;
using mailslurp.Api;
using mailslurp.Client;
using mailslurp.Model;
namespace Example
{
public class ForwardEmailExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://api.mailslurp.com";
// Configure API key authorization: API_KEY
config.AddApiKey("x-api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("x-api-key", "Bearer");
var apiInstance = new EmailControllerApi(config);
var emailId = new Guid(); // Guid | ID of email
var forwardEmailOptions = new ForwardEmailOptions(); // ForwardEmailOptions | forwardEmailOptions
try
{
// Forward email
apiInstance.ForwardEmail(emailId, forwardEmailOptions);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.ForwardEmail: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
emailId | Guid | ID of email | |
forwardEmailOptions | ForwardEmailOptions | forwardEmailOptions |
# Return type
void (empty response body)
# Authorization
# HTTP request headers
- Content-Type: application/json
- Accept: Not defined
# HTTP response details
Status code | Description | Response headers |
---|---|---|
201 | Created | - |
401 | Unauthorized | - |
403 | Forbidden | - |
404 | Not Found | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# GetAttachmentMetaData
AttachmentMetaData GetAttachmentMetaData (string attachmentId, Guid emailId)
Get email attachment metadata
Returns the metadata such as name and content-type for a given attachment and email.
# Example
using System.Collections.Generic;
using System.Diagnostics;
using mailslurp.Api;
using mailslurp.Client;
using mailslurp.Model;
namespace Example
{
public class GetAttachmentMetaDataExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://api.mailslurp.com";
// Configure API key authorization: API_KEY
config.AddApiKey("x-api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("x-api-key", "Bearer");
var apiInstance = new EmailControllerApi(config);
var attachmentId = attachmentId_example; // string | ID of attachment
var emailId = new Guid(); // Guid | ID of email
try
{
// Get email attachment metadata
AttachmentMetaData result = apiInstance.GetAttachmentMetaData(attachmentId, emailId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.GetAttachmentMetaData: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
attachmentId | string | ID of attachment | |
emailId | Guid | ID of email |
# Return type
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
# HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
401 | Unauthorized | - |
403 | Forbidden | - |
404 | Not Found | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# GetAttachments
List<AttachmentMetaData> GetAttachments (Guid emailId)
Get all email attachment metadata
Returns an array of attachment metadata such as name and content-type for a given email if present.
# Example
using System.Collections.Generic;
using System.Diagnostics;
using mailslurp.Api;
using mailslurp.Client;
using mailslurp.Model;
namespace Example
{
public class GetAttachmentsExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://api.mailslurp.com";
// Configure API key authorization: API_KEY
config.AddApiKey("x-api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("x-api-key", "Bearer");
var apiInstance = new EmailControllerApi(config);
var emailId = new Guid(); // Guid | ID of email
try
{
// Get all email attachment metadata
List<AttachmentMetaData> result = apiInstance.GetAttachments(emailId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.GetAttachments: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
emailId | Guid | ID of email |
# Return type
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
# HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
401 | Unauthorized | - |
403 | Forbidden | - |
404 | Not Found | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# GetEmail
Email GetEmail (Guid emailId, bool? decode = null)
Get email content
Returns a email summary object with headers and content. To retrieve the raw unparsed email use the getRawEmail endpoints
# Example
using System.Collections.Generic;
using System.Diagnostics;
using mailslurp.Api;
using mailslurp.Client;
using mailslurp.Model;
namespace Example
{
public class GetEmailExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://api.mailslurp.com";
// Configure API key authorization: API_KEY
config.AddApiKey("x-api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("x-api-key", "Bearer");
var apiInstance = new EmailControllerApi(config);
var emailId = new Guid(); // Guid | emailId
var decode = true; // bool? | 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)
try
{
// Get email content
Email result = apiInstance.GetEmail(emailId, decode);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.GetEmail: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
emailId | Guid | emailId | |
decode | bool? | 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
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
# HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
401 | Unauthorized | - |
403 | Forbidden | - |
404 | Not Found | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# GetEmailContentMatch
EmailContentMatchResult GetEmailContentMatch (Guid emailId, ContentMatchOptions contentMatchOptions)
Get email content regex pattern match results. Runs regex against email body and returns match groups.
Return the matches for a given Java style regex pattern. Do not include the typical /
at start or end of regex in some languages. Given an example your code is: 12345
the pattern to extract match looks like code is: (\\d{6})
. This will return an array of matches with the first matching the entire pattern and the subsequent matching the groups: ['code is: 123456', '123456']
See https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html for more information of available patterns.
# Example
using System.Collections.Generic;
using System.Diagnostics;
using mailslurp.Api;
using mailslurp.Client;
using mailslurp.Model;
namespace Example
{
public class GetEmailContentMatchExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://api.mailslurp.com";
// Configure API key authorization: API_KEY
config.AddApiKey("x-api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("x-api-key", "Bearer");
var apiInstance = new EmailControllerApi(config);
var emailId = new Guid(); // Guid | ID of email to match against
var contentMatchOptions = new ContentMatchOptions(); // ContentMatchOptions | contentMatchOptions
try
{
// Get email content regex pattern match results. Runs regex against email body and returns match groups.
EmailContentMatchResult result = apiInstance.GetEmailContentMatch(emailId, contentMatchOptions);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.GetEmailContentMatch: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
emailId | Guid | ID of email to match against | |
contentMatchOptions | ContentMatchOptions | contentMatchOptions |
# Return type
# Authorization
# HTTP request headers
- Content-Type: application/json
- Accept: application/json
# HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
201 | Created | - |
401 | Unauthorized | - |
403 | Forbidden | - |
404 | Not Found | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# GetEmailHTML
string GetEmailHTML (Guid emailId, bool? decode = null)
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
using System.Collections.Generic;
using System.Diagnostics;
using mailslurp.Api;
using mailslurp.Client;
using mailslurp.Model;
namespace Example
{
public class GetEmailHTMLExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://api.mailslurp.com";
// Configure API key authorization: API_KEY
config.AddApiKey("x-api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("x-api-key", "Bearer");
var apiInstance = new EmailControllerApi(config);
var emailId = new Guid(); // Guid | emailId
var decode = true; // bool? | decode (optional) (default to false)
try
{
// Get email content as HTML
string result = apiInstance.GetEmailHTML(emailId, decode);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.GetEmailHTML: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
emailId | Guid | emailId | |
decode | bool? | decode | [optional] [default to false] |
# Return type
string
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: text/html
# HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
401 | Unauthorized | - |
403 | Forbidden | - |
404 | Not Found | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# GetEmailHTMLQuery
EmailTextLinesResult GetEmailHTMLQuery (Guid emailId, string htmlSelector = null)
Parse and return text from an email, stripping HTML and decoding encoded characters
Parse an email body and return the content as an array of text. HTML parsing uses JSoup which supports JQuery/CSS style selectors
# Example
using System.Collections.Generic;
using System.Diagnostics;
using mailslurp.Api;
using mailslurp.Client;
using mailslurp.Model;
namespace Example
{
public class GetEmailHTMLQueryExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://api.mailslurp.com";
// Configure API key authorization: API_KEY
config.AddApiKey("x-api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("x-api-key", "Bearer");
var apiInstance = new EmailControllerApi(config);
var emailId = new Guid(); // Guid | ID of email to perform HTML query on
var htmlSelector = htmlSelector_example; // string | HTML selector to search for. Uses JQuery/JSoup/CSS style selector like '.my-div' to match content. See https://jsoup.org/apidocs/org/jsoup/select/Selector.html for more information. (optional)
try
{
// Parse and return text from an email, stripping HTML and decoding encoded characters
EmailTextLinesResult result = apiInstance.GetEmailHTMLQuery(emailId, htmlSelector);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.GetEmailHTMLQuery: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
emailId | Guid | ID of email to perform HTML query on | |
htmlSelector | string | HTML selector to search for. Uses JQuery/JSoup/CSS style selector like '.my-div' to match content. See https://jsoup.org/apidocs/org/jsoup/select/Selector.html for more information. | [optional] |
# Return type
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
# HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
401 | Unauthorized | - |
403 | Forbidden | - |
404 | Not Found | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# GetEmailTextLines
EmailTextLinesResult GetEmailTextLines (Guid emailId, bool? decodeHtmlEntities = null, string lineSeparator = null)
Parse and return text from an email, stripping HTML and decoding encoded characters
Parse an email body and return the content as an array of strings. HTML parsing uses JSoup and UNIX line separators.
# Example
using System.Collections.Generic;
using System.Diagnostics;
using mailslurp.Api;
using mailslurp.Client;
using mailslurp.Model;
namespace Example
{
public class GetEmailTextLinesExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://api.mailslurp.com";
// Configure API key authorization: API_KEY
config.AddApiKey("x-api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("x-api-key", "Bearer");
var apiInstance = new EmailControllerApi(config);
var emailId = new Guid(); // Guid | ID of email to fetch text for
var decodeHtmlEntities = true; // bool? | Decode HTML entities (optional)
var lineSeparator = lineSeparator_example; // string | Line separator character (optional)
try
{
// Parse and return text from an email, stripping HTML and decoding encoded characters
EmailTextLinesResult result = apiInstance.GetEmailTextLines(emailId, decodeHtmlEntities, lineSeparator);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.GetEmailTextLines: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
emailId | Guid | ID of email to fetch text for | |
decodeHtmlEntities | bool? | Decode HTML entities | [optional] |
lineSeparator | string | Line separator character | [optional] |
# Return type
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
# HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
401 | Unauthorized | - |
403 | Forbidden | - |
404 | Not Found | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# GetEmailsPaginated
PageEmailProjection GetEmailsPaginated (List<Guid> inboxId = null, int? page = null, int? size = null, string sort = null, bool? unreadOnly = null)
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
using System.Collections.Generic;
using System.Diagnostics;
using mailslurp.Api;
using mailslurp.Client;
using mailslurp.Model;
namespace Example
{
public class GetEmailsPaginatedExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://api.mailslurp.com";
// Configure API key authorization: API_KEY
config.AddApiKey("x-api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("x-api-key", "Bearer");
var apiInstance = new EmailControllerApi(config);
var inboxId = new List<Guid>(); // List<Guid> | Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. (optional)
var page = 56; // int? | Optional page index in email list pagination (optional) (default to 0)
var size = 56; // int? | Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional) (default to 20)
var sort = sort_example; // string | Optional createdAt sort direction ASC or DESC (optional) (default to ASC)
var unreadOnly = true; // bool? | 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)
try
{
// Get all emails
PageEmailProjection result = apiInstance.GetEmailsPaginated(inboxId, page, size, sort, unreadOnly);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.GetEmailsPaginated: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
inboxId | List<Guid> | Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. | [optional] |
page | int? | Optional page index in email list pagination | [optional] [default to 0] |
size | int? | Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results | [optional] [default to 20] |
sort | string | Optional createdAt sort direction ASC or DESC | [optional] [default to ASC] |
unreadOnly | bool? | 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
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
# HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
401 | Unauthorized | - |
403 | Forbidden | - |
404 | Not Found | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# GetLatestEmail
Email GetLatestEmail (List<Guid> inboxIds = null)
Get latest email
Get the newest email in all inboxes or in a passed set of inbox IDs
# Example
using System.Collections.Generic;
using System.Diagnostics;
using mailslurp.Api;
using mailslurp.Client;
using mailslurp.Model;
namespace Example
{
public class GetLatestEmailExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://api.mailslurp.com";
// Configure API key authorization: API_KEY
config.AddApiKey("x-api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("x-api-key", "Bearer");
var apiInstance = new EmailControllerApi(config);
var inboxIds = new List<Guid>(); // List<Guid> | Optional set of inboxes to filter by. Only get the latest email from these inbox IDs (optional)
try
{
// Get latest email
Email result = apiInstance.GetLatestEmail(inboxIds);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.GetLatestEmail: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
inboxIds | List<Guid> | Optional set of inboxes to filter by. Only get the latest email from these inbox IDs | [optional] |
# Return type
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
# HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
401 | Unauthorized | - |
403 | Forbidden | - |
404 | Not Found | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# GetLatestEmailInInbox
Email GetLatestEmailInInbox (Guid? inboxId = null)
Get latest email
Get the newest email in all inboxes or in a passed set of inbox IDs
# Example
using System.Collections.Generic;
using System.Diagnostics;
using mailslurp.Api;
using mailslurp.Client;
using mailslurp.Model;
namespace Example
{
public class GetLatestEmailInInboxExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://api.mailslurp.com";
// Configure API key authorization: API_KEY
config.AddApiKey("x-api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("x-api-key", "Bearer");
var apiInstance = new EmailControllerApi(config);
var inboxId = new Guid?(); // Guid? | ID of the inbox you want to get the latest email from (optional)
try
{
// Get latest email
Email result = apiInstance.GetLatestEmailInInbox(inboxId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.GetLatestEmailInInbox: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
inboxId | Guid? | ID of the inbox you want to get the latest email from | [optional] |
# Return type
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
# HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
401 | Unauthorized | - |
403 | Forbidden | - |
404 | Not Found | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# GetRawEmailContents
string GetRawEmailContents (Guid emailId)
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
using System.Collections.Generic;
using System.Diagnostics;
using mailslurp.Api;
using mailslurp.Client;
using mailslurp.Model;
namespace Example
{
public class GetRawEmailContentsExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://api.mailslurp.com";
// Configure API key authorization: API_KEY
config.AddApiKey("x-api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("x-api-key", "Bearer");
var apiInstance = new EmailControllerApi(config);
var emailId = new Guid(); // Guid | ID of email
try
{
// Get raw email string
string result = apiInstance.GetRawEmailContents(emailId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.GetRawEmailContents: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
emailId | Guid | ID of email |
# Return type
string
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: text/plain
# HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | text/plain raw email | - |
401 | Unauthorized | - |
403 | Forbidden | - |
404 | Not Found | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# GetRawEmailJson
RawEmailJson GetRawEmailJson (Guid emailId)
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
using System.Collections.Generic;
using System.Diagnostics;
using mailslurp.Api;
using mailslurp.Client;
using mailslurp.Model;
namespace Example
{
public class GetRawEmailJsonExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://api.mailslurp.com";
// Configure API key authorization: API_KEY
config.AddApiKey("x-api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("x-api-key", "Bearer");
var apiInstance = new EmailControllerApi(config);
var emailId = new Guid(); // Guid | ID of email
try
{
// Get raw email in JSON
RawEmailJson result = apiInstance.GetRawEmailJson(emailId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.GetRawEmailJson: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
emailId | Guid | ID of email |
# Return type
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
# HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
401 | Unauthorized | - |
403 | Forbidden | - |
404 | Not Found | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# GetUnreadEmailCount
UnreadCount GetUnreadEmailCount ()
Get unread email count
Get number of emails unread
# Example
using System.Collections.Generic;
using System.Diagnostics;
using mailslurp.Api;
using mailslurp.Client;
using mailslurp.Model;
namespace Example
{
public class GetUnreadEmailCountExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://api.mailslurp.com";
// Configure API key authorization: API_KEY
config.AddApiKey("x-api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("x-api-key", "Bearer");
var apiInstance = new EmailControllerApi(config);
try
{
// Get unread email count
UnreadCount result = apiInstance.GetUnreadEmailCount();
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.GetUnreadEmailCount: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
# Parameters
This endpoint does not need any parameter.
# Return type
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
# HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
401 | Unauthorized | - |
403 | Forbidden | - |
404 | Not Found | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# ReplyToEmail
SentEmailDto ReplyToEmail (Guid emailId, ReplyToEmailOptions replyToEmailOptions)
Reply to an email
Send the reply to the email sender or reply-to and include same subject cc bcc etc. Reply to an email and the contents will be sent with the existing subject to the emails to
, cc
, and bcc
.
# Example
using System.Collections.Generic;
using System.Diagnostics;
using mailslurp.Api;
using mailslurp.Client;
using mailslurp.Model;
namespace Example
{
public class ReplyToEmailExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://api.mailslurp.com";
// Configure API key authorization: API_KEY
config.AddApiKey("x-api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("x-api-key", "Bearer");
var apiInstance = new EmailControllerApi(config);
var emailId = new Guid(); // Guid | ID of the email that should be replied to
var replyToEmailOptions = new ReplyToEmailOptions(); // ReplyToEmailOptions | replyToEmailOptions
try
{
// Reply to an email
SentEmailDto result = apiInstance.ReplyToEmail(emailId, replyToEmailOptions);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.ReplyToEmail: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
emailId | Guid | ID of the email that should be replied to | |
replyToEmailOptions | ReplyToEmailOptions | replyToEmailOptions |
# Return type
# Authorization
# HTTP request headers
- Content-Type: application/json
- Accept: application/json
# HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
201 | Created | - |
401 | Unauthorized | - |
403 | Forbidden | - |
404 | Not Found | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# ValidateEmail
ValidationDto ValidateEmail (Guid emailId)
Validate email
Validate the HTML content of email if HTML is found. Considered valid if no HTML.
# Example
using System.Collections.Generic;
using System.Diagnostics;
using mailslurp.Api;
using mailslurp.Client;
using mailslurp.Model;
namespace Example
{
public class ValidateEmailExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://api.mailslurp.com";
// Configure API key authorization: API_KEY
config.AddApiKey("x-api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("x-api-key", "Bearer");
var apiInstance = new EmailControllerApi(config);
var emailId = new Guid(); // Guid | ID of email
try
{
// Validate email
ValidationDto result = apiInstance.ValidateEmail(emailId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.ValidateEmail: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
emailId | Guid | ID of email |
# Return type
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
# HTTP response details
Status code | Description | Response headers |
---|---|---|
201 | Created | - |
401 | Unauthorized | - |
403 | Forbidden | - |
404 | Not Found | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]