OpenPgpContextDecrypt(Stream, DigitalSignatureCollection, CancellationToken) Method

Decrypt the specified encryptedData and extracts the digital signers if the content was also signed.

Namespace: MimeKit.Cryptography
Assembly: MimeKit (in MimeKit.dll) Version: 4.7.1

Syntax

public MimeEntity Decrypt(
	Stream encryptedData,
	out DigitalSignatureCollection signatures,
	CancellationToken cancellationToken = default
)

encryptedData Stream: The encrypted data.
signatures DigitalSignatureCollection: A list of digital signatures if the data was both signed and encrypted.
cancellationToken CancellationToken (Optional): The cancellation token.

Exceptions

Exception	Condition
ArgumentNullException	encryptedData is null.
PrivateKeyNotFoundException	The private key could not be found to decrypt the stream.
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.
PgpException	An OpenPGP error occurred.

Remarks

Decrypts the specified encryptedData and extracts the digital signers if the content was also signed.