Click or drag to resize
MimeKit

ApplicationPkcs7MimeSignAsync(SecureMimeContext, MailboxAddress, DigestAlgorithm, MimeEntity, CancellationToken) Method

Asynchronously sign the specified entity.

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

Parameters

ctx  SecureMimeContext
The S/MIME context to use for signing.
signer  MailboxAddress
The signer.
digestAlgo  DigestAlgorithm
The digest algorithm to use for signing.
entity  MimeEntity
The entity.
cancellationToken  CancellationToken  (Optional)
The cancellation token.

Return Value

TaskApplicationPkcs7Mime
The signed entity.
Exceptions
ExceptionCondition
ArgumentNullException

ctx is null.

-or-

signer is null.

-or-

entity is null.

ObjectDisposedExceptionentity has been disposed.
OperationCanceledException The operation was canceled via the cancellation token.
CertificateNotFoundException A signing certificate could not be found for signer.
CmsException An error occurred in the cryptographic message syntax subsystem.
Remarks

Asynchronously signs the entity using the supplied signer, digest algorithm and SecureMimeContext.

For better interoperability with other mail clients, you should use Create(SecureMimeContext, CmsSigner, MimeEntity, CancellationToken) instead as the multipart/signed format is supported among a much larger subset of mail client software.

See Also