Method CancelAsync

Namespace: MailFathom.Application.Mail.Delivery.Scheduling

Assembly: MailFathom.Application.dll

CancelAsync(IPersistenceSession, RecurringSendId, CancellationToken)

Stops a declaration from producing any further occurrence.

Task<RecurringSendCancellation> CancelAsync(IPersistenceSession session, RecurringSendId recurringSendId, CancellationToken cancellationToken)

Parameters

session IPersistenceSession: The session the write joins.
recurringSendId RecurringSendId: The declaration to stop.
cancellationToken CancellationToken: Cancels the write.

Returns

Task<RecurringSendCancellation>: What became of the request.

Remarks

It stops occasions and touches no message. An occurrence already written down goes out as it was going to, because it is a message the owner asked for at a moment that has already come; stopping that one as well is the other act, asked for against the record it produced.

Exceptions

ArgumentNullException: Thrown when session is null.