Click or drag to resize
MimeKit

OpenPgpContextSign(PgpSecretKey, DigestAlgorithm, Stream, CancellationToken) Method

Sign the content using the specified signer and digest algorithm.

Namespace: MimeKit.Cryptography
Assembly: MimeKit (in MimeKit.dll) Version: 4.7.1
Syntax
C#
Copy
public ApplicationPgpSignature Sign(
	PgpSecretKey signer,
	DigestAlgorithm digestAlgo,
	Stream content,
	CancellationToken cancellationToken = default
)

Parameters

signer  PgpSecretKey
The signer.
digestAlgo  DigestAlgorithm
The digest algorithm to use for signing.
content  Stream
The content.
cancellationToken  CancellationToken  (Optional)
The cancellation token.

Return Value

ApplicationPgpSignature
A new MimePart instance containing the detached signature data.
Exceptions
ExceptionCondition
ArgumentNullException

signer is null.

-or-

content is null.

ArgumentExceptionsigner cannot be used for signing.
ArgumentOutOfRangeException The digestAlgo was out of range.
NotSupportedException The digestAlgo is not supported.
OperationCanceledException

The user chose to cancel the password prompt.

-or-

The operation was canceled via the cancellation token.

UnauthorizedAccessException 3 bad attempts were made to unlock the secret key.
Remarks
Signs the content using the specified signer and digest algorithm.
See Also