Package io.mailtrap.api.trackingoptouts

Class TrackingOptOutsImpl

java.lang.Object

io.mailtrap.api.apiresource.ApiResource

io.mailtrap.api.trackingoptouts.TrackingOptOutsImpl

All Implemented Interfaces:

TrackingOptOuts

public class TrackingOptOutsImpl
extends ApiResource
implements TrackingOptOuts

Field Summary

Fields inherited from class io.mailtrap.api.apiresource.ApiResource

apiHost, httpClient, token

Constructor Summary

Constructors

Constructor	Description
TrackingOptOutsImpl(MailtrapConfig config)

Method Summary

Modifier and Type	Method	Description
TrackingOptOut	createTrackingOptOut(CreateTrackingOptOutRequest request)	Add an email address to the tracking opt-out list for a sending domain.
TrackingOptOut	deleteTrackingOptOut(String trackingOptOutId)	Remove an email address from the tracking opt-out list so open and click tracking can apply again.
TrackingOptOutListResponse	getTrackingOptOuts(TrackingOptOutListFilter filter)	List email addresses that have opted out of open and click tracking.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TrackingOptOutsImpl

public TrackingOptOutsImpl(MailtrapConfig config)

Method Details

getTrackingOptOuts

public TrackingOptOutListResponse getTrackingOptOuts(TrackingOptOutListFilter filter)

Description copied from interface: TrackingOptOuts

List email addresses that have opted out of open and click tracking. The endpoint returns up to 1000 records per request; pass the previous response's lastId to fetch the next page.

Specified by:

getTrackingOptOuts in interface TrackingOptOuts

Parameters:

filter - - optional filtering and pagination parameters

Returns:

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

createTrackingOptOut

public TrackingOptOut createTrackingOptOut(CreateTrackingOptOutRequest request)

Description copied from interface: TrackingOptOuts

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

Specified by:

createTrackingOptOut in interface TrackingOptOuts

Parameters:

request - - request data

Returns:

the created tracking opt-out

deleteTrackingOptOut

public TrackingOptOut deleteTrackingOptOut(String trackingOptOutId)

Description copied from interface: TrackingOptOuts

Remove an email address from the tracking opt-out list so open and click tracking can apply again.

Specified by:

deleteTrackingOptOut in interface TrackingOptOuts

Parameters:

trackingOptOutId - - unique tracking opt-out ID

Returns:

the attributes of the deleted tracking opt-out