mailslurp.Api.EmailControllerApi
All URIs are relative to https://csharp.api.mailslurp.com
Method | HTTP request | Description |
---|---|---|
ApplyImapFlagOperation | POST /emails/{emailId}/imap-flag-operation | Set IMAP flags associated with a message. Only supports 'Seen' flag. |
DeleteAllEmails | DELETE /emails | Delete all emails in all inboxes. |
DeleteEmail | DELETE /emails/{emailId} | Delete an email |
DownloadAttachment | GET /emails/{emailId}/attachments/{attachmentId} | Get email attachment bytes. Returned as octet-stream with content type header. If you have trouble with byte responses try the downloadAttachmentBase64 response endpoints and convert the base 64 encoded content to a file or string. |
DownloadAttachmentBase64 | GET /emails/{emailId}/attachments/{attachmentId}/base64 | Get email attachment as base64 encoded string as an alternative to binary responses. Decode the base64FileContents as a utf-8 encoded string or array of bytes depending on the contentType . |
DownloadBody | GET /emails/{emailId}/body | Get email body as string. Returned as plain/text with content type header. |
DownloadBodyBytes | GET /emails/{emailId}/body-bytes | Get email body in bytes. Returned as octet-stream with content type header. |
ForwardEmail | POST /emails/{emailId}/forward | Forward email to recipients |
GetAttachmentMetaData | GET /emails/{emailId}/attachments/{attachmentId}/metadata | Get email attachment metadata. This is the contentType and contentLength of an attachment. To get the individual attachments use the downloadAttachment methods. |
GetEmail | GET /emails/{emailId} | Get email content including headers and body. Expects email to exist by ID. For emails that may not have arrived yet use the WaitForController. |
GetEmailAttachments | GET /emails/{emailId}/attachments | Get all email attachment metadata. Metadata includes name and size of attachments. |
GetEmailContentMatch | POST /emails/{emailId}/contentMatch | Get email content regex pattern match results. Runs regex against email body and returns match groups. |
GetEmailCount | GET /emails/emails/count | Get email count |
GetEmailHTML | GET /emails/{emailId}/html | Get email content as HTML. For displaying emails in browser context. |
GetEmailHTMLJson | GET /emails/{emailId}/html/json | Get email content as HTML in JSON wrapper. For fetching entity decoded HTML content |
GetEmailHTMLQuery | GET /emails/{emailId}/htmlQuery | Parse and return text from an email, stripping HTML and decoding encoded characters |
GetEmailLinks | GET /emails/{emailId}/links | Parse and return list of links found in an email (only works for HTML content) |
GetEmailPreviewURLs | GET /emails/{emailId}/urls | Get email URLs for viewing in browser or downloading |
GetEmailTextLines | GET /emails/{emailId}/textLines | Parse and return text from an email, stripping HTML and decoding encoded characters |
GetEmailsPaginated | GET /emails | Get all emails in all inboxes in paginated form. Email API list all. |
GetGravatarUrlForEmailAddress | GET /emails/gravatarFor | |
GetLatestEmail | GET /emails/latest | Get latest email in all inboxes. Most recently received. |
GetLatestEmailInInbox1 | GET /emails/latestIn | Get latest email in an inbox. Use WaitForController to get emails that may not have arrived yet. |
GetOrganizationEmailsPaginated | GET /emails/organization | Get all organization emails. List team or shared test email accounts |
GetRawEmailContents | GET /emails/{emailId}/raw | Get raw email string. Returns unparsed raw SMTP message with headers and body. |
GetRawEmailJson | GET /emails/{emailId}/raw/json | Get raw email in JSON. Unparsed SMTP message in JSON wrapper format. |
GetUnreadEmailCount | GET /emails/unreadCount | Get unread email count |
MarkAsRead | PATCH /emails/{emailId}/read | Mark an email as read on unread |
ReplyToEmail | PUT /emails/{emailId} | Reply to an email |
SendEmailSourceOptional | POST /emails | Send email |
ValidateEmail | POST /emails/{emailId}/validate | Validate email HTML contents |
EmailPreview ApplyImapFlagOperation (Guid emailId, ImapFlagOperationOptions imapFlagOperationOptions)
Set IMAP flags associated with a message. Only supports 'Seen' flag.
Apply RFC3501 section-2.3.2 IMAP flag operations on an email
Example
using System.Collections.Generic;
using System.Diagnostics;
using mailslurp.Api;
using mailslurp.Client;
using mailslurp.Model;
namespace Example
{
public class ApplyImapFlagOperationExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://csharp.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 = "emailId_example"; // Guid |
var imapFlagOperationOptions = new ImapFlagOperationOptions(); // ImapFlagOperationOptions |
try
{
// Set IMAP flags associated with a message. Only supports 'Seen' flag.
EmailPreview result = apiInstance.ApplyImapFlagOperation(emailId, imapFlagOperationOptions);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.ApplyImapFlagOperation: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Using the ApplyImapFlagOperationWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Set IMAP flags associated with a message. Only supports 'Seen' flag.
ApiResponse<EmailPreview> response = apiInstance.ApplyImapFlagOperationWithHttpInfo(emailId, imapFlagOperationOptions);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.ApplyImapFlagOperationWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
emailId | Guid | ||
imapFlagOperationOptions | ImapFlagOperationOptions |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to ]
void DeleteAllEmails ()
Delete all emails in all inboxes.
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://csharp.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 in all inboxes.
apiInstance.DeleteAllEmails();
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.DeleteAllEmails: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Using the DeleteAllEmailsWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Delete all emails in all inboxes.
apiInstance.DeleteAllEmailsWithHttpInfo();
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.DeleteAllEmailsWithHttpInfo: " + 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 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to ]
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://csharp.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 = "emailId_example"; // 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);
}
}
}
}
Using the DeleteEmailWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Delete an email
apiInstance.DeleteEmailWithHttpInfo(emailId);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.DeleteEmailWithHttpInfo: " + 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 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to ]
byte[] DownloadAttachment (Guid emailId, string attachmentId, string apiKey = null)
Get email attachment bytes. Returned as octet-stream
with content type header. If you have trouble with byte responses try the downloadAttachmentBase64
response endpoints and convert the base 64 encoded content to a file or string.
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://csharp.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 = "emailId_example"; // Guid | ID of email
var attachmentId = "attachmentId_example"; // string | ID of attachment
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. Returned as `octet-stream` with content type header. If you have trouble with byte responses try the `downloadAttachmentBase64` response endpoints and convert the base 64 encoded content to a file or string.
byte[] result = apiInstance.DownloadAttachment(emailId, attachmentId, 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);
}
}
}
}
Using the DownloadAttachmentWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Get email attachment bytes. Returned as `octet-stream` with content type header. If you have trouble with byte responses try the `downloadAttachmentBase64` response endpoints and convert the base 64 encoded content to a file or string.
ApiResponse<byte[]> response = apiInstance.DownloadAttachmentWithHttpInfo(emailId, attachmentId, apiKey);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.DownloadAttachmentWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
emailId | Guid | ID of email | |
attachmentId | string | ID of attachment | |
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 |
---|---|---|
0 | default response | - |
[Back to top] [Back to API list] [Back to Model list] [Back to ]
DownloadAttachmentDto DownloadAttachmentBase64 (Guid emailId, string attachmentId)
Get email attachment as base64 encoded string as an alternative to binary responses. Decode the base64FileContents
as a utf-8
encoded string or array of bytes depending on the contentType
.
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://csharp.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 = "emailId_example"; // Guid | ID of email
var attachmentId = "attachmentId_example"; // string | ID of attachment
try
{
// Get email attachment as base64 encoded string as an alternative to binary responses. Decode the `base64FileContents` as a `utf-8` encoded string or array of bytes depending on the `contentType`.
DownloadAttachmentDto result = apiInstance.DownloadAttachmentBase64(emailId, attachmentId);
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);
}
}
}
}
Using the DownloadAttachmentBase64WithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Get email attachment as base64 encoded string as an alternative to binary responses. Decode the `base64FileContents` as a `utf-8` encoded string or array of bytes depending on the `contentType`.
ApiResponse<DownloadAttachmentDto> response = apiInstance.DownloadAttachmentBase64WithHttpInfo(emailId, attachmentId);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.DownloadAttachmentBase64WithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
emailId | Guid | ID of email | |
attachmentId | string | ID of attachment |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to ]
string DownloadBody (Guid emailId)
Get email body as string. Returned as plain/text
with content type header.
Returns the specified email body for a given email as a string
Example
using System.Collections.Generic;
using System.Diagnostics;
using mailslurp.Api;
using mailslurp.Client;
using mailslurp.Model;
namespace Example
{
public class DownloadBodyExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://csharp.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 = "emailId_example"; // Guid | ID of email
try
{
// Get email body as string. Returned as `plain/text` with content type header.
string result = apiInstance.DownloadBody(emailId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.DownloadBody: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Using the DownloadBodyWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Get email body as string. Returned as `plain/text` with content type header.
ApiResponse<string> response = apiInstance.DownloadBodyWithHttpInfo(emailId);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.DownloadBodyWithHttpInfo: " + 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, text/html
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to ]
byte[] DownloadBodyBytes (Guid emailId)
Get email body in bytes. Returned as octet-stream
with content type header.
Returns the specified email body for a given email as a stream / array of bytes.
Example
using System.Collections.Generic;
using System.Diagnostics;
using mailslurp.Api;
using mailslurp.Client;
using mailslurp.Model;
namespace Example
{
public class DownloadBodyBytesExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://csharp.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 = "emailId_example"; // Guid | ID of email
try
{
// Get email body in bytes. Returned as `octet-stream` with content type header.
byte[] result = apiInstance.DownloadBodyBytes(emailId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.DownloadBodyBytes: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Using the DownloadBodyBytesWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Get email body in bytes. Returned as `octet-stream` with content type header.
ApiResponse<byte[]> response = apiInstance.DownloadBodyBytesWithHttpInfo(emailId);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.DownloadBodyBytesWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
emailId | Guid | ID of email |
Return type
byte[]
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/octet-stream
HTTP response details
Status code | Description | Response headers |
---|---|---|
0 | default response | - |
[Back to top] [Back to API list] [Back to Model list] [Back to ]
SentEmailDto ForwardEmail (Guid emailId, ForwardEmailOptions forwardEmailOptions)
Forward email to recipients
Forward an existing email to new recipients. The sender of the email will be the inbox that received the email you are forwarding. You can override the sender with the from
option. Note you must have access to the from address in MailSlurp to use the override. For more control consider fetching the email and sending it a new using the send email endpoints.
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://csharp.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 = "emailId_example"; // Guid | ID of email
var forwardEmailOptions = new ForwardEmailOptions(); // ForwardEmailOptions |
try
{
// Forward email to recipients
SentEmailDto result = apiInstance.ForwardEmail(emailId, forwardEmailOptions);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.ForwardEmail: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Using the ForwardEmailWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Forward email to recipients
ApiResponse<SentEmailDto> response = apiInstance.ForwardEmailWithHttpInfo(emailId, forwardEmailOptions);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.ForwardEmailWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
emailId | Guid | ID of email | |
forwardEmailOptions | ForwardEmailOptions |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
HTTP response details
Status code | Description | Response headers |
---|---|---|
201 | Created | - |
[Back to top] [Back to API list] [Back to Model list] [Back to ]
AttachmentMetaData GetAttachmentMetaData (Guid emailId, string attachmentId)
Get email attachment metadata. This is the contentType
and contentLength
of an attachment. To get the individual attachments use the downloadAttachment
methods.
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://csharp.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 = "emailId_example"; // Guid | ID of email
var attachmentId = "attachmentId_example"; // string | ID of attachment
try
{
// Get email attachment metadata. This is the `contentType` and `contentLength` of an attachment. To get the individual attachments use the `downloadAttachment` methods.
AttachmentMetaData result = apiInstance.GetAttachmentMetaData(emailId, attachmentId);
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);
}
}
}
}
Using the GetAttachmentMetaDataWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Get email attachment metadata. This is the `contentType` and `contentLength` of an attachment. To get the individual attachments use the `downloadAttachment` methods.
ApiResponse<AttachmentMetaData> response = apiInstance.GetAttachmentMetaDataWithHttpInfo(emailId, attachmentId);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.GetAttachmentMetaDataWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
emailId | Guid | ID of email | |
attachmentId | string | ID of attachment |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to ]
Email GetEmail (Guid emailId, bool? decode = null)
Get email content including headers and body. Expects email to exist by ID. For emails that may not have arrived yet use the WaitForController.
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://csharp.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 = "emailId_example"; // Guid |
var decode = false; // 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 including headers and body. Expects email to exist by ID. For emails that may not have arrived yet use the WaitForController.
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);
}
}
}
}
Using the GetEmailWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Get email content including headers and body. Expects email to exist by ID. For emails that may not have arrived yet use the WaitForController.
ApiResponse<Email> response = apiInstance.GetEmailWithHttpInfo(emailId, decode);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.GetEmailWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
emailId | Guid | ||
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: /
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to ]
List
GetEmailAttachments (Guid emailId)
Get all email attachment metadata. Metadata includes name and size of attachments.
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 GetEmailAttachmentsExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://csharp.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 = "emailId_example"; // Guid | ID of email
try
{
// Get all email attachment metadata. Metadata includes name and size of attachments.
List<AttachmentMetaData> result = apiInstance.GetEmailAttachments(emailId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.GetEmailAttachments: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Using the GetEmailAttachmentsWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Get all email attachment metadata. Metadata includes name and size of attachments.
ApiResponse<List<AttachmentMetaData>> response = apiInstance.GetEmailAttachmentsWithHttpInfo(emailId);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.GetEmailAttachmentsWithHttpInfo: " + 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: /
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to ]
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/ 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://csharp.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 = "emailId_example"; // Guid | ID of email to match against
var contentMatchOptions = new 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);
}
}
}
}
Using the GetEmailContentMatchWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Get email content regex pattern match results. Runs regex against email body and returns match groups.
ApiResponse<EmailContentMatchResult> response = apiInstance.GetEmailContentMatchWithHttpInfo(emailId, contentMatchOptions);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.GetEmailContentMatchWithHttpInfo: " + 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 |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to ]
CountDto GetEmailCount ()
Get email count
Example
using System.Collections.Generic;
using System.Diagnostics;
using mailslurp.Api;
using mailslurp.Client;
using mailslurp.Model;
namespace Example
{
public class GetEmailCountExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://csharp.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 email count
CountDto result = apiInstance.GetEmailCount();
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.GetEmailCount: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Using the GetEmailCountWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Get email count
ApiResponse<CountDto> response = apiInstance.GetEmailCountWithHttpInfo();
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.GetEmailCountWithHttpInfo: " + 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: /
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to ]
string GetEmailHTML (Guid emailId, bool? decode = null)
Get email content as HTML. For displaying emails in browser context.
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
. Returns content-type text/html;charset=utf-8
so you must call expecting that content response not JSON. For JSON response see the getEmailHTMLJson
method.
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://csharp.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 = "emailId_example"; // Guid |
var decode = false; // bool? | (optional) (default to false)
try
{
// Get email content as HTML. For displaying emails in browser context.
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);
}
}
}
}
Using the GetEmailHTMLWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Get email content as HTML. For displaying emails in browser context.
ApiResponse<string> response = apiInstance.GetEmailHTMLWithHttpInfo(emailId, decode);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.GetEmailHTMLWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
emailId | Guid | ||
decode | bool? | [optional] [default to false] |
Return type
string
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: text/html;charset=utf-8, text/html
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to ]
EmailHtmlDto GetEmailHTMLJson (Guid emailId, bool? decode = null)
Get email content as HTML in JSON wrapper. For fetching entity decoded HTML content
Retrieve email content as HTML response. Decodes quoted-printable entities and converts charset to UTF-8. Returns content-type application/json;charset=utf-8
so you must call expecting that content response not JSON.
Example
using System.Collections.Generic;
using System.Diagnostics;
using mailslurp.Api;
using mailslurp.Client;
using mailslurp.Model;
namespace Example
{
public class GetEmailHTMLJsonExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://csharp.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 = "emailId_example"; // Guid |
var decode = false; // bool? | (optional) (default to false)
try
{
// Get email content as HTML in JSON wrapper. For fetching entity decoded HTML content
EmailHtmlDto result = apiInstance.GetEmailHTMLJson(emailId, decode);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.GetEmailHTMLJson: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Using the GetEmailHTMLJsonWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Get email content as HTML in JSON wrapper. For fetching entity decoded HTML content
ApiResponse<EmailHtmlDto> response = apiInstance.GetEmailHTMLJsonWithHttpInfo(emailId, decode);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.GetEmailHTMLJsonWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
emailId | Guid | ||
decode | bool? | [optional] [default to false] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to ]
EmailTextLinesResult GetEmailHTMLQuery (Guid emailId, string htmlSelector)
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://csharp.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 = "emailId_example"; // 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/ for more information.
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);
}
}
}
}
Using the GetEmailHTMLQueryWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Parse and return text from an email, stripping HTML and decoding encoded characters
ApiResponse<EmailTextLinesResult> response = apiInstance.GetEmailHTMLQueryWithHttpInfo(emailId, htmlSelector);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.GetEmailHTMLQueryWithHttpInfo: " + 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/ for more information. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to ]
EmailLinksResult GetEmailLinks (Guid emailId)
Parse and return list of links found in an email (only works for HTML content)
HTML parsing uses JSoup and UNIX line separators. Searches content for href attributes
Example
using System.Collections.Generic;
using System.Diagnostics;
using mailslurp.Api;
using mailslurp.Client;
using mailslurp.Model;
namespace Example
{
public class GetEmailLinksExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://csharp.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 = "emailId_example"; // Guid | ID of email to fetch text for
try
{
// Parse and return list of links found in an email (only works for HTML content)
EmailLinksResult result = apiInstance.GetEmailLinks(emailId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.GetEmailLinks: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Using the GetEmailLinksWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Parse and return list of links found in an email (only works for HTML content)
ApiResponse<EmailLinksResult> response = apiInstance.GetEmailLinksWithHttpInfo(emailId);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.GetEmailLinksWithHttpInfo: " + 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 |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to ]
EmailPreviewUrls GetEmailPreviewURLs (Guid emailId)
Get email URLs for viewing in browser or downloading
Get a list of URLs for email content as text/html or raw SMTP message for viewing the message in a browser.
Example
using System.Collections.Generic;
using System.Diagnostics;
using mailslurp.Api;
using mailslurp.Client;
using mailslurp.Model;
namespace Example
{
public class GetEmailPreviewURLsExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://csharp.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 = "emailId_example"; // Guid |
try
{
// Get email URLs for viewing in browser or downloading
EmailPreviewUrls result = apiInstance.GetEmailPreviewURLs(emailId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.GetEmailPreviewURLs: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Using the GetEmailPreviewURLsWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Get email URLs for viewing in browser or downloading
ApiResponse<EmailPreviewUrls> response = apiInstance.GetEmailPreviewURLsWithHttpInfo(emailId);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.GetEmailPreviewURLsWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
emailId | Guid |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to ]
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://csharp.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 = "emailId_example"; // 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);
}
}
}
}
Using the GetEmailTextLinesWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Parse and return text from an email, stripping HTML and decoding encoded characters
ApiResponse<EmailTextLinesResult> response = apiInstance.GetEmailTextLinesWithHttpInfo(emailId, decodeHtmlEntities, lineSeparator);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.GetEmailTextLinesWithHttpInfo: " + 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: /
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to ]
PageEmailProjection GetEmailsPaginated (List
inboxId = null, int? page = null, int? size = null, string sort = null, bool? unreadOnly = null, string searchFilter = null, DateTime? since = null, DateTime? before = null)
Get all emails in all inboxes in paginated form. Email API list all.
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://csharp.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 = 0; // int? | Optional page in email list pagination (optional) (default to 0)
var size = 20; // int? | Optional page size in email list pagination. Maximum size is 100. Use page and sort to page through larger results (optional) (default to 20)
var sort = "ASC"; // string | Optional createdAt sort direction ASC or DESC (optional) (default to ASC)
var unreadOnly = false; // 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)
var searchFilter = "searchFilter_example"; // string | Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body (optional)
var since = DateTime.Parse("2013-10-20T19:20:30+01:00"); // DateTime? | Optional filter emails received after given date time (optional)
var before = DateTime.Parse("2013-10-20T19:20:30+01:00"); // DateTime? | Optional filter emails received before given date time (optional)
try
{
// Get all emails in all inboxes in paginated form. Email API list all.
PageEmailProjection result = apiInstance.GetEmailsPaginated(inboxId, page, size, sort, unreadOnly, searchFilter, since, before);
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);
}
}
}
}
Using the GetEmailsPaginatedWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Get all emails in all inboxes in paginated form. Email API list all.
ApiResponse<PageEmailProjection> response = apiInstance.GetEmailsPaginatedWithHttpInfo(inboxId, page, size, sort, unreadOnly, searchFilter, since, before);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.GetEmailsPaginatedWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
inboxId | List | Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. | [optional] |
page | int? | Optional page in email list pagination | [optional] [default to 0] |
size | int? | Optional page size in email list pagination. Maximum size is 100. Use page 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] |
searchFilter | string | Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body | [optional] |
since | DateTime? | Optional filter emails received after given date time | [optional] |
before | DateTime? | Optional filter emails received before given date time | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to ]
GravatarUrl GetGravatarUrlForEmailAddress (string emailAddress, string size = null)
Get gravatar url for email address
Example
using System.Collections.Generic;
using System.Diagnostics;
using mailslurp.Api;
using mailslurp.Client;
using mailslurp.Model;
namespace Example
{
public class GetGravatarUrlForEmailAddressExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://csharp.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 emailAddress = "emailAddress_example"; // string |
var size = "size_example"; // string | (optional)
try
{
GravatarUrl result = apiInstance.GetGravatarUrlForEmailAddress(emailAddress, size);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.GetGravatarUrlForEmailAddress: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Using the GetGravatarUrlForEmailAddressWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
try
{
ApiResponse<GravatarUrl> response = apiInstance.GetGravatarUrlForEmailAddressWithHttpInfo(emailAddress, size);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.GetGravatarUrlForEmailAddressWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
emailAddress | string | ||
size | string | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to ]
Email GetLatestEmail (List
inboxIds = null)
Get latest email in all inboxes. Most recently received.
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://csharp.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. If not provided will search across all inboxes (optional)
try
{
// Get latest email in all inboxes. Most recently received.
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);
}
}
}
}
Using the GetLatestEmailWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Get latest email in all inboxes. Most recently received.
ApiResponse<Email> response = apiInstance.GetLatestEmailWithHttpInfo(inboxIds);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.GetLatestEmailWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
inboxIds | List | Optional set of inboxes to filter by. Only get the latest email from these inbox IDs. If not provided will search across all inboxes | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to ]
Email GetLatestEmailInInbox1 (Guid inboxId)
Get latest email in an inbox. Use WaitForController
to get emails that may not have arrived yet.
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 GetLatestEmailInInbox1Example
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://csharp.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 = "inboxId_example"; // Guid | ID of the inbox you want to get the latest email from
try
{
// Get latest email in an inbox. Use `WaitForController` to get emails that may not have arrived yet.
Email result = apiInstance.GetLatestEmailInInbox1(inboxId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.GetLatestEmailInInbox1: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Using the GetLatestEmailInInbox1WithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Get latest email in an inbox. Use `WaitForController` to get emails that may not have arrived yet.
ApiResponse<Email> response = apiInstance.GetLatestEmailInInbox1WithHttpInfo(inboxId);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.GetLatestEmailInInbox1WithHttpInfo: " + 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 |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to ]
PageEmailProjection GetOrganizationEmailsPaginated (List
inboxId = null, int? page = null, int? size = null, string sort = null, bool? unreadOnly = null, string searchFilter = null, DateTime? since = null, DateTime? before = null)
Get all organization emails. List team or shared test email accounts
By default returns all emails across all team 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 GetOrganizationEmailsPaginatedExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://csharp.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 = 0; // int? | Optional page in email list pagination (optional) (default to 0)
var size = 20; // int? | Optional page size in email list pagination. Maximum size is 100. Use page and sort to page through larger results (optional) (default to 20)
var sort = "ASC"; // string | Optional createdAt sort direction ASC or DESC (optional) (default to ASC)
var unreadOnly = false; // 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)
var searchFilter = "searchFilter_example"; // string | Optional search filter search filter for emails. (optional)
var since = DateTime.Parse("2013-10-20T19:20:30+01:00"); // DateTime? | Optional filter emails received after given date time (optional)
var before = DateTime.Parse("2013-10-20T19:20:30+01:00"); // DateTime? | Optional filter emails received before given date time (optional)
try
{
// Get all organization emails. List team or shared test email accounts
PageEmailProjection result = apiInstance.GetOrganizationEmailsPaginated(inboxId, page, size, sort, unreadOnly, searchFilter, since, before);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.GetOrganizationEmailsPaginated: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Using the GetOrganizationEmailsPaginatedWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Get all organization emails. List team or shared test email accounts
ApiResponse<PageEmailProjection> response = apiInstance.GetOrganizationEmailsPaginatedWithHttpInfo(inboxId, page, size, sort, unreadOnly, searchFilter, since, before);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.GetOrganizationEmailsPaginatedWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
inboxId | List | Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. | [optional] |
page | int? | Optional page in email list pagination | [optional] [default to 0] |
size | int? | Optional page size in email list pagination. Maximum size is 100. Use page 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] |
searchFilter | string | Optional search filter search filter for emails. | [optional] |
since | DateTime? | Optional filter emails received after given date time | [optional] |
before | DateTime? | Optional filter emails received before given date time | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to ]
string GetRawEmailContents (Guid emailId)
Get raw email string. Returns unparsed raw SMTP message with headers and body.
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://csharp.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 = "emailId_example"; // Guid | ID of email
try
{
// Get raw email string. Returns unparsed raw SMTP message with headers and body.
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);
}
}
}
}
Using the GetRawEmailContentsWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Get raw email string. Returns unparsed raw SMTP message with headers and body.
ApiResponse<string> response = apiInstance.GetRawEmailContentsWithHttpInfo(emailId);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.GetRawEmailContentsWithHttpInfo: " + 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 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to ]
RawEmailJson GetRawEmailJson (Guid emailId)
Get raw email in JSON. Unparsed SMTP message in JSON wrapper format.
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://csharp.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 = "emailId_example"; // Guid | ID of email
try
{
// Get raw email in JSON. Unparsed SMTP message in JSON wrapper format.
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);
}
}
}
}
Using the GetRawEmailJsonWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Get raw email in JSON. Unparsed SMTP message in JSON wrapper format.
ApiResponse<RawEmailJson> response = apiInstance.GetRawEmailJsonWithHttpInfo(emailId);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.GetRawEmailJsonWithHttpInfo: " + 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: /
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to ]
UnreadCount GetUnreadEmailCount ()
Get unread email count
Get number of emails unread. Unread means has not been viewed in dashboard or returned in an email API response
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://csharp.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);
}
}
}
}
Using the GetUnreadEmailCountWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Get unread email count
ApiResponse<UnreadCount> response = apiInstance.GetUnreadEmailCountWithHttpInfo();
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.GetUnreadEmailCountWithHttpInfo: " + 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: /
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to ]
EmailPreview MarkAsRead (Guid emailId, bool? read = null)
Mark an email as read on unread
Marks an email as read or unread. Pass boolean read flag to set value. This is useful if you want to read an email but keep it as unread
Example
using System.Collections.Generic;
using System.Diagnostics;
using mailslurp.Api;
using mailslurp.Client;
using mailslurp.Model;
namespace Example
{
public class MarkAsReadExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://csharp.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 = "emailId_example"; // Guid |
var read = true; // bool? | What value to assign to email read property. Default true. (optional) (default to true)
try
{
// Mark an email as read on unread
EmailPreview result = apiInstance.MarkAsRead(emailId, read);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.MarkAsRead: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Using the MarkAsReadWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Mark an email as read on unread
ApiResponse<EmailPreview> response = apiInstance.MarkAsReadWithHttpInfo(emailId, read);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.MarkAsReadWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
emailId | Guid | ||
read | bool? | What value to assign to email read property. Default true. | [optional] [default to true] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to ]
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://csharp.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 = "emailId_example"; // Guid | ID of the email that should be replied to
var replyToEmailOptions = new 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);
}
}
}
}
Using the ReplyToEmailWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Reply to an email
ApiResponse<SentEmailDto> response = apiInstance.ReplyToEmailWithHttpInfo(emailId, replyToEmailOptions);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.ReplyToEmailWithHttpInfo: " + 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 |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to ]
void SendEmailSourceOptional (SendEmailOptions sendEmailOptions, Guid? inboxId = null, bool? useDomainPool = null, bool? virtualSend = null)
Send email
Alias for InboxController.sendEmail
method - see original method for full details. Sends an email from a given inbox that you have created. If no inbox is supplied a random inbox will be created for you and used to send the email.
Example
using System.Collections.Generic;
using System.Diagnostics;
using mailslurp.Api;
using mailslurp.Client;
using mailslurp.Model;
namespace Example
{
public class SendEmailSourceOptionalExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://csharp.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 sendEmailOptions = new SendEmailOptions(); // SendEmailOptions |
var inboxId = "inboxId_example"; // Guid? | ID of the inbox you want to send the email from (optional)
var useDomainPool = true; // bool? | Use domain pool. Optionally create inbox to send from using the mailslurp domain pool. (optional)
var virtualSend = true; // bool? | Optionally create inbox to send from that is a virtual inbox and won't send to external addresses (optional)
try
{
// Send email
apiInstance.SendEmailSourceOptional(sendEmailOptions, inboxId, useDomainPool, virtualSend);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.SendEmailSourceOptional: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Using the SendEmailSourceOptionalWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Send email
apiInstance.SendEmailSourceOptionalWithHttpInfo(sendEmailOptions, inboxId, useDomainPool, virtualSend);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.SendEmailSourceOptionalWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
sendEmailOptions | SendEmailOptions | ||
inboxId | Guid? | ID of the inbox you want to send the email from | [optional] |
useDomainPool | bool? | Use domain pool. Optionally create inbox to send from using the mailslurp domain pool. | [optional] |
virtualSend | bool? | Optionally create inbox to send from that is a virtual inbox and won't send to external addresses | [optional] |
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 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to ]
ValidationDto ValidateEmail (Guid emailId)
Validate email HTML contents
Validate the HTML content of email if HTML is found. Considered valid if no HTML is present.
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://csharp.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 = "emailId_example"; // Guid | ID of email
try
{
// Validate email HTML contents
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);
}
}
}
}
Using the ValidateEmailWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Validate email HTML contents
ApiResponse<ValidationDto> response = apiInstance.ValidateEmailWithHttpInfo(emailId);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EmailControllerApi.ValidateEmailWithHttpInfo: " + 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: /
HTTP response details
Status code | Description | Response headers |
---|---|---|
201 | Created | - |
[Back to top] [Back to API list] [Back to Model list] [Back to ]