Interface IInboxCollectionResource

Namespace

Mailtrap.Inboxes

Assembly

Mailtrap.Abstractions.dll

Represents inbox collection resource.

public interface IInboxCollectionResource : IRestResource

Inherited Members

IRestResource.ResourceUri

Methods

Create(CreateInboxRequest, CancellationToken)

Creates a new inbox with details specified by request.

Task<Inbox> Create(CreateInboxRequest request, CancellationToken cancellationToken = default)

Parameters

request CreateInboxRequest

Request containing inbox details for creation.

cancellationToken CancellationToken

Token to control operation cancellation.

Returns

Task<Inbox>

Created inbox details.

GetAll(CancellationToken)

Gets inbox details collection.

Task<IList<Inbox>> GetAll(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Token to control operation cancellation.

Returns

Task<IList<Inbox>>

Collection of inbox details.