Documentation

EmailControllerApi
in package

MailSlurp

EmailControllerApi Class Doc Comment

contentTypes


    public
        array<string|int, string>
    contentTypes
    = ['applyImapFlagOperation' => ['application/json'], 'canSend' => ['application/json'], 'checkEmailBody' => ['application/json'], 'checkEmailBodyFeatureSupport' => ['application/json'], 'checkEmailClientSupport' => ['application/json'], 'deleteAllEmails' => ['application/json'], 'deleteEmail' => ['application/json'], 'downloadAttachment' => ['application/json'], 'downloadAttachmentBase64' => ['application/json'], 'downloadBody' => ['application/json'], 'downloadBodyBytes' => ['application/json'], 'forwardEmail' => ['application/json'], 'getAttachmentMetaData' => ['application/json'], 'getEmail' => ['application/json'], 'getEmailAttachments' => ['application/json'], 'getEmailContentMatch' => ['application/json'], 'getEmailContentPart' => ['application/json'], 'getEmailCount' => ['application/json'], 'getEmailHTML' => ['application/json'], 'getEmailHTMLJson' => ['application/json'], 'getEmailHTMLQuery' => ['application/json'], 'getEmailLinks' => ['application/json'], 'getEmailPreviewURLs' => ['application/json'], 'getEmailScreenshotAsBase64' => ['application/json'], 'getEmailScreenshotAsBinary' => ['application/json'], 'getEmailTextLines' => ['application/json'], 'getEmailsOffsetPaginated' => ['application/json'], 'getEmailsPaginated' => ['application/json'], 'getGravatarUrlForEmailAddress' => ['application/json'], 'getLatestEmail' => ['application/json'], 'getLatestEmailInInbox1' => ['application/json'], 'getOrganizationEmailsPaginated' => ['application/json'], 'getRawEmailContents' => ['application/json'], 'getRawEmailJson' => ['application/json'], 'getUnreadEmailCount' => ['application/json'], 'markAllAsRead' => ['application/json'], 'markAsRead' => ['application/json'], 'replyToEmail' => ['application/json'], 'searchEmails' => ['application/json'], 'sendEmailSourceOptional' => ['application/json'], 'validateEmail' => ['application/json']]

$client


    protected
        ClientInterface
    $client

$config


    protected
        Configuration
    $config

$headerSelector


    protected
        HeaderSelector
    $headerSelector

$hostIndex


    protected
        int
    $hostIndex

Host index

__construct()


    public
                    __construct([ClientInterface $client = null ][, Configuration $config = null ][, HeaderSelector $selector = null ], int $hostIndex) : mixed

Parameters

$client : ClientInterface = null
$config : Configuration = null
$selector : HeaderSelector = null
$hostIndex : int: (Optional) host index to select the list of hosts if defined in the OpenAPI spec

Return values

mixed —

applyImapFlagOperation()

Operation applyImapFlagOperation


    public
                    applyImapFlagOperation(string $email_id, ImapFlagOperationOptions $imap_flag_operation_options[, string $contentType = self::contentTypes['applyImapFlagOperation'][0] ]) : EmailPreview

Set IMAP flags associated with a message. Only supports '\Seen' flag.

Parameters

$email_id : string: email_id (required)
$imap_flag_operation_options : ImapFlagOperationOptions: imap_flag_operation_options (required)
$contentType : string = self::contentTypes['applyImapFlagOperation'][0]: The value for the Content-Type header. Check self::contentTypes['applyImapFlagOperation'] to see the possible values for this operation

Return values

EmailPreview —

applyImapFlagOperationAsync()

Operation applyImapFlagOperationAsync


    public
                    applyImapFlagOperationAsync(string $email_id, ImapFlagOperationOptions $imap_flag_operation_options[, string $contentType = self::contentTypes['applyImapFlagOperation'][0] ]) : PromiseInterface

Set IMAP flags associated with a message. Only supports '\Seen' flag.

Parameters

$email_id : string: (required)
$imap_flag_operation_options : ImapFlagOperationOptions: (required)
$contentType : string = self::contentTypes['applyImapFlagOperation'][0]: The value for the Content-Type header. Check self::contentTypes['applyImapFlagOperation'] to see the possible values for this operation

Return values

PromiseInterface —

applyImapFlagOperationAsyncWithHttpInfo()

Operation applyImapFlagOperationAsyncWithHttpInfo


    public
                    applyImapFlagOperationAsyncWithHttpInfo(string $email_id, ImapFlagOperationOptions $imap_flag_operation_options[, string $contentType = self::contentTypes['applyImapFlagOperation'][0] ]) : PromiseInterface

Set IMAP flags associated with a message. Only supports '\Seen' flag.

Parameters

$email_id : string: (required)
$imap_flag_operation_options : ImapFlagOperationOptions: (required)
$contentType : string = self::contentTypes['applyImapFlagOperation'][0]: The value for the Content-Type header. Check self::contentTypes['applyImapFlagOperation'] to see the possible values for this operation

Return values

PromiseInterface —

applyImapFlagOperationRequest()

Create request for operation 'applyImapFlagOperation'


    public
                    applyImapFlagOperationRequest(string $email_id, ImapFlagOperationOptions $imap_flag_operation_options[, string $contentType = self::contentTypes['applyImapFlagOperation'][0] ]) : Request

Parameters

$email_id : string: (required)
$imap_flag_operation_options : ImapFlagOperationOptions: (required)
$contentType : string = self::contentTypes['applyImapFlagOperation'][0]: The value for the Content-Type header. Check self::contentTypes['applyImapFlagOperation'] to see the possible values for this operation

Return values

Request —

applyImapFlagOperationWithHttpInfo()

Operation applyImapFlagOperationWithHttpInfo


    public
                    applyImapFlagOperationWithHttpInfo(string $email_id, ImapFlagOperationOptions $imap_flag_operation_options[, string $contentType = self::contentTypes['applyImapFlagOperation'][0] ]) : array<string|int, mixed>

Set IMAP flags associated with a message. Only supports '\Seen' flag.

Parameters

