DocuSign CSharp Docs
|
Represents a collection of functions to interact with the API endpoints More...
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< BccEmailArchive > | 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. More... | |
async System.Threading.Tasks.Task< BccEmailArchive > | 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. 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 `closed` 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 `closed` 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 `closed` 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 `closed` 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< BccEmailArchiveHistoryList > | 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. More... | |
async 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 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< BccEmailArchiveList > | 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. More... | |
async 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 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< 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< 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... | |
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... | |
Represents a collection of functions to interact with the API endpoints
|
inline |
Initializes a new instance of the EmailArchiveApi class using AplClient object
aplClient | An instance of AplClient |
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
bccEmailArchive | (optional) |
Implements DocuSign.eSign.Api.IEmailArchiveApi.
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
bccEmailArchive | (optional) |
Implements DocuSign.eSign.Api.IEmailArchiveApi.
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
bccEmailArchive | (optional) |
Implements DocuSign.eSign.Api.IEmailArchiveApi.
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
bccEmailArchive | (optional) |
Implements DocuSign.eSign.Api.IEmailArchiveApi.
|
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 `closed` and the BCC email address is no longer used to archive DocuSign-generated email messages.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
bccEmailArchiveId |
Implements DocuSign.eSign.Api.IEmailArchiveApi.
|
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 `closed` and the BCC email address is no longer used to archive DocuSign-generated email messages.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
bccEmailArchiveId |
Implements DocuSign.eSign.Api.IEmailArchiveApi.
|
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 `closed` and the BCC email address is no longer used to archive DocuSign-generated email messages.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
bccEmailArchiveId |
Implements DocuSign.eSign.Api.IEmailArchiveApi.
|
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 `closed` and the BCC email address is no longer used to archive DocuSign-generated email messages.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
bccEmailArchiveId |
Implements DocuSign.eSign.Api.IEmailArchiveApi.
|
inline |
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
bccEmailArchiveId | |
options | Options for modifying the behavior of the function. |
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
bccEmailArchiveId | |
options | Options for modifying the behavior of the function. |
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
bccEmailArchiveId | |
options | Options for modifying the behavior of the function. |
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
bccEmailArchiveId | |
options | Options for modifying the behavior of the function. |
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
options | Options for modifying the behavior of the function. |
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
options | Options for modifying the behavior of the function. |
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
options | Options for modifying the behavior of the function. |
|
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.
DocuSign.eSign.Client.ApiException | Thrown when fails to make API call |
accountId | The external account number (int) or account ID Guid. |
options | Options for modifying the behavior of the function. |
|
getset |
Gets or sets the ApiClient object
An instance of the ApiClient
|
getset |
Provides a factory method hook for the creation of exceptions.