EmailArchiveApi
in package
EmailArchiveApi Class Doc Comment
Tags
Table of Contents
- $apiClient : ApiClient
- API Client
- __construct() : void
- Constructor
- createBCCEmailArchive() : BccEmailArchive
- Operation createBCCEmailArchive
- createBCCEmailArchiveWithHttpInfo() : array<string|int, mixed>
- Operation createBCCEmailArchiveWithHttpInfo
- deleteBCCEmailArchive() : mixed
- Operation deleteBCCEmailArchive
- deleteBCCEmailArchiveWithHttpInfo() : array<string|int, mixed>
- Operation deleteBCCEmailArchiveWithHttpInfo
- getApiClient() : ApiClient
- Get API client
- getBCCEmailArchiveHistoryList() : BccEmailArchiveHistoryList
- Operation getBCCEmailArchiveHistoryList
- getBCCEmailArchiveHistoryListWithHttpInfo() : array<string|int, mixed>
- Operation getBCCEmailArchiveHistoryListWithHttpInfo
- getBCCEmailArchiveList() : BccEmailArchiveList
- Operation getBCCEmailArchiveList
- getBCCEmailArchiveListWithHttpInfo() : array<string|int, mixed>
- Operation getBCCEmailArchiveListWithHttpInfo
- setApiClient() : self
- Set the API client
- updateResourcePath() : string
- Update $resourcePath with $
Properties
$apiClient
API Client
protected
ApiClient
$apiClient
instance of the ApiClient
Methods
__construct()
Constructor
public
__construct([ApiClient|null $apiClient = null ]) : void
Parameters
- $apiClient : ApiClient|null = null
-
The api client to use
Return values
void —createBCCEmailArchive()
Operation createBCCEmailArchive
public
createBCCEmailArchive(string|null $account_id[, BccEmailArchive $bcc_email_archive = null ]) : BccEmailArchive
Creates a blind carbon copy email archive entry
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $bcc_email_archive : BccEmailArchive = null
-
(optional)
Tags
Return values
BccEmailArchive —createBCCEmailArchiveWithHttpInfo()
Operation createBCCEmailArchiveWithHttpInfo
public
createBCCEmailArchiveWithHttpInfo(string|null $account_id[, BccEmailArchive $bcc_email_archive = null ]) : array<string|int, mixed>
Creates a blind carbon copy email archive entry
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $bcc_email_archive : BccEmailArchive = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\BccEmailArchive, HTTP status code, HTTP response headers (array of strings)
deleteBCCEmailArchive()
Operation deleteBCCEmailArchive
public
deleteBCCEmailArchive(string|null $account_id, string|null $bcc_email_archive_id) : mixed
Delete a blind carbon copy email archive for an account.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $bcc_email_archive_id : string|null
Tags
Return values
mixed —deleteBCCEmailArchiveWithHttpInfo()
Operation deleteBCCEmailArchiveWithHttpInfo
public
deleteBCCEmailArchiveWithHttpInfo(string|null $account_id, string|null $bcc_email_archive_id) : array<string|int, mixed>
Delete a blind carbon copy email archive for an account.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $bcc_email_archive_id : string|null
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
getApiClient()
Get API client
public
getApiClient() : ApiClient
Return values
ApiClient —get the API client
getBCCEmailArchiveHistoryList()
Operation getBCCEmailArchiveHistoryList
public
getBCCEmailArchiveHistoryList(string|null $account_id, string|null $bcc_email_archive_id[, GetBCCEmailArchiveHistoryListOptions $options = null ]) : BccEmailArchiveHistoryList
Get the blind carbon copy email archive history entries for the specified archive
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $bcc_email_archive_id : string|null
- $options : GetBCCEmailArchiveHistoryListOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
BccEmailArchiveHistoryList —getBCCEmailArchiveHistoryListWithHttpInfo()
Operation getBCCEmailArchiveHistoryListWithHttpInfo
public
getBCCEmailArchiveHistoryListWithHttpInfo(string|null $account_id, string|null $bcc_email_archive_id[, GetBCCEmailArchiveHistoryListOptions $options = null ]) : array<string|int, mixed>
Get the blind carbon copy email archive history entries for the specified archive
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $bcc_email_archive_id : string|null
- $options : GetBCCEmailArchiveHistoryListOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\BccEmailArchiveHistoryList, HTTP status code, HTTP response headers (array of strings)
getBCCEmailArchiveList()
Operation getBCCEmailArchiveList
public
getBCCEmailArchiveList(string|null $account_id[, GetBCCEmailArchiveListOptions $options = null ]) : BccEmailArchiveList
Get the blind carbon copy email archive entries owned by the specified account
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $options : GetBCCEmailArchiveListOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
BccEmailArchiveList —getBCCEmailArchiveListWithHttpInfo()
Operation getBCCEmailArchiveListWithHttpInfo
public
getBCCEmailArchiveListWithHttpInfo(string|null $account_id[, GetBCCEmailArchiveListOptions $options = null ]) : array<string|int, mixed>
Get the blind carbon copy email archive entries owned by the specified account
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $options : GetBCCEmailArchiveListOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\BccEmailArchiveList, HTTP status code, HTTP response headers (array of strings)
setApiClient()
Set the API client
public
setApiClient(ApiClient $apiClient) : self
Parameters
- $apiClient : ApiClient
-
set the API client
Return values
self —updateResourcePath()
Update $resourcePath with $
public
updateResourcePath(string $resourcePath, string $baseName, string $paramName) : string
Parameters
- $resourcePath : string
-
the resource path to use
- $baseName : string
-
the base name param
- $paramName : string
-
the parameter name