module:api/EmailArchiveApi

new module:api/EmailArchiveApi(apiClient)

Source:

api/EmailArchiveApi.js, line 41

Constructs a new EmailArchiveApi.

Parameters:

Name	Type	Description
`apiClient`	module:ApiClient	Optional API client implementation to use, default to `module:ApiClient#instance` if unspecified.

Methods

createBCCEmailArchive(accountId, optsOrCallback, callback)

Source:

api/EmailArchiveApi.js, line 76

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:

Name Type Description

accountId

String

The external account number (int) or account ID Guid.

optsOrCallback

Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties

Name	Type	Description
`bccEmailArchive`	module:model/BccEmailArchive

callback

module:api/EmailArchiveApi~createBCCEmailArchiveCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/BccEmailArchive

deleteBCCEmailArchive(accountId, bccEmailArchiveId, callback)

Source:

api/EmailArchiveApi.js, line 138

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:

Name	Type	Description
`accountId`	String	The external account number (int) or account ID Guid.
`bccEmailArchiveId`	String
`callback`	module:api/EmailArchiveApi~deleteBCCEmailArchiveCallback	The callback function, accepting three arguments: error, data, response

getBCCEmailArchiveHistoryList(accountId, bccEmailArchiveId, optsOrCallback, callback)

Source:

api/EmailArchiveApi.js, line 200

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:

Name Type Description

accountId

String

The external account number (int) or account ID Guid.

bccEmailArchiveId String

optsOrCallback

Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties

Name	Type	Description
`count`	String
`startPosition`	String

callback

module:api/EmailArchiveApi~getBCCEmailArchiveHistoryListCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/BccEmailArchiveHistoryList

getBCCEmailArchiveList(accountId, optsOrCallback, callback)

Source:

api/EmailArchiveApi.js, line 270

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:

Name Type Description

accountId

String

The external account number (int) or account ID Guid.

optsOrCallback

Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties

Name	Type	Description
`count`	String
`startPosition`	String

callback

module:api/EmailArchiveApi~getBCCEmailArchiveListCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/BccEmailArchiveList

Type Definitions

createBCCEmailArchiveCallback(error, data, If)

Source:

api/EmailArchiveApi.js, line 54

(Optional) Callback function to receive the result of the createBCCEmailArchive operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/BccEmailArchive	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

deleteBCCEmailArchiveCallback(error, data, If)

Source:

api/EmailArchiveApi.js, line 120

(Optional) Callback function to receive the result of the deleteBCCEmailArchive operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`		This operation does not return a value.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getBCCEmailArchiveHistoryListCallback(error, data, If)

Source:

api/EmailArchiveApi.js, line 181

(Optional) Callback function to receive the result of the getBCCEmailArchiveHistoryList operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/BccEmailArchiveHistoryList	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getBCCEmailArchiveListCallback(error, data, If)

Source:

api/EmailArchiveApi.js, line 252

(Optional) Callback function to receive the result of the getBCCEmailArchiveList operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/BccEmailArchiveList	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.