IPostaEmailsClient Methods

1. Docs
2. /Reference
3. /Search C# APIs
4. /CommunityToolkit.Aspire.Posta
5. /IPostaEmailsClient
6. /Methods

InterfaceMethods8 members

Provides Posta emails operations.

GetEmailDeliveryStatusAsync(GetEmailDeliveryStatusRequest, CancellationToken)abstractTask<GetEmailDeliveryStatusResponse?>

Invokes the GetEmailDeliveryStatus operation.

public interface IPostaEmailsClient
{
    public abstract Task<GetEmailDeliveryStatusResponse?> GetEmailDeliveryStatusAsync(
        GetEmailDeliveryStatusRequest request,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}

Parameters

requestGetEmailDeliveryStatusRequest

cancellationTokenCancellationTokenoptional

GetEmailDetailsAsync(GetEmailDetailsRequest, CancellationToken)abstractTask<GetEmailDetailsResponse?>

Invokes the GetEmailDetails operation.

public interface IPostaEmailsClient
{
    public abstract Task<GetEmailDetailsResponse?> GetEmailDetailsAsync(
        GetEmailDetailsRequest request,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}

Parameters

requestGetEmailDetailsRequest

cancellationTokenCancellationTokenoptional

PreviewEmailFromTemplateAsync(PreviewEmailFromTemplateRequest, CancellationToken)abstractTask<PreviewEmailFromTemplateResponse?>

Invokes the PreviewEmailFromTemplate operation.

public interface IPostaEmailsClient
{
    public abstract Task<PreviewEmailFromTemplateResponse?> PreviewEmailFromTemplateAsync(
        PreviewEmailFromTemplateRequest request,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}

Parameters

requestPreviewEmailFromTemplateRequest

cancellationTokenCancellationTokenoptional

RetryFailedEmailAsync(RetryFailedEmailRequest, CancellationToken)abstractTask<RetryFailedEmailResponse?>

Invokes the RetryFailedEmail operation.

public interface IPostaEmailsClient
{
    public abstract Task<RetryFailedEmailResponse?> RetryFailedEmailAsync(
        RetryFailedEmailRequest request,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}

Parameters

requestRetryFailedEmailRequest

cancellationTokenCancellationTokenoptional

SendAnEmailAsync(SendAnEmailRequest, CancellationToken)abstractTask<SendAnEmailResponse?>

Invokes the SendAnEmail operation.

public interface IPostaEmailsClient
{
    public abstract Task<SendAnEmailResponse?> SendAnEmailAsync(
        SendAnEmailRequest request,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}

Parameters

requestSendAnEmailRequest

cancellationTokenCancellationTokenoptional

SendBatchEmailsAsync(SendBatchEmailsRequest, CancellationToken)abstractTask<SendBatchEmailsResponse?>

Invokes the SendBatchEmails operation.

public interface IPostaEmailsClient
{
    public abstract Task<SendBatchEmailsResponse?> SendBatchEmailsAsync(
        SendBatchEmailsRequest request,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}

Parameters

requestSendBatchEmailsRequest

cancellationTokenCancellationTokenoptional

SendEmailUsingTemplateAsync(SendEmailUsingTemplateRequest, CancellationToken)abstractTask<SendEmailUsingTemplateResponse?>

Invokes the SendEmailUsingTemplate operation.

public interface IPostaEmailsClient
{
    public abstract Task<SendEmailUsingTemplateResponse?> SendEmailUsingTemplateAsync(
        SendEmailUsingTemplateRequest request,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}

Parameters

requestSendEmailUsingTemplateRequest

cancellationTokenCancellationTokenoptional

VerifyAnEmailAddressAsync(VerifyAnEmailAddressRequest, CancellationToken)abstractTask<VerifyAnEmailAddressResponse?>

Invokes the VerifyAnEmailAddress operation.

public interface IPostaEmailsClient
{
    public abstract Task<VerifyAnEmailAddressResponse?> VerifyAnEmailAddressAsync(
        VerifyAnEmailAddressRequest request,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}

Parameters

requestVerifyAnEmailAddressRequest

cancellationTokenCancellationTokenoptional