Click or drag to resize
MimeKit

ApplicationPkcs7MimeSign(SecureMimeContext, CmsSigner, MimeEntity, CancellationToken) Method

Sign the specified entity.

Namespace: MimeKit.Cryptography
Assembly: MimeKit (in MimeKit.dll) Version: 4.3.0
Syntax
C#
Copy
public static ApplicationPkcs7Mime Sign(
	SecureMimeContext ctx,
	CmsSigner signer,
	MimeEntity entity,
	CancellationToken cancellationToken = default
)

Parameters

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

Return Value

ApplicationPkcs7Mime
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.
CmsException An error occurred in the cryptographic message syntax subsystem.
Remarks

Signs the entity using the supplied signer 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