Represents a collection of functions to interact with the API endpoints More...

Inheritance diagram for DocuSign.eSign.Api.IEmailArchiveApi:

Public Member Functions
BccEmailArchive	CreateBCCEmailArchive (string accountId, BccEmailArchive bccEmailArchive=null)
	Creates a blind carbon copy email archive entry More...

ApiResponse< BccEmailArchive >	CreateBCCEmailArchiveWithHttpInfo (string accountId, BccEmailArchive bccEmailArchive=null)
	Creates a blind carbon copy email archive entry More...

void	DeleteBCCEmailArchive (string accountId, string bccEmailArchiveId)
	Delete a blind carbon copy email archive for an account. More...

ApiResponse< Object >	DeleteBCCEmailArchiveWithHttpInfo (string accountId, string bccEmailArchiveId)
	Delete a blind carbon copy email archive for an account. More...

BccEmailArchiveHistoryList	GetBCCEmailArchiveHistoryList (string accountId, string bccEmailArchiveId, EmailArchiveApi.GetBCCEmailArchiveHistoryListOptions options=null)
	Get the blind carbon copy email archive history entries for the specified archive More...

ApiResponse< BccEmailArchiveHistoryList >	GetBCCEmailArchiveHistoryListWithHttpInfo (string accountId, string bccEmailArchiveId, EmailArchiveApi.GetBCCEmailArchiveHistoryListOptions options=null)
	Get the blind carbon copy email archive history entries for the specified archive More...

BccEmailArchiveList	GetBCCEmailArchiveList (string accountId, EmailArchiveApi.GetBCCEmailArchiveListOptions options=null)
	Get the blind carbon copy email archive entries owned by the specified account More...

ApiResponse< BccEmailArchiveList >	GetBCCEmailArchiveListWithHttpInfo (string accountId, EmailArchiveApi.GetBCCEmailArchiveListOptions options=null)
	Get the blind carbon copy email archive entries owned by the specified account More...

System.Threading.Tasks.Task< BccEmailArchive >	CreateBCCEmailArchiveAsync (string accountId, BccEmailArchive bccEmailArchive=null)
	Creates a blind carbon copy email archive entry More...

System.Threading.Tasks.Task< ApiResponse< BccEmailArchive > >	CreateBCCEmailArchiveAsyncWithHttpInfo (string accountId, BccEmailArchive bccEmailArchive=null)
	Creates a blind carbon copy email archive entry More...

System.Threading.Tasks.Task	DeleteBCCEmailArchiveAsync (string accountId, string bccEmailArchiveId)
	Delete a blind carbon copy email archive for an account. More...

System.Threading.Tasks.Task< ApiResponse< Object > >	DeleteBCCEmailArchiveAsyncWithHttpInfo (string accountId, string bccEmailArchiveId)
	Delete a blind carbon copy email archive for an account. More...

System.Threading.Tasks.Task< BccEmailArchiveHistoryList >	GetBCCEmailArchiveHistoryListAsync (string accountId, string bccEmailArchiveId, EmailArchiveApi.GetBCCEmailArchiveHistoryListOptions options=null)
	Get the blind carbon copy email archive history entries for the specified archive More...

System.Threading.Tasks.Task< ApiResponse< BccEmailArchiveHistoryList > >	GetBCCEmailArchiveHistoryListAsyncWithHttpInfo (string accountId, string bccEmailArchiveId, EmailArchiveApi.GetBCCEmailArchiveHistoryListOptions options=null)
	Get the blind carbon copy email archive history entries for the specified archive More...

System.Threading.Tasks.Task< BccEmailArchiveList >	GetBCCEmailArchiveListAsync (string accountId, EmailArchiveApi.GetBCCEmailArchiveListOptions options=null)
	Get the blind carbon copy email archive entries owned by the specified account More...

System.Threading.Tasks.Task< ApiResponse< BccEmailArchiveList > >	GetBCCEmailArchiveListAsyncWithHttpInfo (string accountId, EmailArchiveApi.GetBCCEmailArchiveListOptions options=null)
	Get the blind carbon copy email archive entries owned by the specified account More...

Public Member Functions inherited from DocuSign.eSign.Client.IApiAccessor
String	GetBasePath ()
	Gets the base path of the API client. More...

