AttachmentControllerApi
in package
AttachmentControllerApi Class Doc Comment
Tags
Table of Contents
- contentTypes = ['deleteAllAttachments' => ['application/json'], 'deleteAttachment' => ['application/json'], 'downloadAttachmentAsBase64Encoded' => ['application/json'], 'downloadAttachmentAsBytes' => ['application/json'], 'getAttachment' => ['application/json'], 'getAttachmentInfo' => ['application/json'], 'getAttachments' => ['application/json'], 'uploadAttachment' => ['application/json'], 'uploadAttachmentBytes' => ['application/json'], 'uploadMultipartForm' => ['application/json']]
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- $hostIndex : int
- __construct() : mixed
- deleteAllAttachments() : void
- Operation deleteAllAttachments
- deleteAllAttachmentsAsync() : PromiseInterface
- Operation deleteAllAttachmentsAsync
- deleteAllAttachmentsAsyncWithHttpInfo() : PromiseInterface
- Operation deleteAllAttachmentsAsyncWithHttpInfo
- deleteAllAttachmentsRequest() : Request
- Create request for operation 'deleteAllAttachments'
- deleteAllAttachmentsWithHttpInfo() : array<string|int, mixed>
- Operation deleteAllAttachmentsWithHttpInfo
- deleteAttachment() : void
- Operation deleteAttachment
- deleteAttachmentAsync() : PromiseInterface
- Operation deleteAttachmentAsync
- deleteAttachmentAsyncWithHttpInfo() : PromiseInterface
- Operation deleteAttachmentAsyncWithHttpInfo
- deleteAttachmentRequest() : Request
- Create request for operation 'deleteAttachment'
- deleteAttachmentWithHttpInfo() : array<string|int, mixed>
- Operation deleteAttachmentWithHttpInfo
- downloadAttachmentAsBase64Encoded() : DownloadAttachmentDto
- Operation downloadAttachmentAsBase64Encoded
- downloadAttachmentAsBase64EncodedAsync() : PromiseInterface
- Operation downloadAttachmentAsBase64EncodedAsync
- downloadAttachmentAsBase64EncodedAsyncWithHttpInfo() : PromiseInterface
- Operation downloadAttachmentAsBase64EncodedAsyncWithHttpInfo
- downloadAttachmentAsBase64EncodedRequest() : Request
- Create request for operation 'downloadAttachmentAsBase64Encoded'
- downloadAttachmentAsBase64EncodedWithHttpInfo() : array<string|int, mixed>
- Operation downloadAttachmentAsBase64EncodedWithHttpInfo
- downloadAttachmentAsBytes() : string
- Operation downloadAttachmentAsBytes
- downloadAttachmentAsBytesAsync() : PromiseInterface
- Operation downloadAttachmentAsBytesAsync
- downloadAttachmentAsBytesAsyncWithHttpInfo() : PromiseInterface
- Operation downloadAttachmentAsBytesAsyncWithHttpInfo
- downloadAttachmentAsBytesRequest() : Request
- Create request for operation 'downloadAttachmentAsBytes'
- downloadAttachmentAsBytesWithHttpInfo() : array<string|int, mixed>
- Operation downloadAttachmentAsBytesWithHttpInfo
- getAttachment() : AttachmentEntity
- Operation getAttachment
- getAttachmentAsync() : PromiseInterface
- Operation getAttachmentAsync
- getAttachmentAsyncWithHttpInfo() : PromiseInterface
- Operation getAttachmentAsyncWithHttpInfo
- getAttachmentInfo() : AttachmentMetaData
- Operation getAttachmentInfo
- getAttachmentInfoAsync() : PromiseInterface
- Operation getAttachmentInfoAsync
- getAttachmentInfoAsyncWithHttpInfo() : PromiseInterface
- Operation getAttachmentInfoAsyncWithHttpInfo
- getAttachmentInfoRequest() : Request
- Create request for operation 'getAttachmentInfo'
- getAttachmentInfoWithHttpInfo() : array<string|int, mixed>
- Operation getAttachmentInfoWithHttpInfo
- getAttachmentRequest() : Request
- Create request for operation 'getAttachment'
- getAttachments() : PageAttachmentEntity
- Operation getAttachments
- getAttachmentsAsync() : PromiseInterface
- Operation getAttachmentsAsync
- getAttachmentsAsyncWithHttpInfo() : PromiseInterface
- Operation getAttachmentsAsyncWithHttpInfo
- getAttachmentsRequest() : Request
- Create request for operation 'getAttachments'
- getAttachmentsWithHttpInfo() : array<string|int, mixed>
- Operation getAttachmentsWithHttpInfo
- getAttachmentWithHttpInfo() : array<string|int, mixed>
- Operation getAttachmentWithHttpInfo
- getConfig() : Configuration
- getHostIndex() : int
- Get the host index
- setHostIndex() : void
- Set the host index
- uploadAttachment() : array<string|int, string>
- Operation uploadAttachment
- uploadAttachmentAsync() : PromiseInterface
- Operation uploadAttachmentAsync
- uploadAttachmentAsyncWithHttpInfo() : PromiseInterface
- Operation uploadAttachmentAsyncWithHttpInfo
- uploadAttachmentBytes() : array<string|int, string>
- Operation uploadAttachmentBytes
- uploadAttachmentBytesAsync() : PromiseInterface
- Operation uploadAttachmentBytesAsync
- uploadAttachmentBytesAsyncWithHttpInfo() : PromiseInterface
- Operation uploadAttachmentBytesAsyncWithHttpInfo
- uploadAttachmentBytesRequest() : Request
- Create request for operation 'uploadAttachmentBytes'
- uploadAttachmentBytesWithHttpInfo() : array<string|int, mixed>
- Operation uploadAttachmentBytesWithHttpInfo
- uploadAttachmentRequest() : Request
- Create request for operation 'uploadAttachment'
- uploadAttachmentWithHttpInfo() : array<string|int, mixed>
- Operation uploadAttachmentWithHttpInfo
- uploadMultipartForm() : array<string|int, string>
- Operation uploadMultipartForm
- uploadMultipartFormAsync() : PromiseInterface
- Operation uploadMultipartFormAsync
- uploadMultipartFormAsyncWithHttpInfo() : PromiseInterface
- Operation uploadMultipartFormAsyncWithHttpInfo
- uploadMultipartFormRequest() : Request
- Create request for operation 'uploadMultipartForm'
- uploadMultipartFormWithHttpInfo() : array<string|int, mixed>
- Operation uploadMultipartFormWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
Constants
contentTypes
public
array<string|int, string>
contentTypes
= ['deleteAllAttachments' => ['application/json'], 'deleteAttachment' => ['application/json'], 'downloadAttachmentAsBase64Encoded' => ['application/json'], 'downloadAttachmentAsBytes' => ['application/json'], 'getAttachment' => ['application/json'], 'getAttachmentInfo' => ['application/json'], 'getAttachments' => ['application/json'], 'uploadAttachment' => ['application/json'], 'uploadAttachmentBytes' => ['application/json'], 'uploadMultipartForm' => ['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 —deleteAllAttachments()
Operation deleteAllAttachments
public
deleteAllAttachments([string $contentType = self::contentTypes['deleteAllAttachments'][0] ]) : void
Delete all attachments
Parameters
- $contentType : string = self::contentTypes['deleteAllAttachments'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteAllAttachments'] to see the possible values for this operation
Tags
Return values
void —deleteAllAttachmentsAsync()
Operation deleteAllAttachmentsAsync
public
deleteAllAttachmentsAsync([string $contentType = self::contentTypes['deleteAllAttachments'][0] ]) : PromiseInterface
Delete all attachments
Parameters
- $contentType : string = self::contentTypes['deleteAllAttachments'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteAllAttachments'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteAllAttachmentsAsyncWithHttpInfo()
Operation deleteAllAttachmentsAsyncWithHttpInfo
public
deleteAllAttachmentsAsyncWithHttpInfo([string $contentType = self::contentTypes['deleteAllAttachments'][0] ]) : PromiseInterface
Delete all attachments
Parameters
- $contentType : string = self::contentTypes['deleteAllAttachments'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteAllAttachments'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteAllAttachmentsRequest()
Create request for operation 'deleteAllAttachments'
public
deleteAllAttachmentsRequest([string $contentType = self::contentTypes['deleteAllAttachments'][0] ]) : Request
Parameters
- $contentType : string = self::contentTypes['deleteAllAttachments'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteAllAttachments'] to see the possible values for this operation
Tags
Return values
Request —deleteAllAttachmentsWithHttpInfo()
Operation deleteAllAttachmentsWithHttpInfo
public
deleteAllAttachmentsWithHttpInfo([string $contentType = self::contentTypes['deleteAllAttachments'][0] ]) : array<string|int, mixed>
Delete all attachments
Parameters
- $contentType : string = self::contentTypes['deleteAllAttachments'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteAllAttachments'] 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)
deleteAttachment()
Operation deleteAttachment
public
deleteAttachment(string $attachment_id[, string $contentType = self::contentTypes['deleteAttachment'][0] ]) : void
Delete an attachment
Parameters
- $attachment_id : string
-
ID of attachment (required)
- $contentType : string = self::contentTypes['deleteAttachment'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteAttachment'] to see the possible values for this operation
Tags
Return values
void —deleteAttachmentAsync()
Operation deleteAttachmentAsync
public
deleteAttachmentAsync(string $attachment_id[, string $contentType = self::contentTypes['deleteAttachment'][0] ]) : PromiseInterface
Delete an attachment
Parameters
- $attachment_id : string
-
ID of attachment (required)
- $contentType : string = self::contentTypes['deleteAttachment'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteAttachment'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteAttachmentAsyncWithHttpInfo()
Operation deleteAttachmentAsyncWithHttpInfo
public
deleteAttachmentAsyncWithHttpInfo(string $attachment_id[, string $contentType = self::contentTypes['deleteAttachment'][0] ]) : PromiseInterface
Delete an attachment
Parameters
- $attachment_id : string
-
ID of attachment (required)
- $contentType : string = self::contentTypes['deleteAttachment'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteAttachment'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteAttachmentRequest()
Create request for operation 'deleteAttachment'
public
deleteAttachmentRequest(string $attachment_id[, string $contentType = self::contentTypes['deleteAttachment'][0] ]) : Request
Parameters
- $attachment_id : string
-
ID of attachment (required)
- $contentType : string = self::contentTypes['deleteAttachment'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteAttachment'] to see the possible values for this operation
Tags
Return values
Request —deleteAttachmentWithHttpInfo()
Operation deleteAttachmentWithHttpInfo
public
deleteAttachmentWithHttpInfo(string $attachment_id[, string $contentType = self::contentTypes['deleteAttachment'][0] ]) : array<string|int, mixed>
Delete an attachment
Parameters
- $attachment_id : string
-
ID of attachment (required)
- $contentType : string = self::contentTypes['deleteAttachment'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteAttachment'] 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)
downloadAttachmentAsBase64Encoded()
Operation downloadAttachmentAsBase64Encoded
public
downloadAttachmentAsBase64Encoded(string $attachment_id[, string $contentType = self::contentTypes['downloadAttachmentAsBase64Encoded'][0] ]) : DownloadAttachmentDto
Get email attachment as base64 encoded string as alternative to binary responses. To read the content decode the Base64 encoded contents.
Parameters
- $attachment_id : string
-
ID of attachment (required)
- $contentType : string = self::contentTypes['downloadAttachmentAsBase64Encoded'][0]
-
The value for the Content-Type header. Check self::contentTypes['downloadAttachmentAsBase64Encoded'] to see the possible values for this operation
Tags
Return values
DownloadAttachmentDto —downloadAttachmentAsBase64EncodedAsync()
Operation downloadAttachmentAsBase64EncodedAsync
public
downloadAttachmentAsBase64EncodedAsync(string $attachment_id[, string $contentType = self::contentTypes['downloadAttachmentAsBase64Encoded'][0] ]) : PromiseInterface
Get email attachment as base64 encoded string as alternative to binary responses. To read the content decode the Base64 encoded contents.
Parameters
- $attachment_id : string
-
ID of attachment (required)
- $contentType : string = self::contentTypes['downloadAttachmentAsBase64Encoded'][0]
-
The value for the Content-Type header. Check self::contentTypes['downloadAttachmentAsBase64Encoded'] to see the possible values for this operation
Tags
Return values
PromiseInterface —downloadAttachmentAsBase64EncodedAsyncWithHttpInfo()
Operation downloadAttachmentAsBase64EncodedAsyncWithHttpInfo
public
downloadAttachmentAsBase64EncodedAsyncWithHttpInfo(string $attachment_id[, string $contentType = self::contentTypes['downloadAttachmentAsBase64Encoded'][0] ]) : PromiseInterface
Get email attachment as base64 encoded string as alternative to binary responses. To read the content decode the Base64 encoded contents.
Parameters
- $attachment_id : string
-
ID of attachment (required)
- $contentType : string = self::contentTypes['downloadAttachmentAsBase64Encoded'][0]
-
The value for the Content-Type header. Check self::contentTypes['downloadAttachmentAsBase64Encoded'] to see the possible values for this operation
Tags
Return values
PromiseInterface —downloadAttachmentAsBase64EncodedRequest()
Create request for operation 'downloadAttachmentAsBase64Encoded'
public
downloadAttachmentAsBase64EncodedRequest(string $attachment_id[, string $contentType = self::contentTypes['downloadAttachmentAsBase64Encoded'][0] ]) : Request
Parameters
- $attachment_id : string
-
ID of attachment (required)
- $contentType : string = self::contentTypes['downloadAttachmentAsBase64Encoded'][0]
-
The value for the Content-Type header. Check self::contentTypes['downloadAttachmentAsBase64Encoded'] to see the possible values for this operation
Tags
Return values
Request —downloadAttachmentAsBase64EncodedWithHttpInfo()
Operation downloadAttachmentAsBase64EncodedWithHttpInfo
public
downloadAttachmentAsBase64EncodedWithHttpInfo(string $attachment_id[, string $contentType = self::contentTypes['downloadAttachmentAsBase64Encoded'][0] ]) : array<string|int, mixed>
Get email attachment as base64 encoded string as alternative to binary responses. To read the content decode the Base64 encoded contents.
Parameters
- $attachment_id : string
-
ID of attachment (required)
- $contentType : string = self::contentTypes['downloadAttachmentAsBase64Encoded'][0]
-
The value for the Content-Type header. Check self::contentTypes['downloadAttachmentAsBase64Encoded'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\DownloadAttachmentDto, HTTP status code, HTTP response headers (array of strings)
downloadAttachmentAsBytes()
Operation downloadAttachmentAsBytes
public
downloadAttachmentAsBytes(string $attachment_id[, string $contentType = self::contentTypes['downloadAttachmentAsBytes'][0] ]) : string
Download attachments. Get email attachment bytes. If you have trouble with byte responses try the `downloadAttachmentBase64` response endpoints.
Parameters
- $attachment_id : string
-
ID of attachment (required)
- $contentType : string = self::contentTypes['downloadAttachmentAsBytes'][0]
-
The value for the Content-Type header. Check self::contentTypes['downloadAttachmentAsBytes'] to see the possible values for this operation
Tags
Return values
string —downloadAttachmentAsBytesAsync()
Operation downloadAttachmentAsBytesAsync
public
downloadAttachmentAsBytesAsync(string $attachment_id[, string $contentType = self::contentTypes['downloadAttachmentAsBytes'][0] ]) : PromiseInterface
Download attachments. Get email attachment bytes. If you have trouble with byte responses try the `downloadAttachmentBase64` response endpoints.
Parameters
- $attachment_id : string
-
ID of attachment (required)
- $contentType : string = self::contentTypes['downloadAttachmentAsBytes'][0]
-
The value for the Content-Type header. Check self::contentTypes['downloadAttachmentAsBytes'] to see the possible values for this operation
Tags
Return values
PromiseInterface —downloadAttachmentAsBytesAsyncWithHttpInfo()
Operation downloadAttachmentAsBytesAsyncWithHttpInfo
public
downloadAttachmentAsBytesAsyncWithHttpInfo(string $attachment_id[, string $contentType = self::contentTypes['downloadAttachmentAsBytes'][0] ]) : PromiseInterface
Download attachments. Get email attachment bytes. If you have trouble with byte responses try the `downloadAttachmentBase64` response endpoints.
Parameters
- $attachment_id : string
-
ID of attachment (required)
- $contentType : string = self::contentTypes['downloadAttachmentAsBytes'][0]
-
The value for the Content-Type header. Check self::contentTypes['downloadAttachmentAsBytes'] to see the possible values for this operation
Tags
Return values
PromiseInterface —downloadAttachmentAsBytesRequest()
Create request for operation 'downloadAttachmentAsBytes'
public
downloadAttachmentAsBytesRequest(string $attachment_id[, string $contentType = self::contentTypes['downloadAttachmentAsBytes'][0] ]) : Request
Parameters
- $attachment_id : string
-
ID of attachment (required)
- $contentType : string = self::contentTypes['downloadAttachmentAsBytes'][0]
-
The value for the Content-Type header. Check self::contentTypes['downloadAttachmentAsBytes'] to see the possible values for this operation
Tags
Return values
Request —downloadAttachmentAsBytesWithHttpInfo()
Operation downloadAttachmentAsBytesWithHttpInfo
public
downloadAttachmentAsBytesWithHttpInfo(string $attachment_id[, string $contentType = self::contentTypes['downloadAttachmentAsBytes'][0] ]) : array<string|int, mixed>
Download attachments. Get email attachment bytes. If you have trouble with byte responses try the `downloadAttachmentBase64` response endpoints.
Parameters
- $attachment_id : string
-
ID of attachment (required)
- $contentType : string = self::contentTypes['downloadAttachmentAsBytes'][0]
-
The value for the Content-Type header. Check self::contentTypes['downloadAttachmentAsBytes'] 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)
getAttachment()
Operation getAttachment
public
getAttachment(string $attachment_id[, string $contentType = self::contentTypes['getAttachment'][0] ]) : AttachmentEntity
Get an attachment entity
Parameters
- $attachment_id : string
-
ID of attachment (required)
- $contentType : string = self::contentTypes['getAttachment'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAttachment'] to see the possible values for this operation
Tags
Return values
AttachmentEntity —getAttachmentAsync()
Operation getAttachmentAsync
public
getAttachmentAsync(string $attachment_id[, string $contentType = self::contentTypes['getAttachment'][0] ]) : PromiseInterface
Get an attachment entity
Parameters
- $attachment_id : string
-
ID of attachment (required)
- $contentType : string = self::contentTypes['getAttachment'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAttachment'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getAttachmentAsyncWithHttpInfo()
Operation getAttachmentAsyncWithHttpInfo
public
getAttachmentAsyncWithHttpInfo(string $attachment_id[, string $contentType = self::contentTypes['getAttachment'][0] ]) : PromiseInterface
Get an attachment entity
Parameters
- $attachment_id : string
-
ID of attachment (required)
- $contentType : string = self::contentTypes['getAttachment'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAttachment'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getAttachmentInfo()
Operation getAttachmentInfo
public
getAttachmentInfo(string $attachment_id[, string $contentType = self::contentTypes['getAttachmentInfo'][0] ]) : AttachmentMetaData
Get email attachment metadata information
Parameters
- $attachment_id : string
-
ID of attachment (required)
- $contentType : string = self::contentTypes['getAttachmentInfo'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAttachmentInfo'] to see the possible values for this operation
Tags
Return values
AttachmentMetaData —getAttachmentInfoAsync()
Operation getAttachmentInfoAsync
public
getAttachmentInfoAsync(string $attachment_id[, string $contentType = self::contentTypes['getAttachmentInfo'][0] ]) : PromiseInterface
Get email attachment metadata information
Parameters
- $attachment_id : string
-
ID of attachment (required)
- $contentType : string = self::contentTypes['getAttachmentInfo'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAttachmentInfo'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getAttachmentInfoAsyncWithHttpInfo()
Operation getAttachmentInfoAsyncWithHttpInfo
public
getAttachmentInfoAsyncWithHttpInfo(string $attachment_id[, string $contentType = self::contentTypes['getAttachmentInfo'][0] ]) : PromiseInterface
Get email attachment metadata information
Parameters
- $attachment_id : string
-
ID of attachment (required)
- $contentType : string = self::contentTypes['getAttachmentInfo'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAttachmentInfo'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getAttachmentInfoRequest()
Create request for operation 'getAttachmentInfo'
public
getAttachmentInfoRequest(string $attachment_id[, string $contentType = self::contentTypes['getAttachmentInfo'][0] ]) : Request
Parameters
- $attachment_id : string
-
ID of attachment (required)
- $contentType : string = self::contentTypes['getAttachmentInfo'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAttachmentInfo'] to see the possible values for this operation
Tags
Return values
Request —getAttachmentInfoWithHttpInfo()
Operation getAttachmentInfoWithHttpInfo
public
getAttachmentInfoWithHttpInfo(string $attachment_id[, string $contentType = self::contentTypes['getAttachmentInfo'][0] ]) : array<string|int, mixed>
Get email attachment metadata information
Parameters
- $attachment_id : string
-
ID of attachment (required)
- $contentType : string = self::contentTypes['getAttachmentInfo'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAttachmentInfo'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\AttachmentMetaData, HTTP status code, HTTP response headers (array of strings)
getAttachmentRequest()
Create request for operation 'getAttachment'
public
getAttachmentRequest(string $attachment_id[, string $contentType = self::contentTypes['getAttachment'][0] ]) : Request
Parameters
- $attachment_id : string
-
ID of attachment (required)
- $contentType : string = self::contentTypes['getAttachment'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAttachment'] to see the possible values for this operation
Tags
Return values
Request —getAttachments()
Operation getAttachments
public
getAttachments(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $file_name_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $inbox_id = null ][, string $contentType = self::contentTypes['getAttachments'][0] ]) : PageAttachmentEntity
Get email attachments
Parameters
- $page : int
-
Optional page index for list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size for list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $file_name_filter : string = null
-
Optional file name and content type 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)
- $inbox_id : string = null
-
Optional inboxId to filter attachments by (optional)
- $contentType : string = self::contentTypes['getAttachments'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAttachments'] to see the possible values for this operation
Tags
Return values
PageAttachmentEntity —getAttachmentsAsync()
Operation getAttachmentsAsync
public
getAttachmentsAsync(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $file_name_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $inbox_id = null ][, string $contentType = self::contentTypes['getAttachments'][0] ]) : PromiseInterface
Get email attachments
Parameters
- $page : int
-
Optional page index for list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size for list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $file_name_filter : string = null
-
Optional file name and content type 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)
- $inbox_id : string = null
-
Optional inboxId to filter attachments by (optional)
- $contentType : string = self::contentTypes['getAttachments'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAttachments'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getAttachmentsAsyncWithHttpInfo()
Operation getAttachmentsAsyncWithHttpInfo
public
getAttachmentsAsyncWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $file_name_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $inbox_id = null ][, string $contentType = self::contentTypes['getAttachments'][0] ]) : PromiseInterface
Get email attachments
Parameters
- $page : int
-
Optional page index for list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size for list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $file_name_filter : string = null
-
Optional file name and content type 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)
- $inbox_id : string = null
-
Optional inboxId to filter attachments by (optional)
- $contentType : string = self::contentTypes['getAttachments'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAttachments'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getAttachmentsRequest()
Create request for operation 'getAttachments'
public
getAttachmentsRequest(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $file_name_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $inbox_id = null ][, string $contentType = self::contentTypes['getAttachments'][0] ]) : Request
Parameters
- $page : int
-
Optional page index for list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size for list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $file_name_filter : string = null
-
Optional file name and content type 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)
- $inbox_id : string = null
-
Optional inboxId to filter attachments by (optional)
- $contentType : string = self::contentTypes['getAttachments'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAttachments'] to see the possible values for this operation
Tags
Return values
Request —getAttachmentsWithHttpInfo()
Operation getAttachmentsWithHttpInfo
public
getAttachmentsWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $file_name_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $inbox_id = null ][, string $contentType = self::contentTypes['getAttachments'][0] ]) : array<string|int, mixed>
Get email attachments
Parameters
- $page : int
-
Optional page index for list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size for list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $file_name_filter : string = null
-
Optional file name and content type 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)
- $inbox_id : string = null
-
Optional inboxId to filter attachments by (optional)
- $contentType : string = self::contentTypes['getAttachments'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAttachments'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\PageAttachmentEntity, HTTP status code, HTTP response headers (array of strings)
getAttachmentWithHttpInfo()
Operation getAttachmentWithHttpInfo
public
getAttachmentWithHttpInfo(string $attachment_id[, string $contentType = self::contentTypes['getAttachment'][0] ]) : array<string|int, mixed>
Get an attachment entity
Parameters
- $attachment_id : string
-
ID of attachment (required)
- $contentType : string = self::contentTypes['getAttachment'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAttachment'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\AttachmentEntity, 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
setHostIndex()
Set the host index
public
setHostIndex(int $hostIndex) : void
Parameters
- $hostIndex : int
-
Host index (required)
Return values
void —uploadAttachment()
Operation uploadAttachment
public
uploadAttachment(UploadAttachmentOptions $upload_attachment_options[, string $contentType = self::contentTypes['uploadAttachment'][0] ]) : array<string|int, string>
Upload an attachment for sending using base64 file encoding. Returns an array whose first element is the ID of the uploaded attachment.
Parameters
- $upload_attachment_options : UploadAttachmentOptions
-
upload_attachment_options (required)
- $contentType : string = self::contentTypes['uploadAttachment'][0]
-
The value for the Content-Type header. Check self::contentTypes['uploadAttachment'] to see the possible values for this operation
Tags
Return values
array<string|int, string> —uploadAttachmentAsync()
Operation uploadAttachmentAsync
public
uploadAttachmentAsync(UploadAttachmentOptions $upload_attachment_options[, string $contentType = self::contentTypes['uploadAttachment'][0] ]) : PromiseInterface
Upload an attachment for sending using base64 file encoding. Returns an array whose first element is the ID of the uploaded attachment.
Parameters
- $upload_attachment_options : UploadAttachmentOptions
-
(required)
- $contentType : string = self::contentTypes['uploadAttachment'][0]
-
The value for the Content-Type header. Check self::contentTypes['uploadAttachment'] to see the possible values for this operation
Tags
Return values
PromiseInterface —uploadAttachmentAsyncWithHttpInfo()
Operation uploadAttachmentAsyncWithHttpInfo
public
uploadAttachmentAsyncWithHttpInfo(UploadAttachmentOptions $upload_attachment_options[, string $contentType = self::contentTypes['uploadAttachment'][0] ]) : PromiseInterface
Upload an attachment for sending using base64 file encoding. Returns an array whose first element is the ID of the uploaded attachment.
Parameters
- $upload_attachment_options : UploadAttachmentOptions
-
(required)
- $contentType : string = self::contentTypes['uploadAttachment'][0]
-
The value for the Content-Type header. Check self::contentTypes['uploadAttachment'] to see the possible values for this operation
Tags
Return values
PromiseInterface —uploadAttachmentBytes()
Operation uploadAttachmentBytes
public
uploadAttachmentBytes([string $content_type = null ][, string $content_type2 = null ][, string $content_id = null ][, string $filename = null ][, string $filename2 = null ][, string $contentType = self::contentTypes['uploadAttachmentBytes'][0] ]) : array<string|int, string>
Upload an attachment for sending using file byte stream input octet stream. Returns an array whose first element is the ID of the uploaded attachment.
Parameters
- $content_type : string = null
-
content_type (optional)
- $content_type2 : string = null
-
Optional contentType for file. For instance `application/pdf` (optional)
- $content_id : string = null
-
Optional content ID (CID) to save upload with (optional)
- $filename : string = null
-
Optional filename to save upload with (optional)
- $filename2 : string = null
-
filename2 (optional)
- $contentType : string = self::contentTypes['uploadAttachmentBytes'][0]
-
The value for the Content-Type header. Check self::contentTypes['uploadAttachmentBytes'] to see the possible values for this operation
Tags
Return values
array<string|int, string> —uploadAttachmentBytesAsync()
Operation uploadAttachmentBytesAsync
public
uploadAttachmentBytesAsync([string $content_type = null ][, string $content_type2 = null ][, string $content_id = null ][, string $filename = null ][, string $filename2 = null ][, string $contentType = self::contentTypes['uploadAttachmentBytes'][0] ]) : PromiseInterface
Upload an attachment for sending using file byte stream input octet stream. Returns an array whose first element is the ID of the uploaded attachment.
Parameters
- $content_type : string = null
-
(optional)
- $content_type2 : string = null
-
Optional contentType for file. For instance `application/pdf` (optional)
- $content_id : string = null
-
Optional content ID (CID) to save upload with (optional)
- $filename : string = null
-
Optional filename to save upload with (optional)
- $filename2 : string = null
-
(optional)
- $contentType : string = self::contentTypes['uploadAttachmentBytes'][0]
-
The value for the Content-Type header. Check self::contentTypes['uploadAttachmentBytes'] to see the possible values for this operation
Tags
Return values
PromiseInterface —uploadAttachmentBytesAsyncWithHttpInfo()
Operation uploadAttachmentBytesAsyncWithHttpInfo
public
uploadAttachmentBytesAsyncWithHttpInfo([string $content_type = null ][, string $content_type2 = null ][, string $content_id = null ][, string $filename = null ][, string $filename2 = null ][, string $contentType = self::contentTypes['uploadAttachmentBytes'][0] ]) : PromiseInterface
Upload an attachment for sending using file byte stream input octet stream. Returns an array whose first element is the ID of the uploaded attachment.
Parameters
- $content_type : string = null
-
(optional)
- $content_type2 : string = null
-
Optional contentType for file. For instance `application/pdf` (optional)
- $content_id : string = null
-
Optional content ID (CID) to save upload with (optional)
- $filename : string = null
-
Optional filename to save upload with (optional)
- $filename2 : string = null
-
(optional)
- $contentType : string = self::contentTypes['uploadAttachmentBytes'][0]
-
The value for the Content-Type header. Check self::contentTypes['uploadAttachmentBytes'] to see the possible values for this operation
Tags
Return values
PromiseInterface —uploadAttachmentBytesRequest()
Create request for operation 'uploadAttachmentBytes'
public
uploadAttachmentBytesRequest([string $content_type = null ][, string $content_type2 = null ][, string $content_id = null ][, string $filename = null ][, string $filename2 = null ][, string $contentType = self::contentTypes['uploadAttachmentBytes'][0] ]) : Request
Parameters
- $content_type : string = null
-
(optional)
- $content_type2 : string = null
-
Optional contentType for file. For instance `application/pdf` (optional)
- $content_id : string = null
-
Optional content ID (CID) to save upload with (optional)
- $filename : string = null
-
Optional filename to save upload with (optional)
- $filename2 : string = null
-
(optional)
- $contentType : string = self::contentTypes['uploadAttachmentBytes'][0]
-
The value for the Content-Type header. Check self::contentTypes['uploadAttachmentBytes'] to see the possible values for this operation
Tags
Return values
Request —uploadAttachmentBytesWithHttpInfo()
Operation uploadAttachmentBytesWithHttpInfo
public
uploadAttachmentBytesWithHttpInfo([string $content_type = null ][, string $content_type2 = null ][, string $content_id = null ][, string $filename = null ][, string $filename2 = null ][, string $contentType = self::contentTypes['uploadAttachmentBytes'][0] ]) : array<string|int, mixed>
Upload an attachment for sending using file byte stream input octet stream. Returns an array whose first element is the ID of the uploaded attachment.
Parameters
- $content_type : string = null
-
(optional)
- $content_type2 : string = null
-
Optional contentType for file. For instance `application/pdf` (optional)
- $content_id : string = null
-
Optional content ID (CID) to save upload with (optional)
- $filename : string = null
-
Optional filename to save upload with (optional)
- $filename2 : string = null
-
(optional)
- $contentType : string = self::contentTypes['uploadAttachmentBytes'][0]
-
The value for the Content-Type header. Check self::contentTypes['uploadAttachmentBytes'] 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)
uploadAttachmentRequest()
Create request for operation 'uploadAttachment'
public
uploadAttachmentRequest(UploadAttachmentOptions $upload_attachment_options[, string $contentType = self::contentTypes['uploadAttachment'][0] ]) : Request
Parameters
- $upload_attachment_options : UploadAttachmentOptions
-
(required)
- $contentType : string = self::contentTypes['uploadAttachment'][0]
-
The value for the Content-Type header. Check self::contentTypes['uploadAttachment'] to see the possible values for this operation
Tags
Return values
Request —uploadAttachmentWithHttpInfo()
Operation uploadAttachmentWithHttpInfo
public
uploadAttachmentWithHttpInfo(UploadAttachmentOptions $upload_attachment_options[, string $contentType = self::contentTypes['uploadAttachment'][0] ]) : array<string|int, mixed>
Upload an attachment for sending using base64 file encoding. Returns an array whose first element is the ID of the uploaded attachment.
Parameters
- $upload_attachment_options : UploadAttachmentOptions
-
(required)
- $contentType : string = self::contentTypes['uploadAttachment'][0]
-
The value for the Content-Type header. Check self::contentTypes['uploadAttachment'] 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)
uploadMultipartForm()
Operation uploadMultipartForm
public
uploadMultipartForm([string $content_id = null ][, string $content_type = null ][, string $filename = null ][, string $x_filename = null ][, UploadMultipartFormRequest $upload_multipart_form_request = null ][, string $contentType = self::contentTypes['uploadMultipartForm'][0] ]) : array<string|int, string>
Upload an attachment for sending using a Multipart Form request. Returns an array whose first element is the ID of the uploaded attachment.
Parameters
- $content_id : string = null
-
Optional content ID of attachment (optional)
- $content_type : string = null
-
Optional content type of attachment (optional)
- $filename : string = null
-
Optional name of file (optional)
- $x_filename : string = null
-
Optional content type header of attachment (optional)
- $upload_multipart_form_request : UploadMultipartFormRequest = null
-
upload_multipart_form_request (optional)
- $contentType : string = self::contentTypes['uploadMultipartForm'][0]
-
The value for the Content-Type header. Check self::contentTypes['uploadMultipartForm'] to see the possible values for this operation
Tags
Return values
array<string|int, string> —uploadMultipartFormAsync()
Operation uploadMultipartFormAsync
public
uploadMultipartFormAsync([string $content_id = null ][, string $content_type = null ][, string $filename = null ][, string $x_filename = null ][, UploadMultipartFormRequest $upload_multipart_form_request = null ][, string $contentType = self::contentTypes['uploadMultipartForm'][0] ]) : PromiseInterface
Upload an attachment for sending using a Multipart Form request. Returns an array whose first element is the ID of the uploaded attachment.
Parameters
- $content_id : string = null
-
Optional content ID of attachment (optional)
- $content_type : string = null
-
Optional content type of attachment (optional)
- $filename : string = null
-
Optional name of file (optional)
- $x_filename : string = null
-
Optional content type header of attachment (optional)
- $upload_multipart_form_request : UploadMultipartFormRequest = null
-
(optional)
- $contentType : string = self::contentTypes['uploadMultipartForm'][0]
-
The value for the Content-Type header. Check self::contentTypes['uploadMultipartForm'] to see the possible values for this operation
Tags
Return values
PromiseInterface —uploadMultipartFormAsyncWithHttpInfo()
Operation uploadMultipartFormAsyncWithHttpInfo
public
uploadMultipartFormAsyncWithHttpInfo([string $content_id = null ][, string $content_type = null ][, string $filename = null ][, string $x_filename = null ][, UploadMultipartFormRequest $upload_multipart_form_request = null ][, string $contentType = self::contentTypes['uploadMultipartForm'][0] ]) : PromiseInterface
Upload an attachment for sending using a Multipart Form request. Returns an array whose first element is the ID of the uploaded attachment.
Parameters
- $content_id : string = null
-
Optional content ID of attachment (optional)
- $content_type : string = null
-
Optional content type of attachment (optional)
- $filename : string = null
-
Optional name of file (optional)
- $x_filename : string = null
-
Optional content type header of attachment (optional)
- $upload_multipart_form_request : UploadMultipartFormRequest = null
-
(optional)
- $contentType : string = self::contentTypes['uploadMultipartForm'][0]
-
The value for the Content-Type header. Check self::contentTypes['uploadMultipartForm'] to see the possible values for this operation
Tags
Return values
PromiseInterface —uploadMultipartFormRequest()
Create request for operation 'uploadMultipartForm'
public
uploadMultipartFormRequest([string $content_id = null ][, string $content_type = null ][, string $filename = null ][, string $x_filename = null ][, UploadMultipartFormRequest $upload_multipart_form_request = null ][, string $contentType = self::contentTypes['uploadMultipartForm'][0] ]) : Request
Parameters
- $content_id : string = null
-
Optional content ID of attachment (optional)
- $content_type : string = null
-
Optional content type of attachment (optional)
- $filename : string = null
-
Optional name of file (optional)
- $x_filename : string = null
-
Optional content type header of attachment (optional)
- $upload_multipart_form_request : UploadMultipartFormRequest = null
-
(optional)
- $contentType : string = self::contentTypes['uploadMultipartForm'][0]
-
The value for the Content-Type header. Check self::contentTypes['uploadMultipartForm'] to see the possible values for this operation
Tags
Return values
Request —uploadMultipartFormWithHttpInfo()
Operation uploadMultipartFormWithHttpInfo
public
uploadMultipartFormWithHttpInfo([string $content_id = null ][, string $content_type = null ][, string $filename = null ][, string $x_filename = null ][, UploadMultipartFormRequest $upload_multipart_form_request = null ][, string $contentType = self::contentTypes['uploadMultipartForm'][0] ]) : array<string|int, mixed>
Upload an attachment for sending using a Multipart Form request. Returns an array whose first element is the ID of the uploaded attachment.
Parameters
- $content_id : string = null
-
Optional content ID of attachment (optional)
- $content_type : string = null
-
Optional content type of attachment (optional)
- $filename : string = null
-
Optional name of file (optional)
- $x_filename : string = null
-
Optional content type header of attachment (optional)
- $upload_multipart_form_request : UploadMultipartFormRequest = null
-
(optional)
- $contentType : string = self::contentTypes['uploadMultipartForm'][0]
-
The value for the Content-Type header. Check self::contentTypes['uploadMultipartForm'] 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)
createHttpClientOption()
Create http client option
protected
createHttpClientOption() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —of http client options