Interface IEmailControllerApiSync
Represents a collection of functions to interact with the API endpoints
Inherited Members
Namespace: mailslurp.Api
Assembly: mailslurp.dll
Syntax
public interface IEmailControllerApiSync : IApiAccessorMethods
View SourceApplyImapFlagOperation(Guid, ImapFlagOperationOptions, int)
Set IMAP flags associated with a message. Only supports '\Seen' flag.
Declaration
EmailPreview ApplyImapFlagOperation(Guid emailId, ImapFlagOperationOptions imapFlagOperationOptions, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | emailId | |
| ImapFlagOperationOptions | imapFlagOperationOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| EmailPreview | EmailPreview |
Remarks
Apply RFC3501 section-2.3.2 IMAP flag operations on an email
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
ApplyImapFlagOperationWithHttpInfo(Guid, ImapFlagOperationOptions, int)
Set IMAP flags associated with a message. Only supports '\Seen' flag.
Declaration
ApiResponse<EmailPreview> ApplyImapFlagOperationWithHttpInfo(Guid emailId, ImapFlagOperationOptions imapFlagOperationOptions, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | emailId | |
| ImapFlagOperationOptions | imapFlagOperationOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<EmailPreview> | ApiResponse of EmailPreview |
Remarks
Apply RFC3501 section-2.3.2 IMAP flag operations on an email
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
CanSend(Guid, SendEmailOptions, int)
Check if email can be sent and options are valid.
Declaration
CanSendEmailResults CanSend(Guid inboxId, SendEmailOptions sendEmailOptions, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | inboxId | ID of the inbox you want to send the email from |
| SendEmailOptions | sendEmailOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| CanSendEmailResults | CanSendEmailResults |
Remarks
Can user send email to given recipient or is the recipient blocked
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
CanSendWithHttpInfo(Guid, SendEmailOptions, int)
Check if email can be sent and options are valid.
Declaration
ApiResponse<CanSendEmailResults> CanSendWithHttpInfo(Guid inboxId, SendEmailOptions sendEmailOptions, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | inboxId | ID of the inbox you want to send the email from |
| SendEmailOptions | sendEmailOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<CanSendEmailResults> | ApiResponse of CanSendEmailResults |
Remarks
Can user send email to given recipient or is the recipient blocked
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
CheckEmailBody(Guid, int)
Detect broken links, spelling, and images in email content
Declaration
CheckEmailBodyResults CheckEmailBody(Guid emailId, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | emailId | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| CheckEmailBodyResults | CheckEmailBodyResults |
Remarks
Find dead links, broken images, and spelling mistakes in email body. Will call included links via HTTP so do not invoke if your links are sensitive or stateful. Any resource that returns a 4xx or 5xx response or is not reachable via HEAD or GET HTTP operations will be considered unhealthy.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
CheckEmailBodyFeatureSupport(Guid, int)
Show which mail clients support the HTML and CSS features used in an email body.
Declaration
CheckEmailBodyFeatureSupportResults CheckEmailBodyFeatureSupport(Guid emailId, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | emailId | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| CheckEmailBodyFeatureSupportResults | CheckEmailBodyFeatureSupportResults |
Remarks
Detect HTML and CSS features inside an email body and return a report of email client support across different platforms and versions.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
CheckEmailBodyFeatureSupportWithHttpInfo(Guid, int)
Show which mail clients support the HTML and CSS features used in an email body.
Declaration
ApiResponse<CheckEmailBodyFeatureSupportResults> CheckEmailBodyFeatureSupportWithHttpInfo(Guid emailId, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | emailId | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<CheckEmailBodyFeatureSupportResults> | ApiResponse of CheckEmailBodyFeatureSupportResults |
Remarks
Detect HTML and CSS features inside an email body and return a report of email client support across different platforms and versions.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
CheckEmailBodyWithHttpInfo(Guid, int)
Detect broken links, spelling, and images in email content
Declaration
ApiResponse<CheckEmailBodyResults> CheckEmailBodyWithHttpInfo(Guid emailId, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | emailId | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<CheckEmailBodyResults> | ApiResponse of CheckEmailBodyResults |
Remarks
Find dead links, broken images, and spelling mistakes in email body. Will call included links via HTTP so do not invoke if your links are sensitive or stateful. Any resource that returns a 4xx or 5xx response or is not reachable via HEAD or GET HTTP operations will be considered unhealthy.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
CheckEmailClientSupport(CheckEmailClientSupportOptions, int)
Show which email programs and devices support the features used in an email body.
Declaration
CheckEmailClientSupportResults CheckEmailClientSupport(CheckEmailClientSupportOptions checkEmailClientSupportOptions, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| CheckEmailClientSupportOptions | checkEmailClientSupportOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| CheckEmailClientSupportResults | CheckEmailClientSupportResults |
Remarks
Evaluate the features used in an email body and return a report of email client support across different platforms and versions.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
CheckEmailClientSupportWithHttpInfo(CheckEmailClientSupportOptions, int)
Show which email programs and devices support the features used in an email body.
Declaration
ApiResponse<CheckEmailClientSupportResults> CheckEmailClientSupportWithHttpInfo(CheckEmailClientSupportOptions checkEmailClientSupportOptions, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| CheckEmailClientSupportOptions | checkEmailClientSupportOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<CheckEmailClientSupportResults> | ApiResponse of CheckEmailClientSupportResults |
Remarks
Evaluate the features used in an email body and return a report of email client support across different platforms and versions.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
DeleteAllEmails(int)
Delete all emails in all inboxes.
Declaration
void DeleteAllEmails(int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| int | operationIndex | Index associated with the operation. |
Remarks
Deletes all emails in your account. Be careful as emails cannot be recovered
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
DeleteAllEmailsWithHttpInfo(int)
Delete all emails in all inboxes.
Declaration
ApiResponse<object> DeleteAllEmailsWithHttpInfo(int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<object> | ApiResponse of Object(void) |
Remarks
Deletes all emails in your account. Be careful as emails cannot be recovered
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
DeleteEmail(Guid, int)
Delete an email
Declaration
void DeleteEmail(Guid emailId, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | emailId | ID of email to delete |
| int | operationIndex | Index associated with the operation. |
Remarks
Deletes an email and removes it from the inbox. Deleted emails cannot be recovered.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
DeleteEmailWithHttpInfo(Guid, int)
Delete an email
Declaration
ApiResponse<object> DeleteEmailWithHttpInfo(Guid emailId, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | emailId | ID of email to delete |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<object> | ApiResponse of Object(void) |
Remarks
Deletes an email and removes it from the inbox. Deleted emails cannot be recovered.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
DownloadAttachment(Guid, string, string, int)
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.
Declaration
byte[] DownloadAttachment(Guid emailId, string attachmentId, string apiKey = null, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | emailId | ID of email |
| string | attachmentId | ID of attachment |
| string | apiKey | 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) |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| byte[] | byte[] |
Remarks
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.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
DownloadAttachmentBase64(Guid, string, int)
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.
Declaration
DownloadAttachmentDto DownloadAttachmentBase64(Guid emailId, string attachmentId, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | emailId | ID of email |
| string | attachmentId | ID of attachment |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| DownloadAttachmentDto | DownloadAttachmentDto |
Remarks
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.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
DownloadAttachmentBase64WithHttpInfo(Guid, string, int)
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.
Declaration
ApiResponse<DownloadAttachmentDto> DownloadAttachmentBase64WithHttpInfo(Guid emailId, string attachmentId, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | emailId | ID of email |
| string | attachmentId | ID of attachment |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<DownloadAttachmentDto> | ApiResponse of DownloadAttachmentDto |
Remarks
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.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
DownloadAttachmentWithHttpInfo(Guid, string, string, int)
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.
Declaration
ApiResponse<byte[]> DownloadAttachmentWithHttpInfo(Guid emailId, string attachmentId, string apiKey = null, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | emailId | ID of email |
| string | attachmentId | ID of attachment |
| string | apiKey | 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) |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<byte[]> | ApiResponse of byte[] |
Remarks
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.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
DownloadBody(Guid, int)
Get email body as string. Returned as plain/text with content type header.
Declaration
string DownloadBody(Guid emailId, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | emailId | ID of email |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| string | string |
Remarks
Returns the specified email body for a given email as a string
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
DownloadBodyBytes(Guid, int)
Get email body in bytes. Returned as octet-stream with content type header.
Declaration
byte[] DownloadBodyBytes(Guid emailId, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | emailId | ID of email |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| byte[] | byte[] |
Remarks
Returns the specified email body for a given email as a stream / array of bytes.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
DownloadBodyBytesWithHttpInfo(Guid, int)
Get email body in bytes. Returned as octet-stream with content type header.
Declaration
ApiResponse<byte[]> DownloadBodyBytesWithHttpInfo(Guid emailId, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | emailId | ID of email |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<byte[]> | ApiResponse of byte[] |
Remarks
Returns the specified email body for a given email as a stream / array of bytes.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
DownloadBodyWithHttpInfo(Guid, int)
Get email body as string. Returned as plain/text with content type header.
Declaration
ApiResponse<string> DownloadBodyWithHttpInfo(Guid emailId, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | emailId | ID of email |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<string> | ApiResponse of string |
Remarks
Returns the specified email body for a given email as a string
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
ForwardEmail(Guid, ForwardEmailOptions, int)
Forward email to recipients
Declaration
SentEmailDto ForwardEmail(Guid emailId, ForwardEmailOptions forwardEmailOptions, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | emailId | ID of email |
| ForwardEmailOptions | forwardEmailOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| SentEmailDto | SentEmailDto |
Remarks
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.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
ForwardEmailWithHttpInfo(Guid, ForwardEmailOptions, int)
Forward email to recipients
Declaration
ApiResponse<SentEmailDto> ForwardEmailWithHttpInfo(Guid emailId, ForwardEmailOptions forwardEmailOptions, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | emailId | ID of email |
| ForwardEmailOptions | forwardEmailOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<SentEmailDto> | ApiResponse of SentEmailDto |
Remarks
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.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetAttachmentMetaData(Guid, string, int)
Get email attachment metadata. This is the contentType and contentLength of an attachment. To get the individual attachments use the downloadAttachment methods.
Declaration
AttachmentMetaData GetAttachmentMetaData(Guid emailId, string attachmentId, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | emailId | ID of email |
| string | attachmentId | ID of attachment |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| AttachmentMetaData | AttachmentMetaData |
Remarks
Returns the metadata such as name and content-type for a given attachment and email.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetAttachmentMetaDataWithHttpInfo(Guid, string, int)
Get email attachment metadata. This is the contentType and contentLength of an attachment. To get the individual attachments use the downloadAttachment methods.
Declaration
ApiResponse<AttachmentMetaData> GetAttachmentMetaDataWithHttpInfo(Guid emailId, string attachmentId, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | emailId | ID of email |
| string | attachmentId | ID of attachment |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<AttachmentMetaData> | ApiResponse of AttachmentMetaData |
Remarks
Returns the metadata such as name and content-type for a given attachment and email.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetEmail(Guid, int)
Get email content including headers and body. Expects email to exist by ID. For emails that may not have arrived yet use the WaitForController.
Declaration
Email GetEmail(Guid emailId, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | emailId | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
Remarks
Returns a email summary object with headers and content. To retrieve the raw unparsed email use the getRawEmail endpoints
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetEmailAttachments(Guid, int)
Get all email attachment metadata. Metadata includes name and size of attachments.
Declaration
List<AttachmentMetaData> GetEmailAttachments(Guid emailId, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | emailId | ID of email |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| List<AttachmentMetaData> | List<AttachmentMetaData> |
Remarks
Returns an array of attachment metadata such as name and content-type for a given email if present.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetEmailAttachmentsWithHttpInfo(Guid, int)
Get all email attachment metadata. Metadata includes name and size of attachments.
Declaration
ApiResponse<List<AttachmentMetaData>> GetEmailAttachmentsWithHttpInfo(Guid emailId, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | emailId | ID of email |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<List<AttachmentMetaData>> | ApiResponse of List<AttachmentMetaData> |
Remarks
Returns an array of attachment metadata such as name and content-type for a given email if present.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetEmailContentMatch(Guid, ContentMatchOptions, int)
Get email content regex pattern match results. Runs regex against email body and returns match groups.
Declaration
EmailContentMatchResult GetEmailContentMatch(Guid emailId, ContentMatchOptions contentMatchOptions, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | emailId | ID of email to match against |
| ContentMatchOptions | contentMatchOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| EmailContentMatchResult | EmailContentMatchResult |
Remarks
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.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetEmailContentMatchWithHttpInfo(Guid, ContentMatchOptions, int)
Get email content regex pattern match results. Runs regex against email body and returns match groups.
Declaration
ApiResponse<EmailContentMatchResult> GetEmailContentMatchWithHttpInfo(Guid emailId, ContentMatchOptions contentMatchOptions, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | emailId | ID of email to match against |
| ContentMatchOptions | contentMatchOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<EmailContentMatchResult> | ApiResponse of EmailContentMatchResult |
Remarks
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.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetEmailContentPart(Guid, string, bool?, int?, int)
Get email content part by content type
Declaration
EmailContentPartResult GetEmailContentPart(Guid emailId, string contentType, bool? strict = null, int? index = null, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | emailId | ID of email to match against |
| string | contentType | Content type |
| bool? | strict | Strict content type match (optional) |
| int? | index | Index of content type part if multiple (optional) |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| EmailContentPartResult | EmailContentPartResult |
Remarks
Get email body content parts from a multipart email message for a given content type
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetEmailContentPartContent(Guid, string, bool?, int?, int)
Get email content part by content type raw response
Declaration
string GetEmailContentPartContent(Guid emailId, string contentType, bool? strict = null, int? index = null, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | emailId | ID of email to match against |
| string | contentType | Content type |
| bool? | strict | Strict content type match (optional) |
| int? | index | Index of content type part if multiple. Starts from 0 and applies to the result list after selecting for your content type. Content type parts are sorted by order found in original MIME message. (optional) |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| string | string |
Remarks
Get email body content parts from a multipart email message for a given content type and return as response
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetEmailContentPartContentWithHttpInfo(Guid, string, bool?, int?, int)
Get email content part by content type raw response
Declaration
ApiResponse<string> GetEmailContentPartContentWithHttpInfo(Guid emailId, string contentType, bool? strict = null, int? index = null, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | emailId | ID of email to match against |
| string | contentType | Content type |
| bool? | strict | Strict content type match (optional) |
| int? | index | Index of content type part if multiple. Starts from 0 and applies to the result list after selecting for your content type. Content type parts are sorted by order found in original MIME message. (optional) |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<string> | ApiResponse of string |
Remarks
Get email body content parts from a multipart email message for a given content type and return as response
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetEmailContentPartWithHttpInfo(Guid, string, bool?, int?, int)
Get email content part by content type
Declaration
ApiResponse<EmailContentPartResult> GetEmailContentPartWithHttpInfo(Guid emailId, string contentType, bool? strict = null, int? index = null, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | emailId | ID of email to match against |
| string | contentType | Content type |
| bool? | strict | Strict content type match (optional) |
| int? | index | Index of content type part if multiple (optional) |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<EmailContentPartResult> | ApiResponse of EmailContentPartResult |
Remarks
Get email body content parts from a multipart email message for a given content type
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetEmailCount(Guid?, int)
Get email count
Declaration
CountDto GetEmailCount(Guid? inboxId = null, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid? | inboxId | (optional) |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| CountDto | CountDto |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetEmailCountWithHttpInfo(Guid?, int)
Get email count
Declaration
ApiResponse<CountDto> GetEmailCountWithHttpInfo(Guid? inboxId = null, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid? | inboxId | (optional) |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<CountDto> | ApiResponse of CountDto |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetEmailHTML(Guid, bool?, int)
Get email content as HTML. For displaying emails in browser context.
Declaration
string GetEmailHTML(Guid emailId, bool? replaceCidImages = null, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | emailId | |
| bool? | replaceCidImages | (optional, default to false) |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| string | string |
Remarks
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.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetEmailHTMLJson(Guid, bool?, int)
Get email content as HTML in JSON wrapper. For fetching entity decoded HTML content
Declaration
EmailHtmlDto GetEmailHTMLJson(Guid emailId, bool? replaceCidImages = null, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | emailId | |
| bool? | replaceCidImages | (optional, default to false) |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| EmailHtmlDto | EmailHtmlDto |
Remarks
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.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetEmailHTMLJsonWithHttpInfo(Guid, bool?, int)
Get email content as HTML in JSON wrapper. For fetching entity decoded HTML content
Declaration
ApiResponse<EmailHtmlDto> GetEmailHTMLJsonWithHttpInfo(Guid emailId, bool? replaceCidImages = null, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | emailId | |
| bool? | replaceCidImages | (optional, default to false) |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<EmailHtmlDto> | ApiResponse of EmailHtmlDto |
Remarks
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.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetEmailHTMLQuery(Guid, string, int)
Parse and return text from an email, stripping HTML and decoding encoded characters
Declaration
EmailTextLinesResult GetEmailHTMLQuery(Guid emailId, string htmlSelector, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | emailId | ID of email to perform HTML query on |
| string | htmlSelector | 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. |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| EmailTextLinesResult | EmailTextLinesResult |
Remarks
Parse an email body and return the content as an array of text. HTML parsing uses JSoup which supports JQuery/CSS style selectors
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetEmailHTMLQueryWithHttpInfo(Guid, string, int)
Parse and return text from an email, stripping HTML and decoding encoded characters
Declaration
ApiResponse<EmailTextLinesResult> GetEmailHTMLQueryWithHttpInfo(Guid emailId, string htmlSelector, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | emailId | ID of email to perform HTML query on |
| string | htmlSelector | 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. |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<EmailTextLinesResult> | ApiResponse of EmailTextLinesResult |
Remarks
Parse an email body and return the content as an array of text. HTML parsing uses JSoup which supports JQuery/CSS style selectors
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetEmailHTMLWithHttpInfo(Guid, bool?, int)
Get email content as HTML. For displaying emails in browser context.
Declaration
ApiResponse<string> GetEmailHTMLWithHttpInfo(Guid emailId, bool? replaceCidImages = null, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | emailId | |
| bool? | replaceCidImages | (optional, default to false) |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<string> | ApiResponse of string |
Remarks
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.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetEmailLinks(Guid, string, int)
Parse and return list of links found in an email (only works for HTML content)
Declaration
EmailLinksResult GetEmailLinks(Guid emailId, string selector = null, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | emailId | ID of email to fetch text for |
| string | selector | Optional HTML query selector for links (optional) |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| EmailLinksResult | EmailLinksResult |
Remarks
HTML parsing uses JSoup and UNIX line separators. Searches content for href attributes
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetEmailLinksWithHttpInfo(Guid, string, int)
Parse and return list of links found in an email (only works for HTML content)
Declaration
ApiResponse<EmailLinksResult> GetEmailLinksWithHttpInfo(Guid emailId, string selector = null, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | emailId | ID of email to fetch text for |
| string | selector | Optional HTML query selector for links (optional) |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<EmailLinksResult> | ApiResponse of EmailLinksResult |
Remarks
HTML parsing uses JSoup and UNIX line separators. Searches content for href attributes
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetEmailPreviewURLs(Guid, int)
Get email URLs for viewing in browser or downloading
Declaration
EmailPreviewUrls GetEmailPreviewURLs(Guid emailId, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | emailId | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| EmailPreviewUrls | EmailPreviewUrls |
Remarks
Get a list of URLs for email content as text/html or raw SMTP message for viewing the message in a browser.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetEmailPreviewURLsWithHttpInfo(Guid, int)
Get email URLs for viewing in browser or downloading
Declaration
ApiResponse<EmailPreviewUrls> GetEmailPreviewURLsWithHttpInfo(Guid emailId, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | emailId | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<EmailPreviewUrls> | ApiResponse of EmailPreviewUrls |
Remarks
Get a list of URLs for email content as text/html or raw SMTP message for viewing the message in a browser.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetEmailScreenshotAsBase64(Guid, GetEmailScreenshotOptions, int)
Take a screenshot of an email in a browser and return base64 encoded string
Declaration
EmailScreenshotResult GetEmailScreenshotAsBase64(Guid emailId, GetEmailScreenshotOptions getEmailScreenshotOptions, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | emailId | |
| GetEmailScreenshotOptions | getEmailScreenshotOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| EmailScreenshotResult | EmailScreenshotResult |
Remarks
Capture image of email screenshot and return as base64 encoded string. Useful for embedding in HTML. Be careful as this may contain sensitive information.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetEmailScreenshotAsBase64WithHttpInfo(Guid, GetEmailScreenshotOptions, int)
Take a screenshot of an email in a browser and return base64 encoded string
Declaration
ApiResponse<EmailScreenshotResult> GetEmailScreenshotAsBase64WithHttpInfo(Guid emailId, GetEmailScreenshotOptions getEmailScreenshotOptions, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | emailId | |
| GetEmailScreenshotOptions | getEmailScreenshotOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<EmailScreenshotResult> | ApiResponse of EmailScreenshotResult |
Remarks
Capture image of email screenshot and return as base64 encoded string. Useful for embedding in HTML. Be careful as this may contain sensitive information.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetEmailScreenshotAsBinary(Guid, GetEmailScreenshotOptions, int)
Take a screenshot of an email in a browser
Declaration
void GetEmailScreenshotAsBinary(Guid emailId, GetEmailScreenshotOptions getEmailScreenshotOptions, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | emailId | |
| GetEmailScreenshotOptions | getEmailScreenshotOptions | |
| int | operationIndex | Index associated with the operation. |
Remarks
Returns binary octet-stream of screenshot of the given email
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetEmailScreenshotAsBinaryWithHttpInfo(Guid, GetEmailScreenshotOptions, int)
Take a screenshot of an email in a browser
Declaration
ApiResponse<object> GetEmailScreenshotAsBinaryWithHttpInfo(Guid emailId, GetEmailScreenshotOptions getEmailScreenshotOptions, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | emailId | |
| GetEmailScreenshotOptions | getEmailScreenshotOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<object> | ApiResponse of Object(void) |
Remarks
Returns binary octet-stream of screenshot of the given email
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetEmailSummary(Guid, bool?, int)
Get email data including headers but not body. Expects email to exist by ID. For emails that may not have arrived yet use the WaitForController.
Declaration
EmailPreview GetEmailSummary(Guid emailId, bool? decode = null, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | emailId | |
| bool? | decode | (optional) |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| EmailPreview | EmailPreview |
Remarks
Returns a email summary object with headers. To retrieve the body see getEmail and to get raw unparsed email use the getRawEmail endpoints
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetEmailSummaryWithHttpInfo(Guid, bool?, int)
Get email data including headers but not body. Expects email to exist by ID. For emails that may not have arrived yet use the WaitForController.
Declaration
ApiResponse<EmailPreview> GetEmailSummaryWithHttpInfo(Guid emailId, bool? decode = null, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | emailId | |
| bool? | decode | (optional) |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<EmailPreview> | ApiResponse of EmailPreview |
Remarks
Returns a email summary object with headers. To retrieve the body see getEmail and to get raw unparsed email use the getRawEmail endpoints
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetEmailTextLines(Guid, bool?, string, int)
Parse and return text from an email, stripping HTML and decoding encoded characters
Declaration
EmailTextLinesResult GetEmailTextLines(Guid emailId, bool? decodeHtmlEntities = null, string lineSeparator = null, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | emailId | ID of email to fetch text for |
| bool? | decodeHtmlEntities | Decode HTML entities (optional) |
| string | lineSeparator | Line separator character (optional) |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| EmailTextLinesResult | EmailTextLinesResult |
Remarks
Parse an email body and return the content as an array of strings. HTML parsing uses JSoup and UNIX line separators.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetEmailTextLinesWithHttpInfo(Guid, bool?, string, int)
Parse and return text from an email, stripping HTML and decoding encoded characters
Declaration
ApiResponse<EmailTextLinesResult> GetEmailTextLinesWithHttpInfo(Guid emailId, bool? decodeHtmlEntities = null, string lineSeparator = null, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | emailId | ID of email to fetch text for |
| bool? | decodeHtmlEntities | Decode HTML entities (optional) |
| string | lineSeparator | Line separator character (optional) |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<EmailTextLinesResult> | ApiResponse of EmailTextLinesResult |
Remarks
Parse an email body and return the content as an array of strings. HTML parsing uses JSoup and UNIX line separators.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetEmailThread(Guid, int)
Return email thread information. Use items endpoints to get messages for thread.
Declaration
EmailThreadDto GetEmailThread(Guid threadId, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | threadId | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| EmailThreadDto | EmailThreadDto |
Remarks
Return email message thread summary from Message-ID, In-Reply-To, and References header. Get messages using items endpoint
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetEmailThreadItems(Guid, string, int)
Return email thread items.
Declaration
EmailThreadItemsDto GetEmailThreadItems(Guid threadId, string sort = null, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | threadId | |
| string | sort | Optional createdAt sort direction ASC or DESC (optional, default to ASC) |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| EmailThreadItemsDto | EmailThreadItemsDto |
Remarks
Return email thread messages based on Message-ID, In-Reply-To, and References header
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetEmailThreadItemsWithHttpInfo(Guid, string, int)
Return email thread items.
Declaration
ApiResponse<EmailThreadItemsDto> GetEmailThreadItemsWithHttpInfo(Guid threadId, string sort = null, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | threadId | |
| string | sort | Optional createdAt sort direction ASC or DESC (optional, default to ASC) |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<EmailThreadItemsDto> | ApiResponse of EmailThreadItemsDto |
Remarks
Return email thread messages based on Message-ID, In-Reply-To, and References header
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetEmailThreadWithHttpInfo(Guid, int)
Return email thread information. Use items endpoints to get messages for thread.
Declaration
ApiResponse<EmailThreadDto> GetEmailThreadWithHttpInfo(Guid threadId, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | threadId | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<EmailThreadDto> | ApiResponse of EmailThreadDto |
Remarks
Return email message thread summary from Message-ID, In-Reply-To, and References header. Get messages using items endpoint
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetEmailThreads(Guid?, int?, int?, string, string, DateTime?, DateTime?, int)
Return email threads in paginated form
Declaration
PageEmailThreadProjection GetEmailThreads(Guid? htmlSelector = null, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid? | htmlSelector | Optional inbox filter (optional) |
| int? | page | Optional page index in email thread pagination (optional, default to 0) |
| int? | size | Optional page size in email thread pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20) |
| string | sort | Optional createdAt sort direction ASC or DESC (optional, default to ASC) |
| string | searchFilter | Optional search filter search filter for email threads. (optional) |
| DateTime? | since | Optional filter email threads created since time (optional) |
| DateTime? | before | Optional filter emails threads created before given date time (optional) |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| PageEmailThreadProjection | PageEmailThreadProjection |
Remarks
Return email message chains built from Message-ID, In-Reply-To, and References header.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetEmailThreadsWithHttpInfo(Guid?, int?, int?, string, string, DateTime?, DateTime?, int)
Return email threads in paginated form
Declaration
ApiResponse<PageEmailThreadProjection> GetEmailThreadsWithHttpInfo(Guid? htmlSelector = null, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid? | htmlSelector | Optional inbox filter (optional) |
| int? | page | Optional page index in email thread pagination (optional, default to 0) |
| int? | size | Optional page size in email thread pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20) |
| string | sort | Optional createdAt sort direction ASC or DESC (optional, default to ASC) |
| string | searchFilter | Optional search filter search filter for email threads. (optional) |
| DateTime? | since | Optional filter email threads created since time (optional) |
| DateTime? | before | Optional filter emails threads created before given date time (optional) |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<PageEmailThreadProjection> | ApiResponse of PageEmailThreadProjection |
Remarks
Return email message chains built from Message-ID, In-Reply-To, and References header.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetEmailWithHttpInfo(Guid, int)
Get email content including headers and body. Expects email to exist by ID. For emails that may not have arrived yet use the WaitForController.
Declaration
ApiResponse<Email> GetEmailWithHttpInfo(Guid emailId, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | emailId | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<Email> | ApiResponse of Email |
Remarks
Returns a email summary object with headers and content. To retrieve the raw unparsed email use the getRawEmail endpoints
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetEmailsOffsetPaginated(List<Guid>, int?, int?, string, bool?, string, DateTime?, DateTime?, bool?, bool?, Guid?, int)
Get all emails in all inboxes in paginated form. Email API list all.
Declaration
PageEmailProjection GetEmailsOffsetPaginated(List<Guid> inboxId = null, int? page = null, int? size = null, string sort = null, bool? unreadOnly = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, bool? favourited = null, bool? syncConnectors = null, Guid? plusAddressId = null, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| List<Guid> | inboxId | Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. (optional) |
| int? | page | Optional page index in email list pagination (optional, default to 0) |
| int? | size | 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) |
| string | sort | Optional createdAt sort direction ASC or DESC (optional, default to ASC) |
| bool? | unreadOnly | 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) |
| string | searchFilter | Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body (optional) |
| DateTime? | since | Optional filter emails received after given date time (optional) |
| DateTime? | before | Optional filter emails received before given date time (optional) |
| bool? | favourited | Optional filter emails that are favourited (optional) |
| bool? | syncConnectors | Sync connectors (optional) |
| Guid? | plusAddressId | Optional plus address ID filter (optional) |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| PageEmailProjection | PageEmailProjection |
Remarks
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
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetEmailsOffsetPaginatedWithHttpInfo(List<Guid>, int?, int?, string, bool?, string, DateTime?, DateTime?, bool?, bool?, Guid?, int)
Get all emails in all inboxes in paginated form. Email API list all.
Declaration
ApiResponse<PageEmailProjection> GetEmailsOffsetPaginatedWithHttpInfo(List<Guid> inboxId = null, int? page = null, int? size = null, string sort = null, bool? unreadOnly = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, bool? favourited = null, bool? syncConnectors = null, Guid? plusAddressId = null, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| List<Guid> | inboxId | Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. (optional) |
| int? | page | Optional page index in email list pagination (optional, default to 0) |
| int? | size | 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) |
| string | sort | Optional createdAt sort direction ASC or DESC (optional, default to ASC) |
| bool? | unreadOnly | 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) |
| string | searchFilter | Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body (optional) |
| DateTime? | since | Optional filter emails received after given date time (optional) |
| DateTime? | before | Optional filter emails received before given date time (optional) |
| bool? | favourited | Optional filter emails that are favourited (optional) |
| bool? | syncConnectors | Sync connectors (optional) |
| Guid? | plusAddressId | Optional plus address ID filter (optional) |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<PageEmailProjection> | ApiResponse of PageEmailProjection |
Remarks
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
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetEmailsPaginated(List<Guid>, int?, int?, string, bool?, string, DateTime?, DateTime?, bool?, Guid?, bool?, int)
Get all emails in all inboxes in paginated form. Email API list all.
Declaration
PageEmailProjection GetEmailsPaginated(List<Guid> inboxId = null, int? page = null, int? size = null, string sort = null, bool? unreadOnly = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, bool? syncConnectors = null, Guid? plusAddressId = null, bool? favourited = null, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| List<Guid> | inboxId | Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. (optional) |
| int? | page | Optional page index in email list pagination (optional, default to 0) |
| int? | size | 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) |
| string | sort | Optional createdAt sort direction ASC or DESC (optional, default to ASC) |
| bool? | unreadOnly | 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) |
| string | searchFilter | Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body (optional) |
| DateTime? | since | Optional filter emails received after given date time. If unset will use time 24hours prior to now. (optional) |
| DateTime? | before | Optional filter emails received before given date time (optional) |
| bool? | syncConnectors | Sync connectors (optional) |
| Guid? | plusAddressId | Optional plus address ID filter (optional) |
| bool? | favourited | Optional filter emails that are favourited (optional) |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| PageEmailProjection | PageEmailProjection |
Remarks
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
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetEmailsPaginatedWithHttpInfo(List<Guid>, int?, int?, string, bool?, string, DateTime?, DateTime?, bool?, Guid?, bool?, int)
Get all emails in all inboxes in paginated form. Email API list all.
Declaration
ApiResponse<PageEmailProjection> GetEmailsPaginatedWithHttpInfo(List<Guid> inboxId = null, int? page = null, int? size = null, string sort = null, bool? unreadOnly = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, bool? syncConnectors = null, Guid? plusAddressId = null, bool? favourited = null, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| List<Guid> | inboxId | Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. (optional) |
| int? | page | Optional page index in email list pagination (optional, default to 0) |
| int? | size | 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) |
| string | sort | Optional createdAt sort direction ASC or DESC (optional, default to ASC) |
| bool? | unreadOnly | 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) |
| string | searchFilter | Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body (optional) |
| DateTime? | since | Optional filter emails received after given date time. If unset will use time 24hours prior to now. (optional) |
| DateTime? | before | Optional filter emails received before given date time (optional) |
| bool? | syncConnectors | Sync connectors (optional) |
| Guid? | plusAddressId | Optional plus address ID filter (optional) |
| bool? | favourited | Optional filter emails that are favourited (optional) |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<PageEmailProjection> | ApiResponse of PageEmailProjection |
Remarks
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
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetGravatarUrlForEmailAddress(string, string, int)
Declaration
GravatarUrl GetGravatarUrlForEmailAddress(string emailAddress, string size = null, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| string | emailAddress | |
| string | size | (optional) |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| GravatarUrl | GravatarUrl |
Remarks
Get gravatar url for email address
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetGravatarUrlForEmailAddressWithHttpInfo(string, string, int)
Declaration
ApiResponse<GravatarUrl> GetGravatarUrlForEmailAddressWithHttpInfo(string emailAddress, string size = null, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| string | emailAddress | |
| string | size | (optional) |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<GravatarUrl> | ApiResponse of GravatarUrl |
Remarks
Get gravatar url for email address
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetLatestEmail(List<Guid>, int)
Get latest email in all inboxes. Most recently received.
Declaration
Email GetLatestEmail(List<Guid> inboxIds = null, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| List<Guid> | inboxIds | 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) |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
Remarks
Get the newest email in all inboxes or in a passed set of inbox IDs
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetLatestEmailInInbox1(Guid, int)
Get latest email in an inbox. Use WaitForController to get emails that may not have arrived yet.
Declaration
Email GetLatestEmailInInbox1(Guid inboxId, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | inboxId | ID of the inbox you want to get the latest email from |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
Remarks
Get the newest email in all inboxes or in a passed set of inbox IDs
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetLatestEmailInInbox1WithHttpInfo(Guid, int)
Get latest email in an inbox. Use WaitForController to get emails that may not have arrived yet.
Declaration
ApiResponse<Email> GetLatestEmailInInbox1WithHttpInfo(Guid inboxId, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | inboxId | ID of the inbox you want to get the latest email from |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<Email> | ApiResponse of Email |
Remarks
Get the newest email in all inboxes or in a passed set of inbox IDs
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetLatestEmailWithHttpInfo(List<Guid>, int)
Get latest email in all inboxes. Most recently received.
Declaration
ApiResponse<Email> GetLatestEmailWithHttpInfo(List<Guid> inboxIds = null, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| List<Guid> | inboxIds | 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) |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<Email> | ApiResponse of Email |
Remarks
Get the newest email in all inboxes or in a passed set of inbox IDs
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetOrganizationEmailsPaginated(List<Guid>, int?, int?, string, bool?, string, DateTime?, DateTime?, bool?, bool?, Guid?, int)
Get all organization emails. List team or shared test email accounts
Declaration
PageEmailProjection GetOrganizationEmailsPaginated(List<Guid> inboxId = null, int? page = null, int? size = null, string sort = null, bool? unreadOnly = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, bool? syncConnectors = null, bool? favourited = null, Guid? plusAddressId = null, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| List<Guid> | inboxId | Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. (optional) |
| int? | page | Optional page index in email list pagination (optional, default to 0) |
| int? | size | 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) |
| string | sort | Optional createdAt sort direction ASC or DESC (optional, default to ASC) |
| bool? | unreadOnly | 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) |
| string | searchFilter | Optional search filter search filter for emails. (optional) |
| DateTime? | since | Optional filter emails received after given date time. If unset will use time 24hours prior to now. (optional) |
| DateTime? | before | Optional filter emails received before given date time (optional) |
| bool? | syncConnectors | Sync connectors (optional) |
| bool? | favourited | Search only favorited emails (optional) |
| Guid? | plusAddressId | Optional plus address ID filter (optional) |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| PageEmailProjection | PageEmailProjection |
Remarks
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
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetOrganizationEmailsPaginatedWithHttpInfo(List<Guid>, int?, int?, string, bool?, string, DateTime?, DateTime?, bool?, bool?, Guid?, int)
Get all organization emails. List team or shared test email accounts
Declaration
ApiResponse<PageEmailProjection> GetOrganizationEmailsPaginatedWithHttpInfo(List<Guid> inboxId = null, int? page = null, int? size = null, string sort = null, bool? unreadOnly = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, bool? syncConnectors = null, bool? favourited = null, Guid? plusAddressId = null, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| List<Guid> | inboxId | Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. (optional) |
| int? | page | Optional page index in email list pagination (optional, default to 0) |
| int? | size | 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) |
| string | sort | Optional createdAt sort direction ASC or DESC (optional, default to ASC) |
| bool? | unreadOnly | 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) |
| string | searchFilter | Optional search filter search filter for emails. (optional) |
| DateTime? | since | Optional filter emails received after given date time. If unset will use time 24hours prior to now. (optional) |
| DateTime? | before | Optional filter emails received before given date time (optional) |
| bool? | syncConnectors | Sync connectors (optional) |
| bool? | favourited | Search only favorited emails (optional) |
| Guid? | plusAddressId | Optional plus address ID filter (optional) |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<PageEmailProjection> | ApiResponse of PageEmailProjection |
Remarks
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
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetRawEmailContents(Guid, int)
Get raw email string. Returns unparsed raw SMTP message with headers and body.
Declaration
void GetRawEmailContents(Guid emailId, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | emailId | ID of email |
| int | operationIndex | Index associated with the operation. |
Remarks
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
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetRawEmailContentsWithHttpInfo(Guid, int)
Get raw email string. Returns unparsed raw SMTP message with headers and body.
Declaration
ApiResponse<object> GetRawEmailContentsWithHttpInfo(Guid emailId, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | emailId | ID of email |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<object> | ApiResponse of Object(void) |
Remarks
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
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetRawEmailJson(Guid, int)
Get raw email in JSON. Unparsed SMTP message in JSON wrapper format.
Declaration
RawEmailJson GetRawEmailJson(Guid emailId, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | emailId | ID of email |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| RawEmailJson | RawEmailJson |
Remarks
Returns a raw, unparsed, and unprocessed email wrapped in a JSON response object for easier handling when compared with the getRawEmail text/plain response
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetRawEmailJsonWithHttpInfo(Guid, int)
Get raw email in JSON. Unparsed SMTP message in JSON wrapper format.
Declaration
ApiResponse<RawEmailJson> GetRawEmailJsonWithHttpInfo(Guid emailId, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | emailId | ID of email |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<RawEmailJson> | ApiResponse of RawEmailJson |
Remarks
Returns a raw, unparsed, and unprocessed email wrapped in a JSON response object for easier handling when compared with the getRawEmail text/plain response
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetUnreadEmailCount(Guid?, int)
Get unread email count
Declaration
UnreadCount GetUnreadEmailCount(Guid? inboxId = null, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid? | inboxId | Optional inbox ID filter (optional) |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| UnreadCount | UnreadCount |
Remarks
Get number of emails unread. Unread means has not been viewed in dashboard or returned in an email API response
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetUnreadEmailCountWithHttpInfo(Guid?, int)
Get unread email count
Declaration
ApiResponse<UnreadCount> GetUnreadEmailCountWithHttpInfo(Guid? inboxId = null, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid? | inboxId | Optional inbox ID filter (optional) |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<UnreadCount> | ApiResponse of UnreadCount |
Remarks
Get number of emails unread. Unread means has not been viewed in dashboard or returned in an email API response
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
MarkAllAsRead(bool?, Guid?, int)
Mark all emails as read or unread
Declaration
void MarkAllAsRead(bool? read = null, Guid? inboxId = null, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| bool? | read | What value to assign to email read property. Default true. (optional, default to true) |
| Guid? | inboxId | Optional inbox ID filter (optional) |
| int | operationIndex | Index associated with the operation. |
Remarks
Marks all emails 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
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
MarkAllAsReadWithHttpInfo(bool?, Guid?, int)
Mark all emails as read or unread
Declaration
ApiResponse<object> MarkAllAsReadWithHttpInfo(bool? read = null, Guid? inboxId = null, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| bool? | read | What value to assign to email read property. Default true. (optional, default to true) |
| Guid? | inboxId | Optional inbox ID filter (optional) |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<object> | ApiResponse of Object(void) |
Remarks
Marks all emails 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
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
MarkAsRead(Guid, bool?, int)
Mark an email as read or unread
Declaration
EmailPreview MarkAsRead(Guid emailId, bool? read = null, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | emailId | |
| bool? | read | What value to assign to email read property. Default true. (optional, default to true) |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| EmailPreview | EmailPreview |
Remarks
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
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
MarkAsReadWithHttpInfo(Guid, bool?, int)
Mark an email as read or unread
Declaration
ApiResponse<EmailPreview> MarkAsReadWithHttpInfo(Guid emailId, bool? read = null, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | emailId | |
| bool? | read | What value to assign to email read property. Default true. (optional, default to true) |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<EmailPreview> | ApiResponse of EmailPreview |
Remarks
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
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
ReplyToEmail(Guid, ReplyToEmailOptions, int)
Reply to an email
Declaration
SentEmailDto ReplyToEmail(Guid emailId, ReplyToEmailOptions replyToEmailOptions, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | emailId | ID of the email that should be replied to |
| ReplyToEmailOptions | replyToEmailOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| SentEmailDto | SentEmailDto |
Remarks
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.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
ReplyToEmailWithHttpInfo(Guid, ReplyToEmailOptions, int)
Reply to an email
Declaration
ApiResponse<SentEmailDto> ReplyToEmailWithHttpInfo(Guid emailId, ReplyToEmailOptions replyToEmailOptions, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | emailId | ID of the email that should be replied to |
| ReplyToEmailOptions | replyToEmailOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<SentEmailDto> | ApiResponse of SentEmailDto |
Remarks
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.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
SearchEmails(SearchEmailsOptions, bool?, bool?, Guid?, int)
Get all emails by search criteria. Return in paginated form.
Declaration
PageEmailProjection SearchEmails(SearchEmailsOptions searchEmailsOptions, bool? syncConnectors = null, bool? favourited = null, Guid? plusAddressId = null, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| SearchEmailsOptions | searchEmailsOptions | |
| bool? | syncConnectors | Sync connectors (optional) |
| bool? | favourited | Search only favourited emails (optional) |
| Guid? | plusAddressId | Optional plus address ID filter (optional) |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| PageEmailProjection | PageEmailProjection |
Remarks
Search emails by given criteria return matches in paginated format. Searches against email recipients, sender, subject, email address and ID. Does not search email body
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
SearchEmailsWithHttpInfo(SearchEmailsOptions, bool?, bool?, Guid?, int)
Get all emails by search criteria. Return in paginated form.
Declaration
ApiResponse<PageEmailProjection> SearchEmailsWithHttpInfo(SearchEmailsOptions searchEmailsOptions, bool? syncConnectors = null, bool? favourited = null, Guid? plusAddressId = null, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| SearchEmailsOptions | searchEmailsOptions | |
| bool? | syncConnectors | Sync connectors (optional) |
| bool? | favourited | Search only favourited emails (optional) |
| Guid? | plusAddressId | Optional plus address ID filter (optional) |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<PageEmailProjection> | ApiResponse of PageEmailProjection |
Remarks
Search emails by given criteria return matches in paginated format. Searches against email recipients, sender, subject, email address and ID. Does not search email body
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
SendEmailSourceOptional(SendEmailOptions, Guid?, bool?, bool?, int)
Send email
Declaration
void SendEmailSourceOptional(SendEmailOptions sendEmailOptions, Guid? inboxId = null, bool? useDomainPool = null, bool? virtualSend = null, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| SendEmailOptions | sendEmailOptions | |
| Guid? | inboxId | ID of the inbox you want to send the email from (optional) |
| bool? | useDomainPool | Use domain pool. Optionally create inbox to send from using the mailslurp domain pool. (optional) |
| bool? | virtualSend | Optionally create inbox to send from that is a virtual inbox and won't send to external addresses (optional) |
| int | operationIndex | Index associated with the operation. |
Remarks
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.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
SendEmailSourceOptionalWithHttpInfo(SendEmailOptions, Guid?, bool?, bool?, int)
Send email
Declaration
ApiResponse<object> SendEmailSourceOptionalWithHttpInfo(SendEmailOptions sendEmailOptions, Guid? inboxId = null, bool? useDomainPool = null, bool? virtualSend = null, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| SendEmailOptions | sendEmailOptions | |
| Guid? | inboxId | ID of the inbox you want to send the email from (optional) |
| bool? | useDomainPool | Use domain pool. Optionally create inbox to send from using the mailslurp domain pool. (optional) |
| bool? | virtualSend | Optionally create inbox to send from that is a virtual inbox and won't send to external addresses (optional) |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<object> | ApiResponse of Object(void) |
Remarks
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.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
SetEmailFavourited(Guid, bool, int)
Set email favourited state
Declaration
void SetEmailFavourited(Guid emailId, bool favourited, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | emailId | ID of email to set favourite state |
| bool | favourited | |
| int | operationIndex | Index associated with the operation. |
Remarks
Set and return new favorite state for an email
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
SetEmailFavouritedWithHttpInfo(Guid, bool, int)
Set email favourited state
Declaration
ApiResponse<object> SetEmailFavouritedWithHttpInfo(Guid emailId, bool favourited, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | emailId | ID of email to set favourite state |
| bool | favourited | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<object> | ApiResponse of Object(void) |
Remarks
Set and return new favorite state for an email
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
ValidateEmail(Guid, int)
Validate email HTML contents
Declaration
ValidationDto ValidateEmail(Guid emailId, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | emailId | ID of email |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ValidationDto | ValidationDto |
Remarks
Validate the HTML content of email if HTML is found. Considered valid if no HTML is present.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
ValidateEmailWithHttpInfo(Guid, int)
Validate email HTML contents
Declaration
ApiResponse<ValidationDto> ValidateEmailWithHttpInfo(Guid emailId, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | emailId | ID of email |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<ValidationDto> | ApiResponse of ValidationDto |
Remarks
Validate the HTML content of email if HTML is found. Considered valid if no HTML is present.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |