Interface IEmailCampaignCollectionResource

Namespace

Mailtrap.EmailCampaigns

Assembly

Mailtrap.Abstractions.dll

Represents email campaign collection resource.

public interface IEmailCampaignCollectionResource : IRestResource

Inherited Members

IRestResource.ResourceUri

Methods

Create(CreateEmailCampaignRequest, CancellationToken)

Creates a new email campaign with details specified by request.
The created campaign is returned in the Draft state.

Task<EmailCampaign> Create(CreateEmailCampaignRequest request, CancellationToken cancellationToken = default)

Parameters

request CreateEmailCampaignRequest

Request containing email campaign details for creation.

cancellationToken CancellationToken

Token to control operation cancellation.

Returns

Task<EmailCampaign>

Created email campaign details.

GetAll(EmailCampaignListFilter?, CancellationToken)

Gets a paginated list of email campaigns for the account, newest first.

Task<EmailCampaignList> GetAll(EmailCampaignListFilter? filter = null, CancellationToken cancellationToken = default)

Parameters

filter EmailCampaignListFilter

Optional filtering and pagination parameters.

cancellationToken CancellationToken

Token to control operation cancellation.

Returns

Task<EmailCampaignList>

A page of email campaigns and the pagination metadata.