SentEmailsControllerApi
in package
SentEmailsControllerApi Class Doc Comment
Tags
Table of Contents
- contentTypes = ['deleteAllSentEmails' => ['application/json'], 'deleteSentEmail' => ['application/json'], 'getAllSentTrackingPixels' => ['application/json'], 'getRawSentEmailContents' => ['application/json'], 'getRawSentEmailJson' => ['application/json'], 'getSentDeliveryStatus' => ['application/json'], 'getSentDeliveryStatuses' => ['application/json'], 'getSentDeliveryStatusesBySentId' => ['application/json'], 'getSentEmail' => ['application/json'], 'getSentEmailHTMLContent' => ['application/json'], 'getSentEmailPreviewURLs' => ['application/json'], 'getSentEmailTrackingPixels' => ['application/json'], 'getSentEmails' => ['application/json'], 'getSentEmailsWithQueueResults' => ['application/json'], 'getSentOrganizationEmails' => ['application/json'], 'waitForDeliveryStatuses' => ['application/json']]
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- $hostIndex : int
- __construct() : mixed
- deleteAllSentEmails() : void
- Operation deleteAllSentEmails
- deleteAllSentEmailsAsync() : PromiseInterface
- Operation deleteAllSentEmailsAsync
- deleteAllSentEmailsAsyncWithHttpInfo() : PromiseInterface
- Operation deleteAllSentEmailsAsyncWithHttpInfo
- deleteAllSentEmailsRequest() : Request
- Create request for operation 'deleteAllSentEmails'
- deleteAllSentEmailsWithHttpInfo() : array<string|int, mixed>
- Operation deleteAllSentEmailsWithHttpInfo
- deleteSentEmail() : void
- Operation deleteSentEmail
- deleteSentEmailAsync() : PromiseInterface
- Operation deleteSentEmailAsync
- deleteSentEmailAsyncWithHttpInfo() : PromiseInterface
- Operation deleteSentEmailAsyncWithHttpInfo
- deleteSentEmailRequest() : Request
- Create request for operation 'deleteSentEmail'
- deleteSentEmailWithHttpInfo() : array<string|int, mixed>
- Operation deleteSentEmailWithHttpInfo
- getAllSentTrackingPixels() : PageTrackingPixelProjection
- Operation getAllSentTrackingPixels
- getAllSentTrackingPixelsAsync() : PromiseInterface
- Operation getAllSentTrackingPixelsAsync
- getAllSentTrackingPixelsAsyncWithHttpInfo() : PromiseInterface
- Operation getAllSentTrackingPixelsAsyncWithHttpInfo
- getAllSentTrackingPixelsRequest() : Request
- Create request for operation 'getAllSentTrackingPixels'
- getAllSentTrackingPixelsWithHttpInfo() : array<string|int, mixed>
- Operation getAllSentTrackingPixelsWithHttpInfo
- getConfig() : Configuration
- getHostIndex() : int
- Get the host index
- getRawSentEmailContents() : void
- Operation getRawSentEmailContents
- getRawSentEmailContentsAsync() : PromiseInterface
- Operation getRawSentEmailContentsAsync
- getRawSentEmailContentsAsyncWithHttpInfo() : PromiseInterface
- Operation getRawSentEmailContentsAsyncWithHttpInfo
- getRawSentEmailContentsRequest() : Request
- Create request for operation 'getRawSentEmailContents'
- getRawSentEmailContentsWithHttpInfo() : array<string|int, mixed>
- Operation getRawSentEmailContentsWithHttpInfo
- getRawSentEmailJson() : RawEmailJson
- Operation getRawSentEmailJson
- getRawSentEmailJsonAsync() : PromiseInterface
- Operation getRawSentEmailJsonAsync
- getRawSentEmailJsonAsyncWithHttpInfo() : PromiseInterface
- Operation getRawSentEmailJsonAsyncWithHttpInfo
- getRawSentEmailJsonRequest() : Request
- Create request for operation 'getRawSentEmailJson'
- getRawSentEmailJsonWithHttpInfo() : array<string|int, mixed>
- Operation getRawSentEmailJsonWithHttpInfo
- getSentDeliveryStatus() : DeliveryStatusDto
- Operation getSentDeliveryStatus
- getSentDeliveryStatusAsync() : PromiseInterface
- Operation getSentDeliveryStatusAsync
- getSentDeliveryStatusAsyncWithHttpInfo() : PromiseInterface
- Operation getSentDeliveryStatusAsyncWithHttpInfo
- getSentDeliveryStatuses() : PageDeliveryStatus
- Operation getSentDeliveryStatuses
- getSentDeliveryStatusesAsync() : PromiseInterface
- Operation getSentDeliveryStatusesAsync
- getSentDeliveryStatusesAsyncWithHttpInfo() : PromiseInterface
- Operation getSentDeliveryStatusesAsyncWithHttpInfo
- getSentDeliveryStatusesBySentId() : PageDeliveryStatus
- Operation getSentDeliveryStatusesBySentId
- getSentDeliveryStatusesBySentIdAsync() : PromiseInterface
- Operation getSentDeliveryStatusesBySentIdAsync
- getSentDeliveryStatusesBySentIdAsyncWithHttpInfo() : PromiseInterface
- Operation getSentDeliveryStatusesBySentIdAsyncWithHttpInfo
- getSentDeliveryStatusesBySentIdRequest() : Request
- Create request for operation 'getSentDeliveryStatusesBySentId'
- getSentDeliveryStatusesBySentIdWithHttpInfo() : array<string|int, mixed>
- Operation getSentDeliveryStatusesBySentIdWithHttpInfo
- getSentDeliveryStatusesRequest() : Request
- Create request for operation 'getSentDeliveryStatuses'
- getSentDeliveryStatusesWithHttpInfo() : array<string|int, mixed>
- Operation getSentDeliveryStatusesWithHttpInfo
- getSentDeliveryStatusRequest() : Request
- Create request for operation 'getSentDeliveryStatus'
- getSentDeliveryStatusWithHttpInfo() : array<string|int, mixed>
- Operation getSentDeliveryStatusWithHttpInfo
- getSentEmail() : SentEmailDto
- Operation getSentEmail
- getSentEmailAsync() : PromiseInterface
- Operation getSentEmailAsync
- getSentEmailAsyncWithHttpInfo() : PromiseInterface
- Operation getSentEmailAsyncWithHttpInfo
- getSentEmailHTMLContent() : string
- Operation getSentEmailHTMLContent
- getSentEmailHTMLContentAsync() : PromiseInterface
- Operation getSentEmailHTMLContentAsync
- getSentEmailHTMLContentAsyncWithHttpInfo() : PromiseInterface
- Operation getSentEmailHTMLContentAsyncWithHttpInfo
- getSentEmailHTMLContentRequest() : Request
- Create request for operation 'getSentEmailHTMLContent'
- getSentEmailHTMLContentWithHttpInfo() : array<string|int, mixed>
- Operation getSentEmailHTMLContentWithHttpInfo
- getSentEmailPreviewURLs() : EmailPreviewUrls
- Operation getSentEmailPreviewURLs
- getSentEmailPreviewURLsAsync() : PromiseInterface
- Operation getSentEmailPreviewURLsAsync
- getSentEmailPreviewURLsAsyncWithHttpInfo() : PromiseInterface
- Operation getSentEmailPreviewURLsAsyncWithHttpInfo
- getSentEmailPreviewURLsRequest() : Request
- Create request for operation 'getSentEmailPreviewURLs'
- getSentEmailPreviewURLsWithHttpInfo() : array<string|int, mixed>
- Operation getSentEmailPreviewURLsWithHttpInfo
- getSentEmailRequest() : Request
- Create request for operation 'getSentEmail'
- getSentEmails() : PageSentEmailProjection
- Operation getSentEmails
- getSentEmailsAsync() : PromiseInterface
- Operation getSentEmailsAsync
- getSentEmailsAsyncWithHttpInfo() : PromiseInterface
- Operation getSentEmailsAsyncWithHttpInfo
- getSentEmailsRequest() : Request
- Create request for operation 'getSentEmails'
- getSentEmailsWithHttpInfo() : array<string|int, mixed>
- Operation getSentEmailsWithHttpInfo
- getSentEmailsWithQueueResults() : PageSentEmailWithQueueProjection
- Operation getSentEmailsWithQueueResults
- getSentEmailsWithQueueResultsAsync() : PromiseInterface
- Operation getSentEmailsWithQueueResultsAsync
- getSentEmailsWithQueueResultsAsyncWithHttpInfo() : PromiseInterface
- Operation getSentEmailsWithQueueResultsAsyncWithHttpInfo
- getSentEmailsWithQueueResultsRequest() : Request
- Create request for operation 'getSentEmailsWithQueueResults'
- getSentEmailsWithQueueResultsWithHttpInfo() : array<string|int, mixed>
- Operation getSentEmailsWithQueueResultsWithHttpInfo
- getSentEmailTrackingPixels() : PageTrackingPixelProjection
- Operation getSentEmailTrackingPixels
- getSentEmailTrackingPixelsAsync() : PromiseInterface
- Operation getSentEmailTrackingPixelsAsync
- getSentEmailTrackingPixelsAsyncWithHttpInfo() : PromiseInterface
- Operation getSentEmailTrackingPixelsAsyncWithHttpInfo
- getSentEmailTrackingPixelsRequest() : Request
- Create request for operation 'getSentEmailTrackingPixels'
- getSentEmailTrackingPixelsWithHttpInfo() : array<string|int, mixed>
- Operation getSentEmailTrackingPixelsWithHttpInfo
- getSentEmailWithHttpInfo() : array<string|int, mixed>
- Operation getSentEmailWithHttpInfo
- getSentOrganizationEmails() : PageSentEmailProjection
- Operation getSentOrganizationEmails
- getSentOrganizationEmailsAsync() : PromiseInterface
- Operation getSentOrganizationEmailsAsync
- getSentOrganizationEmailsAsyncWithHttpInfo() : PromiseInterface
- Operation getSentOrganizationEmailsAsyncWithHttpInfo
- getSentOrganizationEmailsRequest() : Request
- Create request for operation 'getSentOrganizationEmails'
- getSentOrganizationEmailsWithHttpInfo() : array<string|int, mixed>
- Operation getSentOrganizationEmailsWithHttpInfo
- setHostIndex() : void
- Set the host index
- waitForDeliveryStatuses() : DeliveryStatusDto
- Operation waitForDeliveryStatuses
- waitForDeliveryStatusesAsync() : PromiseInterface
- Operation waitForDeliveryStatusesAsync
- waitForDeliveryStatusesAsyncWithHttpInfo() : PromiseInterface
- Operation waitForDeliveryStatusesAsyncWithHttpInfo
- waitForDeliveryStatusesRequest() : Request
- Create request for operation 'waitForDeliveryStatuses'
- waitForDeliveryStatusesWithHttpInfo() : array<string|int, mixed>
- Operation waitForDeliveryStatusesWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
Constants
contentTypes
public
array<string|int, string>
contentTypes
= ['deleteAllSentEmails' => ['application/json'], 'deleteSentEmail' => ['application/json'], 'getAllSentTrackingPixels' => ['application/json'], 'getRawSentEmailContents' => ['application/json'], 'getRawSentEmailJson' => ['application/json'], 'getSentDeliveryStatus' => ['application/json'], 'getSentDeliveryStatuses' => ['application/json'], 'getSentDeliveryStatusesBySentId' => ['application/json'], 'getSentEmail' => ['application/json'], 'getSentEmailHTMLContent' => ['application/json'], 'getSentEmailPreviewURLs' => ['application/json'], 'getSentEmailTrackingPixels' => ['application/json'], 'getSentEmails' => ['application/json'], 'getSentEmailsWithQueueResults' => ['application/json'], 'getSentOrganizationEmails' => ['application/json'], 'waitForDeliveryStatuses' => ['application/json']]
Properties
$client
protected
ClientInterface
$client
$config
protected
Configuration
$config
$headerSelector
protected
HeaderSelector
$headerSelector
$hostIndex
protected
int
$hostIndex
Host index
Methods
__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 —deleteAllSentEmails()
Operation deleteAllSentEmails
public
deleteAllSentEmails([string $contentType = self::contentTypes['deleteAllSentEmails'][0] ]) : void
Delete all sent email receipts
Parameters
- $contentType : string = self::contentTypes['deleteAllSentEmails'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteAllSentEmails'] to see the possible values for this operation
Tags
Return values
void —deleteAllSentEmailsAsync()
Operation deleteAllSentEmailsAsync
public
deleteAllSentEmailsAsync([string $contentType = self::contentTypes['deleteAllSentEmails'][0] ]) : PromiseInterface
Delete all sent email receipts
Parameters
- $contentType : string = self::contentTypes['deleteAllSentEmails'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteAllSentEmails'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteAllSentEmailsAsyncWithHttpInfo()
Operation deleteAllSentEmailsAsyncWithHttpInfo
public
deleteAllSentEmailsAsyncWithHttpInfo([string $contentType = self::contentTypes['deleteAllSentEmails'][0] ]) : PromiseInterface
Delete all sent email receipts
Parameters
- $contentType : string = self::contentTypes['deleteAllSentEmails'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteAllSentEmails'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteAllSentEmailsRequest()
Create request for operation 'deleteAllSentEmails'
public
deleteAllSentEmailsRequest([string $contentType = self::contentTypes['deleteAllSentEmails'][0] ]) : Request
Parameters
- $contentType : string = self::contentTypes['deleteAllSentEmails'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteAllSentEmails'] to see the possible values for this operation
Tags
Return values
Request —deleteAllSentEmailsWithHttpInfo()
Operation deleteAllSentEmailsWithHttpInfo
public
deleteAllSentEmailsWithHttpInfo([string $contentType = self::contentTypes['deleteAllSentEmails'][0] ]) : array<string|int, mixed>
Delete all sent email receipts
Parameters
- $contentType : string = self::contentTypes['deleteAllSentEmails'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteAllSentEmails'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
deleteSentEmail()
Operation deleteSentEmail
public
deleteSentEmail(string $id[, string $contentType = self::contentTypes['deleteSentEmail'][0] ]) : void
Delete sent email receipt
Parameters
- $id : string
-
id (required)
- $contentType : string = self::contentTypes['deleteSentEmail'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteSentEmail'] to see the possible values for this operation
Tags
Return values
void —deleteSentEmailAsync()
Operation deleteSentEmailAsync
public
deleteSentEmailAsync(string $id[, string $contentType = self::contentTypes['deleteSentEmail'][0] ]) : PromiseInterface
Delete sent email receipt
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['deleteSentEmail'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteSentEmail'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteSentEmailAsyncWithHttpInfo()
Operation deleteSentEmailAsyncWithHttpInfo
public
deleteSentEmailAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['deleteSentEmail'][0] ]) : PromiseInterface
Delete sent email receipt
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['deleteSentEmail'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteSentEmail'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteSentEmailRequest()
Create request for operation 'deleteSentEmail'
public
deleteSentEmailRequest(string $id[, string $contentType = self::contentTypes['deleteSentEmail'][0] ]) : Request
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['deleteSentEmail'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteSentEmail'] to see the possible values for this operation
Tags
Return values
Request —deleteSentEmailWithHttpInfo()
Operation deleteSentEmailWithHttpInfo
public
deleteSentEmailWithHttpInfo(string $id[, string $contentType = self::contentTypes['deleteSentEmail'][0] ]) : array<string|int, mixed>
Delete sent email receipt
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['deleteSentEmail'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteSentEmail'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
getAllSentTrackingPixels()
Operation getAllSentTrackingPixels
public
getAllSentTrackingPixels(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAllSentTrackingPixels'][0] ]) : PageTrackingPixelProjection
Parameters
- $page : int
-
Optional page index in sent email tracking pixel list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in sent email tracking pixel list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $search_filter : string = null
-
Optional search filter (optional)
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getAllSentTrackingPixels'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAllSentTrackingPixels'] to see the possible values for this operation
Tags
Return values
PageTrackingPixelProjection —getAllSentTrackingPixelsAsync()
Operation getAllSentTrackingPixelsAsync
public
getAllSentTrackingPixelsAsync(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAllSentTrackingPixels'][0] ]) : PromiseInterface
Parameters
- $page : int
-
Optional page index in sent email tracking pixel list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in sent email tracking pixel list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $search_filter : string = null
-
Optional search filter (optional)
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getAllSentTrackingPixels'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAllSentTrackingPixels'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getAllSentTrackingPixelsAsyncWithHttpInfo()
Operation getAllSentTrackingPixelsAsyncWithHttpInfo
public
getAllSentTrackingPixelsAsyncWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAllSentTrackingPixels'][0] ]) : PromiseInterface
Parameters
- $page : int
-
Optional page index in sent email tracking pixel list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in sent email tracking pixel list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $search_filter : string = null
-
Optional search filter (optional)
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getAllSentTrackingPixels'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAllSentTrackingPixels'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getAllSentTrackingPixelsRequest()
Create request for operation 'getAllSentTrackingPixels'
public
getAllSentTrackingPixelsRequest(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAllSentTrackingPixels'][0] ]) : Request
Parameters
- $page : int
-
Optional page index in sent email tracking pixel list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in sent email tracking pixel list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $search_filter : string = null
-
Optional search filter (optional)
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getAllSentTrackingPixels'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAllSentTrackingPixels'] to see the possible values for this operation
Tags
Return values
Request —getAllSentTrackingPixelsWithHttpInfo()
Operation getAllSentTrackingPixelsWithHttpInfo
public
getAllSentTrackingPixelsWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAllSentTrackingPixels'][0] ]) : array<string|int, mixed>
Parameters
- $page : int
-
Optional page index in sent email tracking pixel list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in sent email tracking pixel list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $search_filter : string = null
-
Optional search filter (optional)
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getAllSentTrackingPixels'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAllSentTrackingPixels'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\PageTrackingPixelProjection, HTTP status code, HTTP response headers (array of strings)
getConfig()
public
getConfig() : Configuration
Return values
Configuration —getHostIndex()
Get the host index
public
getHostIndex() : int
Return values
int —Host index
getRawSentEmailContents()
Operation getRawSentEmailContents
public
getRawSentEmailContents(string $email_id[, string $contentType = self::contentTypes['getRawSentEmailContents'][0] ]) : void
Get raw sent email string. Returns unparsed raw SMTP message with headers and body.
Parameters
- $email_id : string
-
ID of email (required)
- $contentType : string = self::contentTypes['getRawSentEmailContents'][0]
-
The value for the Content-Type header. Check self::contentTypes['getRawSentEmailContents'] to see the possible values for this operation
Tags
Return values
void —getRawSentEmailContentsAsync()
Operation getRawSentEmailContentsAsync
public
getRawSentEmailContentsAsync(string $email_id[, string $contentType = self::contentTypes['getRawSentEmailContents'][0] ]) : PromiseInterface
Get raw sent email string. Returns unparsed raw SMTP message with headers and body.
Parameters
- $email_id : string
-
ID of email (required)
- $contentType : string = self::contentTypes['getRawSentEmailContents'][0]
-
The value for the Content-Type header. Check self::contentTypes['getRawSentEmailContents'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getRawSentEmailContentsAsyncWithHttpInfo()
Operation getRawSentEmailContentsAsyncWithHttpInfo
public
getRawSentEmailContentsAsyncWithHttpInfo(string $email_id[, string $contentType = self::contentTypes['getRawSentEmailContents'][0] ]) : PromiseInterface
Get raw sent email string. Returns unparsed raw SMTP message with headers and body.
Parameters
- $email_id : string
-
ID of email (required)
- $contentType : string = self::contentTypes['getRawSentEmailContents'][0]
-
The value for the Content-Type header. Check self::contentTypes['getRawSentEmailContents'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getRawSentEmailContentsRequest()
Create request for operation 'getRawSentEmailContents'
public
getRawSentEmailContentsRequest(string $email_id[, string $contentType = self::contentTypes['getRawSentEmailContents'][0] ]) : Request
Parameters
- $email_id : string
-
ID of email (required)
- $contentType : string = self::contentTypes['getRawSentEmailContents'][0]
-
The value for the Content-Type header. Check self::contentTypes['getRawSentEmailContents'] to see the possible values for this operation
Tags
Return values
Request —getRawSentEmailContentsWithHttpInfo()
Operation getRawSentEmailContentsWithHttpInfo
public
getRawSentEmailContentsWithHttpInfo(string $email_id[, string $contentType = self::contentTypes['getRawSentEmailContents'][0] ]) : array<string|int, mixed>
Get raw sent email string. Returns unparsed raw SMTP message with headers and body.
Parameters
- $email_id : string
-
ID of email (required)
- $contentType : string = self::contentTypes['getRawSentEmailContents'][0]
-
The value for the Content-Type header. Check self::contentTypes['getRawSentEmailContents'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
getRawSentEmailJson()
Operation getRawSentEmailJson
public
getRawSentEmailJson(string $email_id[, string $contentType = self::contentTypes['getRawSentEmailJson'][0] ]) : RawEmailJson
Get raw sent email in JSON. Unparsed SMTP message in JSON wrapper format.
Parameters
- $email_id : string
-
ID of email (required)
- $contentType : string = self::contentTypes['getRawSentEmailJson'][0]
-
The value for the Content-Type header. Check self::contentTypes['getRawSentEmailJson'] to see the possible values for this operation
Tags
Return values
RawEmailJson —getRawSentEmailJsonAsync()
Operation getRawSentEmailJsonAsync
public
getRawSentEmailJsonAsync(string $email_id[, string $contentType = self::contentTypes['getRawSentEmailJson'][0] ]) : PromiseInterface
Get raw sent email in JSON. Unparsed SMTP message in JSON wrapper format.
Parameters
- $email_id : string
-
ID of email (required)
- $contentType : string = self::contentTypes['getRawSentEmailJson'][0]
-
The value for the Content-Type header. Check self::contentTypes['getRawSentEmailJson'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getRawSentEmailJsonAsyncWithHttpInfo()
Operation getRawSentEmailJsonAsyncWithHttpInfo
public
getRawSentEmailJsonAsyncWithHttpInfo(string $email_id[, string $contentType = self::contentTypes['getRawSentEmailJson'][0] ]) : PromiseInterface
Get raw sent email in JSON. Unparsed SMTP message in JSON wrapper format.
Parameters
- $email_id : string
-
ID of email (required)
- $contentType : string = self::contentTypes['getRawSentEmailJson'][0]
-
The value for the Content-Type header. Check self::contentTypes['getRawSentEmailJson'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getRawSentEmailJsonRequest()
Create request for operation 'getRawSentEmailJson'
public
getRawSentEmailJsonRequest(string $email_id[, string $contentType = self::contentTypes['getRawSentEmailJson'][0] ]) : Request
Parameters
- $email_id : string
-
ID of email (required)
- $contentType : string = self::contentTypes['getRawSentEmailJson'][0]
-
The value for the Content-Type header. Check self::contentTypes['getRawSentEmailJson'] to see the possible values for this operation
Tags
Return values
Request —getRawSentEmailJsonWithHttpInfo()
Operation getRawSentEmailJsonWithHttpInfo
public
getRawSentEmailJsonWithHttpInfo(string $email_id[, string $contentType = self::contentTypes['getRawSentEmailJson'][0] ]) : array<string|int, mixed>
Get raw sent email in JSON. Unparsed SMTP message in JSON wrapper format.
Parameters
- $email_id : string
-
ID of email (required)
- $contentType : string = self::contentTypes['getRawSentEmailJson'][0]
-
The value for the Content-Type header. Check self::contentTypes['getRawSentEmailJson'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\RawEmailJson, HTTP status code, HTTP response headers (array of strings)
getSentDeliveryStatus()
Operation getSentDeliveryStatus
public
getSentDeliveryStatus(string $delivery_id[, string $contentType = self::contentTypes['getSentDeliveryStatus'][0] ]) : DeliveryStatusDto
Parameters
- $delivery_id : string
-
delivery_id (required)
- $contentType : string = self::contentTypes['getSentDeliveryStatus'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSentDeliveryStatus'] to see the possible values for this operation
Tags
Return values
DeliveryStatusDto —getSentDeliveryStatusAsync()
Operation getSentDeliveryStatusAsync
public
getSentDeliveryStatusAsync(string $delivery_id[, string $contentType = self::contentTypes['getSentDeliveryStatus'][0] ]) : PromiseInterface
Parameters
- $delivery_id : string
-
(required)
- $contentType : string = self::contentTypes['getSentDeliveryStatus'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSentDeliveryStatus'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getSentDeliveryStatusAsyncWithHttpInfo()
Operation getSentDeliveryStatusAsyncWithHttpInfo
public
getSentDeliveryStatusAsyncWithHttpInfo(string $delivery_id[, string $contentType = self::contentTypes['getSentDeliveryStatus'][0] ]) : PromiseInterface
Parameters
- $delivery_id : string
-
(required)
- $contentType : string = self::contentTypes['getSentDeliveryStatus'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSentDeliveryStatus'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getSentDeliveryStatuses()
Operation getSentDeliveryStatuses
public
getSentDeliveryStatuses(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getSentDeliveryStatuses'][0] ]) : PageDeliveryStatus
Parameters
- $page : int
-
Optional page index in delivery status list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in delivery status list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getSentDeliveryStatuses'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSentDeliveryStatuses'] to see the possible values for this operation
Tags
Return values
PageDeliveryStatus —getSentDeliveryStatusesAsync()
Operation getSentDeliveryStatusesAsync
public
getSentDeliveryStatusesAsync(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getSentDeliveryStatuses'][0] ]) : PromiseInterface
Parameters
- $page : int
-
Optional page index in delivery status list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in delivery status list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getSentDeliveryStatuses'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSentDeliveryStatuses'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getSentDeliveryStatusesAsyncWithHttpInfo()
Operation getSentDeliveryStatusesAsyncWithHttpInfo
public
getSentDeliveryStatusesAsyncWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getSentDeliveryStatuses'][0] ]) : PromiseInterface
Parameters
- $page : int
-
Optional page index in delivery status list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in delivery status list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getSentDeliveryStatuses'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSentDeliveryStatuses'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getSentDeliveryStatusesBySentId()
Operation getSentDeliveryStatusesBySentId
public
getSentDeliveryStatusesBySentId(string $sent_id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getSentDeliveryStatusesBySentId'][0] ]) : PageDeliveryStatus
Parameters
- $sent_id : string
-
ID of the sent email that you want to get the delivery status of. Sent email object is returned when sending an email (required)
- $page : int
-
Optional page index in delivery status list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in delivery status list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getSentDeliveryStatusesBySentId'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSentDeliveryStatusesBySentId'] to see the possible values for this operation
Tags
Return values
PageDeliveryStatus —getSentDeliveryStatusesBySentIdAsync()
Operation getSentDeliveryStatusesBySentIdAsync
public
getSentDeliveryStatusesBySentIdAsync(string $sent_id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getSentDeliveryStatusesBySentId'][0] ]) : PromiseInterface
Parameters
- $sent_id : string
-
ID of the sent email that you want to get the delivery status of. Sent email object is returned when sending an email (required)
- $page : int
-
Optional page index in delivery status list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in delivery status list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getSentDeliveryStatusesBySentId'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSentDeliveryStatusesBySentId'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getSentDeliveryStatusesBySentIdAsyncWithHttpInfo()
Operation getSentDeliveryStatusesBySentIdAsyncWithHttpInfo
public
getSentDeliveryStatusesBySentIdAsyncWithHttpInfo(string $sent_id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getSentDeliveryStatusesBySentId'][0] ]) : PromiseInterface
Parameters
- $sent_id : string
-
ID of the sent email that you want to get the delivery status of. Sent email object is returned when sending an email (required)
- $page : int
-
Optional page index in delivery status list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in delivery status list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getSentDeliveryStatusesBySentId'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSentDeliveryStatusesBySentId'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getSentDeliveryStatusesBySentIdRequest()
Create request for operation 'getSentDeliveryStatusesBySentId'
public
getSentDeliveryStatusesBySentIdRequest(string $sent_id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getSentDeliveryStatusesBySentId'][0] ]) : Request
Parameters
- $sent_id : string
-
ID of the sent email that you want to get the delivery status of. Sent email object is returned when sending an email (required)
- $page : int
-
Optional page index in delivery status list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in delivery status list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getSentDeliveryStatusesBySentId'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSentDeliveryStatusesBySentId'] to see the possible values for this operation
Tags
Return values
Request —getSentDeliveryStatusesBySentIdWithHttpInfo()
Operation getSentDeliveryStatusesBySentIdWithHttpInfo
public
getSentDeliveryStatusesBySentIdWithHttpInfo(string $sent_id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getSentDeliveryStatusesBySentId'][0] ]) : array<string|int, mixed>
Parameters
- $sent_id : string
-
ID of the sent email that you want to get the delivery status of. Sent email object is returned when sending an email (required)
- $page : int
-
Optional page index in delivery status list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in delivery status list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getSentDeliveryStatusesBySentId'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSentDeliveryStatusesBySentId'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\PageDeliveryStatus, HTTP status code, HTTP response headers (array of strings)
getSentDeliveryStatusesRequest()
Create request for operation 'getSentDeliveryStatuses'
public
getSentDeliveryStatusesRequest(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getSentDeliveryStatuses'][0] ]) : Request
Parameters
- $page : int
-
Optional page index in delivery status list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in delivery status list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getSentDeliveryStatuses'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSentDeliveryStatuses'] to see the possible values for this operation
Tags
Return values
Request —getSentDeliveryStatusesWithHttpInfo()
Operation getSentDeliveryStatusesWithHttpInfo
public
getSentDeliveryStatusesWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getSentDeliveryStatuses'][0] ]) : array<string|int, mixed>
Parameters
- $page : int
-
Optional page index in delivery status list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in delivery status list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getSentDeliveryStatuses'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSentDeliveryStatuses'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\PageDeliveryStatus, HTTP status code, HTTP response headers (array of strings)
getSentDeliveryStatusRequest()
Create request for operation 'getSentDeliveryStatus'
public
getSentDeliveryStatusRequest(string $delivery_id[, string $contentType = self::contentTypes['getSentDeliveryStatus'][0] ]) : Request
Parameters
- $delivery_id : string
-
(required)
- $contentType : string = self::contentTypes['getSentDeliveryStatus'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSentDeliveryStatus'] to see the possible values for this operation
Tags
Return values
Request —getSentDeliveryStatusWithHttpInfo()
Operation getSentDeliveryStatusWithHttpInfo
public
getSentDeliveryStatusWithHttpInfo(string $delivery_id[, string $contentType = self::contentTypes['getSentDeliveryStatus'][0] ]) : array<string|int, mixed>
Parameters
- $delivery_id : string
-
(required)
- $contentType : string = self::contentTypes['getSentDeliveryStatus'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSentDeliveryStatus'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\DeliveryStatusDto, HTTP status code, HTTP response headers (array of strings)
getSentEmail()
Operation getSentEmail
public
getSentEmail(string $id[, string $contentType = self::contentTypes['getSentEmail'][0] ]) : SentEmailDto
Get sent email receipt
Parameters
- $id : string
-
id (required)
- $contentType : string = self::contentTypes['getSentEmail'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSentEmail'] to see the possible values for this operation
Tags
Return values
SentEmailDto —getSentEmailAsync()
Operation getSentEmailAsync
public
getSentEmailAsync(string $id[, string $contentType = self::contentTypes['getSentEmail'][0] ]) : PromiseInterface
Get sent email receipt
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['getSentEmail'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSentEmail'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getSentEmailAsyncWithHttpInfo()
Operation getSentEmailAsyncWithHttpInfo
public
getSentEmailAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['getSentEmail'][0] ]) : PromiseInterface
Get sent email receipt
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['getSentEmail'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSentEmail'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getSentEmailHTMLContent()
Operation getSentEmailHTMLContent
public
getSentEmailHTMLContent(string $id[, string $contentType = self::contentTypes['getSentEmailHTMLContent'][0] ]) : string
Get sent email HTML content
Parameters
- $id : string
-
id (required)
- $contentType : string = self::contentTypes['getSentEmailHTMLContent'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSentEmailHTMLContent'] to see the possible values for this operation
Tags
Return values
string —getSentEmailHTMLContentAsync()
Operation getSentEmailHTMLContentAsync
public
getSentEmailHTMLContentAsync(string $id[, string $contentType = self::contentTypes['getSentEmailHTMLContent'][0] ]) : PromiseInterface
Get sent email HTML content
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['getSentEmailHTMLContent'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSentEmailHTMLContent'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getSentEmailHTMLContentAsyncWithHttpInfo()
Operation getSentEmailHTMLContentAsyncWithHttpInfo
public
getSentEmailHTMLContentAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['getSentEmailHTMLContent'][0] ]) : PromiseInterface
Get sent email HTML content
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['getSentEmailHTMLContent'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSentEmailHTMLContent'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getSentEmailHTMLContentRequest()
Create request for operation 'getSentEmailHTMLContent'
public
getSentEmailHTMLContentRequest(string $id[, string $contentType = self::contentTypes['getSentEmailHTMLContent'][0] ]) : Request
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['getSentEmailHTMLContent'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSentEmailHTMLContent'] to see the possible values for this operation
Tags
Return values
Request —getSentEmailHTMLContentWithHttpInfo()
Operation getSentEmailHTMLContentWithHttpInfo
public
getSentEmailHTMLContentWithHttpInfo(string $id[, string $contentType = self::contentTypes['getSentEmailHTMLContent'][0] ]) : array<string|int, mixed>
Get sent email HTML content
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['getSentEmailHTMLContent'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSentEmailHTMLContent'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of string, HTTP status code, HTTP response headers (array of strings)
getSentEmailPreviewURLs()
Operation getSentEmailPreviewURLs
public
getSentEmailPreviewURLs(string $id[, string $contentType = self::contentTypes['getSentEmailPreviewURLs'][0] ]) : EmailPreviewUrls
Get sent email URL for viewing in browser or downloading
Parameters
- $id : string
-
id (required)
- $contentType : string = self::contentTypes['getSentEmailPreviewURLs'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSentEmailPreviewURLs'] to see the possible values for this operation
Tags
Return values
EmailPreviewUrls —getSentEmailPreviewURLsAsync()
Operation getSentEmailPreviewURLsAsync
public
getSentEmailPreviewURLsAsync(string $id[, string $contentType = self::contentTypes['getSentEmailPreviewURLs'][0] ]) : PromiseInterface
Get sent email URL for viewing in browser or downloading
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['getSentEmailPreviewURLs'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSentEmailPreviewURLs'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getSentEmailPreviewURLsAsyncWithHttpInfo()
Operation getSentEmailPreviewURLsAsyncWithHttpInfo
public
getSentEmailPreviewURLsAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['getSentEmailPreviewURLs'][0] ]) : PromiseInterface
Get sent email URL for viewing in browser or downloading
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['getSentEmailPreviewURLs'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSentEmailPreviewURLs'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getSentEmailPreviewURLsRequest()
Create request for operation 'getSentEmailPreviewURLs'
public
getSentEmailPreviewURLsRequest(string $id[, string $contentType = self::contentTypes['getSentEmailPreviewURLs'][0] ]) : Request
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['getSentEmailPreviewURLs'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSentEmailPreviewURLs'] to see the possible values for this operation
Tags
Return values
Request —getSentEmailPreviewURLsWithHttpInfo()
Operation getSentEmailPreviewURLsWithHttpInfo
public
getSentEmailPreviewURLsWithHttpInfo(string $id[, string $contentType = self::contentTypes['getSentEmailPreviewURLs'][0] ]) : array<string|int, mixed>
Get sent email URL for viewing in browser or downloading
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['getSentEmailPreviewURLs'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSentEmailPreviewURLs'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\EmailPreviewUrls, HTTP status code, HTTP response headers (array of strings)
getSentEmailRequest()
Create request for operation 'getSentEmail'
public
getSentEmailRequest(string $id[, string $contentType = self::contentTypes['getSentEmail'][0] ]) : Request
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['getSentEmail'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSentEmail'] to see the possible values for this operation
Tags
Return values
Request —getSentEmails()
Operation getSentEmails
public
getSentEmails([string $inbox_id = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getSentEmails'][0] ]) : PageSentEmailProjection
Get all sent emails in paginated form
Parameters
- $inbox_id : string = null
-
Optional inboxId to filter sender of sent emails by (optional)
- $page : int
-
Optional page index in inbox sent email list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in inbox sent email list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $search_filter : string = null
-
Optional search filter (optional)
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getSentEmails'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSentEmails'] to see the possible values for this operation
Tags
Return values
PageSentEmailProjection —getSentEmailsAsync()
Operation getSentEmailsAsync
public
getSentEmailsAsync([string $inbox_id = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getSentEmails'][0] ]) : PromiseInterface
Get all sent emails in paginated form
Parameters
- $inbox_id : string = null
-
Optional inboxId to filter sender of sent emails by (optional)
- $page : int
-
Optional page index in inbox sent email list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in inbox sent email list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $search_filter : string = null
-
Optional search filter (optional)
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getSentEmails'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSentEmails'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getSentEmailsAsyncWithHttpInfo()
Operation getSentEmailsAsyncWithHttpInfo
public
getSentEmailsAsyncWithHttpInfo([string $inbox_id = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getSentEmails'][0] ]) : PromiseInterface
Get all sent emails in paginated form
Parameters
- $inbox_id : string = null
-
Optional inboxId to filter sender of sent emails by (optional)
- $page : int
-
Optional page index in inbox sent email list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in inbox sent email list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $search_filter : string = null
-
Optional search filter (optional)
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getSentEmails'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSentEmails'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getSentEmailsRequest()
Create request for operation 'getSentEmails'
public
getSentEmailsRequest([string $inbox_id = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getSentEmails'][0] ]) : Request
Parameters
- $inbox_id : string = null
-
Optional inboxId to filter sender of sent emails by (optional)
- $page : int
-
Optional page index in inbox sent email list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in inbox sent email list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $search_filter : string = null
-
Optional search filter (optional)
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getSentEmails'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSentEmails'] to see the possible values for this operation
Tags
Return values
Request —getSentEmailsWithHttpInfo()
Operation getSentEmailsWithHttpInfo
public
getSentEmailsWithHttpInfo([string $inbox_id = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getSentEmails'][0] ]) : array<string|int, mixed>
Get all sent emails in paginated form
Parameters
- $inbox_id : string = null
-
Optional inboxId to filter sender of sent emails by (optional)
- $page : int
-
Optional page index in inbox sent email list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in inbox sent email list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $search_filter : string = null
-
Optional search filter (optional)
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getSentEmails'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSentEmails'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\PageSentEmailProjection, HTTP status code, HTTP response headers (array of strings)
getSentEmailsWithQueueResults()
Operation getSentEmailsWithQueueResults
public
getSentEmailsWithQueueResults(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getSentEmailsWithQueueResults'][0] ]) : PageSentEmailWithQueueProjection
Get results of email sent with queues in paginated form
Parameters
- $page : int
-
Optional page index in inbox sent email list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in inbox sent email list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getSentEmailsWithQueueResults'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSentEmailsWithQueueResults'] to see the possible values for this operation
Tags
Return values
PageSentEmailWithQueueProjection —getSentEmailsWithQueueResultsAsync()
Operation getSentEmailsWithQueueResultsAsync
public
getSentEmailsWithQueueResultsAsync(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getSentEmailsWithQueueResults'][0] ]) : PromiseInterface
Get results of email sent with queues in paginated form
Parameters
- $page : int
-
Optional page index in inbox sent email list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in inbox sent email list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getSentEmailsWithQueueResults'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSentEmailsWithQueueResults'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getSentEmailsWithQueueResultsAsyncWithHttpInfo()
Operation getSentEmailsWithQueueResultsAsyncWithHttpInfo
public
getSentEmailsWithQueueResultsAsyncWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getSentEmailsWithQueueResults'][0] ]) : PromiseInterface
Get results of email sent with queues in paginated form
Parameters
- $page : int
-
Optional page index in inbox sent email list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in inbox sent email list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getSentEmailsWithQueueResults'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSentEmailsWithQueueResults'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getSentEmailsWithQueueResultsRequest()
Create request for operation 'getSentEmailsWithQueueResults'
public
getSentEmailsWithQueueResultsRequest(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getSentEmailsWithQueueResults'][0] ]) : Request
Parameters
- $page : int
-
Optional page index in inbox sent email list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in inbox sent email list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getSentEmailsWithQueueResults'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSentEmailsWithQueueResults'] to see the possible values for this operation
Tags
Return values
Request —getSentEmailsWithQueueResultsWithHttpInfo()
Operation getSentEmailsWithQueueResultsWithHttpInfo
public
getSentEmailsWithQueueResultsWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getSentEmailsWithQueueResults'][0] ]) : array<string|int, mixed>
Get results of email sent with queues in paginated form
Parameters
- $page : int
-
Optional page index in inbox sent email list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in inbox sent email list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getSentEmailsWithQueueResults'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSentEmailsWithQueueResults'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\PageSentEmailWithQueueProjection, HTTP status code, HTTP response headers (array of strings)
getSentEmailTrackingPixels()
Operation getSentEmailTrackingPixels
public
getSentEmailTrackingPixels(string $id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getSentEmailTrackingPixels'][0] ]) : PageTrackingPixelProjection
Parameters
- $id : string
-
id (required)
- $page : int
-
Optional page index in sent email tracking pixel list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in sent email tracking pixel list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $search_filter : string = null
-
Optional search filter (optional)
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getSentEmailTrackingPixels'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSentEmailTrackingPixels'] to see the possible values for this operation
Tags
Return values
PageTrackingPixelProjection —getSentEmailTrackingPixelsAsync()
Operation getSentEmailTrackingPixelsAsync
public
getSentEmailTrackingPixelsAsync(string $id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getSentEmailTrackingPixels'][0] ]) : PromiseInterface
Parameters
- $id : string
-
(required)
- $page : int
-
Optional page index in sent email tracking pixel list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in sent email tracking pixel list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $search_filter : string = null
-
Optional search filter (optional)
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getSentEmailTrackingPixels'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSentEmailTrackingPixels'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getSentEmailTrackingPixelsAsyncWithHttpInfo()
Operation getSentEmailTrackingPixelsAsyncWithHttpInfo
public
getSentEmailTrackingPixelsAsyncWithHttpInfo(string $id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getSentEmailTrackingPixels'][0] ]) : PromiseInterface
Parameters
- $id : string
-
(required)
- $page : int
-
Optional page index in sent email tracking pixel list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in sent email tracking pixel list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $search_filter : string = null
-
Optional search filter (optional)
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getSentEmailTrackingPixels'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSentEmailTrackingPixels'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getSentEmailTrackingPixelsRequest()
Create request for operation 'getSentEmailTrackingPixels'
public
getSentEmailTrackingPixelsRequest(string $id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getSentEmailTrackingPixels'][0] ]) : Request
Parameters
- $id : string
-
(required)
- $page : int
-
Optional page index in sent email tracking pixel list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in sent email tracking pixel list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $search_filter : string = null
-
Optional search filter (optional)
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getSentEmailTrackingPixels'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSentEmailTrackingPixels'] to see the possible values for this operation
Tags
Return values
Request —getSentEmailTrackingPixelsWithHttpInfo()
Operation getSentEmailTrackingPixelsWithHttpInfo
public
getSentEmailTrackingPixelsWithHttpInfo(string $id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getSentEmailTrackingPixels'][0] ]) : array<string|int, mixed>
Parameters
- $id : string
-
(required)
- $page : int
-
Optional page index in sent email tracking pixel list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in sent email tracking pixel list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $search_filter : string = null
-
Optional search filter (optional)
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getSentEmailTrackingPixels'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSentEmailTrackingPixels'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\PageTrackingPixelProjection, HTTP status code, HTTP response headers (array of strings)
getSentEmailWithHttpInfo()
Operation getSentEmailWithHttpInfo
public
getSentEmailWithHttpInfo(string $id[, string $contentType = self::contentTypes['getSentEmail'][0] ]) : array<string|int, mixed>
Get sent email receipt
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['getSentEmail'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSentEmail'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\SentEmailDto, HTTP status code, HTTP response headers (array of strings)
getSentOrganizationEmails()
Operation getSentOrganizationEmails
public
getSentOrganizationEmails([string $inbox_id = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getSentOrganizationEmails'][0] ]) : PageSentEmailProjection
Parameters
- $inbox_id : string = null
-
Optional inboxId to filter sender of sent emails by (optional)
- $page : int
-
Optional page index in sent email list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in sent email list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $search_filter : string = null
-
Optional search filter (optional)
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getSentOrganizationEmails'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSentOrganizationEmails'] to see the possible values for this operation
Tags
Return values
PageSentEmailProjection —getSentOrganizationEmailsAsync()
Operation getSentOrganizationEmailsAsync
public
getSentOrganizationEmailsAsync([string $inbox_id = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getSentOrganizationEmails'][0] ]) : PromiseInterface
Parameters
- $inbox_id : string = null
-
Optional inboxId to filter sender of sent emails by (optional)
- $page : int
-
Optional page index in sent email list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in sent email list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $search_filter : string = null
-
Optional search filter (optional)
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getSentOrganizationEmails'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSentOrganizationEmails'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getSentOrganizationEmailsAsyncWithHttpInfo()
Operation getSentOrganizationEmailsAsyncWithHttpInfo
public
getSentOrganizationEmailsAsyncWithHttpInfo([string $inbox_id = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getSentOrganizationEmails'][0] ]) : PromiseInterface
Parameters
- $inbox_id : string = null
-
Optional inboxId to filter sender of sent emails by (optional)
- $page : int
-
Optional page index in sent email list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in sent email list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $search_filter : string = null
-
Optional search filter (optional)
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getSentOrganizationEmails'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSentOrganizationEmails'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getSentOrganizationEmailsRequest()
Create request for operation 'getSentOrganizationEmails'
public
getSentOrganizationEmailsRequest([string $inbox_id = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getSentOrganizationEmails'][0] ]) : Request
Parameters
- $inbox_id : string = null
-
Optional inboxId to filter sender of sent emails by (optional)
- $page : int
-
Optional page index in sent email list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in sent email list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $search_filter : string = null
-
Optional search filter (optional)
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getSentOrganizationEmails'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSentOrganizationEmails'] to see the possible values for this operation
Tags
Return values
Request —getSentOrganizationEmailsWithHttpInfo()
Operation getSentOrganizationEmailsWithHttpInfo
public
getSentOrganizationEmailsWithHttpInfo([string $inbox_id = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getSentOrganizationEmails'][0] ]) : array<string|int, mixed>
Parameters
- $inbox_id : string = null
-
Optional inboxId to filter sender of sent emails by (optional)
- $page : int
-
Optional page index in sent email list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in sent email list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $search_filter : string = null
-
Optional search filter (optional)
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getSentOrganizationEmails'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSentOrganizationEmails'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\PageSentEmailProjection, 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 —waitForDeliveryStatuses()
Operation waitForDeliveryStatuses
public
waitForDeliveryStatuses([string $sent_id = null ][, string $inbox_id = null ][, int $timeout = null ][, int $index = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['waitForDeliveryStatuses'][0] ]) : DeliveryStatusDto
Parameters
- $sent_id : string = null
-
Optional sent email ID filter (optional)
- $inbox_id : string = null
-
Optional inbox ID filter (optional)
- $timeout : int = null
-
Optional timeout milliseconds (optional)
- $index : int = null
-
Zero based index of the delivery status to wait for. If 1 delivery status already and you want to wait for the 2nd pass index=1 (optional)
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['waitForDeliveryStatuses'][0]
-
The value for the Content-Type header. Check self::contentTypes['waitForDeliveryStatuses'] to see the possible values for this operation
Tags
Return values
DeliveryStatusDto —waitForDeliveryStatusesAsync()
Operation waitForDeliveryStatusesAsync
public
waitForDeliveryStatusesAsync([string $sent_id = null ][, string $inbox_id = null ][, int $timeout = null ][, int $index = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['waitForDeliveryStatuses'][0] ]) : PromiseInterface
Parameters
- $sent_id : string = null
-
Optional sent email ID filter (optional)
- $inbox_id : string = null
-
Optional inbox ID filter (optional)
- $timeout : int = null
-
Optional timeout milliseconds (optional)
- $index : int = null
-
Zero based index of the delivery status to wait for. If 1 delivery status already and you want to wait for the 2nd pass index=1 (optional)
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['waitForDeliveryStatuses'][0]
-
The value for the Content-Type header. Check self::contentTypes['waitForDeliveryStatuses'] to see the possible values for this operation
Tags
Return values
PromiseInterface —waitForDeliveryStatusesAsyncWithHttpInfo()
Operation waitForDeliveryStatusesAsyncWithHttpInfo
public
waitForDeliveryStatusesAsyncWithHttpInfo([string $sent_id = null ][, string $inbox_id = null ][, int $timeout = null ][, int $index = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['waitForDeliveryStatuses'][0] ]) : PromiseInterface
Parameters
- $sent_id : string = null
-
Optional sent email ID filter (optional)
- $inbox_id : string = null
-
Optional inbox ID filter (optional)
- $timeout : int = null
-
Optional timeout milliseconds (optional)
- $index : int = null
-
Zero based index of the delivery status to wait for. If 1 delivery status already and you want to wait for the 2nd pass index=1 (optional)
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['waitForDeliveryStatuses'][0]
-
The value for the Content-Type header. Check self::contentTypes['waitForDeliveryStatuses'] to see the possible values for this operation
Tags
Return values
PromiseInterface —waitForDeliveryStatusesRequest()
Create request for operation 'waitForDeliveryStatuses'
public
waitForDeliveryStatusesRequest([string $sent_id = null ][, string $inbox_id = null ][, int $timeout = null ][, int $index = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['waitForDeliveryStatuses'][0] ]) : Request
Parameters
- $sent_id : string = null
-
Optional sent email ID filter (optional)
- $inbox_id : string = null
-
Optional inbox ID filter (optional)
- $timeout : int = null
-
Optional timeout milliseconds (optional)
- $index : int = null
-
Zero based index of the delivery status to wait for. If 1 delivery status already and you want to wait for the 2nd pass index=1 (optional)
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['waitForDeliveryStatuses'][0]
-
The value for the Content-Type header. Check self::contentTypes['waitForDeliveryStatuses'] to see the possible values for this operation
Tags
Return values
Request —waitForDeliveryStatusesWithHttpInfo()
Operation waitForDeliveryStatusesWithHttpInfo
public
waitForDeliveryStatusesWithHttpInfo([string $sent_id = null ][, string $inbox_id = null ][, int $timeout = null ][, int $index = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['waitForDeliveryStatuses'][0] ]) : array<string|int, mixed>
Parameters
- $sent_id : string = null
-
Optional sent email ID filter (optional)
- $inbox_id : string = null
-
Optional inbox ID filter (optional)
- $timeout : int = null
-
Optional timeout milliseconds (optional)
- $index : int = null
-
Zero based index of the delivery status to wait for. If 1 delivery status already and you want to wait for the 2nd pass index=1 (optional)
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['waitForDeliveryStatuses'][0]
-
The value for the Content-Type header. Check self::contentTypes['waitForDeliveryStatuses'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\DeliveryStatusDto, HTTP status code, HTTP response headers (array of strings)
createHttpClientOption()
Create http client option
protected
createHttpClientOption() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —of http client options