Package com.docusign.esign.api

Class EmailArchiveApi

java.lang.Object

com.docusign.esign.api.EmailArchiveApi

public class EmailArchiveApi
extends Object

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
EmailArchiveApi()
EmailArchiveApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
BccEmailArchive	createBCCEmailArchive(String accountId, BccEmailArchive bccEmailArchive)	Creates a blind carbon copy email archive entry
void	deleteBCCEmailArchive(String accountId, String bccEmailArchiveId)	Delete a blind carbon copy email archive for an account.
ApiClient	getApiClient()
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
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
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

EmailArchiveApi

public EmailArchiveApi()

EmailArchiveApi

public EmailArchiveApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createBCCEmailArchive

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

Creates a blind carbon copy email archive entry

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.

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

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

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

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

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