Method ReadAsync
- Assembly
- MailFathom.Application.dll
ReadAsync(CancellationToken)
Reads what synchronization is doing across every configured account.
public Task<MailSynchronizationStatus> ReadAsync(CancellationToken cancellationToken)Parameters
cancellationTokenCancellationTokenCancels the durable read.
Returns
- Task<MailSynchronizationStatus>
The status.
Remarks
It refuses nothing about the deployment's own state. A deployment that configures no account, one that switched synchronization off, and one whose process has only just started are all supported states an operator reads here rather than failures to report on — what it does refuse is a caller whose grant does not carry the permission this report is published under.
Exceptions
- PrincipalNotAuthorizedException
Thrown when the use case was reached by anything but a caller granted AdminRead.
- OperationCanceledException
Thrown when the caller cancels.