Package com.docusign.esign.api

Class EmailArchiveApi

java.lang.Object

com.docusign.esign.api.EmailArchiveApi

public class EmailArchiveApi
extends Object

EmailArchiveApi class.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	EmailArchiveApi.GetBCCEmailArchiveHistoryListOptions	GetBCCEmailArchiveHistoryListOptions Class.
class	EmailArchiveApi.GetBCCEmailArchiveListOptions	GetBCCEmailArchiveListOptions Class.

Constructor Summary

Constructors

Constructor	Description
EmailArchiveApi()	EmailArchiveApi.
EmailArchiveApi(ApiClient apiClient)	EmailArchiveApi.

Method Summary

Modifier and Type	Method	Description
BccEmailArchive	createBCCEmailArchive(String accountId, BccEmailArchive bccEmailArchive)	Creates a blind carbon copy email archive entry.
ApiResponse<BccEmailArchive>	createBCCEmailArchiveWithHttpInfo(String accountId, BccEmailArchive bccEmailArchive)	Creates a blind carbon copy email archive entry This method creates a BCC email archive configuration for an account (adds a BCC email address to the account for archiving the emails that DocuSign generates).
void	deleteBCCEmailArchive(String accountId, String bccEmailArchiveId)	Delete a blind carbon copy email archive for an account..
ApiResponse<Object>	deleteBCCEmailArchiveWithHttpInfo(String accountId, String bccEmailArchiveId)	Delete a blind carbon copy email archive for an account.
ApiClient	getApiClient()	getApiClient Method.
BccEmailArchiveHistoryList	getBCCEmailArchiveHistoryList(String accountId, String bccEmailArchiveId)	Get the blind carbon copy email archive history entries for the specified archive.
BccEmailArchiveHistoryList	getBCCEmailArchiveHistoryList(String accountId, String bccEmailArchiveId, EmailArchiveApi.GetBCCEmailArchiveHistoryListOptions options)	Get the blind carbon copy email archive history entries for the specified archive.
ApiResponse<BccEmailArchiveHistoryList>	getBCCEmailArchiveHistoryListWithHttpInfo(String accountId, String bccEmailArchiveId, EmailArchiveApi.GetBCCEmailArchiveHistoryListOptions options)	Get the blind carbon copy email archive history entries for the specified archive This method returns a specific BCC email archive configuration for an account, as well as the history of changes to the email address.
BccEmailArchiveList	getBCCEmailArchiveList(String accountId)	Get the blind carbon copy email archive entries owned by the specified account.
BccEmailArchiveList	getBCCEmailArchiveList(String accountId, EmailArchiveApi.GetBCCEmailArchiveListOptions options)	Get the blind carbon copy email archive entries owned by the specified account.
ApiResponse<BccEmailArchiveList>	getBCCEmailArchiveListWithHttpInfo(String accountId, EmailArchiveApi.GetBCCEmailArchiveListOptions options)	Get the blind carbon copy email archive entries owned by the specified account This method retrieves all of the BCC email archive configurations associated with an account.
void	setApiClient(ApiClient apiClient)	setApiClient Method.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EmailArchiveApi

public EmailArchiveApi()

EmailArchiveApi.

EmailArchiveApi

public EmailArchiveApi(ApiClient apiClient)

EmailArchiveApi.

Method Detail

getApiClient

public ApiClient getApiClient()

getApiClient Method.

Returns:

ApiClient

setApiClient

public void setApiClient(ApiClient apiClient)

setApiClient Method.

createBCCEmailArchive

public BccEmailArchive createBCCEmailArchive(String accountId,
                                             BccEmailArchive bccEmailArchive)
                                      throws ApiException

Creates a blind carbon copy email archive entry. This method creates a BCC email archive configuration for an account (adds a BCC email address to the account for archiving the emails that DocuSign generates). The only property that you must set in the request body is the BCC email address that you want to use. **Note:** An account can have up to five active and pending email archive addresses combined, but you must use this method to add them to the account one at a time. Each email address is considered a separate BCC email archive configuration.

Parameters:

accountId - The external account number (int) or account ID Guid. (required)

bccEmailArchive - (optional)

Returns:

BccEmailArchive

Throws:

ApiException - if fails to make API call

createBCCEmailArchiveWithHttpInfo

public ApiResponse<BccEmailArchive> createBCCEmailArchiveWithHttpInfo(String accountId,
                                                                      BccEmailArchive bccEmailArchive)
                                                               throws ApiException

Creates a blind carbon copy email archive entry This method creates a BCC email archive configuration for an account (adds a BCC email address to the account for archiving the emails that DocuSign generates). The only property that you must set in the request body is the BCC email address that you want to use. **Note:** An account can have up to five active and pending email archive addresses combined, but you must use this method to add them to the account one at a time. Each email address is considered a separate BCC email archive configuration.

