Class EmailCampaignListFilter

Namespace

Mailtrap.EmailCampaigns.Models

Assembly

Mailtrap.Abstractions.dll

Represents a set of filtering and pagination parameters for listing email campaigns.

public sealed record EmailCampaignListFilter : IEquatable<EmailCampaignListFilter>

Inheritance

object

EmailCampaignListFilter

Implements

IEquatable<EmailCampaignListFilter>

Properties

PerPage

Gets or sets the number of campaigns per page.

public int? PerPage { get; set; }

Property Value

int?

Number of campaigns per page. Defaults to 50 and is capped at 100 by the API.

Search

Gets or sets the campaign name filter (case-insensitive partial match).

public string? Search { get; set; }

Property Value

string

Name filter, or null for no filtering.

Remarks

Serialized to the search query parameter.

Token

Gets or sets the page number to retrieve (page-token pagination).

public int? Token { get; set; }

Property Value

int?

Page number to retrieve. Defaults to 1 when not specified.