DocuSign CSharp Docs
Classes | Public Member Functions | Properties | List of all members
DocuSign.eSign.Api.EmailArchiveApi Class Reference

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

Inheritance diagram for DocuSign.eSign.Api.EmailArchiveApi:
DocuSign.eSign.Api.IEmailArchiveApi DocuSign.eSign.Client.IApiAccessor

Classes

class  GetBCCEmailArchiveHistoryListOptions
 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. More...
 
class  GetBCCEmailArchiveListOptions
 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. More...
 

Public Member Functions

 EmailArchiveApi (DocuSignClient aplClient)
 Initializes a new instance of the EmailArchiveApi class using AplClient object More...
 
String GetBasePath ()
 Gets the base path of the API client. More...
 
BccEmailArchive 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. More...
 
ApiResponse< BccEmailArchiveCreateBCCEmailArchiveWithHttpInfo (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. More...
 
async System.Threading.Tasks.Task< BccEmailArchiveCreateBCCEmailArchiveAsync (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. More...
 
async System.Threading.Tasks.Task< ApiResponse< BccEmailArchive > > 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. More...
 
void 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 &#x60;closed&#x60; and the BCC email address is no longer used to archive DocuSign-generated email messages. More...
 
ApiResponse< Object > 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 &#x60;closed&#x60; and the BCC email address is no longer used to archive DocuSign-generated email messages. More...
 
async System.Threading.Tasks.Task 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 &#x60;closed&#x60; and the BCC email address is no longer used to archive DocuSign-generated email messages. More...
 
async System.Threading.Tasks.Task< ApiResponse< Object > > 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 &#x60;closed&#x60; and the BCC email address is no longer used to archive DocuSign-generated email messages. More...
 
BccEmailArchiveHistoryList 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. More...
 
ApiResponse< BccEmailArchiveHistoryListGetBCCEmailArchiveHistoryListWithHttpInfo (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. More...
 
async System.Threading.Tasks.Task< BccEmailArchiveHistoryListGetBCCEmailArchiveHistoryListAsync (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. More...
 
async 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 This method returns a specific BCC email archive configuration for an account, as well as the history of changes to the email address. More...
 
BccEmailArchiveList 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. More...
 
ApiResponse< BccEmailArchiveListGetBCCEmailArchiveListWithHttpInfo (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. More...
 
async System.Threading.Tasks.Task< BccEmailArchiveListGetBCCEmailArchiveListAsync (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. More...
 
async 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 This method retrieves all of the BCC email archive configurations associated with an account. More...
 
- Public Member Functions inherited from DocuSign.eSign.Api.IEmailArchiveApi
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< BccEmailArchiveHistoryListGetBCCEmailArchiveHistoryListWithHttpInfo (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< BccEmailArchiveListGetBCCEmailArchiveListWithHttpInfo (string accountId, EmailArchiveApi.GetBCCEmailArchiveListOptions options=null)
 Get the blind carbon copy email archive entries owned by the specified account More...
 
System.Threading.Tasks.Task< BccEmailArchiveHistoryListGetBCCEmailArchiveHistoryListAsync (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< BccEmailArchiveListGetBCCEmailArchiveListAsync (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...
 

Properties

DocuSignClient ApiClient [get, set]
 Gets or sets the ApiClient object More...
 
DocuSign.eSign.Client.ExceptionFactory ExceptionFactory [get, set]
 Provides a factory method hook for the creation of exceptions. More...
 
- 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

Constructor & Destructor Documentation

◆ EmailArchiveApi()

DocuSign.eSign.Api.EmailArchiveApi.EmailArchiveApi ( DocuSignClient  aplClient)
inline

Initializes a new instance of the EmailArchiveApi class using AplClient object

Parameters
aplClientAn instance of AplClient
Returns

Member Function Documentation

◆ CreateBCCEmailArchive()

BccEmailArchive DocuSign.eSign.Api.EmailArchiveApi.CreateBCCEmailArchive ( string  accountId,
BccEmailArchive  bccEmailArchive = null 
)
inline

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.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
bccEmailArchive(optional)
Returns
BccEmailArchive

Implements DocuSign.eSign.Api.IEmailArchiveApi.

◆ CreateBCCEmailArchiveAsync()

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

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.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
bccEmailArchive(optional)
Returns
Task of BccEmailArchive

Implements DocuSign.eSign.Api.IEmailArchiveApi.

◆ CreateBCCEmailArchiveAsyncWithHttpInfo()

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

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.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
bccEmailArchive(optional)
Returns
Task of ApiResponse (BccEmailArchive)

Implements DocuSign.eSign.Api.IEmailArchiveApi.

◆ CreateBCCEmailArchiveWithHttpInfo()

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

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.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
bccEmailArchive(optional)
Returns
ApiResponse of BccEmailArchive

Implements DocuSign.eSign.Api.IEmailArchiveApi.

◆ DeleteBCCEmailArchive()

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

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 &#x60;closed&#x60; and the BCC email address is no longer used to archive DocuSign-generated email messages.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
bccEmailArchiveId
Returns

Implements DocuSign.eSign.Api.IEmailArchiveApi.

◆ DeleteBCCEmailArchiveAsync()

async System.Threading.Tasks.Task DocuSign.eSign.Api.EmailArchiveApi.DeleteBCCEmailArchiveAsync ( string  accountId,
string  bccEmailArchiveId 
)
inline

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 &#x60;closed&#x60; and the BCC email address is no longer used to archive DocuSign-generated email messages.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
bccEmailArchiveId
Returns
Task of void

Implements DocuSign.eSign.Api.IEmailArchiveApi.

◆ DeleteBCCEmailArchiveAsyncWithHttpInfo()

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

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 &#x60;closed&#x60; and the BCC email address is no longer used to archive DocuSign-generated email messages.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
bccEmailArchiveId
Returns
Task of ApiResponse

Implements DocuSign.eSign.Api.IEmailArchiveApi.

◆ DeleteBCCEmailArchiveWithHttpInfo()

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

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 &#x60;closed&#x60; and the BCC email address is no longer used to archive DocuSign-generated email messages.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
bccEmailArchiveId
Returns
ApiResponse of Object(void)

Implements DocuSign.eSign.Api.IEmailArchiveApi.

◆ GetBasePath()

String DocuSign.eSign.Api.EmailArchiveApi.GetBasePath ( )
inline

Gets the base path of the API client.

The base path

Implements DocuSign.eSign.Client.IApiAccessor.

◆ GetBCCEmailArchiveHistoryList()

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

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.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
bccEmailArchiveId
optionsOptions for modifying the behavior of the function.
Returns
BccEmailArchiveHistoryList

◆ GetBCCEmailArchiveHistoryListAsync()

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

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.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
bccEmailArchiveId
optionsOptions for modifying the behavior of the function.
Returns
Task of BccEmailArchiveHistoryList

◆ GetBCCEmailArchiveHistoryListAsyncWithHttpInfo()

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

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.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
bccEmailArchiveId
optionsOptions for modifying the behavior of the function.
Returns
Task of ApiResponse (BccEmailArchiveHistoryList)

◆ GetBCCEmailArchiveHistoryListWithHttpInfo()

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

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.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
bccEmailArchiveId
optionsOptions for modifying the behavior of the function.
Returns
ApiResponse of BccEmailArchiveHistoryList

◆ GetBCCEmailArchiveList()

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

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.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
optionsOptions for modifying the behavior of the function.
Returns
BccEmailArchiveList

◆ GetBCCEmailArchiveListAsync()

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

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.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
optionsOptions for modifying the behavior of the function.
Returns
Task of BccEmailArchiveList

◆ GetBCCEmailArchiveListAsyncWithHttpInfo()

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

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.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
optionsOptions for modifying the behavior of the function.
Returns
Task of ApiResponse (BccEmailArchiveList)

◆ GetBCCEmailArchiveListWithHttpInfo()

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

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.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
optionsOptions for modifying the behavior of the function.
Returns
ApiResponse of BccEmailArchiveList

Property Documentation

◆ ApiClient

DocuSignClient DocuSign.eSign.Api.EmailArchiveApi.ApiClient
getset

Gets or sets the ApiClient object

An instance of the ApiClient

◆ ExceptionFactory

DocuSign.eSign.Client.ExceptionFactory DocuSign.eSign.Api.EmailArchiveApi.ExceptionFactory
getset

Provides a factory method hook for the creation of exceptions.


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