Click or drag to resize
MimeKit

OpenPgpContextSignAsync(MailboxAddress, DigestAlgorithm, Stream, CancellationToken) Method

Asynchronously 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 override Task<MimePart> SignAsync(
	MailboxAddress signer,
	DigestAlgorithm digestAlgo,
	Stream content,
	CancellationToken cancellationToken = default
)

Parameters

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

Return Value

TaskMimePart
A new MimePart instance containing the detached signature data.

Implements

ICryptographyContextSignAsync(MailboxAddress, DigestAlgorithm, Stream, CancellationToken)
Exceptions
ExceptionCondition
ArgumentNullException

signer is null.

-or-

content is null.

ArgumentOutOfRangeExceptiondigestAlgo is out of range.
NotSupportedException The specified DigestAlgorithm is not supported by this context.
PrivateKeyNotFoundException A signing key could not be found for signer.
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
Asynchronously signs the content using the specified signer and digest algorithm.
See Also