Additional Inherited Members
Properties inherited from DocuSign.eSign.Client.IApiAccessor
DocuSignClient	ApiClient `[get, set]`
	Gets or sets the ApiClient object More...

ExceptionFactory	ExceptionFactory `[get, set]`
	Provides a factory method hook for the creation of exceptions. More...

Detailed Description

Represents a collection of functions to interact with the API endpoints

Member Function Documentation

◆ CreateBCCEmailArchive()

BccEmailArchive DocuSign.eSign.Api.IEmailArchiveApi.CreateBCCEmailArchive	(	string	accountId,
		BccEmailArchive	bccEmailArchive = `null`
	)

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.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
bccEmailArchive	(optional)

Returns

Implemented in DocuSign.eSign.Api.EmailArchiveApi.

◆ CreateBCCEmailArchiveAsync()

System.Threading.Tasks.Task<BccEmailArchive> DocuSign.eSign.Api.IEmailArchiveApi.CreateBCCEmailArchiveAsync	(	string	accountId,
		BccEmailArchive	bccEmailArchive = `null`
	)

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.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
bccEmailArchive	(optional)

Returns: Task of BccEmailArchive

Implemented in DocuSign.eSign.Api.EmailArchiveApi.

◆ CreateBCCEmailArchiveAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<BccEmailArchive> > DocuSign.eSign.Api.IEmailArchiveApi.CreateBCCEmailArchiveAsyncWithHttpInfo	(	string	accountId,
		BccEmailArchive	bccEmailArchive = `null`
	)

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.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
bccEmailArchive	(optional)

Returns: Task of ApiResponse (BccEmailArchive)

Implemented in DocuSign.eSign.Api.EmailArchiveApi.

◆ CreateBCCEmailArchiveWithHttpInfo()

ApiResponse<BccEmailArchive> DocuSign.eSign.Api.IEmailArchiveApi.CreateBCCEmailArchiveWithHttpInfo	(	string	accountId,
		BccEmailArchive	bccEmailArchive = `null`
	)

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.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
bccEmailArchive	(optional)

Returns: ApiResponse of

Implemented in DocuSign.eSign.Api.EmailArchiveApi.

◆ DeleteBCCEmailArchive()

void DocuSign.eSign.Api.IEmailArchiveApi.DeleteBCCEmailArchive	(	string	accountId,
		string	bccEmailArchiveId
	)

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.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

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

Returns

Implemented in DocuSign.eSign.Api.EmailArchiveApi.

◆ DeleteBCCEmailArchiveAsync()

System.Threading.Tasks.Task DocuSign.eSign.Api.IEmailArchiveApi.DeleteBCCEmailArchiveAsync	(	string	accountId,
		string	bccEmailArchiveId
	)

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.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

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

Returns: Task of void

Implemented in DocuSign.eSign.Api.EmailArchiveApi.

◆ DeleteBCCEmailArchiveAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<Object> > DocuSign.eSign.Api.IEmailArchiveApi.DeleteBCCEmailArchiveAsyncWithHttpInfo	(	string	accountId,
		string	bccEmailArchiveId
	)

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.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

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

Returns: Task of ApiResponse

Implemented in DocuSign.eSign.Api.EmailArchiveApi.

◆ DeleteBCCEmailArchiveWithHttpInfo()

ApiResponse<Object> DocuSign.eSign.Api.IEmailArchiveApi.DeleteBCCEmailArchiveWithHttpInfo	(	string	accountId,
		string	bccEmailArchiveId
	)

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.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

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

Returns: ApiResponse of Object(void)

Implemented in DocuSign.eSign.Api.EmailArchiveApi.

◆ GetBCCEmailArchiveHistoryList()

BccEmailArchiveHistoryList DocuSign.eSign.Api.IEmailArchiveApi.GetBCCEmailArchiveHistoryList	(	string	accountId,
		string	bccEmailArchiveId,
		EmailArchiveApi.GetBCCEmailArchiveHistoryListOptions	options = `null`
	)

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.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
bccEmailArchiveId
options	Options for modifying the behavior of the function.

Returns

◆ GetBCCEmailArchiveHistoryListAsync()

