ApplicationPkcs7MimeSign(MailboxAddress, DigestAlgorithm, MimeEntity, CancellationToken) Method

Sign the specified entity.

Definition

Namespace: MimeKit.Cryptography
Assembly: MimeKit.Cryptography (in MimeKit.Cryptography.dll) Version: 5.0.0
C#
public static ApplicationPkcs7Mime Sign(
	MailboxAddress signer,
	DigestAlgorithm digestAlgo,
	MimeEntity entity,
	CancellationToken cancellationToken = default
)

Parameters

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

ApplicationPkcs7Mime
The signed entity.

Remarks

Signs the entity using the supplied signer, digest algorithm and the default 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.

Exceptions

ArgumentNullException

signer is .

-or-

entity is .
ObjectDisposedException entity 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.

See Also