Interface IInboundInboxResource

Namespace

Mailtrap.Inbound

Assembly

Mailtrap.Abstractions.dll

Represents an inbound inbox resource for management (folder-scoped).
To work with the inbox's messages and threads, use Inbox(long).

public interface IInboundInboxResource : IRestResource

Inherited Members

IRestResource.ResourceUri

Methods

Delete(CancellationToken)

Permanently deletes the inbox, represented by the current resource instance.

Task Delete(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Token to control operation cancellation.

Returns

Task

A task that represents the asynchronous delete operation.

GetDetails(CancellationToken)

Gets details of the inbox, represented by the current resource instance.

Task<InboundInbox> GetDetails(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Token to control operation cancellation.

Returns

Task<InboundInbox>

Requested inbox details.

Update(UpdateInboundInboxRequest, CancellationToken)

Updates the inbox, represented by the current resource instance, with details specified by request.

Task<InboundInbox> Update(UpdateInboundInboxRequest request, CancellationToken cancellationToken = default)

Parameters

request UpdateInboundInboxRequest

Inbox details for update.

cancellationToken CancellationToken

Token to control operation cancellation.

Returns

Task<InboundInbox>

Updated inbox details.