Class ToolsControllerApi
Represents a collection of functions to interact with the API endpoints
Inherited Members
Namespace: mailslurp.Api
Assembly: mailslurp.dll
Syntax
public class ToolsControllerApi : IToolsControllerApi, IToolsControllerApiSync, IToolsControllerApiAsync, IApiAccessor
Constructors
View SourceToolsControllerApi()
Initializes a new instance of the ToolsControllerApi class.
Declaration
public ToolsControllerApi()
ToolsControllerApi(string)
Initializes a new instance of the ToolsControllerApi class.
Declaration
public ToolsControllerApi(string basePath)
Parameters
| Type | Name | Description |
|---|---|---|
| string | basePath |
ToolsControllerApi(Configuration)
Initializes a new instance of the ToolsControllerApi class using Configuration object
Declaration
public ToolsControllerApi(Configuration configuration)
Parameters
| Type | Name | Description |
|---|---|---|
| Configuration | configuration | An instance of Configuration |
ToolsControllerApi(ISynchronousClient, IAsynchronousClient, IReadableConfiguration)
Initializes a new instance of the ToolsControllerApi class using a Configuration object and client instance.
Declaration
public ToolsControllerApi(ISynchronousClient client, IAsynchronousClient asyncClient, IReadableConfiguration configuration)
Parameters
| Type | Name | Description |
|---|---|---|
| ISynchronousClient | client | The client interface for synchronous API access. |
| IAsynchronousClient | asyncClient | The client interface for asynchronous API access. |
| IReadableConfiguration | configuration | The configuration object. |
Properties
View SourceAsynchronousClient
The client for accessing this underlying API asynchronously.
Declaration
public IAsynchronousClient AsynchronousClient { get; set; }
Property Value
| Type | Description |
|---|---|
| IAsynchronousClient |
Client
The client for accessing this underlying API synchronously.
Declaration
public ISynchronousClient Client { get; set; }
Property Value
| Type | Description |
|---|---|
| ISynchronousClient |
Configuration
Gets or sets the configuration object
Declaration
public IReadableConfiguration Configuration { get; set; }
Property Value
| Type | Description |
|---|---|
| IReadableConfiguration | An instance of the Configuration |
ExceptionFactory
Provides a factory method hook for the creation of exceptions.
Declaration
public ExceptionFactory ExceptionFactory { get; set; }
Property Value
| Type | Description |
|---|---|
| ExceptionFactory |
Methods
View SourceAnalyzeDmarcReport(AnalyzeDmarcReportOptions, int)
Parse and summarize a DMARC aggregate XML report
Declaration
public AnalyzeDmarcReportResults AnalyzeDmarcReport(AnalyzeDmarcReportOptions analyzeDmarcReportOptions, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| AnalyzeDmarcReportOptions | analyzeDmarcReportOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| AnalyzeDmarcReportResults | AnalyzeDmarcReportResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
AnalyzeDmarcReportAsync(AnalyzeDmarcReportOptions, int, CancellationToken)
Parse and summarize a DMARC aggregate XML report
Declaration
public Task<AnalyzeDmarcReportResults> AnalyzeDmarcReportAsync(AnalyzeDmarcReportOptions analyzeDmarcReportOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| AnalyzeDmarcReportOptions | analyzeDmarcReportOptions | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<AnalyzeDmarcReportResults> | Task of AnalyzeDmarcReportResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
AnalyzeDmarcReportWithHttpInfo(AnalyzeDmarcReportOptions, int)
Parse and summarize a DMARC aggregate XML report
Declaration
public ApiResponse<AnalyzeDmarcReportResults> AnalyzeDmarcReportWithHttpInfo(AnalyzeDmarcReportOptions analyzeDmarcReportOptions, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| AnalyzeDmarcReportOptions | analyzeDmarcReportOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<AnalyzeDmarcReportResults> | ApiResponse of AnalyzeDmarcReportResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
AnalyzeDmarcReportWithHttpInfoAsync(AnalyzeDmarcReportOptions, int, CancellationToken)
Parse and summarize a DMARC aggregate XML report
Declaration
public Task<ApiResponse<AnalyzeDmarcReportResults>> AnalyzeDmarcReportWithHttpInfoAsync(AnalyzeDmarcReportOptions analyzeDmarcReportOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| AnalyzeDmarcReportOptions | analyzeDmarcReportOptions | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<ApiResponse<AnalyzeDmarcReportResults>> | Task of ApiResponse (AnalyzeDmarcReportResults) |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
AnalyzeEmailHeaders(AnalyzeEmailHeadersOptions, int)
Analyze email headers for auth results and delivery path
Declaration
public AnalyzeEmailHeadersResults AnalyzeEmailHeaders(AnalyzeEmailHeadersOptions analyzeEmailHeadersOptions, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| AnalyzeEmailHeadersOptions | analyzeEmailHeadersOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| AnalyzeEmailHeadersResults | AnalyzeEmailHeadersResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
AnalyzeEmailHeadersAsync(AnalyzeEmailHeadersOptions, int, CancellationToken)
Analyze email headers for auth results and delivery path
Declaration
public Task<AnalyzeEmailHeadersResults> AnalyzeEmailHeadersAsync(AnalyzeEmailHeadersOptions analyzeEmailHeadersOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| AnalyzeEmailHeadersOptions | analyzeEmailHeadersOptions | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<AnalyzeEmailHeadersResults> | Task of AnalyzeEmailHeadersResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
AnalyzeEmailHeadersWithHttpInfo(AnalyzeEmailHeadersOptions, int)
Analyze email headers for auth results and delivery path
Declaration
public ApiResponse<AnalyzeEmailHeadersResults> AnalyzeEmailHeadersWithHttpInfo(AnalyzeEmailHeadersOptions analyzeEmailHeadersOptions, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| AnalyzeEmailHeadersOptions | analyzeEmailHeadersOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<AnalyzeEmailHeadersResults> | ApiResponse of AnalyzeEmailHeadersResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
AnalyzeEmailHeadersWithHttpInfoAsync(AnalyzeEmailHeadersOptions, int, CancellationToken)
Analyze email headers for auth results and delivery path
Declaration
public Task<ApiResponse<AnalyzeEmailHeadersResults>> AnalyzeEmailHeadersWithHttpInfoAsync(AnalyzeEmailHeadersOptions analyzeEmailHeadersOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| AnalyzeEmailHeadersOptions | analyzeEmailHeadersOptions | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<ApiResponse<AnalyzeEmailHeadersResults>> | Task of ApiResponse (AnalyzeEmailHeadersResults) |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
CheckCampaignProbe(CheckCampaignProbeOptions, int)
Run a one-shot free campaign probe preflight check
Declaration
public CheckCampaignProbeResults CheckCampaignProbe(CheckCampaignProbeOptions checkCampaignProbeOptions, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| CheckCampaignProbeOptions | checkCampaignProbeOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| CheckCampaignProbeResults | CheckCampaignProbeResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
CheckCampaignProbeAsync(CheckCampaignProbeOptions, int, CancellationToken)
Run a one-shot free campaign probe preflight check
Declaration
public Task<CheckCampaignProbeResults> CheckCampaignProbeAsync(CheckCampaignProbeOptions checkCampaignProbeOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| CheckCampaignProbeOptions | checkCampaignProbeOptions | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<CheckCampaignProbeResults> | Task of CheckCampaignProbeResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
CheckCampaignProbeWithHttpInfo(CheckCampaignProbeOptions, int)
Run a one-shot free campaign probe preflight check
Declaration
public ApiResponse<CheckCampaignProbeResults> CheckCampaignProbeWithHttpInfo(CheckCampaignProbeOptions checkCampaignProbeOptions, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| CheckCampaignProbeOptions | checkCampaignProbeOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<CheckCampaignProbeResults> | ApiResponse of CheckCampaignProbeResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
CheckCampaignProbeWithHttpInfoAsync(CheckCampaignProbeOptions, int, CancellationToken)
Run a one-shot free campaign probe preflight check
Declaration
public Task<ApiResponse<CheckCampaignProbeResults>> CheckCampaignProbeWithHttpInfoAsync(CheckCampaignProbeOptions checkCampaignProbeOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| CheckCampaignProbeOptions | checkCampaignProbeOptions | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<ApiResponse<CheckCampaignProbeResults>> | Task of ApiResponse (CheckCampaignProbeResults) |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
CheckDnsPropagation(CheckDnsPropagationOptions, int)
Check DNS propagation for a host and record type across configured resolvers
Declaration
public CheckDnsPropagationResults CheckDnsPropagation(CheckDnsPropagationOptions checkDnsPropagationOptions, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| CheckDnsPropagationOptions | checkDnsPropagationOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| CheckDnsPropagationResults | CheckDnsPropagationResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
CheckDnsPropagationAsync(CheckDnsPropagationOptions, int, CancellationToken)
Check DNS propagation for a host and record type across configured resolvers
Declaration
public Task<CheckDnsPropagationResults> CheckDnsPropagationAsync(CheckDnsPropagationOptions checkDnsPropagationOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| CheckDnsPropagationOptions | checkDnsPropagationOptions | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<CheckDnsPropagationResults> | Task of CheckDnsPropagationResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
CheckDnsPropagationWithHttpInfo(CheckDnsPropagationOptions, int)
Check DNS propagation for a host and record type across configured resolvers
Declaration
public ApiResponse<CheckDnsPropagationResults> CheckDnsPropagationWithHttpInfo(CheckDnsPropagationOptions checkDnsPropagationOptions, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| CheckDnsPropagationOptions | checkDnsPropagationOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<CheckDnsPropagationResults> | ApiResponse of CheckDnsPropagationResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
CheckDnsPropagationWithHttpInfoAsync(CheckDnsPropagationOptions, int, CancellationToken)
Check DNS propagation for a host and record type across configured resolvers
Declaration
public Task<ApiResponse<CheckDnsPropagationResults>> CheckDnsPropagationWithHttpInfoAsync(CheckDnsPropagationOptions checkDnsPropagationOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| CheckDnsPropagationOptions | checkDnsPropagationOptions | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<ApiResponse<CheckDnsPropagationResults>> | Task of ApiResponse (CheckDnsPropagationResults) |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
CheckDomainMonitor(CheckDomainMonitorOptions, int)
Run a one-shot free domain monitor posture check
Declaration
public CheckDomainMonitorResults CheckDomainMonitor(CheckDomainMonitorOptions checkDomainMonitorOptions, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| CheckDomainMonitorOptions | checkDomainMonitorOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| CheckDomainMonitorResults | CheckDomainMonitorResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
CheckDomainMonitorAsync(CheckDomainMonitorOptions, int, CancellationToken)
Run a one-shot free domain monitor posture check
Declaration
public Task<CheckDomainMonitorResults> CheckDomainMonitorAsync(CheckDomainMonitorOptions checkDomainMonitorOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| CheckDomainMonitorOptions | checkDomainMonitorOptions | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<CheckDomainMonitorResults> | Task of CheckDomainMonitorResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
CheckDomainMonitorWithHttpInfo(CheckDomainMonitorOptions, int)
Run a one-shot free domain monitor posture check
Declaration
public ApiResponse<CheckDomainMonitorResults> CheckDomainMonitorWithHttpInfo(CheckDomainMonitorOptions checkDomainMonitorOptions, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| CheckDomainMonitorOptions | checkDomainMonitorOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<CheckDomainMonitorResults> | ApiResponse of CheckDomainMonitorResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
CheckDomainMonitorWithHttpInfoAsync(CheckDomainMonitorOptions, int, CancellationToken)
Run a one-shot free domain monitor posture check
Declaration
public Task<ApiResponse<CheckDomainMonitorResults>> CheckDomainMonitorWithHttpInfoAsync(CheckDomainMonitorOptions checkDomainMonitorOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| CheckDomainMonitorOptions | checkDomainMonitorOptions | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<ApiResponse<CheckDomainMonitorResults>> | Task of ApiResponse (CheckDomainMonitorResults) |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
CheckEmailAudit(CheckEmailAuditOptions, int)
Run a one-shot free email audit across links, images, HTML, and client support
Declaration
public EmailAuditAnalysisResult CheckEmailAudit(CheckEmailAuditOptions checkEmailAuditOptions, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| CheckEmailAuditOptions | checkEmailAuditOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| EmailAuditAnalysisResult | EmailAuditAnalysisResult |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
CheckEmailAuditAsync(CheckEmailAuditOptions, int, CancellationToken)
Run a one-shot free email audit across links, images, HTML, and client support
Declaration
public Task<EmailAuditAnalysisResult> CheckEmailAuditAsync(CheckEmailAuditOptions checkEmailAuditOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| CheckEmailAuditOptions | checkEmailAuditOptions | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<EmailAuditAnalysisResult> | Task of EmailAuditAnalysisResult |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
CheckEmailAuditWithHttpInfo(CheckEmailAuditOptions, int)
Run a one-shot free email audit across links, images, HTML, and client support
Declaration
public ApiResponse<EmailAuditAnalysisResult> CheckEmailAuditWithHttpInfo(CheckEmailAuditOptions checkEmailAuditOptions, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| CheckEmailAuditOptions | checkEmailAuditOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<EmailAuditAnalysisResult> | ApiResponse of EmailAuditAnalysisResult |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
CheckEmailAuditWithHttpInfoAsync(CheckEmailAuditOptions, int, CancellationToken)
Run a one-shot free email audit across links, images, HTML, and client support
Declaration
public Task<ApiResponse<EmailAuditAnalysisResult>> CheckEmailAuditWithHttpInfoAsync(CheckEmailAuditOptions checkEmailAuditOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| CheckEmailAuditOptions | checkEmailAuditOptions | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<ApiResponse<EmailAuditAnalysisResult>> | Task of ApiResponse (EmailAuditAnalysisResult) |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
CheckEmailAuthStack(CheckEmailAuthStackOptions, int)
Run a one-shot combined SPF, DKIM, DMARC, BIMI, MX, MTA-STS, and TLS-RPT check
Declaration
public CheckEmailAuthStackResults CheckEmailAuthStack(CheckEmailAuthStackOptions checkEmailAuthStackOptions, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| CheckEmailAuthStackOptions | checkEmailAuthStackOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| CheckEmailAuthStackResults | CheckEmailAuthStackResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
CheckEmailAuthStackAsync(CheckEmailAuthStackOptions, int, CancellationToken)
Run a one-shot combined SPF, DKIM, DMARC, BIMI, MX, MTA-STS, and TLS-RPT check
Declaration
public Task<CheckEmailAuthStackResults> CheckEmailAuthStackAsync(CheckEmailAuthStackOptions checkEmailAuthStackOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| CheckEmailAuthStackOptions | checkEmailAuthStackOptions | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<CheckEmailAuthStackResults> | Task of CheckEmailAuthStackResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
CheckEmailAuthStackWithHttpInfo(CheckEmailAuthStackOptions, int)
Run a one-shot combined SPF, DKIM, DMARC, BIMI, MX, MTA-STS, and TLS-RPT check
Declaration
public ApiResponse<CheckEmailAuthStackResults> CheckEmailAuthStackWithHttpInfo(CheckEmailAuthStackOptions checkEmailAuthStackOptions, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| CheckEmailAuthStackOptions | checkEmailAuthStackOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<CheckEmailAuthStackResults> | ApiResponse of CheckEmailAuthStackResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
CheckEmailAuthStackWithHttpInfoAsync(CheckEmailAuthStackOptions, int, CancellationToken)
Run a one-shot combined SPF, DKIM, DMARC, BIMI, MX, MTA-STS, and TLS-RPT check
Declaration
public Task<ApiResponse<CheckEmailAuthStackResults>> CheckEmailAuthStackWithHttpInfoAsync(CheckEmailAuthStackOptions checkEmailAuthStackOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| CheckEmailAuthStackOptions | checkEmailAuthStackOptions | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<ApiResponse<CheckEmailAuthStackResults>> | Task of ApiResponse (CheckEmailAuthStackResults) |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
CheckEmailBlacklist(CheckEmailBlacklistOptions, int)
Check whether a domain or IP appears on configured DNS blacklists
Declaration
public CheckEmailBlacklistResults CheckEmailBlacklist(CheckEmailBlacklistOptions checkEmailBlacklistOptions, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| CheckEmailBlacklistOptions | checkEmailBlacklistOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| CheckEmailBlacklistResults | CheckEmailBlacklistResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
CheckEmailBlacklistAsync(CheckEmailBlacklistOptions, int, CancellationToken)
Check whether a domain or IP appears on configured DNS blacklists
Declaration
public Task<CheckEmailBlacklistResults> CheckEmailBlacklistAsync(CheckEmailBlacklistOptions checkEmailBlacklistOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| CheckEmailBlacklistOptions | checkEmailBlacklistOptions | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<CheckEmailBlacklistResults> | Task of CheckEmailBlacklistResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
CheckEmailBlacklistWithHttpInfo(CheckEmailBlacklistOptions, int)
Check whether a domain or IP appears on configured DNS blacklists
Declaration
public ApiResponse<CheckEmailBlacklistResults> CheckEmailBlacklistWithHttpInfo(CheckEmailBlacklistOptions checkEmailBlacklistOptions, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| CheckEmailBlacklistOptions | checkEmailBlacklistOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<CheckEmailBlacklistResults> | ApiResponse of CheckEmailBlacklistResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
CheckEmailBlacklistWithHttpInfoAsync(CheckEmailBlacklistOptions, int, CancellationToken)
Check whether a domain or IP appears on configured DNS blacklists
Declaration
public Task<ApiResponse<CheckEmailBlacklistResults>> CheckEmailBlacklistWithHttpInfoAsync(CheckEmailBlacklistOptions checkEmailBlacklistOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| CheckEmailBlacklistOptions | checkEmailBlacklistOptions | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<ApiResponse<CheckEmailBlacklistResults>> | Task of ApiResponse (CheckEmailBlacklistResults) |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
CheckEmailFeaturesClientSupport(CheckEmailFeaturesClientSupportOptions, int)
Check email client support for email HTML and CSS features
Declaration
public CheckEmailFeaturesClientSupportResults CheckEmailFeaturesClientSupport(CheckEmailFeaturesClientSupportOptions checkEmailFeaturesClientSupportOptions, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| CheckEmailFeaturesClientSupportOptions | checkEmailFeaturesClientSupportOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| CheckEmailFeaturesClientSupportResults | CheckEmailFeaturesClientSupportResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
CheckEmailFeaturesClientSupportAsync(CheckEmailFeaturesClientSupportOptions, int, CancellationToken)
Check email client support for email HTML and CSS features
Declaration
public Task<CheckEmailFeaturesClientSupportResults> CheckEmailFeaturesClientSupportAsync(CheckEmailFeaturesClientSupportOptions checkEmailFeaturesClientSupportOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| CheckEmailFeaturesClientSupportOptions | checkEmailFeaturesClientSupportOptions | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<CheckEmailFeaturesClientSupportResults> | Task of CheckEmailFeaturesClientSupportResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
CheckEmailFeaturesClientSupportWithHttpInfo(CheckEmailFeaturesClientSupportOptions, int)
Check email client support for email HTML and CSS features
Declaration
public ApiResponse<CheckEmailFeaturesClientSupportResults> CheckEmailFeaturesClientSupportWithHttpInfo(CheckEmailFeaturesClientSupportOptions checkEmailFeaturesClientSupportOptions, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| CheckEmailFeaturesClientSupportOptions | checkEmailFeaturesClientSupportOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<CheckEmailFeaturesClientSupportResults> | ApiResponse of CheckEmailFeaturesClientSupportResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
CheckEmailFeaturesClientSupportWithHttpInfoAsync(CheckEmailFeaturesClientSupportOptions, int, CancellationToken)
Check email client support for email HTML and CSS features
Declaration
public Task<ApiResponse<CheckEmailFeaturesClientSupportResults>> CheckEmailFeaturesClientSupportWithHttpInfoAsync(CheckEmailFeaturesClientSupportOptions checkEmailFeaturesClientSupportOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| CheckEmailFeaturesClientSupportOptions | checkEmailFeaturesClientSupportOptions | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<ApiResponse<CheckEmailFeaturesClientSupportResults>> | Task of ApiResponse (CheckEmailFeaturesClientSupportResults) |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
CreateNewFakeEmailAddress(int)
Create a new email address using the fake email domains
Declaration
public NewFakeEmailAddressResult CreateNewFakeEmailAddress(int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| NewFakeEmailAddressResult | NewFakeEmailAddressResult |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
CreateNewFakeEmailAddressAsync(int, CancellationToken)
Create a new email address using the fake email domains
Declaration
public Task<NewFakeEmailAddressResult> CreateNewFakeEmailAddressAsync(int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<NewFakeEmailAddressResult> | Task of NewFakeEmailAddressResult |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
CreateNewFakeEmailAddressWithHttpInfo(int)
Create a new email address using the fake email domains
Declaration
public ApiResponse<NewFakeEmailAddressResult> CreateNewFakeEmailAddressWithHttpInfo(int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<NewFakeEmailAddressResult> | ApiResponse of NewFakeEmailAddressResult |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
CreateNewFakeEmailAddressWithHttpInfoAsync(int, CancellationToken)
Create a new email address using the fake email domains
Declaration
public Task<ApiResponse<NewFakeEmailAddressResult>> CreateNewFakeEmailAddressWithHttpInfoAsync(int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<ApiResponse<NewFakeEmailAddressResult>> | Task of ApiResponse (NewFakeEmailAddressResult) |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
DeleteNewFakeEmailAddress(string, int)
Delete a fake email address using the fake email domains Delete a fake email address using the fake email domains
Declaration
public void DeleteNewFakeEmailAddress(string emailAddress, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| string | emailAddress | |
| int | operationIndex | Index associated with the operation. |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
DeleteNewFakeEmailAddressAsync(string, int, CancellationToken)
Delete a fake email address using the fake email domains Delete a fake email address using the fake email domains
Declaration
public Task DeleteNewFakeEmailAddressAsync(string emailAddress, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| string | emailAddress | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task | Task of void |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
DeleteNewFakeEmailAddressWithHttpInfo(string, int)
Delete a fake email address using the fake email domains Delete a fake email address using the fake email domains
Declaration
public ApiResponse<object> DeleteNewFakeEmailAddressWithHttpInfo(string emailAddress, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| string | emailAddress | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<object> | ApiResponse of Object(void) |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
DeleteNewFakeEmailAddressWithHttpInfoAsync(string, int, CancellationToken)
Delete a fake email address using the fake email domains Delete a fake email address using the fake email domains
Declaration
public Task<ApiResponse<object>> DeleteNewFakeEmailAddressWithHttpInfoAsync(string emailAddress, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| string | emailAddress | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<ApiResponse<object>> | Task of ApiResponse |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GenerateBimiRecord(GenerateBimiRecordOptions, int)
Create a BIMI record policy
Declaration
public GenerateBimiRecordResults GenerateBimiRecord(GenerateBimiRecordOptions generateBimiRecordOptions, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| GenerateBimiRecordOptions | generateBimiRecordOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| GenerateBimiRecordResults | GenerateBimiRecordResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GenerateBimiRecordAsync(GenerateBimiRecordOptions, int, CancellationToken)
Create a BIMI record policy
Declaration
public Task<GenerateBimiRecordResults> GenerateBimiRecordAsync(GenerateBimiRecordOptions generateBimiRecordOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| GenerateBimiRecordOptions | generateBimiRecordOptions | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<GenerateBimiRecordResults> | Task of GenerateBimiRecordResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GenerateBimiRecordWithHttpInfo(GenerateBimiRecordOptions, int)
Create a BIMI record policy
Declaration
public ApiResponse<GenerateBimiRecordResults> GenerateBimiRecordWithHttpInfo(GenerateBimiRecordOptions generateBimiRecordOptions, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| GenerateBimiRecordOptions | generateBimiRecordOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<GenerateBimiRecordResults> | ApiResponse of GenerateBimiRecordResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GenerateBimiRecordWithHttpInfoAsync(GenerateBimiRecordOptions, int, CancellationToken)
Create a BIMI record policy
Declaration
public Task<ApiResponse<GenerateBimiRecordResults>> GenerateBimiRecordWithHttpInfoAsync(GenerateBimiRecordOptions generateBimiRecordOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| GenerateBimiRecordOptions | generateBimiRecordOptions | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<ApiResponse<GenerateBimiRecordResults>> | Task of ApiResponse (GenerateBimiRecordResults) |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GenerateDmarcRecord(GenerateDmarcRecordOptions, int)
Create a DMARC record policy
Declaration
public GenerateDmarcRecordResults GenerateDmarcRecord(GenerateDmarcRecordOptions generateDmarcRecordOptions, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| GenerateDmarcRecordOptions | generateDmarcRecordOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| GenerateDmarcRecordResults | GenerateDmarcRecordResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GenerateDmarcRecordAsync(GenerateDmarcRecordOptions, int, CancellationToken)
Create a DMARC record policy
Declaration
public Task<GenerateDmarcRecordResults> GenerateDmarcRecordAsync(GenerateDmarcRecordOptions generateDmarcRecordOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| GenerateDmarcRecordOptions | generateDmarcRecordOptions | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<GenerateDmarcRecordResults> | Task of GenerateDmarcRecordResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GenerateDmarcRecordWithHttpInfo(GenerateDmarcRecordOptions, int)
Create a DMARC record policy
Declaration
public ApiResponse<GenerateDmarcRecordResults> GenerateDmarcRecordWithHttpInfo(GenerateDmarcRecordOptions generateDmarcRecordOptions, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| GenerateDmarcRecordOptions | generateDmarcRecordOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<GenerateDmarcRecordResults> | ApiResponse of GenerateDmarcRecordResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GenerateDmarcRecordWithHttpInfoAsync(GenerateDmarcRecordOptions, int, CancellationToken)
Create a DMARC record policy
Declaration
public Task<ApiResponse<GenerateDmarcRecordResults>> GenerateDmarcRecordWithHttpInfoAsync(GenerateDmarcRecordOptions generateDmarcRecordOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| GenerateDmarcRecordOptions | generateDmarcRecordOptions | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<ApiResponse<GenerateDmarcRecordResults>> | Task of ApiResponse (GenerateDmarcRecordResults) |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GenerateMtaStsRecord(GenerateMtaStsRecordOptions, int)
Create a TLS reporting record policy
Declaration
public GenerateMtaStsRecordResults GenerateMtaStsRecord(GenerateMtaStsRecordOptions generateMtaStsRecordOptions, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| GenerateMtaStsRecordOptions | generateMtaStsRecordOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| GenerateMtaStsRecordResults | GenerateMtaStsRecordResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GenerateMtaStsRecordAsync(GenerateMtaStsRecordOptions, int, CancellationToken)
Create a TLS reporting record policy
Declaration
public Task<GenerateMtaStsRecordResults> GenerateMtaStsRecordAsync(GenerateMtaStsRecordOptions generateMtaStsRecordOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| GenerateMtaStsRecordOptions | generateMtaStsRecordOptions | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<GenerateMtaStsRecordResults> | Task of GenerateMtaStsRecordResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GenerateMtaStsRecordWithHttpInfo(GenerateMtaStsRecordOptions, int)
Create a TLS reporting record policy
Declaration
public ApiResponse<GenerateMtaStsRecordResults> GenerateMtaStsRecordWithHttpInfo(GenerateMtaStsRecordOptions generateMtaStsRecordOptions, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| GenerateMtaStsRecordOptions | generateMtaStsRecordOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<GenerateMtaStsRecordResults> | ApiResponse of GenerateMtaStsRecordResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GenerateMtaStsRecordWithHttpInfoAsync(GenerateMtaStsRecordOptions, int, CancellationToken)
Create a TLS reporting record policy
Declaration
public Task<ApiResponse<GenerateMtaStsRecordResults>> GenerateMtaStsRecordWithHttpInfoAsync(GenerateMtaStsRecordOptions generateMtaStsRecordOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| GenerateMtaStsRecordOptions | generateMtaStsRecordOptions | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<ApiResponse<GenerateMtaStsRecordResults>> | Task of ApiResponse (GenerateMtaStsRecordResults) |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GenerateSpfRecord(GenerateSpfRecordOptions, int)
Create an SPF record
Declaration
public GenerateSpfRecordResults GenerateSpfRecord(GenerateSpfRecordOptions generateSpfRecordOptions, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| GenerateSpfRecordOptions | generateSpfRecordOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| GenerateSpfRecordResults | GenerateSpfRecordResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GenerateSpfRecordAsync(GenerateSpfRecordOptions, int, CancellationToken)
Create an SPF record
Declaration
public Task<GenerateSpfRecordResults> GenerateSpfRecordAsync(GenerateSpfRecordOptions generateSpfRecordOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| GenerateSpfRecordOptions | generateSpfRecordOptions | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<GenerateSpfRecordResults> | Task of GenerateSpfRecordResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GenerateSpfRecordWithHttpInfo(GenerateSpfRecordOptions, int)
Create an SPF record
Declaration
public ApiResponse<GenerateSpfRecordResults> GenerateSpfRecordWithHttpInfo(GenerateSpfRecordOptions generateSpfRecordOptions, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| GenerateSpfRecordOptions | generateSpfRecordOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<GenerateSpfRecordResults> | ApiResponse of GenerateSpfRecordResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GenerateSpfRecordWithHttpInfoAsync(GenerateSpfRecordOptions, int, CancellationToken)
Create an SPF record
Declaration
public Task<ApiResponse<GenerateSpfRecordResults>> GenerateSpfRecordWithHttpInfoAsync(GenerateSpfRecordOptions generateSpfRecordOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| GenerateSpfRecordOptions | generateSpfRecordOptions | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<ApiResponse<GenerateSpfRecordResults>> | Task of ApiResponse (GenerateSpfRecordResults) |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GenerateTlsReportingRecord(GenerateTlsReportingRecordOptions, int)
Create a TLS reporting record policy
Declaration
public GenerateTlsReportingRecordResults GenerateTlsReportingRecord(GenerateTlsReportingRecordOptions generateTlsReportingRecordOptions, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| GenerateTlsReportingRecordOptions | generateTlsReportingRecordOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| GenerateTlsReportingRecordResults | GenerateTlsReportingRecordResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GenerateTlsReportingRecordAsync(GenerateTlsReportingRecordOptions, int, CancellationToken)
Create a TLS reporting record policy
Declaration
public Task<GenerateTlsReportingRecordResults> GenerateTlsReportingRecordAsync(GenerateTlsReportingRecordOptions generateTlsReportingRecordOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| GenerateTlsReportingRecordOptions | generateTlsReportingRecordOptions | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<GenerateTlsReportingRecordResults> | Task of GenerateTlsReportingRecordResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GenerateTlsReportingRecordWithHttpInfo(GenerateTlsReportingRecordOptions, int)
Create a TLS reporting record policy
Declaration
public ApiResponse<GenerateTlsReportingRecordResults> GenerateTlsReportingRecordWithHttpInfo(GenerateTlsReportingRecordOptions generateTlsReportingRecordOptions, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| GenerateTlsReportingRecordOptions | generateTlsReportingRecordOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<GenerateTlsReportingRecordResults> | ApiResponse of GenerateTlsReportingRecordResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GenerateTlsReportingRecordWithHttpInfoAsync(GenerateTlsReportingRecordOptions, int, CancellationToken)
Create a TLS reporting record policy
Declaration
public Task<ApiResponse<GenerateTlsReportingRecordResults>> GenerateTlsReportingRecordWithHttpInfoAsync(GenerateTlsReportingRecordOptions generateTlsReportingRecordOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| GenerateTlsReportingRecordOptions | generateTlsReportingRecordOptions | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<ApiResponse<GenerateTlsReportingRecordResults>> | Task of ApiResponse (GenerateTlsReportingRecordResults) |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetBasePath()
Gets the base path of the API client.
Declaration
public string GetBasePath()
Returns
| Type | Description |
|---|---|
| string | The base path |
GetFakeEmailByEmailAddress(string, int)
Declaration
public FakeEmailResult GetFakeEmailByEmailAddress(string emailAddress, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| string | emailAddress | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| FakeEmailResult | FakeEmailResult |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetFakeEmailByEmailAddressAsync(string, int, CancellationToken)
Declaration
public Task<FakeEmailResult> GetFakeEmailByEmailAddressAsync(string emailAddress, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| string | emailAddress | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<FakeEmailResult> | Task of FakeEmailResult |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetFakeEmailByEmailAddressWithHttpInfo(string, int)
Declaration
public ApiResponse<FakeEmailResult> GetFakeEmailByEmailAddressWithHttpInfo(string emailAddress, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| string | emailAddress | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<FakeEmailResult> | ApiResponse of FakeEmailResult |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetFakeEmailByEmailAddressWithHttpInfoAsync(string, int, CancellationToken)
Declaration
public Task<ApiResponse<FakeEmailResult>> GetFakeEmailByEmailAddressWithHttpInfoAsync(string emailAddress, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| string | emailAddress | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<ApiResponse<FakeEmailResult>> | Task of ApiResponse (FakeEmailResult) |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetFakeEmailById(Guid, int)
Get a fake email by its ID Get a fake email by its ID
Declaration
public FakeEmailResult GetFakeEmailById(Guid id, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| Guid | id | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| FakeEmailResult | FakeEmailResult |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetFakeEmailByIdAsync(Guid, int, CancellationToken)
Get a fake email by its ID Get a fake email by its ID
Declaration
public Task<FakeEmailResult> GetFakeEmailByIdAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| Guid | id | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<FakeEmailResult> | Task of FakeEmailResult |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetFakeEmailByIdWithHttpInfo(Guid, int)
Get a fake email by its ID Get a fake email by its ID
Declaration
public ApiResponse<FakeEmailResult> GetFakeEmailByIdWithHttpInfo(Guid id, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| Guid | id | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<FakeEmailResult> | ApiResponse of FakeEmailResult |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetFakeEmailByIdWithHttpInfoAsync(Guid, int, CancellationToken)
Get a fake email by its ID Get a fake email by its ID
Declaration
public Task<ApiResponse<FakeEmailResult>> GetFakeEmailByIdWithHttpInfoAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| Guid | id | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<ApiResponse<FakeEmailResult>> | Task of ApiResponse (FakeEmailResult) |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetFakeEmailRaw(Guid, int)
Get raw fake email content Retrieve the raw content of a fake email by its ID
Declaration
public string GetFakeEmailRaw(Guid id, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| Guid | id | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| string | string |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetFakeEmailRawAsync(Guid, int, CancellationToken)
Get raw fake email content Retrieve the raw content of a fake email by its ID
Declaration
public Task<string> GetFakeEmailRawAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| Guid | id | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<string> | Task of string |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetFakeEmailRawWithHttpInfo(Guid, int)
Get raw fake email content Retrieve the raw content of a fake email by its ID
Declaration
public ApiResponse<string> GetFakeEmailRawWithHttpInfo(Guid id, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| Guid | id | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<string> | ApiResponse of string |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetFakeEmailRawWithHttpInfoAsync(Guid, int, CancellationToken)
Get raw fake email content Retrieve the raw content of a fake email by its ID
Declaration
public Task<ApiResponse<string>> GetFakeEmailRawWithHttpInfoAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| Guid | id | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<ApiResponse<string>> | Task of ApiResponse (string) |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetFakeEmailsForAddress(string, int?, int)
Get fake emails for an address Get fake emails for an address
Declaration
public List<FakeEmailPreview> GetFakeEmailsForAddress(string emailAddress, int? page = null, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| string | emailAddress | |
| int? | page | (optional) |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| List<FakeEmailPreview> | List<FakeEmailPreview> |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetFakeEmailsForAddressAsync(string, int?, int, CancellationToken)
Get fake emails for an address Get fake emails for an address
Declaration
public Task<List<FakeEmailPreview>> GetFakeEmailsForAddressAsync(string emailAddress, int? page = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| string | emailAddress | |
| int? | page | (optional) |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<List<FakeEmailPreview>> | Task of List<FakeEmailPreview> |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetFakeEmailsForAddressWithHttpInfo(string, int?, int)
Get fake emails for an address Get fake emails for an address
Declaration
public ApiResponse<List<FakeEmailPreview>> GetFakeEmailsForAddressWithHttpInfo(string emailAddress, int? page = null, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| string | emailAddress | |
| int? | page | (optional) |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<List<FakeEmailPreview>> | ApiResponse of List<FakeEmailPreview> |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetFakeEmailsForAddressWithHttpInfoAsync(string, int?, int, CancellationToken)
Get fake emails for an address Get fake emails for an address
Declaration
public Task<ApiResponse<List<FakeEmailPreview>>> GetFakeEmailsForAddressWithHttpInfoAsync(string emailAddress, int? page = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| string | emailAddress | |
| int? | page | (optional) |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<ApiResponse<List<FakeEmailPreview>>> | Task of ApiResponse (List<FakeEmailPreview>) |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupBimiDomain(LookupBimiDomainOptions, int)
Lookup a BIMI record policy
Declaration
public LookupBimiDomainResults LookupBimiDomain(LookupBimiDomainOptions lookupBimiDomainOptions, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| LookupBimiDomainOptions | lookupBimiDomainOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| LookupBimiDomainResults | LookupBimiDomainResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupBimiDomainAsync(LookupBimiDomainOptions, int, CancellationToken)
Lookup a BIMI record policy
Declaration
public Task<LookupBimiDomainResults> LookupBimiDomainAsync(LookupBimiDomainOptions lookupBimiDomainOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| LookupBimiDomainOptions | lookupBimiDomainOptions | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<LookupBimiDomainResults> | Task of LookupBimiDomainResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupBimiDomainWithHttpInfo(LookupBimiDomainOptions, int)
Lookup a BIMI record policy
Declaration
public ApiResponse<LookupBimiDomainResults> LookupBimiDomainWithHttpInfo(LookupBimiDomainOptions lookupBimiDomainOptions, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| LookupBimiDomainOptions | lookupBimiDomainOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<LookupBimiDomainResults> | ApiResponse of LookupBimiDomainResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupBimiDomainWithHttpInfoAsync(LookupBimiDomainOptions, int, CancellationToken)
Lookup a BIMI record policy
Declaration
public Task<ApiResponse<LookupBimiDomainResults>> LookupBimiDomainWithHttpInfoAsync(LookupBimiDomainOptions lookupBimiDomainOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| LookupBimiDomainOptions | lookupBimiDomainOptions | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<ApiResponse<LookupBimiDomainResults>> | Task of ApiResponse (LookupBimiDomainResults) |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupDkimDomain(LookupDkimDomainOptions, int)
Lookup and validate a DKIM record
Declaration
public LookupDkimDomainResults LookupDkimDomain(LookupDkimDomainOptions lookupDkimDomainOptions, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| LookupDkimDomainOptions | lookupDkimDomainOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| LookupDkimDomainResults | LookupDkimDomainResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupDkimDomainAsync(LookupDkimDomainOptions, int, CancellationToken)
Lookup and validate a DKIM record
Declaration
public Task<LookupDkimDomainResults> LookupDkimDomainAsync(LookupDkimDomainOptions lookupDkimDomainOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| LookupDkimDomainOptions | lookupDkimDomainOptions | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<LookupDkimDomainResults> | Task of LookupDkimDomainResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupDkimDomainWithHttpInfo(LookupDkimDomainOptions, int)
Lookup and validate a DKIM record
Declaration
public ApiResponse<LookupDkimDomainResults> LookupDkimDomainWithHttpInfo(LookupDkimDomainOptions lookupDkimDomainOptions, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| LookupDkimDomainOptions | lookupDkimDomainOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<LookupDkimDomainResults> | ApiResponse of LookupDkimDomainResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupDkimDomainWithHttpInfoAsync(LookupDkimDomainOptions, int, CancellationToken)
Lookup and validate a DKIM record
Declaration
public Task<ApiResponse<LookupDkimDomainResults>> LookupDkimDomainWithHttpInfoAsync(LookupDkimDomainOptions lookupDkimDomainOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| LookupDkimDomainOptions | lookupDkimDomainOptions | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<ApiResponse<LookupDkimDomainResults>> | Task of ApiResponse (LookupDkimDomainResults) |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupDmarcDomain(LookupDmarcDomainOptions, int)
Lookup a DMARC record policy
Declaration
public LookupDmarcDomainResults LookupDmarcDomain(LookupDmarcDomainOptions lookupDmarcDomainOptions, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| LookupDmarcDomainOptions | lookupDmarcDomainOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| LookupDmarcDomainResults | LookupDmarcDomainResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupDmarcDomainAsync(LookupDmarcDomainOptions, int, CancellationToken)
Lookup a DMARC record policy
Declaration
public Task<LookupDmarcDomainResults> LookupDmarcDomainAsync(LookupDmarcDomainOptions lookupDmarcDomainOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| LookupDmarcDomainOptions | lookupDmarcDomainOptions | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<LookupDmarcDomainResults> | Task of LookupDmarcDomainResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupDmarcDomainWithHttpInfo(LookupDmarcDomainOptions, int)
Lookup a DMARC record policy
Declaration
public ApiResponse<LookupDmarcDomainResults> LookupDmarcDomainWithHttpInfo(LookupDmarcDomainOptions lookupDmarcDomainOptions, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| LookupDmarcDomainOptions | lookupDmarcDomainOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<LookupDmarcDomainResults> | ApiResponse of LookupDmarcDomainResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupDmarcDomainWithHttpInfoAsync(LookupDmarcDomainOptions, int, CancellationToken)
Lookup a DMARC record policy
Declaration
public Task<ApiResponse<LookupDmarcDomainResults>> LookupDmarcDomainWithHttpInfoAsync(LookupDmarcDomainOptions lookupDmarcDomainOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| LookupDmarcDomainOptions | lookupDmarcDomainOptions | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<ApiResponse<LookupDmarcDomainResults>> | Task of ApiResponse (LookupDmarcDomainResults) |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupMtaStsDomain(LookupMtaStsDomainOptions, int)
Lookup a MTA-STS domain policy
Declaration
public LookupMtaStsDomainResults LookupMtaStsDomain(LookupMtaStsDomainOptions lookupMtaStsDomainOptions, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| LookupMtaStsDomainOptions | lookupMtaStsDomainOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| LookupMtaStsDomainResults | LookupMtaStsDomainResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupMtaStsDomainAsync(LookupMtaStsDomainOptions, int, CancellationToken)
Lookup a MTA-STS domain policy
Declaration
public Task<LookupMtaStsDomainResults> LookupMtaStsDomainAsync(LookupMtaStsDomainOptions lookupMtaStsDomainOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| LookupMtaStsDomainOptions | lookupMtaStsDomainOptions | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<LookupMtaStsDomainResults> | Task of LookupMtaStsDomainResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupMtaStsDomainWithHttpInfo(LookupMtaStsDomainOptions, int)
Lookup a MTA-STS domain policy
Declaration
public ApiResponse<LookupMtaStsDomainResults> LookupMtaStsDomainWithHttpInfo(LookupMtaStsDomainOptions lookupMtaStsDomainOptions, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| LookupMtaStsDomainOptions | lookupMtaStsDomainOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<LookupMtaStsDomainResults> | ApiResponse of LookupMtaStsDomainResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupMtaStsDomainWithHttpInfoAsync(LookupMtaStsDomainOptions, int, CancellationToken)
Lookup a MTA-STS domain policy
Declaration
public Task<ApiResponse<LookupMtaStsDomainResults>> LookupMtaStsDomainWithHttpInfoAsync(LookupMtaStsDomainOptions lookupMtaStsDomainOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| LookupMtaStsDomainOptions | lookupMtaStsDomainOptions | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<ApiResponse<LookupMtaStsDomainResults>> | Task of ApiResponse (LookupMtaStsDomainResults) |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupMxRecord(LookupMxRecordsOptions, int)
Lookup a MX records for a domain
Declaration
public LookupMxRecordsResults LookupMxRecord(LookupMxRecordsOptions lookupMxRecordsOptions, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| LookupMxRecordsOptions | lookupMxRecordsOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| LookupMxRecordsResults | LookupMxRecordsResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupMxRecordAsync(LookupMxRecordsOptions, int, CancellationToken)
Lookup a MX records for a domain
Declaration
public Task<LookupMxRecordsResults> LookupMxRecordAsync(LookupMxRecordsOptions lookupMxRecordsOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| LookupMxRecordsOptions | lookupMxRecordsOptions | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<LookupMxRecordsResults> | Task of LookupMxRecordsResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupMxRecordWithHttpInfo(LookupMxRecordsOptions, int)
Lookup a MX records for a domain
Declaration
public ApiResponse<LookupMxRecordsResults> LookupMxRecordWithHttpInfo(LookupMxRecordsOptions lookupMxRecordsOptions, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| LookupMxRecordsOptions | lookupMxRecordsOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<LookupMxRecordsResults> | ApiResponse of LookupMxRecordsResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupMxRecordWithHttpInfoAsync(LookupMxRecordsOptions, int, CancellationToken)
Lookup a MX records for a domain
Declaration
public Task<ApiResponse<LookupMxRecordsResults>> LookupMxRecordWithHttpInfoAsync(LookupMxRecordsOptions lookupMxRecordsOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| LookupMxRecordsOptions | lookupMxRecordsOptions | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<ApiResponse<LookupMxRecordsResults>> | Task of ApiResponse (LookupMxRecordsResults) |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupPtr(LookupPtrOptions, int)
Lookup PTR records for an IP address
Declaration
public LookupPtrResults LookupPtr(LookupPtrOptions lookupPtrOptions, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| LookupPtrOptions | lookupPtrOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| LookupPtrResults | LookupPtrResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupPtrAsync(LookupPtrOptions, int, CancellationToken)
Lookup PTR records for an IP address
Declaration
public Task<LookupPtrResults> LookupPtrAsync(LookupPtrOptions lookupPtrOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| LookupPtrOptions | lookupPtrOptions | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<LookupPtrResults> | Task of LookupPtrResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupPtrWithHttpInfo(LookupPtrOptions, int)
Lookup PTR records for an IP address
Declaration
public ApiResponse<LookupPtrResults> LookupPtrWithHttpInfo(LookupPtrOptions lookupPtrOptions, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| LookupPtrOptions | lookupPtrOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<LookupPtrResults> | ApiResponse of LookupPtrResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupPtrWithHttpInfoAsync(LookupPtrOptions, int, CancellationToken)
Lookup PTR records for an IP address
Declaration
public Task<ApiResponse<LookupPtrResults>> LookupPtrWithHttpInfoAsync(LookupPtrOptions lookupPtrOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| LookupPtrOptions | lookupPtrOptions | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<ApiResponse<LookupPtrResults>> | Task of ApiResponse (LookupPtrResults) |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupSpfDomain(LookupSpfDomainOptions, int)
Lookup and validate an SPF record
Declaration
public LookupSpfDomainResults LookupSpfDomain(LookupSpfDomainOptions lookupSpfDomainOptions, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| LookupSpfDomainOptions | lookupSpfDomainOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| LookupSpfDomainResults | LookupSpfDomainResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupSpfDomainAsync(LookupSpfDomainOptions, int, CancellationToken)
Lookup and validate an SPF record
Declaration
public Task<LookupSpfDomainResults> LookupSpfDomainAsync(LookupSpfDomainOptions lookupSpfDomainOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| LookupSpfDomainOptions | lookupSpfDomainOptions | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<LookupSpfDomainResults> | Task of LookupSpfDomainResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupSpfDomainWithHttpInfo(LookupSpfDomainOptions, int)
Lookup and validate an SPF record
Declaration
public ApiResponse<LookupSpfDomainResults> LookupSpfDomainWithHttpInfo(LookupSpfDomainOptions lookupSpfDomainOptions, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| LookupSpfDomainOptions | lookupSpfDomainOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<LookupSpfDomainResults> | ApiResponse of LookupSpfDomainResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupSpfDomainWithHttpInfoAsync(LookupSpfDomainOptions, int, CancellationToken)
Lookup and validate an SPF record
Declaration
public Task<ApiResponse<LookupSpfDomainResults>> LookupSpfDomainWithHttpInfoAsync(LookupSpfDomainOptions lookupSpfDomainOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| LookupSpfDomainOptions | lookupSpfDomainOptions | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<ApiResponse<LookupSpfDomainResults>> | Task of ApiResponse (LookupSpfDomainResults) |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupTlsReportingDomain(LookupTlsReportingDomainOptions, int)
Lookup a TLS reporting domain policy
Declaration
public LookupTlsReportingDomainResults LookupTlsReportingDomain(LookupTlsReportingDomainOptions lookupTlsReportingDomainOptions, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| LookupTlsReportingDomainOptions | lookupTlsReportingDomainOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| LookupTlsReportingDomainResults | LookupTlsReportingDomainResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupTlsReportingDomainAsync(LookupTlsReportingDomainOptions, int, CancellationToken)
Lookup a TLS reporting domain policy
Declaration
public Task<LookupTlsReportingDomainResults> LookupTlsReportingDomainAsync(LookupTlsReportingDomainOptions lookupTlsReportingDomainOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| LookupTlsReportingDomainOptions | lookupTlsReportingDomainOptions | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<LookupTlsReportingDomainResults> | Task of LookupTlsReportingDomainResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupTlsReportingDomainWithHttpInfo(LookupTlsReportingDomainOptions, int)
Lookup a TLS reporting domain policy
Declaration
public ApiResponse<LookupTlsReportingDomainResults> LookupTlsReportingDomainWithHttpInfo(LookupTlsReportingDomainOptions lookupTlsReportingDomainOptions, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| LookupTlsReportingDomainOptions | lookupTlsReportingDomainOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<LookupTlsReportingDomainResults> | ApiResponse of LookupTlsReportingDomainResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
LookupTlsReportingDomainWithHttpInfoAsync(LookupTlsReportingDomainOptions, int, CancellationToken)
Lookup a TLS reporting domain policy
Declaration
public Task<ApiResponse<LookupTlsReportingDomainResults>> LookupTlsReportingDomainWithHttpInfoAsync(LookupTlsReportingDomainOptions lookupTlsReportingDomainOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| LookupTlsReportingDomainOptions | lookupTlsReportingDomainOptions | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<ApiResponse<LookupTlsReportingDomainResults>> | Task of ApiResponse (LookupTlsReportingDomainResults) |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
TestSmtpServer(TestSmtpServerOptions, int)
Run a conservative SMTP connectivity, TLS, and AUTH diagnostic
Declaration
public TestSmtpServerResults TestSmtpServer(TestSmtpServerOptions testSmtpServerOptions, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| TestSmtpServerOptions | testSmtpServerOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| TestSmtpServerResults | TestSmtpServerResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
TestSmtpServerAsync(TestSmtpServerOptions, int, CancellationToken)
Run a conservative SMTP connectivity, TLS, and AUTH diagnostic
Declaration
public Task<TestSmtpServerResults> TestSmtpServerAsync(TestSmtpServerOptions testSmtpServerOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| TestSmtpServerOptions | testSmtpServerOptions | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<TestSmtpServerResults> | Task of TestSmtpServerResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
TestSmtpServerWithHttpInfo(TestSmtpServerOptions, int)
Run a conservative SMTP connectivity, TLS, and AUTH diagnostic
Declaration
public ApiResponse<TestSmtpServerResults> TestSmtpServerWithHttpInfo(TestSmtpServerOptions testSmtpServerOptions, int operationIndex = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| TestSmtpServerOptions | testSmtpServerOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<TestSmtpServerResults> | ApiResponse of TestSmtpServerResults |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
TestSmtpServerWithHttpInfoAsync(TestSmtpServerOptions, int, CancellationToken)
Run a conservative SMTP connectivity, TLS, and AUTH diagnostic
Declaration
public Task<ApiResponse<TestSmtpServerResults>> TestSmtpServerWithHttpInfoAsync(TestSmtpServerOptions testSmtpServerOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| TestSmtpServerOptions | testSmtpServerOptions | |
| int | operationIndex | Index associated with the operation. |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<ApiResponse<TestSmtpServerResults>> | Task of ApiResponse (TestSmtpServerResults) |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |