Interface ITrackingOptOutCollectionResource

Namespace

Mailtrap.TrackingOptOuts

Assembly

Mailtrap.Abstractions.dll

Represents tracking opt-outs collection resource.

public interface ITrackingOptOutCollectionResource : IRestResource

Inherited Members

IRestResource.ResourceUri

Methods

Create(CreateTrackingOptOutRequest, CancellationToken)

Adds an email address to the tracking opt-out list for a sending domain.

Task<TrackingOptOut> Create(CreateTrackingOptOutRequest request, CancellationToken cancellationToken = default)

Parameters

request CreateTrackingOptOutRequest

Request containing the email address and sending domain.

cancellationToken CancellationToken

Token to control operation cancellation.

Returns

Task<TrackingOptOut>

Created tracking opt-out.

Fetch(TrackingOptOutFilter?, CancellationToken)

Lists email addresses that have opted out of open and click tracking.

Task<TrackingOptOutList> Fetch(TrackingOptOutFilter? filter = null, CancellationToken cancellationToken = default)

Parameters

filter TrackingOptOutFilter

Optional filter to apply when fetching tracking opt-outs.

cancellationToken CancellationToken

Token to control operation cancellation.

Returns

Task<TrackingOptOutList>

Page of tracking opt-outs and the cursor for the next page.

Remarks

The endpoint returns up to 1000 records per request. When the result carries a cursor, pass it as LastId to fetch the next page.