Pop 3ClientGet Message Size Async Method
Asynchronously get the size of the specified message, in bytes.
Definition
Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
The message size, in bytes.
IMailSpoolGetMessageSizeAsync(Int32, CancellationToken)
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
public override Task<long> GetMessageSizeAsync(
int index,
CancellationToken cancellationToken = default
)Parameters
- index Int32
- The index of the message.
- cancellationToken CancellationToken (Optional)
- The cancellation token.
Return Value
TaskInt64The message size, in bytes.
Implements
IMailSpoolGetMessageSizeAsync(Int32, CancellationToken)IMailSpoolGetMessageSizeAsync(Int32, CancellationToken)
Remarks
Gets the size of the specified message, in bytes.
Exceptions
| ArgumentOutOfRangeException | index is not a valid message index. |
| ObjectDisposedException | The Pop3Client has been disposed. |
| ServiceNotConnectedException | The Pop3Client is not connected. |
| ServiceNotAuthenticatedException | The Pop3Client is not authenticated. |
| OperationCanceledException | The operation was canceled via the cancellation token. |
| IOException | An I/O error occurred. |
| Pop3CommandException | The POP3 command failed. |
| Pop3ProtocolException | A POP3 protocol error occurred. |