Click or drag to resize
MimeKit

ApplicationPkcs7MimeCompressAsync(SecureMimeContext, MimeEntity, CancellationToken) Method

Asynchronously compress the specified entity.

Namespace: MimeKit.Cryptography
Assembly: MimeKit (in MimeKit.dll) Version: 4.7.1
Syntax
C#
Copy
public static Task<ApplicationPkcs7Mime> CompressAsync(
	SecureMimeContext ctx,
	MimeEntity entity,
	CancellationToken cancellationToken = default
)

Parameters

ctx  SecureMimeContext
The S/MIME context to use for compressing.
entity  MimeEntity
The entity.
cancellationToken  CancellationToken  (Optional)
The cancellation token.

Return Value

TaskApplicationPkcs7Mime
The compressed entity.
Exceptions
ExceptionCondition
ArgumentNullException

ctx is null.

-or-

entity is null.

ObjectDisposedExceptionentity has been disposed.
OperationCanceledException The operation was canceled via the cancellation token.
CmsException An error occurred in the cryptographic message syntax subsystem.
Remarks

Asynchronously compresses the specified entity using the specified SecureMimeContext.

Caution note  Caution
Most mail clients, even among those that support S/MIME, do not support compression.
See Also