Interface IInboundFolderResource

Namespace

Mailtrap.Inbound

Assembly

Mailtrap.Abstractions.dll

Represents an inbound folder resource.

public interface IInboundFolderResource : IRestResource

Inherited Members

IRestResource.ResourceUri

Methods

Delete(CancellationToken)

Permanently deletes the folder (and all of its inboxes), 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 folder, represented by the current resource instance.

Task<InboundFolder> GetDetails(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Token to control operation cancellation.

Returns

Task<InboundFolder>

Requested folder details.

Inbox(long)

Gets the resource for a specific inbox in this folder, identified by inboxId.

IInboundInboxResource Inbox(long inboxId)

Parameters

inboxId long

ID of the inbox to get resource for.

Returns

IInboundInboxResource

Resource for the inbox with the specified ID.

Inboxes()

Gets the inbox collection resource for this folder.

IInboundInboxCollectionResource Inboxes()

Returns

IInboundInboxCollectionResource

Inbox collection resource for this folder.

Update(UpdateInboundFolderRequest, CancellationToken)

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

Task<InboundFolder> Update(UpdateInboundFolderRequest request, CancellationToken cancellationToken = default)

Parameters

request UpdateInboundFolderRequest

Folder details for update.

cancellationToken CancellationToken

Token to control operation cancellation.

Returns

Task<InboundFolder>

Updated folder details.