Interface ISuppressionCollectionResource

Namespace

Mailtrap.Suppressions

Assembly

Mailtrap.Abstractions.dll

Represents suppressions collection resource.

public interface ISuppressionCollectionResource : IRestResource

Inherited Members

IRestResource.ResourceUri

Methods

Create(CreateSuppressionRequest, CancellationToken)

Adds an email address to the account's suppression list.

Task<Suppression> Create(CreateSuppressionRequest request, CancellationToken cancellationToken = default)

Parameters

request CreateSuppressionRequest

Request containing the email address, domain and sending stream to suppress.

cancellationToken CancellationToken

Token to control operation cancellation.

Returns

Task<Suppression>

Created suppression.

Fetch(SuppressionFilter?, CancellationToken)

List and search suppressions

Task<IList<Suppression>> Fetch(SuppressionFilter? filter = null, CancellationToken cancellationToken = default)

Parameters

filter SuppressionFilter

Optional filter to apply when fetching suppressions.

cancellationToken CancellationToken

Token to control operation cancellation.

Returns

Task<IList<Suppression>>

Collection of suppression details.

Remarks

The endpoint returns up to 1000 suppressions per request.