System.Threading.Tasks.Task<BccEmailArchiveHistoryList> DocuSign.eSign.Api.IEmailArchiveApi.GetBCCEmailArchiveHistoryListAsync	(	string	accountId,
		string	bccEmailArchiveId,
		EmailArchiveApi.GetBCCEmailArchiveHistoryListOptions	options = `null`
	)

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.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
bccEmailArchiveId
options	Options for modifying the behavior of the function.

Returns: Task of BccEmailArchiveHistoryList

◆ GetBCCEmailArchiveHistoryListAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<BccEmailArchiveHistoryList> > DocuSign.eSign.Api.IEmailArchiveApi.GetBCCEmailArchiveHistoryListAsyncWithHttpInfo	(	string	accountId,
		string	bccEmailArchiveId,
		EmailArchiveApi.GetBCCEmailArchiveHistoryListOptions	options = `null`
	)

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.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
bccEmailArchiveId
options	Options for modifying the behavior of the function.

Returns: Task of ApiResponse (BccEmailArchiveHistoryList)

◆ GetBCCEmailArchiveHistoryListWithHttpInfo()

ApiResponse<BccEmailArchiveHistoryList> DocuSign.eSign.Api.IEmailArchiveApi.GetBCCEmailArchiveHistoryListWithHttpInfo	(	string	accountId,
		string	bccEmailArchiveId,
		EmailArchiveApi.GetBCCEmailArchiveHistoryListOptions	options = `null`
	)

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.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
bccEmailArchiveId
options	Options for modifying the behavior of the function.

Returns: ApiResponse of

◆ GetBCCEmailArchiveList()

BccEmailArchiveList DocuSign.eSign.Api.IEmailArchiveApi.GetBCCEmailArchiveList	(	string	accountId,
		EmailArchiveApi.GetBCCEmailArchiveListOptions	options = `null`
	)

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.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
options	Options for modifying the behavior of the function.

Returns

◆ GetBCCEmailArchiveListAsync()

System.Threading.Tasks.Task<BccEmailArchiveList> DocuSign.eSign.Api.IEmailArchiveApi.GetBCCEmailArchiveListAsync	(	string	accountId,
		EmailArchiveApi.GetBCCEmailArchiveListOptions	options = `null`
	)

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.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
options	Options for modifying the behavior of the function.

Returns: Task of BccEmailArchiveList

◆ GetBCCEmailArchiveListAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<BccEmailArchiveList> > DocuSign.eSign.Api.IEmailArchiveApi.GetBCCEmailArchiveListAsyncWithHttpInfo	(	string	accountId,
		EmailArchiveApi.GetBCCEmailArchiveListOptions	options = `null`
	)

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.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
options	Options for modifying the behavior of the function.

Returns: Task of ApiResponse (BccEmailArchiveList)

◆ GetBCCEmailArchiveListWithHttpInfo()

ApiResponse<BccEmailArchiveList> DocuSign.eSign.Api.IEmailArchiveApi.GetBCCEmailArchiveListWithHttpInfo	(	string	accountId,
		EmailArchiveApi.GetBCCEmailArchiveListOptions	options = `null`
	)

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.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
options	Options for modifying the behavior of the function.

Returns: ApiResponse of

The documentation for this interface was generated from the following file:

sdk/src/DocuSign.eSign/Api/EmailArchiveApi.cs

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ CreateBCCEmailArchive()

◆ CreateBCCEmailArchiveAsync()

◆ CreateBCCEmailArchiveAsyncWithHttpInfo()

◆ CreateBCCEmailArchiveWithHttpInfo()

◆ DeleteBCCEmailArchive()

◆ DeleteBCCEmailArchiveAsync()

◆ DeleteBCCEmailArchiveAsyncWithHttpInfo()

◆ DeleteBCCEmailArchiveWithHttpInfo()

◆ GetBCCEmailArchiveHistoryList()

◆ GetBCCEmailArchiveHistoryListAsync()

◆ GetBCCEmailArchiveHistoryListAsyncWithHttpInfo()

◆ GetBCCEmailArchiveHistoryListWithHttpInfo()

◆ GetBCCEmailArchiveList()

◆ GetBCCEmailArchiveListAsync()

◆ GetBCCEmailArchiveListAsyncWithHttpInfo()

◆ GetBCCEmailArchiveListWithHttpInfo()