Interface IInboundMessageResource

Namespace

Mailtrap.Inbound

Assembly

Mailtrap.Abstractions.dll

Represents an inbound message resource.

public interface IInboundMessageResource : IRestResource

Inherited Members

IRestResource.ResourceUri

Methods

Delete(CancellationToken)

Permanently deletes the message, 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.

Forward(ForwardInboundMessageRequest, CancellationToken)

Forwards the message to new recipients (at least one To is required). Sends a real email.

Task<SendMessageResult> Forward(ForwardInboundMessageRequest request, CancellationToken cancellationToken = default)

Parameters

request ForwardInboundMessageRequest

The forward body.

cancellationToken CancellationToken

Token to control operation cancellation.

Returns

Task<SendMessageResult>

The send result, containing the sent message UUIDs.

GetDetails(CancellationToken)

Gets details of the message (with body and attachment download URLs), represented by the current resource instance.

Task<InboundMessage> GetDetails(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Token to control operation cancellation.

Returns

Task<InboundMessage>

Requested message details.

Reply(ReplyInboundMessageRequest, CancellationToken)

Replies to the message (to the original sender). Sends a real email.

Task<SendMessageResult> Reply(ReplyInboundMessageRequest request, CancellationToken cancellationToken = default)

Parameters

request ReplyInboundMessageRequest

The reply body.

cancellationToken CancellationToken

Token to control operation cancellation.

Returns

Task<SendMessageResult>

The send result, containing the sent message UUIDs.

ReplyAll(ReplyInboundMessageRequest, CancellationToken)

Replies to the message and copies the original's other recipients. Sends a real email.

Task<SendMessageResult> ReplyAll(ReplyInboundMessageRequest request, CancellationToken cancellationToken = default)

Parameters

request ReplyInboundMessageRequest

The reply body.

cancellationToken CancellationToken

Token to control operation cancellation.

Returns

Task<SendMessageResult>

The send result, containing the sent message UUIDs.