Search Results for

    Show / Hide Table of Contents

    Class ToolsControllerApi

    Represents a collection of functions to interact with the API endpoints

    Inheritance
    object
    ToolsControllerApi
    Implements
    IToolsControllerApi
    IToolsControllerApiSync
    IToolsControllerApiAsync
    IApiAccessor
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: mailslurp.Api
    Assembly: mailslurp.dll
    Syntax
    public class ToolsControllerApi : IToolsControllerApi, IToolsControllerApiSync, IToolsControllerApiAsync, IApiAccessor

    Constructors

    View Source

    ToolsControllerApi()

    Initializes a new instance of the ToolsControllerApi class.

    Declaration
    public ToolsControllerApi()
    View Source

    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

    View Source

    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.

    View Source

    ToolsControllerApi(string)

    Initializes a new instance of the ToolsControllerApi class.

    Declaration
    public ToolsControllerApi(string basePath)
    Parameters
    Type Name Description
    string basePath

    Properties

    View Source

    AsynchronousClient

    The client for accessing this underlying API asynchronously.

    Declaration
    public IAsynchronousClient AsynchronousClient { get; set; }
    Property Value
    Type Description
    IAsynchronousClient
    View Source

    Client

    The client for accessing this underlying API synchronously.

    Declaration
    public ISynchronousClient Client { get; set; }
    Property Value
    Type Description
    ISynchronousClient
    View Source

    Configuration

    Gets or sets the configuration object

    Declaration
    public IReadableConfiguration Configuration { get; set; }
    Property Value
    Type Description
    IReadableConfiguration

    An instance of the Configuration

    View Source

    ExceptionFactory

    Provides a factory method hook for the creation of exceptions.

    Declaration
    public ExceptionFactory ExceptionFactory { get; set; }
    Property Value
    Type Description
    ExceptionFactory

    Methods

    View Source

    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

    View Source

    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

    View Source

    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

    View Source

    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

    View Source

    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

    View Source

    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

    View Source

    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

    View Source

    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

    View Source

    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

    View Source

    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

    View Source

    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

    View Source

    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

    View Source

    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

    View Source

    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

    View Source

    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

    View Source

    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

    View Source

    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

    View Source

    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

    View Source

    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

    View Source

    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

    View Source

    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

    View Source

    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

    View Source

    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

    View Source

    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

    View Source

    GetBasePath()

    Gets the base path of the API client.

    Declaration
    public string GetBasePath()
    Returns
    Type Description
    string

    The base path

    View Source

    GetFakeEmailById(Guid, int)

    Declaration
    public FakeEmailResult GetFakeEmailById(Guid id, int operationIndex = 0)
    Parameters
    Type Name Description
    System.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

    View Source

    GetFakeEmailByIdAsync(Guid, int, CancellationToken)

    Declaration
    public Task<FakeEmailResult> GetFakeEmailByIdAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    System.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

    View Source

    GetFakeEmailByIdWithHttpInfo(Guid, int)

    Declaration
    public ApiResponse<FakeEmailResult> GetFakeEmailByIdWithHttpInfo(Guid id, int operationIndex = 0)
    Parameters
    Type Name Description
    System.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

    View Source

    GetFakeEmailByIdWithHttpInfoAsync(Guid, int, CancellationToken)

    Declaration
    public Task<ApiResponse<FakeEmailResult>> GetFakeEmailByIdWithHttpInfoAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    System.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

    View Source

    GetFakeEmailsForAddress(string, int?, int)

    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
    System.Collections.Generic.List<T><FakeEmailPreview>

    List<FakeEmailPreview>

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetFakeEmailsForAddressAsync(string, int?, int, CancellationToken)

    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<System.Collections.Generic.List<T><FakeEmailPreview>>

    Task of List<FakeEmailPreview>

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetFakeEmailsForAddressWithHttpInfo(string, int?, int)

    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<System.Collections.Generic.List<T><FakeEmailPreview>>

    ApiResponse of List<FakeEmailPreview>

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetFakeEmailsForAddressWithHttpInfoAsync(string, int?, int, CancellationToken)

    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<System.Collections.Generic.List<T><FakeEmailPreview>>>

    Task of ApiResponse (List<FakeEmailPreview>)

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    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

    View Source

    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

    View Source

    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

    View Source

    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

    View Source

    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

    View Source

    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

    View Source

    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

    View Source

    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

    View Source

    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

    View Source

    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

    View Source

    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

    View Source

    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

    View Source

    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

    View Source

    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

    View Source

    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

    View Source

    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

    Implements

    IToolsControllerApi
    IToolsControllerApiSync
    IToolsControllerApiAsync
    IApiAccessor
    • View Source
    In This Article
    Back to top See MailSlurp website for more information.