Parameters:

accountId - The external account number (int) or account ID Guid. (required)

bccEmailArchive - (optional)

Returns:

BccEmailArchive

Throws:

ApiException - if fails to make API call

deleteBCCEmailArchive

public void deleteBCCEmailArchive(String accountId,
                                  String bccEmailArchiveId)
                           throws ApiException

Delete a blind carbon copy email archive for an account.. This method deletes a BCC email archive configuration from an account. When you use this method, the status of the BCC email archive configuration switches to `closed` and the BCC email address is no longer used to archive DocuSign-generated email messages.

Parameters:

accountId - The external account number (int) or account ID Guid. (required)

bccEmailArchiveId - (required)

Throws:

ApiException - if fails to make API call

deleteBCCEmailArchiveWithHttpInfo

public ApiResponse<Object> deleteBCCEmailArchiveWithHttpInfo(String accountId,
                                                             String bccEmailArchiveId)
                                                      throws ApiException

Delete a blind carbon copy email archive for an account. This method deletes a BCC email archive configuration from an account. When you use this method, the status of the BCC email archive configuration switches to `closed` and the BCC email address is no longer used to archive DocuSign-generated email messages.

Parameters:

accountId - The external account number (int) or account ID Guid. (required)

bccEmailArchiveId - (required)

Throws:

ApiException - if fails to make API call

getBCCEmailArchiveHistoryList

public BccEmailArchiveHistoryList getBCCEmailArchiveHistoryList(String accountId,
                                                                String bccEmailArchiveId)
                                                         throws ApiException

Get the blind carbon copy email archive history entries for the specified archive. This method returns a specific BCC email archive configuration for an account, as well as the history of changes to the email address.

Parameters:

accountId - The external account number (int) or account ID Guid. (required)

bccEmailArchiveId - (required)

Returns:

BccEmailArchiveHistoryList

Throws:

ApiException

getBCCEmailArchiveHistoryList

public BccEmailArchiveHistoryList getBCCEmailArchiveHistoryList(String accountId,
                                                                String bccEmailArchiveId,
                                                                EmailArchiveApi.GetBCCEmailArchiveHistoryListOptions options)
                                                         throws ApiException

Get the blind carbon copy email archive history entries for the specified archive. This method returns a specific BCC email archive configuration for an account, as well as the history of changes to the email address.

Parameters:

accountId - The external account number (int) or account ID Guid. (required)

bccEmailArchiveId - (required)

options - for modifying the method behavior.

Returns:

BccEmailArchiveHistoryList

Throws:

ApiException - if fails to make API call

getBCCEmailArchiveHistoryListWithHttpInfo

public ApiResponse<BccEmailArchiveHistoryList> getBCCEmailArchiveHistoryListWithHttpInfo(String accountId,
                                                                                         String bccEmailArchiveId,
                                                                                         EmailArchiveApi.GetBCCEmailArchiveHistoryListOptions options)
                                                                                  throws ApiException

Get the blind carbon copy email archive history entries for the specified archive This method returns a specific BCC email archive configuration for an account, as well as the history of changes to the email address.

Parameters:

accountId - The external account number (int) or account ID Guid. (required)

bccEmailArchiveId - (required)

options - for modifying the method behavior.

Returns:

BccEmailArchiveHistoryList

Throws:

ApiException - if fails to make API call

getBCCEmailArchiveList

public BccEmailArchiveList getBCCEmailArchiveList(String accountId)
                                           throws ApiException

Get the blind carbon copy email archive entries owned by the specified account. This method retrieves all of the BCC email archive configurations associated with an account.

Parameters:

accountId - The external account number (int) or account ID Guid. (required)

Returns:

BccEmailArchiveList

Throws:

ApiException

getBCCEmailArchiveList

public BccEmailArchiveList getBCCEmailArchiveList(String accountId,
                                                  EmailArchiveApi.GetBCCEmailArchiveListOptions options)
                                           throws ApiException

Get the blind carbon copy email archive entries owned by the specified account. This method retrieves all of the BCC email archive configurations associated with an account.

Parameters:

accountId - The external account number (int) or account ID Guid. (required)

options - for modifying the method behavior.

Returns:

BccEmailArchiveList

Throws:

ApiException - if fails to make API call

getBCCEmailArchiveListWithHttpInfo

public ApiResponse<BccEmailArchiveList> getBCCEmailArchiveListWithHttpInfo(String accountId,
                                                                           EmailArchiveApi.GetBCCEmailArchiveListOptions options)
                                                                    throws ApiException

Get the blind carbon copy email archive entries owned by the specified account This method retrieves all of the BCC email archive configurations associated with an account.

Parameters:

accountId - The external account number (int) or account ID Guid. (required)

options - for modifying the method behavior.

Returns:

BccEmailArchiveList

Throws:

ApiException - if fails to make API call