IImapClientCompress Method

Enable compression over the IMAP connection.

Definition

Namespace: MailKit.Net.Imap
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
void Compress(
	CancellationToken cancellationToken = default
)

Parameters

cancellationToken  CancellationToken  (Optional)
The cancellation token.

Remarks

Enables compression over the IMAP connection.

If the IMAP server supports the Compress extension, it is possible at any point after connecting to enable compression to reduce network bandwidth usage. Ideally, this method should be called before authenticating.

  Note

This method is only available on .NET 8.0 and later.

Exceptions

ObjectDisposedException The ImapClient has been disposed.
ServiceNotConnectedException The ImapClient is not connected.
InvalidOperationException Compression must be enabled before a folder has been selected.
NotSupportedException The IMAP server does not support the Compress extension.
OperationCanceledException The operation was canceled via the cancellation token.
IOException An I/O error occurred.
ImapCommandException The server replied to the COMPRESS command with a NO or BAD response.
ImapProtocolException An IMAP protocol error occurred.

See Also