ImapControllerApi
in package
ImapControllerApi Class Doc Comment
Tags
Table of Contents
- contentTypes = ['imapServerFetch' => ['application/json'], 'imapServerGet' => ['application/json'], 'imapServerList' => ['application/json'], 'imapServerMailbox' => ['application/json'], 'imapServerSearch' => ['application/json'], 'imapServerStatus' => ['application/json'], 'imapServerUpdateFlags' => ['application/json']]
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- $hostIndex : int
- __construct() : mixed
- getConfig() : Configuration
- getHostIndex() : int
- Get the host index
- imapServerFetch() : ImapServerFetchResult
- Operation imapServerFetch
- imapServerFetchAsync() : PromiseInterface
- Operation imapServerFetchAsync
- imapServerFetchAsyncWithHttpInfo() : PromiseInterface
- Operation imapServerFetchAsyncWithHttpInfo
- imapServerFetchRequest() : Request
- Create request for operation 'imapServerFetch'
- imapServerFetchWithHttpInfo() : array<string|int, mixed>
- Operation imapServerFetchWithHttpInfo
- imapServerGet() : ImapServerGetResult
- Operation imapServerGet
- imapServerGetAsync() : PromiseInterface
- Operation imapServerGetAsync
- imapServerGetAsyncWithHttpInfo() : PromiseInterface
- Operation imapServerGetAsyncWithHttpInfo
- imapServerGetRequest() : Request
- Create request for operation 'imapServerGet'
- imapServerGetWithHttpInfo() : array<string|int, mixed>
- Operation imapServerGetWithHttpInfo
- imapServerList() : ImapServerListResult
- Operation imapServerList
- imapServerListAsync() : PromiseInterface
- Operation imapServerListAsync
- imapServerListAsyncWithHttpInfo() : PromiseInterface
- Operation imapServerListAsyncWithHttpInfo
- imapServerListRequest() : Request
- Create request for operation 'imapServerList'
- imapServerListWithHttpInfo() : array<string|int, mixed>
- Operation imapServerListWithHttpInfo
- imapServerMailbox() : ImapServerMailboxResult
- Operation imapServerMailbox
- imapServerMailboxAsync() : PromiseInterface
- Operation imapServerMailboxAsync
- imapServerMailboxAsyncWithHttpInfo() : PromiseInterface
- Operation imapServerMailboxAsyncWithHttpInfo
- imapServerMailboxRequest() : Request
- Create request for operation 'imapServerMailbox'
- imapServerMailboxWithHttpInfo() : array<string|int, mixed>
- Operation imapServerMailboxWithHttpInfo
- imapServerSearch() : ImapServerSearchResult
- Operation imapServerSearch
- imapServerSearchAsync() : PromiseInterface
- Operation imapServerSearchAsync
- imapServerSearchAsyncWithHttpInfo() : PromiseInterface
- Operation imapServerSearchAsyncWithHttpInfo
- imapServerSearchRequest() : Request
- Create request for operation 'imapServerSearch'
- imapServerSearchWithHttpInfo() : array<string|int, mixed>
- Operation imapServerSearchWithHttpInfo
- imapServerStatus() : ImapServerStatusResult
- Operation imapServerStatus
- imapServerStatusAsync() : PromiseInterface
- Operation imapServerStatusAsync
- imapServerStatusAsyncWithHttpInfo() : PromiseInterface
- Operation imapServerStatusAsyncWithHttpInfo
- imapServerStatusRequest() : Request
- Create request for operation 'imapServerStatus'
- imapServerStatusWithHttpInfo() : array<string|int, mixed>
- Operation imapServerStatusWithHttpInfo
- imapServerUpdateFlags() : void
- Operation imapServerUpdateFlags
- imapServerUpdateFlagsAsync() : PromiseInterface
- Operation imapServerUpdateFlagsAsync
- imapServerUpdateFlagsAsyncWithHttpInfo() : PromiseInterface
- Operation imapServerUpdateFlagsAsyncWithHttpInfo
- imapServerUpdateFlagsRequest() : Request
- Create request for operation 'imapServerUpdateFlags'
- imapServerUpdateFlagsWithHttpInfo() : array<string|int, mixed>
- Operation imapServerUpdateFlagsWithHttpInfo
- setHostIndex() : void
- Set the host index
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
Constants
contentTypes
public
array<string|int, string>
contentTypes
= ['imapServerFetch' => ['application/json'], 'imapServerGet' => ['application/json'], 'imapServerList' => ['application/json'], 'imapServerMailbox' => ['application/json'], 'imapServerSearch' => ['application/json'], 'imapServerStatus' => ['application/json'], 'imapServerUpdateFlags' => ['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 —getConfig()
public
getConfig() : Configuration
Return values
Configuration —getHostIndex()
Get the host index
public
getHostIndex() : int
Return values
int —Host index
imapServerFetch()
Operation imapServerFetch
public
imapServerFetch(int $seq_num[, string $inbox_id = null ][, string $contentType = self::contentTypes['imapServerFetch'][0] ]) : ImapServerFetchResult
Fetch message in an inbox
Parameters
- $seq_num : int
-
seq_num (required)
- $inbox_id : string = null
-
Inbox ID to search (optional)
- $contentType : string = self::contentTypes['imapServerFetch'][0]
-
The value for the Content-Type header. Check self::contentTypes['imapServerFetch'] to see the possible values for this operation
Tags
Return values
ImapServerFetchResult —imapServerFetchAsync()
Operation imapServerFetchAsync
public
imapServerFetchAsync(int $seq_num[, string $inbox_id = null ][, string $contentType = self::contentTypes['imapServerFetch'][0] ]) : PromiseInterface
Fetch message in an inbox
Parameters
- $seq_num : int
-
(required)
- $inbox_id : string = null
-
Inbox ID to search (optional)
- $contentType : string = self::contentTypes['imapServerFetch'][0]
-
The value for the Content-Type header. Check self::contentTypes['imapServerFetch'] to see the possible values for this operation
Tags
Return values
PromiseInterface —imapServerFetchAsyncWithHttpInfo()
Operation imapServerFetchAsyncWithHttpInfo
public
imapServerFetchAsyncWithHttpInfo(int $seq_num[, string $inbox_id = null ][, string $contentType = self::contentTypes['imapServerFetch'][0] ]) : PromiseInterface
Fetch message in an inbox
Parameters
- $seq_num : int
-
(required)
- $inbox_id : string = null
-
Inbox ID to search (optional)
- $contentType : string = self::contentTypes['imapServerFetch'][0]
-
The value for the Content-Type header. Check self::contentTypes['imapServerFetch'] to see the possible values for this operation
Tags
Return values
PromiseInterface —imapServerFetchRequest()
Create request for operation 'imapServerFetch'
public
imapServerFetchRequest(int $seq_num[, string $inbox_id = null ][, string $contentType = self::contentTypes['imapServerFetch'][0] ]) : Request
Parameters
- $seq_num : int
-
(required)
- $inbox_id : string = null
-
Inbox ID to search (optional)
- $contentType : string = self::contentTypes['imapServerFetch'][0]
-
The value for the Content-Type header. Check self::contentTypes['imapServerFetch'] to see the possible values for this operation
Tags
Return values
Request —imapServerFetchWithHttpInfo()
Operation imapServerFetchWithHttpInfo
public
imapServerFetchWithHttpInfo(int $seq_num[, string $inbox_id = null ][, string $contentType = self::contentTypes['imapServerFetch'][0] ]) : array<string|int, mixed>
Fetch message in an inbox
Parameters
- $seq_num : int
-
(required)
- $inbox_id : string = null
-
Inbox ID to search (optional)
- $contentType : string = self::contentTypes['imapServerFetch'][0]
-
The value for the Content-Type header. Check self::contentTypes['imapServerFetch'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\ImapServerFetchResult, HTTP status code, HTTP response headers (array of strings)
imapServerGet()
Operation imapServerGet
public
imapServerGet(string $email_id[, string $inbox_id = null ][, string $contentType = self::contentTypes['imapServerGet'][0] ]) : ImapServerGetResult
Get a message by email ID
Parameters
- $email_id : string
-
Email ID to get (required)
- $inbox_id : string = null
-
Inbox ID to search (optional)
- $contentType : string = self::contentTypes['imapServerGet'][0]
-
The value for the Content-Type header. Check self::contentTypes['imapServerGet'] to see the possible values for this operation
Tags
Return values
ImapServerGetResult —imapServerGetAsync()
Operation imapServerGetAsync
public
imapServerGetAsync(string $email_id[, string $inbox_id = null ][, string $contentType = self::contentTypes['imapServerGet'][0] ]) : PromiseInterface
Get a message by email ID
Parameters
- $email_id : string
-
Email ID to get (required)
- $inbox_id : string = null
-
Inbox ID to search (optional)
- $contentType : string = self::contentTypes['imapServerGet'][0]
-
The value for the Content-Type header. Check self::contentTypes['imapServerGet'] to see the possible values for this operation
Tags
Return values
PromiseInterface —imapServerGetAsyncWithHttpInfo()
Operation imapServerGetAsyncWithHttpInfo
public
imapServerGetAsyncWithHttpInfo(string $email_id[, string $inbox_id = null ][, string $contentType = self::contentTypes['imapServerGet'][0] ]) : PromiseInterface
Get a message by email ID
Parameters
- $email_id : string
-
Email ID to get (required)
- $inbox_id : string = null
-
Inbox ID to search (optional)
- $contentType : string = self::contentTypes['imapServerGet'][0]
-
The value for the Content-Type header. Check self::contentTypes['imapServerGet'] to see the possible values for this operation
Tags
Return values
PromiseInterface —imapServerGetRequest()
Create request for operation 'imapServerGet'
public
imapServerGetRequest(string $email_id[, string $inbox_id = null ][, string $contentType = self::contentTypes['imapServerGet'][0] ]) : Request
Parameters
- $email_id : string
-
Email ID to get (required)
- $inbox_id : string = null
-
Inbox ID to search (optional)
- $contentType : string = self::contentTypes['imapServerGet'][0]
-
The value for the Content-Type header. Check self::contentTypes['imapServerGet'] to see the possible values for this operation
Tags
Return values
Request —imapServerGetWithHttpInfo()
Operation imapServerGetWithHttpInfo
public
imapServerGetWithHttpInfo(string $email_id[, string $inbox_id = null ][, string $contentType = self::contentTypes['imapServerGet'][0] ]) : array<string|int, mixed>
Get a message by email ID
Parameters
- $email_id : string
-
Email ID to get (required)
- $inbox_id : string = null
-
Inbox ID to search (optional)
- $contentType : string = self::contentTypes['imapServerGet'][0]
-
The value for the Content-Type header. Check self::contentTypes['imapServerGet'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\ImapServerGetResult, HTTP status code, HTTP response headers (array of strings)
imapServerList()
Operation imapServerList
public
imapServerList(ImapServerListOptions $imap_server_list_options[, string $inbox_id = null ][, string $contentType = self::contentTypes['imapServerList'][0] ]) : ImapServerListResult
List messages in an inbox
Parameters
- $imap_server_list_options : ImapServerListOptions
-
imap_server_list_options (required)
- $inbox_id : string = null
-
Inbox ID to list (optional)
- $contentType : string = self::contentTypes['imapServerList'][0]
-
The value for the Content-Type header. Check self::contentTypes['imapServerList'] to see the possible values for this operation
Tags
Return values
ImapServerListResult —imapServerListAsync()
Operation imapServerListAsync
public
imapServerListAsync(ImapServerListOptions $imap_server_list_options[, string $inbox_id = null ][, string $contentType = self::contentTypes['imapServerList'][0] ]) : PromiseInterface
List messages in an inbox
Parameters
- $imap_server_list_options : ImapServerListOptions
-
(required)
- $inbox_id : string = null
-
Inbox ID to list (optional)
- $contentType : string = self::contentTypes['imapServerList'][0]
-
The value for the Content-Type header. Check self::contentTypes['imapServerList'] to see the possible values for this operation
Tags
Return values
PromiseInterface —imapServerListAsyncWithHttpInfo()
Operation imapServerListAsyncWithHttpInfo
public
imapServerListAsyncWithHttpInfo(ImapServerListOptions $imap_server_list_options[, string $inbox_id = null ][, string $contentType = self::contentTypes['imapServerList'][0] ]) : PromiseInterface
List messages in an inbox
Parameters
- $imap_server_list_options : ImapServerListOptions
-
(required)
- $inbox_id : string = null
-
Inbox ID to list (optional)
- $contentType : string = self::contentTypes['imapServerList'][0]
-
The value for the Content-Type header. Check self::contentTypes['imapServerList'] to see the possible values for this operation
Tags
Return values
PromiseInterface —imapServerListRequest()
Create request for operation 'imapServerList'
public
imapServerListRequest(ImapServerListOptions $imap_server_list_options[, string $inbox_id = null ][, string $contentType = self::contentTypes['imapServerList'][0] ]) : Request
Parameters
- $imap_server_list_options : ImapServerListOptions
-
(required)
- $inbox_id : string = null
-
Inbox ID to list (optional)
- $contentType : string = self::contentTypes['imapServerList'][0]
-
The value for the Content-Type header. Check self::contentTypes['imapServerList'] to see the possible values for this operation
Tags
Return values
Request —imapServerListWithHttpInfo()
Operation imapServerListWithHttpInfo
public
imapServerListWithHttpInfo(ImapServerListOptions $imap_server_list_options[, string $inbox_id = null ][, string $contentType = self::contentTypes['imapServerList'][0] ]) : array<string|int, mixed>
List messages in an inbox
Parameters
- $imap_server_list_options : ImapServerListOptions
-
(required)
- $inbox_id : string = null
-
Inbox ID to list (optional)
- $contentType : string = self::contentTypes['imapServerList'][0]
-
The value for the Content-Type header. Check self::contentTypes['imapServerList'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\ImapServerListResult, HTTP status code, HTTP response headers (array of strings)
imapServerMailbox()
Operation imapServerMailbox
public
imapServerMailbox(string $name[, string $contentType = self::contentTypes['imapServerMailbox'][0] ]) : ImapServerMailboxResult
Create a new mailbox if possible
Parameters
- $name : string
-
Inbox email address to create (required)
- $contentType : string = self::contentTypes['imapServerMailbox'][0]
-
The value for the Content-Type header. Check self::contentTypes['imapServerMailbox'] to see the possible values for this operation
Tags
Return values
ImapServerMailboxResult —imapServerMailboxAsync()
Operation imapServerMailboxAsync
public
imapServerMailboxAsync(string $name[, string $contentType = self::contentTypes['imapServerMailbox'][0] ]) : PromiseInterface
Create a new mailbox if possible
Parameters
- $name : string
-
Inbox email address to create (required)
- $contentType : string = self::contentTypes['imapServerMailbox'][0]
-
The value for the Content-Type header. Check self::contentTypes['imapServerMailbox'] to see the possible values for this operation
Tags
Return values
PromiseInterface —imapServerMailboxAsyncWithHttpInfo()
Operation imapServerMailboxAsyncWithHttpInfo
public
imapServerMailboxAsyncWithHttpInfo(string $name[, string $contentType = self::contentTypes['imapServerMailbox'][0] ]) : PromiseInterface
Create a new mailbox if possible
Parameters
- $name : string
-
Inbox email address to create (required)
- $contentType : string = self::contentTypes['imapServerMailbox'][0]
-
The value for the Content-Type header. Check self::contentTypes['imapServerMailbox'] to see the possible values for this operation
Tags
Return values
PromiseInterface —imapServerMailboxRequest()
Create request for operation 'imapServerMailbox'
public
imapServerMailboxRequest(string $name[, string $contentType = self::contentTypes['imapServerMailbox'][0] ]) : Request
Parameters
- $name : string
-
Inbox email address to create (required)
- $contentType : string = self::contentTypes['imapServerMailbox'][0]
-
The value for the Content-Type header. Check self::contentTypes['imapServerMailbox'] to see the possible values for this operation
Tags
Return values
Request —imapServerMailboxWithHttpInfo()
Operation imapServerMailboxWithHttpInfo
public
imapServerMailboxWithHttpInfo(string $name[, string $contentType = self::contentTypes['imapServerMailbox'][0] ]) : array<string|int, mixed>
Create a new mailbox if possible
Parameters
- $name : string
-
Inbox email address to create (required)
- $contentType : string = self::contentTypes['imapServerMailbox'][0]
-
The value for the Content-Type header. Check self::contentTypes['imapServerMailbox'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\ImapServerMailboxResult, HTTP status code, HTTP response headers (array of strings)
imapServerSearch()
Operation imapServerSearch
public
imapServerSearch(ImapServerSearchOptions $imap_server_search_options[, string $inbox_id = null ][, string $contentType = self::contentTypes['imapServerSearch'][0] ]) : ImapServerSearchResult
Search messages in an inbox
Parameters
- $imap_server_search_options : ImapServerSearchOptions
-
imap_server_search_options (required)
- $inbox_id : string = null
-
Inbox ID to search (optional)
- $contentType : string = self::contentTypes['imapServerSearch'][0]
-
The value for the Content-Type header. Check self::contentTypes['imapServerSearch'] to see the possible values for this operation
Tags
Return values
ImapServerSearchResult —imapServerSearchAsync()
Operation imapServerSearchAsync
public
imapServerSearchAsync(ImapServerSearchOptions $imap_server_search_options[, string $inbox_id = null ][, string $contentType = self::contentTypes['imapServerSearch'][0] ]) : PromiseInterface
Search messages in an inbox
Parameters
- $imap_server_search_options : ImapServerSearchOptions
-
(required)
- $inbox_id : string = null
-
Inbox ID to search (optional)
- $contentType : string = self::contentTypes['imapServerSearch'][0]
-
The value for the Content-Type header. Check self::contentTypes['imapServerSearch'] to see the possible values for this operation
Tags
Return values
PromiseInterface —imapServerSearchAsyncWithHttpInfo()
Operation imapServerSearchAsyncWithHttpInfo
public
imapServerSearchAsyncWithHttpInfo(ImapServerSearchOptions $imap_server_search_options[, string $inbox_id = null ][, string $contentType = self::contentTypes['imapServerSearch'][0] ]) : PromiseInterface
Search messages in an inbox
Parameters
- $imap_server_search_options : ImapServerSearchOptions
-
(required)
- $inbox_id : string = null
-
Inbox ID to search (optional)
- $contentType : string = self::contentTypes['imapServerSearch'][0]
-
The value for the Content-Type header. Check self::contentTypes['imapServerSearch'] to see the possible values for this operation
Tags
Return values
PromiseInterface —imapServerSearchRequest()
Create request for operation 'imapServerSearch'
public
imapServerSearchRequest(ImapServerSearchOptions $imap_server_search_options[, string $inbox_id = null ][, string $contentType = self::contentTypes['imapServerSearch'][0] ]) : Request
Parameters
- $imap_server_search_options : ImapServerSearchOptions
-
(required)
- $inbox_id : string = null
-
Inbox ID to search (optional)
- $contentType : string = self::contentTypes['imapServerSearch'][0]
-
The value for the Content-Type header. Check self::contentTypes['imapServerSearch'] to see the possible values for this operation
Tags
Return values
Request —imapServerSearchWithHttpInfo()
Operation imapServerSearchWithHttpInfo
public
imapServerSearchWithHttpInfo(ImapServerSearchOptions $imap_server_search_options[, string $inbox_id = null ][, string $contentType = self::contentTypes['imapServerSearch'][0] ]) : array<string|int, mixed>
Search messages in an inbox
Parameters
- $imap_server_search_options : ImapServerSearchOptions
-
(required)
- $inbox_id : string = null
-
Inbox ID to search (optional)
- $contentType : string = self::contentTypes['imapServerSearch'][0]
-
The value for the Content-Type header. Check self::contentTypes['imapServerSearch'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\ImapServerSearchResult, HTTP status code, HTTP response headers (array of strings)
imapServerStatus()
Operation imapServerStatus
public
imapServerStatus(ImapServerStatusOptions $imap_server_status_options[, string $inbox_id = null ][, string $contentType = self::contentTypes['imapServerStatus'][0] ]) : ImapServerStatusResult
Get status for mailbox
Parameters
- $imap_server_status_options : ImapServerStatusOptions
-
imap_server_status_options (required)
- $inbox_id : string = null
-
Inbox ID to list (optional)
- $contentType : string = self::contentTypes['imapServerStatus'][0]
-
The value for the Content-Type header. Check self::contentTypes['imapServerStatus'] to see the possible values for this operation
Tags
Return values
ImapServerStatusResult —imapServerStatusAsync()
Operation imapServerStatusAsync
public
imapServerStatusAsync(ImapServerStatusOptions $imap_server_status_options[, string $inbox_id = null ][, string $contentType = self::contentTypes['imapServerStatus'][0] ]) : PromiseInterface
Get status for mailbox
Parameters
- $imap_server_status_options : ImapServerStatusOptions
-
(required)
- $inbox_id : string = null
-
Inbox ID to list (optional)
- $contentType : string = self::contentTypes['imapServerStatus'][0]
-
The value for the Content-Type header. Check self::contentTypes['imapServerStatus'] to see the possible values for this operation
Tags
Return values
PromiseInterface —imapServerStatusAsyncWithHttpInfo()
Operation imapServerStatusAsyncWithHttpInfo
public
imapServerStatusAsyncWithHttpInfo(ImapServerStatusOptions $imap_server_status_options[, string $inbox_id = null ][, string $contentType = self::contentTypes['imapServerStatus'][0] ]) : PromiseInterface
Get status for mailbox
Parameters
- $imap_server_status_options : ImapServerStatusOptions
-
(required)
- $inbox_id : string = null
-
Inbox ID to list (optional)
- $contentType : string = self::contentTypes['imapServerStatus'][0]
-
The value for the Content-Type header. Check self::contentTypes['imapServerStatus'] to see the possible values for this operation
Tags
Return values
PromiseInterface —imapServerStatusRequest()
Create request for operation 'imapServerStatus'
public
imapServerStatusRequest(ImapServerStatusOptions $imap_server_status_options[, string $inbox_id = null ][, string $contentType = self::contentTypes['imapServerStatus'][0] ]) : Request
Parameters
- $imap_server_status_options : ImapServerStatusOptions
-
(required)
- $inbox_id : string = null
-
Inbox ID to list (optional)
- $contentType : string = self::contentTypes['imapServerStatus'][0]
-
The value for the Content-Type header. Check self::contentTypes['imapServerStatus'] to see the possible values for this operation
Tags
Return values
Request —imapServerStatusWithHttpInfo()
Operation imapServerStatusWithHttpInfo
public
imapServerStatusWithHttpInfo(ImapServerStatusOptions $imap_server_status_options[, string $inbox_id = null ][, string $contentType = self::contentTypes['imapServerStatus'][0] ]) : array<string|int, mixed>
Get status for mailbox
Parameters
- $imap_server_status_options : ImapServerStatusOptions
-
(required)
- $inbox_id : string = null
-
Inbox ID to list (optional)
- $contentType : string = self::contentTypes['imapServerStatus'][0]
-
The value for the Content-Type header. Check self::contentTypes['imapServerStatus'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\ImapServerStatusResult, HTTP status code, HTTP response headers (array of strings)
imapServerUpdateFlags()
Operation imapServerUpdateFlags
public
imapServerUpdateFlags(ImapUpdateFlagsOptions $imap_update_flags_options[, string $inbox_id = null ][, string $contentType = self::contentTypes['imapServerUpdateFlags'][0] ]) : void
Parameters
- $imap_update_flags_options : ImapUpdateFlagsOptions
-
imap_update_flags_options (required)
- $inbox_id : string = null
-
inbox_id (optional)
- $contentType : string = self::contentTypes['imapServerUpdateFlags'][0]
-
The value for the Content-Type header. Check self::contentTypes['imapServerUpdateFlags'] to see the possible values for this operation
Tags
Return values
void —imapServerUpdateFlagsAsync()
Operation imapServerUpdateFlagsAsync
public
imapServerUpdateFlagsAsync(ImapUpdateFlagsOptions $imap_update_flags_options[, string $inbox_id = null ][, string $contentType = self::contentTypes['imapServerUpdateFlags'][0] ]) : PromiseInterface
Parameters
- $imap_update_flags_options : ImapUpdateFlagsOptions
-
(required)
- $inbox_id : string = null
-
(optional)
- $contentType : string = self::contentTypes['imapServerUpdateFlags'][0]
-
The value for the Content-Type header. Check self::contentTypes['imapServerUpdateFlags'] to see the possible values for this operation
Tags
Return values
PromiseInterface —imapServerUpdateFlagsAsyncWithHttpInfo()
Operation imapServerUpdateFlagsAsyncWithHttpInfo
public
imapServerUpdateFlagsAsyncWithHttpInfo(ImapUpdateFlagsOptions $imap_update_flags_options[, string $inbox_id = null ][, string $contentType = self::contentTypes['imapServerUpdateFlags'][0] ]) : PromiseInterface
Parameters
- $imap_update_flags_options : ImapUpdateFlagsOptions
-
(required)
- $inbox_id : string = null
-
(optional)
- $contentType : string = self::contentTypes['imapServerUpdateFlags'][0]
-
The value for the Content-Type header. Check self::contentTypes['imapServerUpdateFlags'] to see the possible values for this operation
Tags
Return values
PromiseInterface —imapServerUpdateFlagsRequest()
Create request for operation 'imapServerUpdateFlags'
public
imapServerUpdateFlagsRequest(ImapUpdateFlagsOptions $imap_update_flags_options[, string $inbox_id = null ][, string $contentType = self::contentTypes['imapServerUpdateFlags'][0] ]) : Request
Parameters
- $imap_update_flags_options : ImapUpdateFlagsOptions
-
(required)
- $inbox_id : string = null
-
(optional)
- $contentType : string = self::contentTypes['imapServerUpdateFlags'][0]
-
The value for the Content-Type header. Check self::contentTypes['imapServerUpdateFlags'] to see the possible values for this operation
Tags
Return values
Request —imapServerUpdateFlagsWithHttpInfo()
Operation imapServerUpdateFlagsWithHttpInfo
public
imapServerUpdateFlagsWithHttpInfo(ImapUpdateFlagsOptions $imap_update_flags_options[, string $inbox_id = null ][, string $contentType = self::contentTypes['imapServerUpdateFlags'][0] ]) : array<string|int, mixed>
Parameters
- $imap_update_flags_options : ImapUpdateFlagsOptions
-
(required)
- $inbox_id : string = null
-
(optional)
- $contentType : string = self::contentTypes['imapServerUpdateFlags'][0]
-
The value for the Content-Type header. Check self::contentTypes['imapServerUpdateFlags'] 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)
setHostIndex()
Set the host index
public
setHostIndex(int $hostIndex) : void
Parameters
- $hostIndex : int
-
Host index (required)
Return values
void —createHttpClientOption()
Create http client option
protected
createHttpClientOption() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —of http client options