$email_id : string: (required)
$imap_flag_operation_options : ImapFlagOperationOptions: (required)
$contentType : string = self::contentTypes['applyImapFlagOperation'][0]: The value for the Content-Type header. Check self::contentTypes['applyImapFlagOperation'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\EmailPreview, HTTP status code, HTTP response headers (array of strings)

canSend()

Operation canSend


    public
                    canSend(string $inbox_id, SendEmailOptions $send_email_options[, string $contentType = self::contentTypes['canSend'][0] ]) : CanSendEmailResults

Check if email can be sent and options are valid.

Parameters

$inbox_id : string: ID of the inbox you want to send the email from (required)
$send_email_options : SendEmailOptions: send_email_options (required)
$contentType : string = self::contentTypes['canSend'][0]: The value for the Content-Type header. Check self::contentTypes['canSend'] to see the possible values for this operation

Return values

CanSendEmailResults —

canSendAsync()

Operation canSendAsync


    public
                    canSendAsync(string $inbox_id, SendEmailOptions $send_email_options[, string $contentType = self::contentTypes['canSend'][0] ]) : PromiseInterface

Check if email can be sent and options are valid.

Parameters

$inbox_id : string: ID of the inbox you want to send the email from (required)
$send_email_options : SendEmailOptions: (required)
$contentType : string = self::contentTypes['canSend'][0]: The value for the Content-Type header. Check self::contentTypes['canSend'] to see the possible values for this operation

Return values

PromiseInterface —

canSendAsyncWithHttpInfo()

Operation canSendAsyncWithHttpInfo


    public
                    canSendAsyncWithHttpInfo(string $inbox_id, SendEmailOptions $send_email_options[, string $contentType = self::contentTypes['canSend'][0] ]) : PromiseInterface

Check if email can be sent and options are valid.

Parameters

$inbox_id : string: ID of the inbox you want to send the email from (required)
$send_email_options : SendEmailOptions: (required)
$contentType : string = self::contentTypes['canSend'][0]: The value for the Content-Type header. Check self::contentTypes['canSend'] to see the possible values for this operation

Return values

PromiseInterface —

canSendRequest()

Create request for operation 'canSend'


    public
                    canSendRequest(string $inbox_id, SendEmailOptions $send_email_options[, string $contentType = self::contentTypes['canSend'][0] ]) : Request

Parameters

$inbox_id : string: ID of the inbox you want to send the email from (required)
$send_email_options : SendEmailOptions: (required)
$contentType : string = self::contentTypes['canSend'][0]: The value for the Content-Type header. Check self::contentTypes['canSend'] to see the possible values for this operation

Return values

Request —

canSendWithHttpInfo()

Operation canSendWithHttpInfo


    public
                    canSendWithHttpInfo(string $inbox_id, SendEmailOptions $send_email_options[, string $contentType = self::contentTypes['canSend'][0] ]) : array<string|int, mixed>

Check if email can be sent and options are valid.

Parameters

$inbox_id : string: ID of the inbox you want to send the email from (required)
$send_email_options : SendEmailOptions: (required)
$contentType : string = self::contentTypes['canSend'][0]: The value for the Content-Type header. Check self::contentTypes['canSend'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\CanSendEmailResults, HTTP status code, HTTP response headers (array of strings)

checkEmailBody()

Operation checkEmailBody


    public
                    checkEmailBody(string $email_id[, string $contentType = self::contentTypes['checkEmailBody'][0] ]) : CheckEmailBodyResults

Detect broken links, spelling, and images in email content

Parameters

$email_id : string: email_id (required)
$contentType : string = self::contentTypes['checkEmailBody'][0]: The value for the Content-Type header. Check self::contentTypes['checkEmailBody'] to see the possible values for this operation

Return values

CheckEmailBodyResults —

checkEmailBodyAsync()

Operation checkEmailBodyAsync


    public
                    checkEmailBodyAsync(string $email_id[, string $contentType = self::contentTypes['checkEmailBody'][0] ]) : PromiseInterface

Detect broken links, spelling, and images in email content

Parameters

$email_id : string: (required)
$contentType : string = self::contentTypes['checkEmailBody'][0]: The value for the Content-Type header. Check self::contentTypes['checkEmailBody'] to see the possible values for this operation

Return values

PromiseInterface —

checkEmailBodyAsyncWithHttpInfo()

Operation checkEmailBodyAsyncWithHttpInfo


    public
                    checkEmailBodyAsyncWithHttpInfo(string $email_id[, string $contentType = self::contentTypes['checkEmailBody'][0] ]) : PromiseInterface

Detect broken links, spelling, and images in email content

Parameters

$email_id : string: (required)
$contentType : string = self::contentTypes['checkEmailBody'][0]: The value for the Content-Type header. Check self::contentTypes['checkEmailBody'] to see the possible values for this operation

Return values

PromiseInterface —

checkEmailBodyFeatureSupport()

Operation checkEmailBodyFeatureSupport


    public
                    checkEmailBodyFeatureSupport(string $email_id[, string $contentType = self::contentTypes['checkEmailBodyFeatureSupport'][0] ]) : CheckEmailBodyFeatureSupportResults

Show which mail clients support the HTML and CSS features used in an email body.

Parameters

$email_id : string: email_id (required)
$contentType : string = self::contentTypes['checkEmailBodyFeatureSupport'][0]: The value for the Content-Type header. Check self::contentTypes['checkEmailBodyFeatureSupport'] to see the possible values for this operation

Return values

CheckEmailBodyFeatureSupportResults —

checkEmailBodyFeatureSupportAsync()

Operation checkEmailBodyFeatureSupportAsync


    public
                    checkEmailBodyFeatureSupportAsync(string $email_id[, string $contentType = self::contentTypes['checkEmailBodyFeatureSupport'][0] ]) : PromiseInterface

Show which mail clients support the HTML and CSS features used in an email body.

Parameters

$email_id : string: (required)
$contentType : string = self::contentTypes['checkEmailBodyFeatureSupport'][0]: The value for the Content-Type header. Check self::contentTypes['checkEmailBodyFeatureSupport'] to see the possible values for this operation

Return values

PromiseInterface —

checkEmailBodyFeatureSupportAsyncWithHttpInfo()

Operation checkEmailBodyFeatureSupportAsyncWithHttpInfo


    public
                    checkEmailBodyFeatureSupportAsyncWithHttpInfo(string $email_id[, string $contentType = self::contentTypes['checkEmailBodyFeatureSupport'][0] ]) : PromiseInterface

Show which mail clients support the HTML and CSS features used in an email body.

Parameters

$email_id : string: (required)
$contentType : string = self::contentTypes['checkEmailBodyFeatureSupport'][0]: The value for the Content-Type header. Check self::contentTypes['checkEmailBodyFeatureSupport'] to see the possible values for this operation

Return values

PromiseInterface —

checkEmailBodyFeatureSupportRequest()

Create request for operation 'checkEmailBodyFeatureSupport'


    public
                    checkEmailBodyFeatureSupportRequest(string $email_id[, string $contentType = self::contentTypes['checkEmailBodyFeatureSupport'][0] ]) : Request

Parameters

$email_id : string: (required)
$contentType : string = self::contentTypes['checkEmailBodyFeatureSupport'][0]: The value for the Content-Type header. Check self::contentTypes['checkEmailBodyFeatureSupport'] to see the possible values for this operation

Return values

Request —

checkEmailBodyFeatureSupportWithHttpInfo()

Operation checkEmailBodyFeatureSupportWithHttpInfo


    public
                    checkEmailBodyFeatureSupportWithHttpInfo(string $email_id[, string $contentType = self::contentTypes['checkEmailBodyFeatureSupport'][0] ]) : array<string|int, mixed>

Show which mail clients support the HTML and CSS features used in an email body.

Parameters

$email_id : string: (required)
$contentType : string = self::contentTypes['checkEmailBodyFeatureSupport'][0]: The value for the Content-Type header. Check self::contentTypes['checkEmailBodyFeatureSupport'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\CheckEmailBodyFeatureSupportResults, HTTP status code, HTTP response headers (array of strings)

checkEmailBodyRequest()

Create request for operation 'checkEmailBody'


    public
                    checkEmailBodyRequest(string $email_id[, string $contentType = self::contentTypes['checkEmailBody'][0] ]) : Request

Parameters

$email_id : string: (required)
$contentType : string = self::contentTypes['checkEmailBody'][0]: The value for the Content-Type header. Check self::contentTypes['checkEmailBody'] to see the possible values for this operation

Return values

Request —

checkEmailBodyWithHttpInfo()

Operation checkEmailBodyWithHttpInfo


    public
                    checkEmailBodyWithHttpInfo(string $email_id[, string $contentType = self::contentTypes['checkEmailBody'][0] ]) : array<string|int, mixed>

Detect broken links, spelling, and images in email content

Parameters

$email_id : string: (required)
$contentType : string = self::contentTypes['checkEmailBody'][0]: The value for the Content-Type header. Check self::contentTypes['checkEmailBody'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\CheckEmailBodyResults, HTTP status code, HTTP response headers (array of strings)

checkEmailClientSupport()

Operation checkEmailClientSupport


    public
                    checkEmailClientSupport(CheckEmailClientSupportOptions $check_email_client_support_options[, string $contentType = self::contentTypes['checkEmailClientSupport'][0] ]) : CheckEmailClientSupportResults

Show which email programs and devices support the features used in an email body.

Parameters

$check_email_client_support_options : CheckEmailClientSupportOptions: check_email_client_support_options (required)
$contentType : string = self::contentTypes['checkEmailClientSupport'][0]: The value for the Content-Type header. Check self::contentTypes['checkEmailClientSupport'] to see the possible values for this operation

Return values

CheckEmailClientSupportResults —

checkEmailClientSupportAsync()

Operation checkEmailClientSupportAsync


    public
                    checkEmailClientSupportAsync(CheckEmailClientSupportOptions $check_email_client_support_options[, string $contentType = self::contentTypes['checkEmailClientSupport'][0] ]) : PromiseInterface

Show which email programs and devices support the features used in an email body.

Parameters

$check_email_client_support_options : CheckEmailClientSupportOptions: (required)
$contentType : string = self::contentTypes['checkEmailClientSupport'][0]: The value for the Content-Type header. Check self::contentTypes['checkEmailClientSupport'] to see the possible values for this operation

Return values

PromiseInterface —

checkEmailClientSupportAsyncWithHttpInfo()

Operation checkEmailClientSupportAsyncWithHttpInfo


    public
                    checkEmailClientSupportAsyncWithHttpInfo(CheckEmailClientSupportOptions $check_email_client_support_options[, string $contentType = self::contentTypes['checkEmailClientSupport'][0] ]) : PromiseInterface

Show which email programs and devices support the features used in an email body.

Parameters

$check_email_client_support_options : CheckEmailClientSupportOptions: (required)
$contentType : string = self::contentTypes['checkEmailClientSupport'][0]: The value for the Content-Type header. Check self::contentTypes['checkEmailClientSupport'] to see the possible values for this operation

Return values

PromiseInterface —

checkEmailClientSupportRequest()

Create request for operation 'checkEmailClientSupport'


    public
                    checkEmailClientSupportRequest(CheckEmailClientSupportOptions $check_email_client_support_options[, string $contentType = self::contentTypes['checkEmailClientSupport'][0] ]) : Request

Parameters

$check_email_client_support_options : CheckEmailClientSupportOptions: (required)
$contentType : string = self::contentTypes['checkEmailClientSupport'][0]: The value for the Content-Type header. Check self::contentTypes['checkEmailClientSupport'] to see the possible values for this operation

Return values

Request —

checkEmailClientSupportWithHttpInfo()

Operation checkEmailClientSupportWithHttpInfo


    public
                    checkEmailClientSupportWithHttpInfo(CheckEmailClientSupportOptions $check_email_client_support_options[, string $contentType = self::contentTypes['checkEmailClientSupport'][0] ]) : array<string|int, mixed>

Show which email programs and devices support the features used in an email body.

Parameters

$check_email_client_support_options : CheckEmailClientSupportOptions: (required)
$contentType : string = self::contentTypes['checkEmailClientSupport'][0]: The value for the Content-Type header. Check self::contentTypes['checkEmailClientSupport'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\CheckEmailClientSupportResults, HTTP status code, HTTP response headers (array of strings)

deleteAllEmails()

Operation deleteAllEmails


    public
                    deleteAllEmails([string $contentType = self::contentTypes['deleteAllEmails'][0] ]) : void

Delete all emails in all inboxes.

Parameters

$contentType : string = self::contentTypes['deleteAllEmails'][0]: The value for the Content-Type header. Check self::contentTypes['deleteAllEmails'] to see the possible values for this operation

Return values

void —

deleteAllEmailsAsync()

Operation deleteAllEmailsAsync


    public
                    deleteAllEmailsAsync([string $contentType = self::contentTypes['deleteAllEmails'][0] ]) : PromiseInterface

Delete all emails in all inboxes.

Parameters

$contentType : string = self::contentTypes['deleteAllEmails'][0]: The value for the Content-Type header. Check self::contentTypes['deleteAllEmails'] to see the possible values for this operation

Return values

PromiseInterface —

deleteAllEmailsAsyncWithHttpInfo()

Operation deleteAllEmailsAsyncWithHttpInfo


    public
                    deleteAllEmailsAsyncWithHttpInfo([string $contentType = self::contentTypes['deleteAllEmails'][0] ]) : PromiseInterface

Delete all emails in all inboxes.

Parameters

$contentType : string = self::contentTypes['deleteAllEmails'][0]: The value for the Content-Type header. Check self::contentTypes['deleteAllEmails'] to see the possible values for this operation

Return values

PromiseInterface —

deleteAllEmailsRequest()

Create request for operation 'deleteAllEmails'


    public
                    deleteAllEmailsRequest([string $contentType = self::contentTypes['deleteAllEmails'][0] ]) : Request

Parameters

$contentType : string = self::contentTypes['deleteAllEmails'][0]: The value for the Content-Type header. Check self::contentTypes['deleteAllEmails'] to see the possible values for this operation

Return values

Request —

deleteAllEmailsWithHttpInfo()

Operation deleteAllEmailsWithHttpInfo


    public
                    deleteAllEmailsWithHttpInfo([string $contentType = self::contentTypes['deleteAllEmails'][0] ]) : array<string|int, mixed>

Delete all emails in all inboxes.

Parameters

$contentType : string = self::contentTypes['deleteAllEmails'][0]: The value for the Content-Type header. Check self::contentTypes['deleteAllEmails'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of null, HTTP status code, HTTP response headers (array of strings)

deleteEmail()

Operation deleteEmail


    public
                    deleteEmail(string $email_id[, string $contentType = self::contentTypes['deleteEmail'][0] ]) : void

Delete an email

Parameters

$email_id : string: ID of email to delete (required)
$contentType : string = self::contentTypes['deleteEmail'][0]: The value for the Content-Type header. Check self::contentTypes['deleteEmail'] to see the possible values for this operation

Return values

void —

deleteEmailAsync()

Operation deleteEmailAsync


    public
                    deleteEmailAsync(string $email_id[, string $contentType = self::contentTypes['deleteEmail'][0] ]) : PromiseInterface

Delete an email

Parameters

$email_id : string: ID of email to delete (required)
$contentType : string = self::contentTypes['deleteEmail'][0]: The value for the Content-Type header. Check self::contentTypes['deleteEmail'] to see the possible values for this operation

Return values

PromiseInterface —

deleteEmailAsyncWithHttpInfo()

Operation deleteEmailAsyncWithHttpInfo


    public
                    deleteEmailAsyncWithHttpInfo(string $email_id[, string $contentType = self::contentTypes['deleteEmail'][0] ]) : PromiseInterface

Delete an email

Parameters

$email_id : string: ID of email to delete (required)
$contentType : string = self::contentTypes['deleteEmail'][0]: The value for the Content-Type header. Check self::contentTypes['deleteEmail'] to see the possible values for this operation

Return values

PromiseInterface —

deleteEmailRequest()

Create request for operation 'deleteEmail'


    public
                    deleteEmailRequest(string $email_id[, string $contentType = self::contentTypes['deleteEmail'][0] ]) : Request

Parameters

$email_id : string: ID of email to delete (required)
$contentType : string = self::contentTypes['deleteEmail'][0]: The value for the Content-Type header. Check self::contentTypes['deleteEmail'] to see the possible values for this operation

Return values

Request —

deleteEmailWithHttpInfo()

Operation deleteEmailWithHttpInfo


    public
                    deleteEmailWithHttpInfo(string $email_id[, string $contentType = self::contentTypes['deleteEmail'][0] ]) : array<string|int, mixed>

Delete an email

Parameters

$email_id : string: ID of email to delete (required)
$contentType : string = self::contentTypes['deleteEmail'][0]: The value for the Content-Type header. Check self::contentTypes['deleteEmail'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of null, HTTP status code, HTTP response headers (array of strings)

downloadAttachment()

Operation downloadAttachment


    public
                    downloadAttachment(string $email_id, string $attachment_id[, string $api_key = null ][, string $contentType = self::contentTypes['downloadAttachment'][0] ]) : string

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.

Parameters

$email_id : string: ID of email (required)
$attachment_id : string: ID of attachment (required)
$api_key : string = null: 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)
$contentType : string = self::contentTypes['downloadAttachment'][0]: The value for the Content-Type header. Check self::contentTypes['downloadAttachment'] to see the possible values for this operation

Return values

string —

downloadAttachmentAsync()

Operation downloadAttachmentAsync


    public
                    downloadAttachmentAsync(string $email_id, string $attachment_id[, string $api_key = null ][, string $contentType = self::contentTypes['downloadAttachment'][0] ]) : PromiseInterface

Parameters

$email_id : string: ID of email (required)
$attachment_id : string: ID of attachment (required)
$api_key : string = null: 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)
$contentType : string = self::contentTypes['downloadAttachment'][0]: The value for the Content-Type header. Check self::contentTypes['downloadAttachment'] to see the possible values for this operation

Return values

PromiseInterface —

downloadAttachmentAsyncWithHttpInfo()

Operation downloadAttachmentAsyncWithHttpInfo


    public
                    downloadAttachmentAsyncWithHttpInfo(string $email_id, string $attachment_id[, string $api_key = null ][, string $contentType = self::contentTypes['downloadAttachment'][0] ]) : PromiseInterface

Parameters

$email_id : string: ID of email (required)
$attachment_id : string: ID of attachment (required)
$api_key : string = null: 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)
$contentType : string = self::contentTypes['downloadAttachment'][0]: The value for the Content-Type header. Check self::contentTypes['downloadAttachment'] to see the possible values for this operation

Return values

PromiseInterface —

downloadAttachmentBase64()

Operation downloadAttachmentBase64


    public
                    downloadAttachmentBase64(string $email_id, string $attachment_id[, string $contentType = self::contentTypes['downloadAttachmentBase64'][0] ]) : DownloadAttachmentDto

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`.

Parameters

$email_id : string: ID of email (required)
$attachment_id : string: ID of attachment (required)
$contentType : string = self::contentTypes['downloadAttachmentBase64'][0]: The value for the Content-Type header. Check self::contentTypes['downloadAttachmentBase64'] to see the possible values for this operation

Return values

DownloadAttachmentDto —

downloadAttachmentBase64Async()

Operation downloadAttachmentBase64Async


    public
                    downloadAttachmentBase64Async(string $email_id, string $attachment_id[, string $contentType = self::contentTypes['downloadAttachmentBase64'][0] ]) : PromiseInterface

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`.

Parameters

$email_id : string: ID of email (required)
$attachment_id : string: ID of attachment (required)
$contentType : string = self::contentTypes['downloadAttachmentBase64'][0]: The value for the Content-Type header. Check self::contentTypes['downloadAttachmentBase64'] to see the possible values for this operation

Return values

PromiseInterface —

downloadAttachmentBase64AsyncWithHttpInfo()

Operation downloadAttachmentBase64AsyncWithHttpInfo


    public
                    downloadAttachmentBase64AsyncWithHttpInfo(string $email_id, string $attachment_id[, string $contentType = self::contentTypes['downloadAttachmentBase64'][0] ]) : PromiseInterface

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`.

Parameters

$email_id : string: ID of email (required)
$attachment_id : string: ID of attachment (required)
$contentType : string = self::contentTypes['downloadAttachmentBase64'][0]: The value for the Content-Type header. Check self::contentTypes['downloadAttachmentBase64'] to see the possible values for this operation

Return values

PromiseInterface —

downloadAttachmentBase64Request()

Create request for operation 'downloadAttachmentBase64'


    public
                    downloadAttachmentBase64Request(string $email_id, string $attachment_id[, string $contentType = self::contentTypes['downloadAttachmentBase64'][0] ]) : Request

Parameters

$email_id : string: ID of email (required)
$attachment_id : string: ID of attachment (required)
$contentType : string = self::contentTypes['downloadAttachmentBase64'][0]: The value for the Content-Type header. Check self::contentTypes['downloadAttachmentBase64'] to see the possible values for this operation

Return values

Request —

downloadAttachmentBase64WithHttpInfo()

Operation downloadAttachmentBase64WithHttpInfo


    public
                    downloadAttachmentBase64WithHttpInfo(string $email_id, string $attachment_id[, string $contentType = self::contentTypes['downloadAttachmentBase64'][0] ]) : array<string|int, mixed>

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`.

Parameters

$email_id : string: ID of email (required)
$attachment_id : string: ID of attachment (required)
$contentType : string = self::contentTypes['downloadAttachmentBase64'][0]: The value for the Content-Type header. Check self::contentTypes['downloadAttachmentBase64'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\DownloadAttachmentDto, HTTP status code, HTTP response headers (array of strings)

downloadAttachmentRequest()

Create request for operation 'downloadAttachment'


    public
                    downloadAttachmentRequest(string $email_id, string $attachment_id[, string $api_key = null ][, string $contentType = self::contentTypes['downloadAttachment'][0] ]) : Request

Parameters

$email_id : string: ID of email (required)
$attachment_id : string: ID of attachment (required)
$api_key : string = null: 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)
$contentType : string = self::contentTypes['downloadAttachment'][0]: The value for the Content-Type header. Check self::contentTypes['downloadAttachment'] to see the possible values for this operation

Return values

Request —

downloadAttachmentWithHttpInfo()

Operation downloadAttachmentWithHttpInfo


    public
                    downloadAttachmentWithHttpInfo(string $email_id, string $attachment_id[, string $api_key = null ][, string $contentType = self::contentTypes['downloadAttachment'][0] ]) : array<string|int, mixed>

Parameters

$email_id : string: ID of email (required)
$attachment_id : string: ID of attachment (required)
$api_key : string = null: 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)
$contentType : string = self::contentTypes['downloadAttachment'][0]: The value for the Content-Type header. Check self::contentTypes['downloadAttachment'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of string, HTTP status code, HTTP response headers (array of strings)

downloadBody()

Operation downloadBody


    public
                    downloadBody(string $email_id[, string $contentType = self::contentTypes['downloadBody'][0] ]) : string

Get email body as string. Returned as `plain/text` with content type header.

Parameters

$email_id : string: ID of email (required)
$contentType : string = self::contentTypes['downloadBody'][0]: The value for the Content-Type header. Check self::contentTypes['downloadBody'] to see the possible values for this operation

Return values

string —

downloadBodyAsync()

Operation downloadBodyAsync


    public
                    downloadBodyAsync(string $email_id[, string $contentType = self::contentTypes['downloadBody'][0] ]) : PromiseInterface

Get email body as string. Returned as `plain/text` with content type header.

Parameters

$email_id : string: ID of email (required)
$contentType : string = self::contentTypes['downloadBody'][0]: The value for the Content-Type header. Check self::contentTypes['downloadBody'] to see the possible values for this operation

Return values

PromiseInterface —

downloadBodyAsyncWithHttpInfo()

Operation downloadBodyAsyncWithHttpInfo


    public
                    downloadBodyAsyncWithHttpInfo(string $email_id[, string $contentType = self::contentTypes['downloadBody'][0] ]) : PromiseInterface

Get email body as string. Returned as `plain/text` with content type header.

Parameters

$email_id : string: ID of email (required)
$contentType : string = self::contentTypes['downloadBody'][0]: The value for the Content-Type header. Check self::contentTypes['downloadBody'] to see the possible values for this operation

Return values

PromiseInterface —

downloadBodyBytes()

Operation downloadBodyBytes


    public
                    downloadBodyBytes(string $email_id[, string $contentType = self::contentTypes['downloadBodyBytes'][0] ]) : string

Get email body in bytes. Returned as `octet-stream` with content type header.

Parameters

$email_id : string: ID of email (required)
$contentType : string = self::contentTypes['downloadBodyBytes'][0]: The value for the Content-Type header. Check self::contentTypes['downloadBodyBytes'] to see the possible values for this operation

Return values

string —

downloadBodyBytesAsync()

Operation downloadBodyBytesAsync


    public
                    downloadBodyBytesAsync(string $email_id[, string $contentType = self::contentTypes['downloadBodyBytes'][0] ]) : PromiseInterface

Get email body in bytes. Returned as `octet-stream` with content type header.

Parameters

$email_id : string: ID of email (required)
$contentType : string = self::contentTypes['downloadBodyBytes'][0]: The value for the Content-Type header. Check self::contentTypes['downloadBodyBytes'] to see the possible values for this operation

Return values

PromiseInterface —

downloadBodyBytesAsyncWithHttpInfo()

Operation downloadBodyBytesAsyncWithHttpInfo


    public
                    downloadBodyBytesAsyncWithHttpInfo(string $email_id[, string $contentType = self::contentTypes['downloadBodyBytes'][0] ]) : PromiseInterface

Get email body in bytes. Returned as `octet-stream` with content type header.

Parameters

$email_id : string: ID of email (required)
$contentType : string = self::contentTypes['downloadBodyBytes'][0]: The value for the Content-Type header. Check self::contentTypes['downloadBodyBytes'] to see the possible values for this operation

Return values

PromiseInterface —

downloadBodyBytesRequest()

Create request for operation 'downloadBodyBytes'


    public
                    downloadBodyBytesRequest(string $email_id[, string $contentType = self::contentTypes['downloadBodyBytes'][0] ]) : Request

Parameters

$email_id : string: ID of email (required)
$contentType : string = self::contentTypes['downloadBodyBytes'][0]: The value for the Content-Type header. Check self::contentTypes['downloadBodyBytes'] to see the possible values for this operation

Return values

Request —

downloadBodyBytesWithHttpInfo()

Operation downloadBodyBytesWithHttpInfo


    public
                    downloadBodyBytesWithHttpInfo(string $email_id[, string $contentType = self::contentTypes['downloadBodyBytes'][0] ]) : array<string|int, mixed>

Get email body in bytes. Returned as `octet-stream` with content type header.

Parameters

$email_id : string: ID of email (required)
$contentType : string = self::contentTypes['downloadBodyBytes'][0]: The value for the Content-Type header. Check self::contentTypes['downloadBodyBytes'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of string, HTTP status code, HTTP response headers (array of strings)

downloadBodyRequest()

Create request for operation 'downloadBody'


    public
                    downloadBodyRequest(string $email_id[, string $contentType = self::contentTypes['downloadBody'][0] ]) : Request

Parameters

$email_id : string: ID of email (required)
$contentType : string = self::contentTypes['downloadBody'][0]: The value for the Content-Type header. Check self::contentTypes['downloadBody'] to see the possible values for this operation

Return values

Request —

downloadBodyWithHttpInfo()

Operation downloadBodyWithHttpInfo


    public
                    downloadBodyWithHttpInfo(string $email_id[, string $contentType = self::contentTypes['downloadBody'][0] ]) : array<string|int, mixed>

Get email body as string. Returned as `plain/text` with content type header.

Parameters

$email_id : string: ID of email (required)
$contentType : string = self::contentTypes['downloadBody'][0]: The value for the Content-Type header. Check self::contentTypes['downloadBody'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of string, HTTP status code, HTTP response headers (array of strings)

forwardEmail()

Operation forwardEmail


    public
                    forwardEmail(string $email_id, ForwardEmailOptions $forward_email_options[, string $contentType = self::contentTypes['forwardEmail'][0] ]) : SentEmailDto

Forward email to recipients

Parameters

$email_id : string: ID of email (required)
$forward_email_options : ForwardEmailOptions: forward_email_options (required)
$contentType : string = self::contentTypes['forwardEmail'][0]: The value for the Content-Type header. Check self::contentTypes['forwardEmail'] to see the possible values for this operation

Return values

SentEmailDto —

forwardEmailAsync()

Operation forwardEmailAsync


    public
                    forwardEmailAsync(string $email_id, ForwardEmailOptions $forward_email_options[, string $contentType = self::contentTypes['forwardEmail'][0] ]) : PromiseInterface

Forward email to recipients

Parameters

$email_id : string: ID of email (required)
$forward_email_options : ForwardEmailOptions: (required)
$contentType : string = self::contentTypes['forwardEmail'][0]: The value for the Content-Type header. Check self::contentTypes['forwardEmail'] to see the possible values for this operation

Return values

PromiseInterface —

forwardEmailAsyncWithHttpInfo()

Operation forwardEmailAsyncWithHttpInfo


    public
                    forwardEmailAsyncWithHttpInfo(string $email_id, ForwardEmailOptions $forward_email_options[, string $contentType = self::contentTypes['forwardEmail'][0] ]) : PromiseInterface

Forward email to recipients

Parameters

$email_id : string: ID of email (required)
$forward_email_options : ForwardEmailOptions: (required)
$contentType : string = self::contentTypes['forwardEmail'][0]: The value for the Content-Type header. Check self::contentTypes['forwardEmail'] to see the possible values for this operation

Return values

PromiseInterface —

forwardEmailRequest()

Create request for operation 'forwardEmail'


    public
                    forwardEmailRequest(string $email_id, ForwardEmailOptions $forward_email_options[, string $contentType = self::contentTypes['forwardEmail'][0] ]) : Request

Parameters

$email_id : string: ID of email (required)
$forward_email_options : ForwardEmailOptions: (required)
$contentType : string = self::contentTypes['forwardEmail'][0]: The value for the Content-Type header. Check self::contentTypes['forwardEmail'] to see the possible values for this operation

Return values

Request —

forwardEmailWithHttpInfo()

Operation forwardEmailWithHttpInfo


    public
                    forwardEmailWithHttpInfo(string $email_id, ForwardEmailOptions $forward_email_options[, string $contentType = self::contentTypes['forwardEmail'][0] ]) : array<string|int, mixed>

Forward email to recipients

Parameters

$email_id : string: ID of email (required)
$forward_email_options : ForwardEmailOptions: (required)
$contentType : string = self::contentTypes['forwardEmail'][0]: The value for the Content-Type header. Check self::contentTypes['forwardEmail'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\SentEmailDto, HTTP status code, HTTP response headers (array of strings)

getAttachmentMetaData()

Operation getAttachmentMetaData


    public
                    getAttachmentMetaData(string $email_id, string $attachment_id[, string $contentType = self::contentTypes['getAttachmentMetaData'][0] ]) : AttachmentMetaData

Get email attachment metadata. This is the `contentType` and `contentLength` of an attachment. To get the individual attachments use the `downloadAttachment` methods.

Parameters

$email_id : string: ID of email (required)
$attachment_id : string: ID of attachment (required)
$contentType : string = self::contentTypes['getAttachmentMetaData'][0]: The value for the Content-Type header. Check self::contentTypes['getAttachmentMetaData'] to see the possible values for this operation

Return values

AttachmentMetaData —

getAttachmentMetaDataAsync()

Operation getAttachmentMetaDataAsync


    public
                    getAttachmentMetaDataAsync(string $email_id, string $attachment_id[, string $contentType = self::contentTypes['getAttachmentMetaData'][0] ]) : PromiseInterface

Get email attachment metadata. This is the `contentType` and `contentLength` of an attachment. To get the individual attachments use the `downloadAttachment` methods.

Parameters

$email_id : string: ID of email (required)
$attachment_id : string: ID of attachment (required)
$contentType : string = self::contentTypes['getAttachmentMetaData'][0]: The value for the Content-Type header. Check self::contentTypes['getAttachmentMetaData'] to see the possible values for this operation

Return values

PromiseInterface —

getAttachmentMetaDataAsyncWithHttpInfo()

Operation getAttachmentMetaDataAsyncWithHttpInfo


    public
                    getAttachmentMetaDataAsyncWithHttpInfo(string $email_id, string $attachment_id[, string $contentType = self::contentTypes['getAttachmentMetaData'][0] ]) : PromiseInterface

Get email attachment metadata. This is the `contentType` and `contentLength` of an attachment. To get the individual attachments use the `downloadAttachment` methods.

Parameters

$email_id : string: ID of email (required)
$attachment_id : string: ID of attachment (required)
$contentType : string = self::contentTypes['getAttachmentMetaData'][0]: The value for the Content-Type header. Check self::contentTypes['getAttachmentMetaData'] to see the possible values for this operation

Return values

PromiseInterface —

getAttachmentMetaDataRequest()

Create request for operation 'getAttachmentMetaData'


    public
                    getAttachmentMetaDataRequest(string $email_id, string $attachment_id[, string $contentType = self::contentTypes['getAttachmentMetaData'][0] ]) : Request

Parameters

$email_id : string: ID of email (required)
$attachment_id : string: ID of attachment (required)
$contentType : string = self::contentTypes['getAttachmentMetaData'][0]: The value for the Content-Type header. Check self::contentTypes['getAttachmentMetaData'] to see the possible values for this operation

Return values

Request —

getAttachmentMetaDataWithHttpInfo()

Operation getAttachmentMetaDataWithHttpInfo


    public
                    getAttachmentMetaDataWithHttpInfo(string $email_id, string $attachment_id[, string $contentType = self::contentTypes['getAttachmentMetaData'][0] ]) : array<string|int, mixed>

Get email attachment metadata. This is the `contentType` and `contentLength` of an attachment. To get the individual attachments use the `downloadAttachment` methods.

Parameters

$email_id : string: ID of email (required)
$attachment_id : string: ID of attachment (required)
$contentType : string = self::contentTypes['getAttachmentMetaData'][0]: The value for the Content-Type header. Check self::contentTypes['getAttachmentMetaData'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\AttachmentMetaData, HTTP status code, HTTP response headers (array of strings)

getConfig()


    public
                    getConfig() : Configuration

Return values

Configuration —

getEmail()

Operation getEmail


    public
                    getEmail(string $email_id[, bool $decode = false ][, string $contentType = self::contentTypes['getEmail'][0] ]) : Email

Get email content including headers and body. Expects email to exist by ID. For emails that may not have arrived yet use the WaitForController.

Parameters

$email_id : string: email_id (required)
$decode : bool = false: 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)
$contentType : string = self::contentTypes['getEmail'][0]: The value for the Content-Type header. Check self::contentTypes['getEmail'] to see the possible values for this operation

Return values

Email —

getEmailAsync()

Operation getEmailAsync


    public
                    getEmailAsync(string $email_id[, bool $decode = false ][, string $contentType = self::contentTypes['getEmail'][0] ]) : PromiseInterface

Get email content including headers and body. Expects email to exist by ID. For emails that may not have arrived yet use the WaitForController.

Parameters

$email_id : string: (required)
$decode : bool = false: 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)
$contentType : string = self::contentTypes['getEmail'][0]: The value for the Content-Type header. Check self::contentTypes['getEmail'] to see the possible values for this operation

Return values

PromiseInterface —

getEmailAsyncWithHttpInfo()

Operation getEmailAsyncWithHttpInfo


    public
                    getEmailAsyncWithHttpInfo(string $email_id[, bool $decode = false ][, string $contentType = self::contentTypes['getEmail'][0] ]) : PromiseInterface

Get email content including headers and body. Expects email to exist by ID. For emails that may not have arrived yet use the WaitForController.

Parameters

$email_id : string: (required)
$decode : bool = false: 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)
$contentType : string = self::contentTypes['getEmail'][0]: The value for the Content-Type header. Check self::contentTypes['getEmail'] to see the possible values for this operation

Return values

PromiseInterface —

getEmailAttachments()

Operation getEmailAttachments


    public
                    getEmailAttachments(string $email_id[, string $contentType = self::contentTypes['getEmailAttachments'][0] ]) : array<string|int, AttachmentMetaData>

Get all email attachment metadata. Metadata includes name and size of attachments.

Parameters

$email_id : string: ID of email (required)
$contentType : string = self::contentTypes['getEmailAttachments'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailAttachments'] to see the possible values for this operation

Return values

array<string|int, AttachmentMetaData> —

getEmailAttachmentsAsync()

Operation getEmailAttachmentsAsync


    public
                    getEmailAttachmentsAsync(string $email_id[, string $contentType = self::contentTypes['getEmailAttachments'][0] ]) : PromiseInterface

Get all email attachment metadata. Metadata includes name and size of attachments.

Parameters

$email_id : string: ID of email (required)
$contentType : string = self::contentTypes['getEmailAttachments'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailAttachments'] to see the possible values for this operation

Return values

PromiseInterface —

getEmailAttachmentsAsyncWithHttpInfo()

Operation getEmailAttachmentsAsyncWithHttpInfo


    public
                    getEmailAttachmentsAsyncWithHttpInfo(string $email_id[, string $contentType = self::contentTypes['getEmailAttachments'][0] ]) : PromiseInterface

Get all email attachment metadata. Metadata includes name and size of attachments.

Parameters

$email_id : string: ID of email (required)
$contentType : string = self::contentTypes['getEmailAttachments'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailAttachments'] to see the possible values for this operation

Return values

PromiseInterface —

getEmailAttachmentsRequest()

Create request for operation 'getEmailAttachments'


    public
                    getEmailAttachmentsRequest(string $email_id[, string $contentType = self::contentTypes['getEmailAttachments'][0] ]) : Request

Parameters

$email_id : string: ID of email (required)
$contentType : string = self::contentTypes['getEmailAttachments'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailAttachments'] to see the possible values for this operation

Return values

Request —

getEmailAttachmentsWithHttpInfo()

Operation getEmailAttachmentsWithHttpInfo


    public
                    getEmailAttachmentsWithHttpInfo(string $email_id[, string $contentType = self::contentTypes['getEmailAttachments'][0] ]) : array<string|int, mixed>

Get all email attachment metadata. Metadata includes name and size of attachments.

Parameters

$email_id : string: ID of email (required)
$contentType : string = self::contentTypes['getEmailAttachments'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailAttachments'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\AttachmentMetaData[], HTTP status code, HTTP response headers (array of strings)

getEmailContentMatch()

Operation getEmailContentMatch


    public
                    getEmailContentMatch(string $email_id, ContentMatchOptions $content_match_options[, string $contentType = self::contentTypes['getEmailContentMatch'][0] ]) : EmailContentMatchResult

Get email content regex pattern match results. Runs regex against email body and returns match groups.

Parameters

$email_id : string: ID of email to match against (required)
$content_match_options : ContentMatchOptions: content_match_options (required)
$contentType : string = self::contentTypes['getEmailContentMatch'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailContentMatch'] to see the possible values for this operation

Return values

EmailContentMatchResult —

getEmailContentMatchAsync()

Operation getEmailContentMatchAsync


    public
                    getEmailContentMatchAsync(string $email_id, ContentMatchOptions $content_match_options[, string $contentType = self::contentTypes['getEmailContentMatch'][0] ]) : PromiseInterface

Get email content regex pattern match results. Runs regex against email body and returns match groups.

Parameters

$email_id : string: ID of email to match against (required)
$content_match_options : ContentMatchOptions: (required)
$contentType : string = self::contentTypes['getEmailContentMatch'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailContentMatch'] to see the possible values for this operation

Return values

PromiseInterface —

getEmailContentMatchAsyncWithHttpInfo()

Operation getEmailContentMatchAsyncWithHttpInfo


    public
                    getEmailContentMatchAsyncWithHttpInfo(string $email_id, ContentMatchOptions $content_match_options[, string $contentType = self::contentTypes['getEmailContentMatch'][0] ]) : PromiseInterface

Get email content regex pattern match results. Runs regex against email body and returns match groups.

Parameters

$email_id : string: ID of email to match against (required)
$content_match_options : ContentMatchOptions: (required)
$contentType : string = self::contentTypes['getEmailContentMatch'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailContentMatch'] to see the possible values for this operation

Return values

PromiseInterface —

getEmailContentMatchRequest()

Create request for operation 'getEmailContentMatch'


    public
                    getEmailContentMatchRequest(string $email_id, ContentMatchOptions $content_match_options[, string $contentType = self::contentTypes['getEmailContentMatch'][0] ]) : Request

Parameters

$email_id : string: ID of email to match against (required)
$content_match_options : ContentMatchOptions: (required)
$contentType : string = self::contentTypes['getEmailContentMatch'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailContentMatch'] to see the possible values for this operation

Return values

Request —

getEmailContentMatchWithHttpInfo()

Operation getEmailContentMatchWithHttpInfo


    public
                    getEmailContentMatchWithHttpInfo(string $email_id, ContentMatchOptions $content_match_options[, string $contentType = self::contentTypes['getEmailContentMatch'][0] ]) : array<string|int, mixed>

Get email content regex pattern match results. Runs regex against email body and returns match groups.

Parameters

$email_id : string: ID of email to match against (required)
$content_match_options : ContentMatchOptions: (required)
$contentType : string = self::contentTypes['getEmailContentMatch'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailContentMatch'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\EmailContentMatchResult, HTTP status code, HTTP response headers (array of strings)

getEmailContentPart()

Operation getEmailContentPart


    public
                    getEmailContentPart(string $email_id, string $content_type[, string $contentType = self::contentTypes['getEmailContentPart'][0] ]) : EmailContentPartResult

Get email content part by content type

Parameters

$email_id : string: ID of email to match against (required)
$content_type : string: Content type (required)
$contentType : string = self::contentTypes['getEmailContentPart'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailContentPart'] to see the possible values for this operation

Return values

EmailContentPartResult —

getEmailContentPartAsync()

Operation getEmailContentPartAsync


    public
                    getEmailContentPartAsync(string $email_id, string $content_type[, string $contentType = self::contentTypes['getEmailContentPart'][0] ]) : PromiseInterface

Get email content part by content type

Parameters

$email_id : string: ID of email to match against (required)
$content_type : string: Content type (required)
$contentType : string = self::contentTypes['getEmailContentPart'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailContentPart'] to see the possible values for this operation

Return values

PromiseInterface —

getEmailContentPartAsyncWithHttpInfo()

Operation getEmailContentPartAsyncWithHttpInfo


    public
                    getEmailContentPartAsyncWithHttpInfo(string $email_id, string $content_type[, string $contentType = self::contentTypes['getEmailContentPart'][0] ]) : PromiseInterface

Get email content part by content type

Parameters

$email_id : string: ID of email to match against (required)
$content_type : string: Content type (required)
$contentType : string = self::contentTypes['getEmailContentPart'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailContentPart'] to see the possible values for this operation

Return values

PromiseInterface —

getEmailContentPartRequest()

Create request for operation 'getEmailContentPart'


    public
                    getEmailContentPartRequest(string $email_id, string $content_type[, string $contentType = self::contentTypes['getEmailContentPart'][0] ]) : Request

Parameters

$email_id : string: ID of email to match against (required)
$content_type : string: Content type (required)
$contentType : string = self::contentTypes['getEmailContentPart'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailContentPart'] to see the possible values for this operation

Return values

Request —

getEmailContentPartWithHttpInfo()

Operation getEmailContentPartWithHttpInfo


    public
                    getEmailContentPartWithHttpInfo(string $email_id, string $content_type[, string $contentType = self::contentTypes['getEmailContentPart'][0] ]) : array<string|int, mixed>

Get email content part by content type

Parameters

$email_id : string: ID of email to match against (required)
$content_type : string: Content type (required)
$contentType : string = self::contentTypes['getEmailContentPart'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailContentPart'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\EmailContentPartResult, HTTP status code, HTTP response headers (array of strings)

getEmailCount()

Operation getEmailCount


    public
                    getEmailCount([string $inbox_id = null ][, string $contentType = self::contentTypes['getEmailCount'][0] ]) : CountDto

Get email count

Parameters

$inbox_id : string = null: inbox_id (optional)
$contentType : string = self::contentTypes['getEmailCount'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailCount'] to see the possible values for this operation

Return values

CountDto —

getEmailCountAsync()

Operation getEmailCountAsync


    public
                    getEmailCountAsync([string $inbox_id = null ][, string $contentType = self::contentTypes['getEmailCount'][0] ]) : PromiseInterface

Get email count

Parameters

$inbox_id : string = null: (optional)
$contentType : string = self::contentTypes['getEmailCount'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailCount'] to see the possible values for this operation

Return values

PromiseInterface —

getEmailCountAsyncWithHttpInfo()

Operation getEmailCountAsyncWithHttpInfo


    public
                    getEmailCountAsyncWithHttpInfo([string $inbox_id = null ][, string $contentType = self::contentTypes['getEmailCount'][0] ]) : PromiseInterface

Get email count

Parameters

$inbox_id : string = null: (optional)
$contentType : string = self::contentTypes['getEmailCount'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailCount'] to see the possible values for this operation

Return values

PromiseInterface —

getEmailCountRequest()

Create request for operation 'getEmailCount'


    public
                    getEmailCountRequest([string $inbox_id = null ][, string $contentType = self::contentTypes['getEmailCount'][0] ]) : Request

Parameters

$inbox_id : string = null: (optional)
$contentType : string = self::contentTypes['getEmailCount'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailCount'] to see the possible values for this operation

Return values

Request —

getEmailCountWithHttpInfo()

Operation getEmailCountWithHttpInfo


    public
                    getEmailCountWithHttpInfo([string $inbox_id = null ][, string $contentType = self::contentTypes['getEmailCount'][0] ]) : array<string|int, mixed>

Get email count

Parameters

$inbox_id : string = null: (optional)
$contentType : string = self::contentTypes['getEmailCount'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailCount'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\CountDto, HTTP status code, HTTP response headers (array of strings)

getEmailHTML()

Operation getEmailHTML


    public
                    getEmailHTML(string $email_id[, bool $decode = false ][, bool $replace_cid_images = false ][, string $contentType = self::contentTypes['getEmailHTML'][0] ]) : string

Get email content as HTML. For displaying emails in browser context.

Parameters

$email_id : string: email_id (required)
$decode : bool = false: decode (optional, default to false)
$replace_cid_images : bool = false: replace_cid_images (optional, default to false)
$contentType : string = self::contentTypes['getEmailHTML'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailHTML'] to see the possible values for this operation

Return values

string —

getEmailHTMLAsync()

Operation getEmailHTMLAsync


    public
                    getEmailHTMLAsync(string $email_id[, bool $decode = false ][, bool $replace_cid_images = false ][, string $contentType = self::contentTypes['getEmailHTML'][0] ]) : PromiseInterface

Get email content as HTML. For displaying emails in browser context.

Parameters

$email_id : string: (required)
$decode : bool = false: (optional, default to false)
$replace_cid_images : bool = false: (optional, default to false)
$contentType : string = self::contentTypes['getEmailHTML'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailHTML'] to see the possible values for this operation

Return values

PromiseInterface —

getEmailHTMLAsyncWithHttpInfo()

Operation getEmailHTMLAsyncWithHttpInfo


    public
                    getEmailHTMLAsyncWithHttpInfo(string $email_id[, bool $decode = false ][, bool $replace_cid_images = false ][, string $contentType = self::contentTypes['getEmailHTML'][0] ]) : PromiseInterface

Get email content as HTML. For displaying emails in browser context.

Parameters

$email_id : string: (required)
$decode : bool = false: (optional, default to false)
$replace_cid_images : bool = false: (optional, default to false)
$contentType : string = self::contentTypes['getEmailHTML'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailHTML'] to see the possible values for this operation

Return values

PromiseInterface —

getEmailHTMLJson()

Operation getEmailHTMLJson


    public
                    getEmailHTMLJson(string $email_id[, bool $decode = false ][, bool $replace_cid_images = false ][, string $contentType = self::contentTypes['getEmailHTMLJson'][0] ]) : EmailHtmlDto

Get email content as HTML in JSON wrapper. For fetching entity decoded HTML content

Parameters

$email_id : string: email_id (required)
$decode : bool = false: decode (optional, default to false)
$replace_cid_images : bool = false: replace_cid_images (optional, default to false)
$contentType : string = self::contentTypes['getEmailHTMLJson'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailHTMLJson'] to see the possible values for this operation

Return values

EmailHtmlDto —

getEmailHTMLJsonAsync()

Operation getEmailHTMLJsonAsync


    public
                    getEmailHTMLJsonAsync(string $email_id[, bool $decode = false ][, bool $replace_cid_images = false ][, string $contentType = self::contentTypes['getEmailHTMLJson'][0] ]) : PromiseInterface

Get email content as HTML in JSON wrapper. For fetching entity decoded HTML content

Parameters

$email_id : string: (required)
$decode : bool = false: (optional, default to false)
$replace_cid_images : bool = false: (optional, default to false)
$contentType : string = self::contentTypes['getEmailHTMLJson'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailHTMLJson'] to see the possible values for this operation

Return values

PromiseInterface —

getEmailHTMLJsonAsyncWithHttpInfo()

Operation getEmailHTMLJsonAsyncWithHttpInfo


    public
                    getEmailHTMLJsonAsyncWithHttpInfo(string $email_id[, bool $decode = false ][, bool $replace_cid_images = false ][, string $contentType = self::contentTypes['getEmailHTMLJson'][0] ]) : PromiseInterface

Get email content as HTML in JSON wrapper. For fetching entity decoded HTML content

Parameters

$email_id : string: (required)
$decode : bool = false: (optional, default to false)
$replace_cid_images : bool = false: (optional, default to false)
$contentType : string = self::contentTypes['getEmailHTMLJson'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailHTMLJson'] to see the possible values for this operation

Return values

PromiseInterface —

getEmailHTMLJsonRequest()

Create request for operation 'getEmailHTMLJson'


    public
                    getEmailHTMLJsonRequest(string $email_id[, bool $decode = false ][, bool $replace_cid_images = false ][, string $contentType = self::contentTypes['getEmailHTMLJson'][0] ]) : Request

Parameters

$email_id : string: (required)
$decode : bool = false: (optional, default to false)
$replace_cid_images : bool = false: (optional, default to false)
$contentType : string = self::contentTypes['getEmailHTMLJson'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailHTMLJson'] to see the possible values for this operation

Return values

Request —

getEmailHTMLJsonWithHttpInfo()

Operation getEmailHTMLJsonWithHttpInfo


    public
                    getEmailHTMLJsonWithHttpInfo(string $email_id[, bool $decode = false ][, bool $replace_cid_images = false ][, string $contentType = self::contentTypes['getEmailHTMLJson'][0] ]) : array<string|int, mixed>

Get email content as HTML in JSON wrapper. For fetching entity decoded HTML content

Parameters

$email_id : string: (required)
$decode : bool = false: (optional, default to false)
$replace_cid_images : bool = false: (optional, default to false)
$contentType : string = self::contentTypes['getEmailHTMLJson'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailHTMLJson'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\EmailHtmlDto, HTTP status code, HTTP response headers (array of strings)

getEmailHTMLQuery()

Operation getEmailHTMLQuery


    public
                    getEmailHTMLQuery(string $email_id, string $html_selector[, string $contentType = self::contentTypes['getEmailHTMLQuery'][0] ]) : EmailTextLinesResult

Parse and return text from an email, stripping HTML and decoding encoded characters

Parameters

$email_id : string: ID of email to perform HTML query on (required)
$html_selector : string: HTML selector to search for. Uses JQuery/JSoup/CSS style selector like '.my-div' to match content. See https://jsoup.org/apidocs/org/jsoup/select/Selector.html for more information. (required)
$contentType : string = self::contentTypes['getEmailHTMLQuery'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailHTMLQuery'] to see the possible values for this operation

Return values

EmailTextLinesResult —

getEmailHTMLQueryAsync()

Operation getEmailHTMLQueryAsync


    public
                    getEmailHTMLQueryAsync(string $email_id, string $html_selector[, string $contentType = self::contentTypes['getEmailHTMLQuery'][0] ]) : PromiseInterface

Parse and return text from an email, stripping HTML and decoding encoded characters

Parameters

$email_id : string: ID of email to perform HTML query on (required)
$html_selector : string: HTML selector to search for. Uses JQuery/JSoup/CSS style selector like '.my-div' to match content. See https://jsoup.org/apidocs/org/jsoup/select/Selector.html for more information. (required)
$contentType : string = self::contentTypes['getEmailHTMLQuery'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailHTMLQuery'] to see the possible values for this operation

Return values

PromiseInterface —

getEmailHTMLQueryAsyncWithHttpInfo()

Operation getEmailHTMLQueryAsyncWithHttpInfo


    public
                    getEmailHTMLQueryAsyncWithHttpInfo(string $email_id, string $html_selector[, string $contentType = self::contentTypes['getEmailHTMLQuery'][0] ]) : PromiseInterface

Parse and return text from an email, stripping HTML and decoding encoded characters

Parameters

$email_id : string: ID of email to perform HTML query on (required)
$html_selector : string: HTML selector to search for. Uses JQuery/JSoup/CSS style selector like '.my-div' to match content. See https://jsoup.org/apidocs/org/jsoup/select/Selector.html for more information. (required)
$contentType : string = self::contentTypes['getEmailHTMLQuery'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailHTMLQuery'] to see the possible values for this operation

Return values

PromiseInterface —

getEmailHTMLQueryRequest()

Create request for operation 'getEmailHTMLQuery'


    public
                    getEmailHTMLQueryRequest(string $email_id, string $html_selector[, string $contentType = self::contentTypes['getEmailHTMLQuery'][0] ]) : Request

Parameters

$email_id : string: ID of email to perform HTML query on (required)
$html_selector : string: HTML selector to search for. Uses JQuery/JSoup/CSS style selector like '.my-div' to match content. See https://jsoup.org/apidocs/org/jsoup/select/Selector.html for more information. (required)
$contentType : string = self::contentTypes['getEmailHTMLQuery'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailHTMLQuery'] to see the possible values for this operation

Return values

Request —

getEmailHTMLQueryWithHttpInfo()

Operation getEmailHTMLQueryWithHttpInfo


    public
                    getEmailHTMLQueryWithHttpInfo(string $email_id, string $html_selector[, string $contentType = self::contentTypes['getEmailHTMLQuery'][0] ]) : array<string|int, mixed>

Parse and return text from an email, stripping HTML and decoding encoded characters

Parameters

$email_id : string: ID of email to perform HTML query on (required)
$html_selector : string: HTML selector to search for. Uses JQuery/JSoup/CSS style selector like '.my-div' to match content. See https://jsoup.org/apidocs/org/jsoup/select/Selector.html for more information. (required)
$contentType : string = self::contentTypes['getEmailHTMLQuery'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailHTMLQuery'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\EmailTextLinesResult, HTTP status code, HTTP response headers (array of strings)

getEmailHTMLRequest()

Create request for operation 'getEmailHTML'


    public
                    getEmailHTMLRequest(string $email_id[, bool $decode = false ][, bool $replace_cid_images = false ][, string $contentType = self::contentTypes['getEmailHTML'][0] ]) : Request

Parameters

$email_id : string: (required)
$decode : bool = false: (optional, default to false)
$replace_cid_images : bool = false: (optional, default to false)
$contentType : string = self::contentTypes['getEmailHTML'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailHTML'] to see the possible values for this operation

Return values

Request —

getEmailHTMLWithHttpInfo()

Operation getEmailHTMLWithHttpInfo


    public
                    getEmailHTMLWithHttpInfo(string $email_id[, bool $decode = false ][, bool $replace_cid_images = false ][, string $contentType = self::contentTypes['getEmailHTML'][0] ]) : array<string|int, mixed>

Get email content as HTML. For displaying emails in browser context.

Parameters

$email_id : string: (required)
$decode : bool = false: (optional, default to false)
$replace_cid_images : bool = false: (optional, default to false)
$contentType : string = self::contentTypes['getEmailHTML'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailHTML'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of string, HTTP status code, HTTP response headers (array of strings)

getEmailLinks()

Operation getEmailLinks


    public
                    getEmailLinks(string $email_id[, string $contentType = self::contentTypes['getEmailLinks'][0] ]) : EmailLinksResult

Parse and return list of links found in an email (only works for HTML content)

Parameters

$email_id : string: ID of email to fetch text for (required)
$contentType : string = self::contentTypes['getEmailLinks'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailLinks'] to see the possible values for this operation

Return values

EmailLinksResult —

getEmailLinksAsync()

Operation getEmailLinksAsync


    public
                    getEmailLinksAsync(string $email_id[, string $contentType = self::contentTypes['getEmailLinks'][0] ]) : PromiseInterface

Parse and return list of links found in an email (only works for HTML content)

Parameters

$email_id : string: ID of email to fetch text for (required)
$contentType : string = self::contentTypes['getEmailLinks'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailLinks'] to see the possible values for this operation

Return values

PromiseInterface —

getEmailLinksAsyncWithHttpInfo()

Operation getEmailLinksAsyncWithHttpInfo


    public
                    getEmailLinksAsyncWithHttpInfo(string $email_id[, string $contentType = self::contentTypes['getEmailLinks'][0] ]) : PromiseInterface

Parse and return list of links found in an email (only works for HTML content)

Parameters

$email_id : string: ID of email to fetch text for (required)
$contentType : string = self::contentTypes['getEmailLinks'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailLinks'] to see the possible values for this operation

Return values

PromiseInterface —

getEmailLinksRequest()

Create request for operation 'getEmailLinks'


    public
                    getEmailLinksRequest(string $email_id[, string $contentType = self::contentTypes['getEmailLinks'][0] ]) : Request

Parameters

$email_id : string: ID of email to fetch text for (required)
$contentType : string = self::contentTypes['getEmailLinks'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailLinks'] to see the possible values for this operation

Return values

Request —

getEmailLinksWithHttpInfo()

Operation getEmailLinksWithHttpInfo


    public
                    getEmailLinksWithHttpInfo(string $email_id[, string $contentType = self::contentTypes['getEmailLinks'][0] ]) : array<string|int, mixed>

Parse and return list of links found in an email (only works for HTML content)

Parameters

$email_id : string: ID of email to fetch text for (required)
$contentType : string = self::contentTypes['getEmailLinks'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailLinks'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\EmailLinksResult, HTTP status code, HTTP response headers (array of strings)

getEmailPreviewURLs()

Operation getEmailPreviewURLs


    public
                    getEmailPreviewURLs(string $email_id[, string $contentType = self::contentTypes['getEmailPreviewURLs'][0] ]) : EmailPreviewUrls

Get email URLs for viewing in browser or downloading

Parameters

$email_id : string: email_id (required)
$contentType : string = self::contentTypes['getEmailPreviewURLs'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailPreviewURLs'] to see the possible values for this operation

Return values

EmailPreviewUrls —

getEmailPreviewURLsAsync()

Operation getEmailPreviewURLsAsync


    public
                    getEmailPreviewURLsAsync(string $email_id[, string $contentType = self::contentTypes['getEmailPreviewURLs'][0] ]) : PromiseInterface

Get email URLs for viewing in browser or downloading

Parameters

$email_id : string: (required)
$contentType : string = self::contentTypes['getEmailPreviewURLs'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailPreviewURLs'] to see the possible values for this operation

Return values

PromiseInterface —

getEmailPreviewURLsAsyncWithHttpInfo()

Operation getEmailPreviewURLsAsyncWithHttpInfo


    public
                    getEmailPreviewURLsAsyncWithHttpInfo(string $email_id[, string $contentType = self::contentTypes['getEmailPreviewURLs'][0] ]) : PromiseInterface

Get email URLs for viewing in browser or downloading

Parameters

$email_id : string: (required)
$contentType : string = self::contentTypes['getEmailPreviewURLs'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailPreviewURLs'] to see the possible values for this operation

Return values

PromiseInterface —

getEmailPreviewURLsRequest()

Create request for operation 'getEmailPreviewURLs'


    public
                    getEmailPreviewURLsRequest(string $email_id[, string $contentType = self::contentTypes['getEmailPreviewURLs'][0] ]) : Request

Parameters

$email_id : string: (required)
$contentType : string = self::contentTypes['getEmailPreviewURLs'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailPreviewURLs'] to see the possible values for this operation

Return values

Request —

getEmailPreviewURLsWithHttpInfo()

Operation getEmailPreviewURLsWithHttpInfo


    public
                    getEmailPreviewURLsWithHttpInfo(string $email_id[, string $contentType = self::contentTypes['getEmailPreviewURLs'][0] ]) : array<string|int, mixed>

Get email URLs for viewing in browser or downloading

Parameters

$email_id : string: (required)
$contentType : string = self::contentTypes['getEmailPreviewURLs'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailPreviewURLs'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\EmailPreviewUrls, HTTP status code, HTTP response headers (array of strings)

getEmailRequest()

Create request for operation 'getEmail'


    public
                    getEmailRequest(string $email_id[, bool $decode = false ][, string $contentType = self::contentTypes['getEmail'][0] ]) : Request

Parameters

$email_id : string: (required)
$decode : bool = false: 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)
$contentType : string = self::contentTypes['getEmail'][0]: The value for the Content-Type header. Check self::contentTypes['getEmail'] to see the possible values for this operation

Return values

Request —

getEmailScreenshotAsBase64()

Operation getEmailScreenshotAsBase64


    public
                    getEmailScreenshotAsBase64(string $email_id, GetEmailScreenshotOptions $get_email_screenshot_options[, string $contentType = self::contentTypes['getEmailScreenshotAsBase64'][0] ]) : EmailScreenshotResult

Take a screenshot of an email in a browser and return base64 encoded string

Parameters

$email_id : string: email_id (required)
$get_email_screenshot_options : GetEmailScreenshotOptions: get_email_screenshot_options (required)
$contentType : string = self::contentTypes['getEmailScreenshotAsBase64'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailScreenshotAsBase64'] to see the possible values for this operation

Return values

EmailScreenshotResult —

getEmailScreenshotAsBase64Async()

Operation getEmailScreenshotAsBase64Async


    public
                    getEmailScreenshotAsBase64Async(string $email_id, GetEmailScreenshotOptions $get_email_screenshot_options[, string $contentType = self::contentTypes['getEmailScreenshotAsBase64'][0] ]) : PromiseInterface

Take a screenshot of an email in a browser and return base64 encoded string

Parameters

$email_id : string: (required)
$get_email_screenshot_options : GetEmailScreenshotOptions: (required)
$contentType : string = self::contentTypes['getEmailScreenshotAsBase64'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailScreenshotAsBase64'] to see the possible values for this operation

Return values

PromiseInterface —

getEmailScreenshotAsBase64AsyncWithHttpInfo()

Operation getEmailScreenshotAsBase64AsyncWithHttpInfo


    public
                    getEmailScreenshotAsBase64AsyncWithHttpInfo(string $email_id, GetEmailScreenshotOptions $get_email_screenshot_options[, string $contentType = self::contentTypes['getEmailScreenshotAsBase64'][0] ]) : PromiseInterface

Take a screenshot of an email in a browser and return base64 encoded string

Parameters

$email_id : string: (required)
$get_email_screenshot_options : GetEmailScreenshotOptions: (required)
$contentType : string = self::contentTypes['getEmailScreenshotAsBase64'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailScreenshotAsBase64'] to see the possible values for this operation

Return values

PromiseInterface —

getEmailScreenshotAsBase64Request()

Create request for operation 'getEmailScreenshotAsBase64'


    public
                    getEmailScreenshotAsBase64Request(string $email_id, GetEmailScreenshotOptions $get_email_screenshot_options[, string $contentType = self::contentTypes['getEmailScreenshotAsBase64'][0] ]) : Request

Parameters

$email_id : string: (required)
$get_email_screenshot_options : GetEmailScreenshotOptions: (required)
$contentType : string = self::contentTypes['getEmailScreenshotAsBase64'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailScreenshotAsBase64'] to see the possible values for this operation

Return values

Request —

getEmailScreenshotAsBase64WithHttpInfo()

Operation getEmailScreenshotAsBase64WithHttpInfo


    public
                    getEmailScreenshotAsBase64WithHttpInfo(string $email_id, GetEmailScreenshotOptions $get_email_screenshot_options[, string $contentType = self::contentTypes['getEmailScreenshotAsBase64'][0] ]) : array<string|int, mixed>

Take a screenshot of an email in a browser and return base64 encoded string

Parameters

$email_id : string: (required)
$get_email_screenshot_options : GetEmailScreenshotOptions: (required)
$contentType : string = self::contentTypes['getEmailScreenshotAsBase64'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailScreenshotAsBase64'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\EmailScreenshotResult, HTTP status code, HTTP response headers (array of strings)

getEmailScreenshotAsBinary()

Operation getEmailScreenshotAsBinary


    public
                    getEmailScreenshotAsBinary(string $email_id, GetEmailScreenshotOptions $get_email_screenshot_options[, string $contentType = self::contentTypes['getEmailScreenshotAsBinary'][0] ]) : void

Take a screenshot of an email in a browser

Parameters

$email_id : string: email_id (required)
$get_email_screenshot_options : GetEmailScreenshotOptions: get_email_screenshot_options (required)
$contentType : string = self::contentTypes['getEmailScreenshotAsBinary'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailScreenshotAsBinary'] to see the possible values for this operation

Return values

void —

getEmailScreenshotAsBinaryAsync()

Operation getEmailScreenshotAsBinaryAsync


    public
                    getEmailScreenshotAsBinaryAsync(string $email_id, GetEmailScreenshotOptions $get_email_screenshot_options[, string $contentType = self::contentTypes['getEmailScreenshotAsBinary'][0] ]) : PromiseInterface

Take a screenshot of an email in a browser

Parameters

$email_id : string: (required)
$get_email_screenshot_options : GetEmailScreenshotOptions: (required)
$contentType : string = self::contentTypes['getEmailScreenshotAsBinary'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailScreenshotAsBinary'] to see the possible values for this operation

Return values

PromiseInterface —

getEmailScreenshotAsBinaryAsyncWithHttpInfo()

Operation getEmailScreenshotAsBinaryAsyncWithHttpInfo


    public
                    getEmailScreenshotAsBinaryAsyncWithHttpInfo(string $email_id, GetEmailScreenshotOptions $get_email_screenshot_options[, string $contentType = self::contentTypes['getEmailScreenshotAsBinary'][0] ]) : PromiseInterface

Take a screenshot of an email in a browser

Parameters

$email_id : string: (required)
$get_email_screenshot_options : GetEmailScreenshotOptions: (required)
$contentType : string = self::contentTypes['getEmailScreenshotAsBinary'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailScreenshotAsBinary'] to see the possible values for this operation

Return values

PromiseInterface —

getEmailScreenshotAsBinaryRequest()

Create request for operation 'getEmailScreenshotAsBinary'


    public
                    getEmailScreenshotAsBinaryRequest(string $email_id, GetEmailScreenshotOptions $get_email_screenshot_options[, string $contentType = self::contentTypes['getEmailScreenshotAsBinary'][0] ]) : Request

Parameters

$email_id : string: (required)
$get_email_screenshot_options : GetEmailScreenshotOptions: (required)
$contentType : string = self::contentTypes['getEmailScreenshotAsBinary'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailScreenshotAsBinary'] to see the possible values for this operation

Return values

Request —

getEmailScreenshotAsBinaryWithHttpInfo()

Operation getEmailScreenshotAsBinaryWithHttpInfo


    public
                    getEmailScreenshotAsBinaryWithHttpInfo(string $email_id, GetEmailScreenshotOptions $get_email_screenshot_options[, string $contentType = self::contentTypes['getEmailScreenshotAsBinary'][0] ]) : array<string|int, mixed>

Take a screenshot of an email in a browser

Parameters

$email_id : string: (required)
$get_email_screenshot_options : GetEmailScreenshotOptions: (required)
$contentType : string = self::contentTypes['getEmailScreenshotAsBinary'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailScreenshotAsBinary'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of null, HTTP status code, HTTP response headers (array of strings)

getEmailsOffsetPaginated()

Operation getEmailsOffsetPaginated


    public
                    getEmailsOffsetPaginated([array<string|int, string> $inbox_id = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, bool $unread_only = false ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getEmailsOffsetPaginated'][0] ]) : PageEmailProjection

Get all emails in all inboxes in paginated form. Email API list all.

Parameters

$inbox_id : array<string|int, string> = null: Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. (optional)
$page : int: Optional page index in email list pagination (optional, default to 0)
$size : int = 20: Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
$sort : string = 'ASC': Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
$unread_only : bool = false: 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)
$search_filter : string = null: Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body (optional)
$since : DateTime = null: Optional filter emails received after given date time (optional)
$before : DateTime = null: Optional filter emails received before given date time (optional)
$contentType : string = self::contentTypes['getEmailsOffsetPaginated'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailsOffsetPaginated'] to see the possible values for this operation

Return values

PageEmailProjection —

getEmailsOffsetPaginatedAsync()

Operation getEmailsOffsetPaginatedAsync


    public
                    getEmailsOffsetPaginatedAsync([array<string|int, string> $inbox_id = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, bool $unread_only = false ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getEmailsOffsetPaginated'][0] ]) : PromiseInterface

Get all emails in all inboxes in paginated form. Email API list all.

Parameters

$inbox_id : array<string|int, string> = null: Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. (optional)
$page : int: Optional page index in email list pagination (optional, default to 0)
$size : int = 20: Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
$sort : string = 'ASC': Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
$unread_only : bool = false: 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)
$search_filter : string = null: Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body (optional)
$since : DateTime = null: Optional filter emails received after given date time (optional)
$before : DateTime = null: Optional filter emails received before given date time (optional)
$contentType : string = self::contentTypes['getEmailsOffsetPaginated'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailsOffsetPaginated'] to see the possible values for this operation

Return values

PromiseInterface —

getEmailsOffsetPaginatedAsyncWithHttpInfo()

Operation getEmailsOffsetPaginatedAsyncWithHttpInfo


    public
                    getEmailsOffsetPaginatedAsyncWithHttpInfo([array<string|int, string> $inbox_id = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, bool $unread_only = false ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getEmailsOffsetPaginated'][0] ]) : PromiseInterface

Get all emails in all inboxes in paginated form. Email API list all.

Parameters

$inbox_id : array<string|int, string> = null: Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. (optional)
$page : int: Optional page index in email list pagination (optional, default to 0)
$size : int = 20: Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
$sort : string = 'ASC': Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
$unread_only : bool = false: 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)
$search_filter : string = null: Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body (optional)
$since : DateTime = null: Optional filter emails received after given date time (optional)
$before : DateTime = null: Optional filter emails received before given date time (optional)
$contentType : string = self::contentTypes['getEmailsOffsetPaginated'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailsOffsetPaginated'] to see the possible values for this operation

Return values

PromiseInterface —

getEmailsOffsetPaginatedRequest()

Create request for operation 'getEmailsOffsetPaginated'


    public
                    getEmailsOffsetPaginatedRequest([array<string|int, string> $inbox_id = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, bool $unread_only = false ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getEmailsOffsetPaginated'][0] ]) : Request

Parameters

$inbox_id : array<string|int, string> = null: Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. (optional)
$page : int: Optional page index in email list pagination (optional, default to 0)
$size : int = 20: Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
$sort : string = 'ASC': Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
$unread_only : bool = false: 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)
$search_filter : string = null: Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body (optional)
$since : DateTime = null: Optional filter emails received after given date time (optional)
$before : DateTime = null: Optional filter emails received before given date time (optional)
$contentType : string = self::contentTypes['getEmailsOffsetPaginated'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailsOffsetPaginated'] to see the possible values for this operation

Return values

Request —

getEmailsOffsetPaginatedWithHttpInfo()

Operation getEmailsOffsetPaginatedWithHttpInfo


    public
                    getEmailsOffsetPaginatedWithHttpInfo([array<string|int, string> $inbox_id = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, bool $unread_only = false ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getEmailsOffsetPaginated'][0] ]) : array<string|int, mixed>

Get all emails in all inboxes in paginated form. Email API list all.

Parameters

$inbox_id : array<string|int, string> = null: Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. (optional)
$page : int: Optional page index in email list pagination (optional, default to 0)
$size : int = 20: Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
$sort : string = 'ASC': Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
$unread_only : bool = false: 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)
$search_filter : string = null: Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body (optional)
$since : DateTime = null: Optional filter emails received after given date time (optional)
$before : DateTime = null: Optional filter emails received before given date time (optional)
$contentType : string = self::contentTypes['getEmailsOffsetPaginated'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailsOffsetPaginated'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\PageEmailProjection, HTTP status code, HTTP response headers (array of strings)

getEmailsPaginated()

Operation getEmailsPaginated


    public
                    getEmailsPaginated([array<string|int, string> $inbox_id = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, bool $unread_only = false ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getEmailsPaginated'][0] ]) : PageEmailProjection

Get all emails in all inboxes in paginated form. Email API list all.

Parameters

$inbox_id : array<string|int, string> = null: Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. (optional)
$page : int: Optional page index in email list pagination (optional, default to 0)
$size : int = 20: Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
$sort : string = 'ASC': Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
$unread_only : bool = false: 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)
$search_filter : string = null: Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body (optional)
$since : DateTime = null: Optional filter emails received after given date time. If unset will use time 24hours prior to now. (optional)
$before : DateTime = null: Optional filter emails received before given date time (optional)
$contentType : string = self::contentTypes['getEmailsPaginated'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailsPaginated'] to see the possible values for this operation

Return values

PageEmailProjection —

getEmailsPaginatedAsync()

Operation getEmailsPaginatedAsync


    public
                    getEmailsPaginatedAsync([array<string|int, string> $inbox_id = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, bool $unread_only = false ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getEmailsPaginated'][0] ]) : PromiseInterface

Get all emails in all inboxes in paginated form. Email API list all.

Parameters

$inbox_id : array<string|int, string> = null: Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. (optional)
$page : int: Optional page index in email list pagination (optional, default to 0)
$size : int = 20: Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
$sort : string = 'ASC': Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
$unread_only : bool = false: 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)
$search_filter : string = null: Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body (optional)
$since : DateTime = null: Optional filter emails received after given date time. If unset will use time 24hours prior to now. (optional)
$before : DateTime = null: Optional filter emails received before given date time (optional)
$contentType : string = self::contentTypes['getEmailsPaginated'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailsPaginated'] to see the possible values for this operation

Return values

PromiseInterface —

getEmailsPaginatedAsyncWithHttpInfo()

Operation getEmailsPaginatedAsyncWithHttpInfo


    public
                    getEmailsPaginatedAsyncWithHttpInfo([array<string|int, string> $inbox_id = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, bool $unread_only = false ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getEmailsPaginated'][0] ]) : PromiseInterface

Get all emails in all inboxes in paginated form. Email API list all.

Parameters

$inbox_id : array<string|int, string> = null: Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. (optional)
$page : int: Optional page index in email list pagination (optional, default to 0)
$size : int = 20: Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
$sort : string = 'ASC': Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
$unread_only : bool = false: 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)
$search_filter : string = null: Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body (optional)
$since : DateTime = null: Optional filter emails received after given date time. If unset will use time 24hours prior to now. (optional)
$before : DateTime = null: Optional filter emails received before given date time (optional)
$contentType : string = self::contentTypes['getEmailsPaginated'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailsPaginated'] to see the possible values for this operation

Return values

PromiseInterface —

getEmailsPaginatedRequest()

Create request for operation 'getEmailsPaginated'


    public
                    getEmailsPaginatedRequest([array<string|int, string> $inbox_id = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, bool $unread_only = false ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getEmailsPaginated'][0] ]) : Request

Parameters

$inbox_id : array<string|int, string> = null: Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. (optional)
$page : int: Optional page index in email list pagination (optional, default to 0)
$size : int = 20: Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
$sort : string = 'ASC': Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
$unread_only : bool = false: 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)
$search_filter : string = null: Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body (optional)
$since : DateTime = null: Optional filter emails received after given date time. If unset will use time 24hours prior to now. (optional)
$before : DateTime = null: Optional filter emails received before given date time (optional)
$contentType : string = self::contentTypes['getEmailsPaginated'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailsPaginated'] to see the possible values for this operation

Return values

Request —

getEmailsPaginatedWithHttpInfo()

Operation getEmailsPaginatedWithHttpInfo


    public
                    getEmailsPaginatedWithHttpInfo([array<string|int, string> $inbox_id = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, bool $unread_only = false ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getEmailsPaginated'][0] ]) : array<string|int, mixed>

Get all emails in all inboxes in paginated form. Email API list all.

Parameters

$inbox_id : array<string|int, string> = null: Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. (optional)
$page : int: Optional page index in email list pagination (optional, default to 0)
$size : int = 20: Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
$sort : string = 'ASC': Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
$unread_only : bool = false: 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)
$search_filter : string = null: Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body (optional)
$since : DateTime = null: Optional filter emails received after given date time. If unset will use time 24hours prior to now. (optional)
$before : DateTime = null: Optional filter emails received before given date time (optional)
$contentType : string = self::contentTypes['getEmailsPaginated'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailsPaginated'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\PageEmailProjection, HTTP status code, HTTP response headers (array of strings)

getEmailTextLines()

Operation getEmailTextLines


    public
                    getEmailTextLines(string $email_id[, bool $decode_html_entities = null ][, string $line_separator = null ][, string $contentType = self::contentTypes['getEmailTextLines'][0] ]) : EmailTextLinesResult

Parse and return text from an email, stripping HTML and decoding encoded characters

Parameters

$email_id : string: ID of email to fetch text for (required)
$decode_html_entities : bool = null: Decode HTML entities (optional)
$line_separator : string = null: Line separator character (optional)
$contentType : string = self::contentTypes['getEmailTextLines'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailTextLines'] to see the possible values for this operation

Return values

EmailTextLinesResult —

getEmailTextLinesAsync()

Operation getEmailTextLinesAsync


    public
                    getEmailTextLinesAsync(string $email_id[, bool $decode_html_entities = null ][, string $line_separator = null ][, string $contentType = self::contentTypes['getEmailTextLines'][0] ]) : PromiseInterface

Parse and return text from an email, stripping HTML and decoding encoded characters

Parameters

$email_id : string: ID of email to fetch text for (required)
$decode_html_entities : bool = null: Decode HTML entities (optional)
$line_separator : string = null: Line separator character (optional)
$contentType : string = self::contentTypes['getEmailTextLines'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailTextLines'] to see the possible values for this operation

Return values

PromiseInterface —

getEmailTextLinesAsyncWithHttpInfo()

Operation getEmailTextLinesAsyncWithHttpInfo


    public
                    getEmailTextLinesAsyncWithHttpInfo(string $email_id[, bool $decode_html_entities = null ][, string $line_separator = null ][, string $contentType = self::contentTypes['getEmailTextLines'][0] ]) : PromiseInterface

Parse and return text from an email, stripping HTML and decoding encoded characters

Parameters

$email_id : string: ID of email to fetch text for (required)
$decode_html_entities : bool = null: Decode HTML entities (optional)
$line_separator : string = null: Line separator character (optional)
$contentType : string = self::contentTypes['getEmailTextLines'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailTextLines'] to see the possible values for this operation

Return values

PromiseInterface —

getEmailTextLinesRequest()

Create request for operation 'getEmailTextLines'


    public
                    getEmailTextLinesRequest(string $email_id[, bool $decode_html_entities = null ][, string $line_separator = null ][, string $contentType = self::contentTypes['getEmailTextLines'][0] ]) : Request

Parameters

$email_id : string: ID of email to fetch text for (required)
$decode_html_entities : bool = null: Decode HTML entities (optional)
$line_separator : string = null: Line separator character (optional)
$contentType : string = self::contentTypes['getEmailTextLines'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailTextLines'] to see the possible values for this operation

Return values

Request —

getEmailTextLinesWithHttpInfo()

Operation getEmailTextLinesWithHttpInfo


    public
                    getEmailTextLinesWithHttpInfo(string $email_id[, bool $decode_html_entities = null ][, string $line_separator = null ][, string $contentType = self::contentTypes['getEmailTextLines'][0] ]) : array<string|int, mixed>

Parse and return text from an email, stripping HTML and decoding encoded characters

Parameters

$email_id : string: ID of email to fetch text for (required)
$decode_html_entities : bool = null: Decode HTML entities (optional)
$line_separator : string = null: Line separator character (optional)
$contentType : string = self::contentTypes['getEmailTextLines'][0]: The value for the Content-Type header. Check self::contentTypes['getEmailTextLines'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\EmailTextLinesResult, HTTP status code, HTTP response headers (array of strings)

getEmailWithHttpInfo()

Operation getEmailWithHttpInfo


    public
                    getEmailWithHttpInfo(string $email_id[, bool $decode = false ][, string $contentType = self::contentTypes['getEmail'][0] ]) : array<string|int, mixed>

Get email content including headers and body. Expects email to exist by ID. For emails that may not have arrived yet use the WaitForController.

Parameters

$email_id : string: (required)
$decode : bool = false: 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)
$contentType : string = self::contentTypes['getEmail'][0]: The value for the Content-Type header. Check self::contentTypes['getEmail'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\Email, HTTP status code, HTTP response headers (array of strings)

getGravatarUrlForEmailAddress()

Operation getGravatarUrlForEmailAddress


    public
                    getGravatarUrlForEmailAddress(string $email_address[, string $size = null ][, string $contentType = self::contentTypes['getGravatarUrlForEmailAddress'][0] ]) : GravatarUrl

Parameters

$email_address : string: email_address (required)
$size : string = null: size (optional)
$contentType : string = self::contentTypes['getGravatarUrlForEmailAddress'][0]: The value for the Content-Type header. Check self::contentTypes['getGravatarUrlForEmailAddress'] to see the possible values for this operation

Return values

GravatarUrl —

getGravatarUrlForEmailAddressAsync()

Operation getGravatarUrlForEmailAddressAsync


    public
                    getGravatarUrlForEmailAddressAsync(string $email_address[, string $size = null ][, string $contentType = self::contentTypes['getGravatarUrlForEmailAddress'][0] ]) : PromiseInterface

Parameters

$email_address : string: (required)
$size : string = null: (optional)
$contentType : string = self::contentTypes['getGravatarUrlForEmailAddress'][0]: The value for the Content-Type header. Check self::contentTypes['getGravatarUrlForEmailAddress'] to see the possible values for this operation

Return values

PromiseInterface —

getGravatarUrlForEmailAddressAsyncWithHttpInfo()

Operation getGravatarUrlForEmailAddressAsyncWithHttpInfo


    public
                    getGravatarUrlForEmailAddressAsyncWithHttpInfo(string $email_address[, string $size = null ][, string $contentType = self::contentTypes['getGravatarUrlForEmailAddress'][0] ]) : PromiseInterface

Parameters

$email_address : string: (required)
$size : string = null: (optional)
$contentType : string = self::contentTypes['getGravatarUrlForEmailAddress'][0]: The value for the Content-Type header. Check self::contentTypes['getGravatarUrlForEmailAddress'] to see the possible values for this operation

Return values

PromiseInterface —

getGravatarUrlForEmailAddressRequest()

Create request for operation 'getGravatarUrlForEmailAddress'


    public
                    getGravatarUrlForEmailAddressRequest(string $email_address[, string $size = null ][, string $contentType = self::contentTypes['getGravatarUrlForEmailAddress'][0] ]) : Request

Parameters

$email_address : string: (required)
$size : string = null: (optional)
$contentType : string = self::contentTypes['getGravatarUrlForEmailAddress'][0]: The value for the Content-Type header. Check self::contentTypes['getGravatarUrlForEmailAddress'] to see the possible values for this operation

Return values

Request —

getGravatarUrlForEmailAddressWithHttpInfo()

Operation getGravatarUrlForEmailAddressWithHttpInfo


    public
                    getGravatarUrlForEmailAddressWithHttpInfo(string $email_address[, string $size = null ][, string $contentType = self::contentTypes['getGravatarUrlForEmailAddress'][0] ]) : array<string|int, mixed>

Parameters

$email_address : string: (required)
$size : string = null: (optional)
$contentType : string = self::contentTypes['getGravatarUrlForEmailAddress'][0]: The value for the Content-Type header. Check self::contentTypes['getGravatarUrlForEmailAddress'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\GravatarUrl, HTTP status code, HTTP response headers (array of strings)

getHostIndex()

Get the host index


    public
                    getHostIndex() : int

Return values

int —

Host index

getLatestEmail()

Operation getLatestEmail


    public
                    getLatestEmail([array<string|int, string> $inbox_ids = null ][, string $contentType = self::contentTypes['getLatestEmail'][0] ]) : Email

Get latest email in all inboxes. Most recently received.

Parameters

$inbox_ids : array<string|int, string> = null: 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)
$contentType : string = self::contentTypes['getLatestEmail'][0]: The value for the Content-Type header. Check self::contentTypes['getLatestEmail'] to see the possible values for this operation

Return values

Email —

getLatestEmailAsync()

Operation getLatestEmailAsync


    public
                    getLatestEmailAsync([array<string|int, string> $inbox_ids = null ][, string $contentType = self::contentTypes['getLatestEmail'][0] ]) : PromiseInterface

Get latest email in all inboxes. Most recently received.

Parameters

$inbox_ids : array<string|int, string> = null: 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)
$contentType : string = self::contentTypes['getLatestEmail'][0]: The value for the Content-Type header. Check self::contentTypes['getLatestEmail'] to see the possible values for this operation

Return values

PromiseInterface —

getLatestEmailAsyncWithHttpInfo()

Operation getLatestEmailAsyncWithHttpInfo


    public
                    getLatestEmailAsyncWithHttpInfo([array<string|int, string> $inbox_ids = null ][, string $contentType = self::contentTypes['getLatestEmail'][0] ]) : PromiseInterface

Get latest email in all inboxes. Most recently received.

Parameters

$inbox_ids : array<string|int, string> = null: 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)
$contentType : string = self::contentTypes['getLatestEmail'][0]: The value for the Content-Type header. Check self::contentTypes['getLatestEmail'] to see the possible values for this operation

Return values

PromiseInterface —

getLatestEmailInInbox1()

Operation getLatestEmailInInbox1


    public
                    getLatestEmailInInbox1(string $inbox_id[, string $contentType = self::contentTypes['getLatestEmailInInbox1'][0] ]) : Email

Get latest email in an inbox. Use `WaitForController` to get emails that may not have arrived yet.

Parameters

$inbox_id : string: ID of the inbox you want to get the latest email from (required)
$contentType : string = self::contentTypes['getLatestEmailInInbox1'][0]: The value for the Content-Type header. Check self::contentTypes['getLatestEmailInInbox1'] to see the possible values for this operation

Return values

Email —

getLatestEmailInInbox1Async()

Operation getLatestEmailInInbox1Async


    public
                    getLatestEmailInInbox1Async(string $inbox_id[, string $contentType = self::contentTypes['getLatestEmailInInbox1'][0] ]) : PromiseInterface

Get latest email in an inbox. Use `WaitForController` to get emails that may not have arrived yet.

Parameters

$inbox_id : string: ID of the inbox you want to get the latest email from (required)
$contentType : string = self::contentTypes['getLatestEmailInInbox1'][0]: The value for the Content-Type header. Check self::contentTypes['getLatestEmailInInbox1'] to see the possible values for this operation

Return values

PromiseInterface —

getLatestEmailInInbox1AsyncWithHttpInfo()

Operation getLatestEmailInInbox1AsyncWithHttpInfo


    public
                    getLatestEmailInInbox1AsyncWithHttpInfo(string $inbox_id[, string $contentType = self::contentTypes['getLatestEmailInInbox1'][0] ]) : PromiseInterface

Get latest email in an inbox. Use `WaitForController` to get emails that may not have arrived yet.

Parameters

$inbox_id : string: ID of the inbox you want to get the latest email from (required)
$contentType : string = self::contentTypes['getLatestEmailInInbox1'][0]: The value for the Content-Type header. Check self::contentTypes['getLatestEmailInInbox1'] to see the possible values for this operation

Return values

PromiseInterface —

getLatestEmailInInbox1Request()

Create request for operation 'getLatestEmailInInbox1'


    public
                    getLatestEmailInInbox1Request(string $inbox_id[, string $contentType = self::contentTypes['getLatestEmailInInbox1'][0] ]) : Request

Parameters

$inbox_id : string: ID of the inbox you want to get the latest email from (required)
$contentType : string = self::contentTypes['getLatestEmailInInbox1'][0]: The value for the Content-Type header. Check self::contentTypes['getLatestEmailInInbox1'] to see the possible values for this operation

Return values

Request —

getLatestEmailInInbox1WithHttpInfo()

Operation getLatestEmailInInbox1WithHttpInfo


    public
                    getLatestEmailInInbox1WithHttpInfo(string $inbox_id[, string $contentType = self::contentTypes['getLatestEmailInInbox1'][0] ]) : array<string|int, mixed>

Get latest email in an inbox. Use `WaitForController` to get emails that may not have arrived yet.

Parameters

$inbox_id : string: ID of the inbox you want to get the latest email from (required)
$contentType : string = self::contentTypes['getLatestEmailInInbox1'][0]: The value for the Content-Type header. Check self::contentTypes['getLatestEmailInInbox1'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\Email, HTTP status code, HTTP response headers (array of strings)

getLatestEmailRequest()

Create request for operation 'getLatestEmail'


    public
                    getLatestEmailRequest([array<string|int, string> $inbox_ids = null ][, string $contentType = self::contentTypes['getLatestEmail'][0] ]) : Request

Parameters

$inbox_ids : array<string|int, string> = null: 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)
$contentType : string = self::contentTypes['getLatestEmail'][0]: The value for the Content-Type header. Check self::contentTypes['getLatestEmail'] to see the possible values for this operation

Return values

Request —

getLatestEmailWithHttpInfo()

Operation getLatestEmailWithHttpInfo


    public
                    getLatestEmailWithHttpInfo([array<string|int, string> $inbox_ids = null ][, string $contentType = self::contentTypes['getLatestEmail'][0] ]) : array<string|int, mixed>

Get latest email in all inboxes. Most recently received.

Parameters

$inbox_ids : array<string|int, string> = null: 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)
$contentType : string = self::contentTypes['getLatestEmail'][0]: The value for the Content-Type header. Check self::contentTypes['getLatestEmail'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\Email, HTTP status code, HTTP response headers (array of strings)

getOrganizationEmailsPaginated()

Operation getOrganizationEmailsPaginated


    public
                    getOrganizationEmailsPaginated([array<string|int, string> $inbox_id = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, bool $unread_only = false ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getOrganizationEmailsPaginated'][0] ]) : PageEmailProjection

Get all organization emails. List team or shared test email accounts

Parameters

$inbox_id : array<string|int, string> = null: Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. (optional)
$page : int: Optional page index in email list pagination (optional, default to 0)
$size : int = 20: Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
$sort : string = 'ASC': Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
$unread_only : bool = false: 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)
$search_filter : string = null: Optional search filter search filter for emails. (optional)
$since : DateTime = null: Optional filter emails received after given date time. If unset will use time 24hours prior to now. (optional)
$before : DateTime = null: Optional filter emails received before given date time (optional)
$contentType : string = self::contentTypes['getOrganizationEmailsPaginated'][0]: The value for the Content-Type header. Check self::contentTypes['getOrganizationEmailsPaginated'] to see the possible values for this operation

Return values

PageEmailProjection —

getOrganizationEmailsPaginatedAsync()

Operation getOrganizationEmailsPaginatedAsync


    public
                    getOrganizationEmailsPaginatedAsync([array<string|int, string> $inbox_id = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, bool $unread_only = false ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getOrganizationEmailsPaginated'][0] ]) : PromiseInterface

Get all organization emails. List team or shared test email accounts

Parameters

$inbox_id : array<string|int, string> = null: Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. (optional)
$page : int: Optional page index in email list pagination (optional, default to 0)
$size : int = 20: Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
$sort : string = 'ASC': Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
$unread_only : bool = false: 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)
$search_filter : string = null: Optional search filter search filter for emails. (optional)
$since : DateTime = null: Optional filter emails received after given date time. If unset will use time 24hours prior to now. (optional)
$before : DateTime = null: Optional filter emails received before given date time (optional)
$contentType : string = self::contentTypes['getOrganizationEmailsPaginated'][0]: The value for the Content-Type header. Check self::contentTypes['getOrganizationEmailsPaginated'] to see the possible values for this operation

Return values

PromiseInterface —

getOrganizationEmailsPaginatedAsyncWithHttpInfo()

Operation getOrganizationEmailsPaginatedAsyncWithHttpInfo


    public
                    getOrganizationEmailsPaginatedAsyncWithHttpInfo([array<string|int, string> $inbox_id = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, bool $unread_only = false ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getOrganizationEmailsPaginated'][0] ]) : PromiseInterface

Get all organization emails. List team or shared test email accounts

Parameters

$inbox_id : array<string|int, string> = null: Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. (optional)
$page : int: Optional page index in email list pagination (optional, default to 0)
$size : int = 20: Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
$sort : string = 'ASC': Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
$unread_only : bool = false: 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)
$search_filter : string = null: Optional search filter search filter for emails. (optional)
$since : DateTime = null: Optional filter emails received after given date time. If unset will use time 24hours prior to now. (optional)
$before : DateTime = null: Optional filter emails received before given date time (optional)
$contentType : string = self::contentTypes['getOrganizationEmailsPaginated'][0]: The value for the Content-Type header. Check self::contentTypes['getOrganizationEmailsPaginated'] to see the possible values for this operation

Return values

PromiseInterface —

getOrganizationEmailsPaginatedRequest()

Create request for operation 'getOrganizationEmailsPaginated'


    public
                    getOrganizationEmailsPaginatedRequest([array<string|int, string> $inbox_id = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, bool $unread_only = false ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getOrganizationEmailsPaginated'][0] ]) : Request

Parameters

$inbox_id : array<string|int, string> = null: Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. (optional)
$page : int: Optional page index in email list pagination (optional, default to 0)
$size : int = 20: Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
$sort : string = 'ASC': Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
$unread_only : bool = false: 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)
$search_filter : string = null: Optional search filter search filter for emails. (optional)
$since : DateTime = null: Optional filter emails received after given date time. If unset will use time 24hours prior to now. (optional)
$before : DateTime = null: Optional filter emails received before given date time (optional)
$contentType : string = self::contentTypes['getOrganizationEmailsPaginated'][0]: The value for the Content-Type header. Check self::contentTypes['getOrganizationEmailsPaginated'] to see the possible values for this operation

Return values

Request —

getOrganizationEmailsPaginatedWithHttpInfo()

Operation getOrganizationEmailsPaginatedWithHttpInfo


    public
                    getOrganizationEmailsPaginatedWithHttpInfo([array<string|int, string> $inbox_id = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, bool $unread_only = false ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getOrganizationEmailsPaginated'][0] ]) : array<string|int, mixed>

Get all organization emails. List team or shared test email accounts

Parameters

$inbox_id : array<string|int, string> = null: Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. (optional)
$page : int: Optional page index in email list pagination (optional, default to 0)
$size : int = 20: Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
$sort : string = 'ASC': Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
$unread_only : bool = false: 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)
$search_filter : string = null: Optional search filter search filter for emails. (optional)
$since : DateTime = null: Optional filter emails received after given date time. If unset will use time 24hours prior to now. (optional)
$before : DateTime = null: Optional filter emails received before given date time (optional)
$contentType : string = self::contentTypes['getOrganizationEmailsPaginated'][0]: The value for the Content-Type header. Check self::contentTypes['getOrganizationEmailsPaginated'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\PageEmailProjection, HTTP status code, HTTP response headers (array of strings)

getRawEmailContents()

Operation getRawEmailContents


    public
                    getRawEmailContents(string $email_id[, string $contentType = self::contentTypes['getRawEmailContents'][0] ]) : void

Get raw email string. Returns unparsed raw SMTP message with headers and body.

Parameters

$email_id : string: ID of email (required)
$contentType : string = self::contentTypes['getRawEmailContents'][0]: The value for the Content-Type header. Check self::contentTypes['getRawEmailContents'] to see the possible values for this operation

Return values

void —

getRawEmailContentsAsync()

Operation getRawEmailContentsAsync


    public
                    getRawEmailContentsAsync(string $email_id[, string $contentType = self::contentTypes['getRawEmailContents'][0] ]) : PromiseInterface

Get raw email string. Returns unparsed raw SMTP message with headers and body.

Parameters

$email_id : string: ID of email (required)
$contentType : string = self::contentTypes['getRawEmailContents'][0]: The value for the Content-Type header. Check self::contentTypes['getRawEmailContents'] to see the possible values for this operation

Return values

PromiseInterface —

getRawEmailContentsAsyncWithHttpInfo()

Operation getRawEmailContentsAsyncWithHttpInfo


    public
                    getRawEmailContentsAsyncWithHttpInfo(string $email_id[, string $contentType = self::contentTypes['getRawEmailContents'][0] ]) : PromiseInterface

Get raw email string. Returns unparsed raw SMTP message with headers and body.

Parameters

$email_id : string: ID of email (required)
$contentType : string = self::contentTypes['getRawEmailContents'][0]: The value for the Content-Type header. Check self::contentTypes['getRawEmailContents'] to see the possible values for this operation

Return values

PromiseInterface —

getRawEmailContentsRequest()

Create request for operation 'getRawEmailContents'


    public
                    getRawEmailContentsRequest(string $email_id[, string $contentType = self::contentTypes['getRawEmailContents'][0] ]) : Request

Parameters

$email_id : string: ID of email (required)
$contentType : string = self::contentTypes['getRawEmailContents'][0]: The value for the Content-Type header. Check self::contentTypes['getRawEmailContents'] to see the possible values for this operation

Return values

Request —

getRawEmailContentsWithHttpInfo()

Operation getRawEmailContentsWithHttpInfo


    public
                    getRawEmailContentsWithHttpInfo(string $email_id[, string $contentType = self::contentTypes['getRawEmailContents'][0] ]) : array<string|int, mixed>

Get raw email string. Returns unparsed raw SMTP message with headers and body.

Parameters

$email_id : string: ID of email (required)
$contentType : string = self::contentTypes['getRawEmailContents'][0]: The value for the Content-Type header. Check self::contentTypes['getRawEmailContents'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of null, HTTP status code, HTTP response headers (array of strings)

getRawEmailJson()

Operation getRawEmailJson


    public
                    getRawEmailJson(string $email_id[, string $contentType = self::contentTypes['getRawEmailJson'][0] ]) : RawEmailJson

Get raw email in JSON. Unparsed SMTP message in JSON wrapper format.

Parameters

$email_id : string: ID of email (required)
$contentType : string = self::contentTypes['getRawEmailJson'][0]: The value for the Content-Type header. Check self::contentTypes['getRawEmailJson'] to see the possible values for this operation

Return values

RawEmailJson —

getRawEmailJsonAsync()

Operation getRawEmailJsonAsync


    public
                    getRawEmailJsonAsync(string $email_id[, string $contentType = self::contentTypes['getRawEmailJson'][0] ]) : PromiseInterface

Get raw email in JSON. Unparsed SMTP message in JSON wrapper format.

Parameters

$email_id : string: ID of email (required)
$contentType : string = self::contentTypes['getRawEmailJson'][0]: The value for the Content-Type header. Check self::contentTypes['getRawEmailJson'] to see the possible values for this operation

Return values

PromiseInterface —

getRawEmailJsonAsyncWithHttpInfo()

Operation getRawEmailJsonAsyncWithHttpInfo


    public
                    getRawEmailJsonAsyncWithHttpInfo(string $email_id[, string $contentType = self::contentTypes['getRawEmailJson'][0] ]) : PromiseInterface

Get raw email in JSON. Unparsed SMTP message in JSON wrapper format.

Parameters

$email_id : string: ID of email (required)
$contentType : string = self::contentTypes['getRawEmailJson'][0]: The value for the Content-Type header. Check self::contentTypes['getRawEmailJson'] to see the possible values for this operation

Return values

PromiseInterface —

getRawEmailJsonRequest()

Create request for operation 'getRawEmailJson'


    public
                    getRawEmailJsonRequest(string $email_id[, string $contentType = self::contentTypes['getRawEmailJson'][0] ]) : Request

Parameters

$email_id : string: ID of email (required)
$contentType : string = self::contentTypes['getRawEmailJson'][0]: The value for the Content-Type header. Check self::contentTypes['getRawEmailJson'] to see the possible values for this operation

Return values

Request —

getRawEmailJsonWithHttpInfo()

Operation getRawEmailJsonWithHttpInfo


    public
                    getRawEmailJsonWithHttpInfo(string $email_id[, string $contentType = self::contentTypes['getRawEmailJson'][0] ]) : array<string|int, mixed>

Get raw email in JSON. Unparsed SMTP message in JSON wrapper format.

Parameters

$email_id : string: ID of email (required)
$contentType : string = self::contentTypes['getRawEmailJson'][0]: The value for the Content-Type header. Check self::contentTypes['getRawEmailJson'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\RawEmailJson, HTTP status code, HTTP response headers (array of strings)

getUnreadEmailCount()

Operation getUnreadEmailCount


    public
                    getUnreadEmailCount([string $inbox_id = null ][, string $contentType = self::contentTypes['getUnreadEmailCount'][0] ]) : UnreadCount

Get unread email count

Parameters

$inbox_id : string = null: Optional inbox ID filter (optional)
$contentType : string = self::contentTypes['getUnreadEmailCount'][0]: The value for the Content-Type header. Check self::contentTypes['getUnreadEmailCount'] to see the possible values for this operation

Return values

UnreadCount —

getUnreadEmailCountAsync()

Operation getUnreadEmailCountAsync


    public
                    getUnreadEmailCountAsync([string $inbox_id = null ][, string $contentType = self::contentTypes['getUnreadEmailCount'][0] ]) : PromiseInterface

Get unread email count

Parameters

$inbox_id : string = null: Optional inbox ID filter (optional)
$contentType : string = self::contentTypes['getUnreadEmailCount'][0]: The value for the Content-Type header. Check self::contentTypes['getUnreadEmailCount'] to see the possible values for this operation

Return values

PromiseInterface —

getUnreadEmailCountAsyncWithHttpInfo()

Operation getUnreadEmailCountAsyncWithHttpInfo


    public
                    getUnreadEmailCountAsyncWithHttpInfo([string $inbox_id = null ][, string $contentType = self::contentTypes['getUnreadEmailCount'][0] ]) : PromiseInterface

Get unread email count

Parameters

$inbox_id : string = null: Optional inbox ID filter (optional)
$contentType : string = self::contentTypes['getUnreadEmailCount'][0]: The value for the Content-Type header. Check self::contentTypes['getUnreadEmailCount'] to see the possible values for this operation

Return values

PromiseInterface —

getUnreadEmailCountRequest()

Create request for operation 'getUnreadEmailCount'


    public
                    getUnreadEmailCountRequest([string $inbox_id = null ][, string $contentType = self::contentTypes['getUnreadEmailCount'][0] ]) : Request

Parameters

$inbox_id : string = null: Optional inbox ID filter (optional)
$contentType : string = self::contentTypes['getUnreadEmailCount'][0]: The value for the Content-Type header. Check self::contentTypes['getUnreadEmailCount'] to see the possible values for this operation

Return values

Request —

getUnreadEmailCountWithHttpInfo()

Operation getUnreadEmailCountWithHttpInfo


    public
                    getUnreadEmailCountWithHttpInfo([string $inbox_id = null ][, string $contentType = self::contentTypes['getUnreadEmailCount'][0] ]) : array<string|int, mixed>

Get unread email count

Parameters

$inbox_id : string = null: Optional inbox ID filter (optional)
$contentType : string = self::contentTypes['getUnreadEmailCount'][0]: The value for the Content-Type header. Check self::contentTypes['getUnreadEmailCount'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\UnreadCount, HTTP status code, HTTP response headers (array of strings)

markAllAsRead()

Operation markAllAsRead


    public
                    markAllAsRead([bool $read = true ][, string $inbox_id = null ][, string $contentType = self::contentTypes['markAllAsRead'][0] ]) : void

Mark all emails as read or unread

Parameters

$read : bool = true: What value to assign to email read property. Default true. (optional, default to true)
$inbox_id : string = null: Optional inbox ID filter (optional)
$contentType : string = self::contentTypes['markAllAsRead'][0]: The value for the Content-Type header. Check self::contentTypes['markAllAsRead'] to see the possible values for this operation

Return values

void —

markAllAsReadAsync()

Operation markAllAsReadAsync


    public
                    markAllAsReadAsync([bool $read = true ][, string $inbox_id = null ][, string $contentType = self::contentTypes['markAllAsRead'][0] ]) : PromiseInterface

Mark all emails as read or unread

Parameters

$read : bool = true: What value to assign to email read property. Default true. (optional, default to true)
$inbox_id : string = null: Optional inbox ID filter (optional)
$contentType : string = self::contentTypes['markAllAsRead'][0]: The value for the Content-Type header. Check self::contentTypes['markAllAsRead'] to see the possible values for this operation

Return values

PromiseInterface —

markAllAsReadAsyncWithHttpInfo()

Operation markAllAsReadAsyncWithHttpInfo


    public
                    markAllAsReadAsyncWithHttpInfo([bool $read = true ][, string $inbox_id = null ][, string $contentType = self::contentTypes['markAllAsRead'][0] ]) : PromiseInterface

Mark all emails as read or unread

Parameters

$read : bool = true: What value to assign to email read property. Default true. (optional, default to true)
$inbox_id : string = null: Optional inbox ID filter (optional)
$contentType : string = self::contentTypes['markAllAsRead'][0]: The value for the Content-Type header. Check self::contentTypes['markAllAsRead'] to see the possible values for this operation

Return values

PromiseInterface —

markAllAsReadRequest()

Create request for operation 'markAllAsRead'


    public
                    markAllAsReadRequest([bool $read = true ][, string $inbox_id = null ][, string $contentType = self::contentTypes['markAllAsRead'][0] ]) : Request

Parameters

$read : bool = true: What value to assign to email read property. Default true. (optional, default to true)
$inbox_id : string = null: Optional inbox ID filter (optional)
$contentType : string = self::contentTypes['markAllAsRead'][0]: The value for the Content-Type header. Check self::contentTypes['markAllAsRead'] to see the possible values for this operation

Return values

Request —

markAllAsReadWithHttpInfo()

Operation markAllAsReadWithHttpInfo


    public
                    markAllAsReadWithHttpInfo([bool $read = true ][, string $inbox_id = null ][, string $contentType = self::contentTypes['markAllAsRead'][0] ]) : array<string|int, mixed>

Mark all emails as read or unread

Parameters

$read : bool = true: What value to assign to email read property. Default true. (optional, default to true)
$inbox_id : string = null: Optional inbox ID filter (optional)
$contentType : string = self::contentTypes['markAllAsRead'][0]: The value for the Content-Type header. Check self::contentTypes['markAllAsRead'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of null, HTTP status code, HTTP response headers (array of strings)

markAsRead()

Operation markAsRead


    public
                    markAsRead(string $email_id[, bool $read = true ][, string $contentType = self::contentTypes['markAsRead'][0] ]) : EmailPreview

Mark an email as read or unread

Parameters

$email_id : string: email_id (required)
$read : bool = true: What value to assign to email read property. Default true. (optional, default to true)
$contentType : string = self::contentTypes['markAsRead'][0]: The value for the Content-Type header. Check self::contentTypes['markAsRead'] to see the possible values for this operation

Return values

EmailPreview —

markAsReadAsync()

Operation markAsReadAsync


    public
                    markAsReadAsync(string $email_id[, bool $read = true ][, string $contentType = self::contentTypes['markAsRead'][0] ]) : PromiseInterface

Mark an email as read or unread

Parameters

$email_id : string: (required)
$read : bool = true: What value to assign to email read property. Default true. (optional, default to true)
$contentType : string = self::contentTypes['markAsRead'][0]: The value for the Content-Type header. Check self::contentTypes['markAsRead'] to see the possible values for this operation

Return values

PromiseInterface —

markAsReadAsyncWithHttpInfo()

Operation markAsReadAsyncWithHttpInfo


    public
                    markAsReadAsyncWithHttpInfo(string $email_id[, bool $read = true ][, string $contentType = self::contentTypes['markAsRead'][0] ]) : PromiseInterface

Mark an email as read or unread

Parameters

$email_id : string: (required)
$read : bool = true: What value to assign to email read property. Default true. (optional, default to true)
$contentType : string = self::contentTypes['markAsRead'][0]: The value for the Content-Type header. Check self::contentTypes['markAsRead'] to see the possible values for this operation

Return values

PromiseInterface —

markAsReadRequest()

Create request for operation 'markAsRead'


    public
                    markAsReadRequest(string $email_id[, bool $read = true ][, string $contentType = self::contentTypes['markAsRead'][0] ]) : Request

Parameters

$email_id : string: (required)
$read : bool = true: What value to assign to email read property. Default true. (optional, default to true)
$contentType : string = self::contentTypes['markAsRead'][0]: The value for the Content-Type header. Check self::contentTypes['markAsRead'] to see the possible values for this operation

Return values

Request —

markAsReadWithHttpInfo()

Operation markAsReadWithHttpInfo


    public
                    markAsReadWithHttpInfo(string $email_id[, bool $read = true ][, string $contentType = self::contentTypes['markAsRead'][0] ]) : array<string|int, mixed>

Mark an email as read or unread

Parameters

$email_id : string: (required)
$read : bool = true: What value to assign to email read property. Default true. (optional, default to true)
$contentType : string = self::contentTypes['markAsRead'][0]: The value for the Content-Type header. Check self::contentTypes['markAsRead'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\EmailPreview, HTTP status code, HTTP response headers (array of strings)

replyToEmail()

Operation replyToEmail


    public
                    replyToEmail(string $email_id, ReplyToEmailOptions $reply_to_email_options[, string $contentType = self::contentTypes['replyToEmail'][0] ]) : SentEmailDto

Reply to an email

Parameters

$email_id : string: ID of the email that should be replied to (required)
$reply_to_email_options : ReplyToEmailOptions: reply_to_email_options (required)
$contentType : string = self::contentTypes['replyToEmail'][0]: The value for the Content-Type header. Check self::contentTypes['replyToEmail'] to see the possible values for this operation

Return values

SentEmailDto —

replyToEmailAsync()

Operation replyToEmailAsync


    public
                    replyToEmailAsync(string $email_id, ReplyToEmailOptions $reply_to_email_options[, string $contentType = self::contentTypes['replyToEmail'][0] ]) : PromiseInterface

Reply to an email

Parameters

$email_id : string: ID of the email that should be replied to (required)
$reply_to_email_options : ReplyToEmailOptions: (required)
$contentType : string = self::contentTypes['replyToEmail'][0]: The value for the Content-Type header. Check self::contentTypes['replyToEmail'] to see the possible values for this operation

Return values

PromiseInterface —

replyToEmailAsyncWithHttpInfo()

Operation replyToEmailAsyncWithHttpInfo


    public
                    replyToEmailAsyncWithHttpInfo(string $email_id, ReplyToEmailOptions $reply_to_email_options[, string $contentType = self::contentTypes['replyToEmail'][0] ]) : PromiseInterface

Reply to an email

Parameters

$email_id : string: ID of the email that should be replied to (required)
$reply_to_email_options : ReplyToEmailOptions: (required)
$contentType : string = self::contentTypes['replyToEmail'][0]: The value for the Content-Type header. Check self::contentTypes['replyToEmail'] to see the possible values for this operation

Return values

PromiseInterface —

replyToEmailRequest()

Create request for operation 'replyToEmail'


    public
                    replyToEmailRequest(string $email_id, ReplyToEmailOptions $reply_to_email_options[, string $contentType = self::contentTypes['replyToEmail'][0] ]) : Request

Parameters

$email_id : string: ID of the email that should be replied to (required)
$reply_to_email_options : ReplyToEmailOptions: (required)
$contentType : string = self::contentTypes['replyToEmail'][0]: The value for the Content-Type header. Check self::contentTypes['replyToEmail'] to see the possible values for this operation

Return values

Request —

replyToEmailWithHttpInfo()

Operation replyToEmailWithHttpInfo


    public
                    replyToEmailWithHttpInfo(string $email_id, ReplyToEmailOptions $reply_to_email_options[, string $contentType = self::contentTypes['replyToEmail'][0] ]) : array<string|int, mixed>

Reply to an email

Parameters

$email_id : string: ID of the email that should be replied to (required)
$reply_to_email_options : ReplyToEmailOptions: (required)
$contentType : string = self::contentTypes['replyToEmail'][0]: The value for the Content-Type header. Check self::contentTypes['replyToEmail'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\SentEmailDto, HTTP status code, HTTP response headers (array of strings)

searchEmails()

Operation searchEmails


    public
                    searchEmails(SearchEmailsOptions $search_emails_options[, string $contentType = self::contentTypes['searchEmails'][0] ]) : PageEmailProjection

Get all emails by search criteria. Return in paginated form.

Parameters

$search_emails_options : SearchEmailsOptions: search_emails_options (required)
$contentType : string = self::contentTypes['searchEmails'][0]: The value for the Content-Type header. Check self::contentTypes['searchEmails'] to see the possible values for this operation

Return values

PageEmailProjection —

searchEmailsAsync()

Operation searchEmailsAsync


    public
                    searchEmailsAsync(SearchEmailsOptions $search_emails_options[, string $contentType = self::contentTypes['searchEmails'][0] ]) : PromiseInterface

Get all emails by search criteria. Return in paginated form.

Parameters

$search_emails_options : SearchEmailsOptions: (required)
$contentType : string = self::contentTypes['searchEmails'][0]: The value for the Content-Type header. Check self::contentTypes['searchEmails'] to see the possible values for this operation

Return values

PromiseInterface —

searchEmailsAsyncWithHttpInfo()

Operation searchEmailsAsyncWithHttpInfo


    public
                    searchEmailsAsyncWithHttpInfo(SearchEmailsOptions $search_emails_options[, string $contentType = self::contentTypes['searchEmails'][0] ]) : PromiseInterface

Get all emails by search criteria. Return in paginated form.

Parameters

$search_emails_options : SearchEmailsOptions: (required)
$contentType : string = self::contentTypes['searchEmails'][0]: The value for the Content-Type header. Check self::contentTypes['searchEmails'] to see the possible values for this operation

Return values

PromiseInterface —

searchEmailsRequest()

Create request for operation 'searchEmails'


    public
                    searchEmailsRequest(SearchEmailsOptions $search_emails_options[, string $contentType = self::contentTypes['searchEmails'][0] ]) : Request

Parameters

$search_emails_options : SearchEmailsOptions: (required)
$contentType : string = self::contentTypes['searchEmails'][0]: The value for the Content-Type header. Check self::contentTypes['searchEmails'] to see the possible values for this operation

Return values

Request —

searchEmailsWithHttpInfo()

Operation searchEmailsWithHttpInfo


    public
                    searchEmailsWithHttpInfo(SearchEmailsOptions $search_emails_options[, string $contentType = self::contentTypes['searchEmails'][0] ]) : array<string|int, mixed>

Get all emails by search criteria. Return in paginated form.

Parameters

$search_emails_options : SearchEmailsOptions: (required)
$contentType : string = self::contentTypes['searchEmails'][0]: The value for the Content-Type header. Check self::contentTypes['searchEmails'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\PageEmailProjection, HTTP status code, HTTP response headers (array of strings)

sendEmailSourceOptional()

Operation sendEmailSourceOptional


    public
                    sendEmailSourceOptional(SendEmailOptions $send_email_options[, string $inbox_id = null ][, bool $use_domain_pool = null ][, bool $virtual_send = null ][, string $contentType = self::contentTypes['sendEmailSourceOptional'][0] ]) : void

Send email

Parameters

$send_email_options : SendEmailOptions: send_email_options (required)
$inbox_id : string = null: ID of the inbox you want to send the email from (optional)
$use_domain_pool : bool = null: Use domain pool. Optionally create inbox to send from using the mailslurp domain pool. (optional)
$virtual_send : bool = null: Optionally create inbox to send from that is a virtual inbox and won't send to external addresses (optional)
$contentType : string = self::contentTypes['sendEmailSourceOptional'][0]: The value for the Content-Type header. Check self::contentTypes['sendEmailSourceOptional'] to see the possible values for this operation

Return values

void —

sendEmailSourceOptionalAsync()

Operation sendEmailSourceOptionalAsync


    public
                    sendEmailSourceOptionalAsync(SendEmailOptions $send_email_options[, string $inbox_id = null ][, bool $use_domain_pool = null ][, bool $virtual_send = null ][, string $contentType = self::contentTypes['sendEmailSourceOptional'][0] ]) : PromiseInterface

Send email

Parameters

$send_email_options : SendEmailOptions: (required)
$inbox_id : string = null: ID of the inbox you want to send the email from (optional)
$use_domain_pool : bool = null: Use domain pool. Optionally create inbox to send from using the mailslurp domain pool. (optional)
$virtual_send : bool = null: Optionally create inbox to send from that is a virtual inbox and won't send to external addresses (optional)
$contentType : string = self::contentTypes['sendEmailSourceOptional'][0]: The value for the Content-Type header. Check self::contentTypes['sendEmailSourceOptional'] to see the possible values for this operation

Return values

PromiseInterface —

sendEmailSourceOptionalAsyncWithHttpInfo()

Operation sendEmailSourceOptionalAsyncWithHttpInfo


    public
                    sendEmailSourceOptionalAsyncWithHttpInfo(SendEmailOptions $send_email_options[, string $inbox_id = null ][, bool $use_domain_pool = null ][, bool $virtual_send = null ][, string $contentType = self::contentTypes['sendEmailSourceOptional'][0] ]) : PromiseInterface

Send email

Parameters

$send_email_options : SendEmailOptions: (required)
$inbox_id : string = null: ID of the inbox you want to send the email from (optional)
$use_domain_pool : bool = null: Use domain pool. Optionally create inbox to send from using the mailslurp domain pool. (optional)
$virtual_send : bool = null: Optionally create inbox to send from that is a virtual inbox and won't send to external addresses (optional)
$contentType : string = self::contentTypes['sendEmailSourceOptional'][0]: The value for the Content-Type header. Check self::contentTypes['sendEmailSourceOptional'] to see the possible values for this operation

Return values

PromiseInterface —

sendEmailSourceOptionalRequest()

Create request for operation 'sendEmailSourceOptional'


    public
                    sendEmailSourceOptionalRequest(SendEmailOptions $send_email_options[, string $inbox_id = null ][, bool $use_domain_pool = null ][, bool $virtual_send = null ][, string $contentType = self::contentTypes['sendEmailSourceOptional'][0] ]) : Request

Parameters

$send_email_options : SendEmailOptions: (required)
$inbox_id : string = null: ID of the inbox you want to send the email from (optional)
$use_domain_pool : bool = null: Use domain pool. Optionally create inbox to send from using the mailslurp domain pool. (optional)
$virtual_send : bool = null: Optionally create inbox to send from that is a virtual inbox and won't send to external addresses (optional)
$contentType : string = self::contentTypes['sendEmailSourceOptional'][0]: The value for the Content-Type header. Check self::contentTypes['sendEmailSourceOptional'] to see the possible values for this operation

Return values

Request —

sendEmailSourceOptionalWithHttpInfo()

Operation sendEmailSourceOptionalWithHttpInfo


    public
                    sendEmailSourceOptionalWithHttpInfo(SendEmailOptions $send_email_options[, string $inbox_id = null ][, bool $use_domain_pool = null ][, bool $virtual_send = null ][, string $contentType = self::contentTypes['sendEmailSourceOptional'][0] ]) : array<string|int, mixed>

Send email

Parameters

$send_email_options : SendEmailOptions: (required)
$inbox_id : string = null: ID of the inbox you want to send the email from (optional)
$use_domain_pool : bool = null: Use domain pool. Optionally create inbox to send from using the mailslurp domain pool. (optional)
$virtual_send : bool = null: Optionally create inbox to send from that is a virtual inbox and won't send to external addresses (optional)
$contentType : string = self::contentTypes['sendEmailSourceOptional'][0]: The value for the Content-Type header. Check self::contentTypes['sendEmailSourceOptional'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of null, HTTP status code, HTTP response headers (array of strings)

setHostIndex()

Set the host index


    public
                    setHostIndex(int $hostIndex) : void

Parameters

$hostIndex : int: Host index (required)

Return values

void —

validateEmail()

Operation validateEmail


    public
                    validateEmail(string $email_id[, string $contentType = self::contentTypes['validateEmail'][0] ]) : ValidationDto

Validate email HTML contents

Parameters

$email_id : string: ID of email (required)
$contentType : string = self::contentTypes['validateEmail'][0]: The value for the Content-Type header. Check self::contentTypes['validateEmail'] to see the possible values for this operation

Return values

ValidationDto —

validateEmailAsync()

Operation validateEmailAsync


    public
                    validateEmailAsync(string $email_id[, string $contentType = self::contentTypes['validateEmail'][0] ]) : PromiseInterface

Validate email HTML contents

Parameters

$email_id : string: ID of email (required)
$contentType : string = self::contentTypes['validateEmail'][0]: The value for the Content-Type header. Check self::contentTypes['validateEmail'] to see the possible values for this operation

Return values

PromiseInterface —

validateEmailAsyncWithHttpInfo()

Operation validateEmailAsyncWithHttpInfo


    public
                    validateEmailAsyncWithHttpInfo(string $email_id[, string $contentType = self::contentTypes['validateEmail'][0] ]) : PromiseInterface

Validate email HTML contents

Parameters

$email_id : string: ID of email (required)
$contentType : string = self::contentTypes['validateEmail'][0]: The value for the Content-Type header. Check self::contentTypes['validateEmail'] to see the possible values for this operation

Return values

PromiseInterface —

validateEmailRequest()

Create request for operation 'validateEmail'


    public
                    validateEmailRequest(string $email_id[, string $contentType = self::contentTypes['validateEmail'][0] ]) : Request

Parameters

$email_id : string: ID of email (required)
$contentType : string = self::contentTypes['validateEmail'][0]: The value for the Content-Type header. Check self::contentTypes['validateEmail'] to see the possible values for this operation

Return values

Request —

validateEmailWithHttpInfo()

Operation validateEmailWithHttpInfo


    public
                    validateEmailWithHttpInfo(string $email_id[, string $contentType = self::contentTypes['validateEmail'][0] ]) : array<string|int, mixed>

Validate email HTML contents

Parameters

$email_id : string: ID of email (required)
$contentType : string = self::contentTypes['validateEmail'][0]: The value for the Content-Type header. Check self::contentTypes['validateEmail'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\ValidationDto, HTTP status code, HTTP response headers (array of strings)

createHttpClientOption()

Create http client option


    protected
                    createHttpClientOption() : array<string|int, mixed>

Return values

array<string|int, mixed> —

of http client options

EmailControllerApi in package MailSlurp

Tags

Table of Contents

Constants

contentTypes

Properties

$client

$config

$headerSelector

$hostIndex

Methods

__construct()

Parameters

Return values

applyImapFlagOperation()

Parameters

Tags

Return values

applyImapFlagOperationAsync()

Parameters

Tags

Return values

applyImapFlagOperationAsyncWithHttpInfo()

Parameters

Tags

Return values

applyImapFlagOperationRequest()

Parameters

Tags

Return values

applyImapFlagOperationWithHttpInfo()

Parameters

Tags

Return values

canSend()

Parameters

Tags

Return values

canSendAsync()

Parameters

Tags

Return values

canSendAsyncWithHttpInfo()

Parameters

Tags

Return values

canSendRequest()

Parameters

Tags

Return values

canSendWithHttpInfo()

Parameters

Tags

Return values

checkEmailBody()

Parameters

Tags

Return values

checkEmailBodyAsync()

Parameters

Tags

Return values

checkEmailBodyAsyncWithHttpInfo()

Parameters

Tags

Return values

checkEmailBodyFeatureSupport()

Parameters

Tags

Return values

checkEmailBodyFeatureSupportAsync()

Parameters

Tags

Return values

checkEmailBodyFeatureSupportAsyncWithHttpInfo()

Parameters

Tags

Return values

checkEmailBodyFeatureSupportRequest()

Parameters

EmailControllerApi
in package

MailSlurp