IMultipartEncryptedDecrypt(OpenPgpContext, DigitalSignatureCollection, CancellationToken) Method

Decrypts the IMultipartEncrypted part.

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

Syntax

MimeEntity Decrypt(
	OpenPgpContext ctx,
	out DigitalSignatureCollection signatures,
	CancellationToken cancellationToken = default
)

ctx OpenPgpContext: The OpenPGP cryptography context to use for decrypting.
signatures DigitalSignatureCollection: A list of digital signatures if the data was both signed and encrypted.
cancellationToken CancellationToken (Optional): The cancellation token.

MimeEntity
The decrypted entity.

Exceptions

Exception	Condition
ArgumentNullException	ctx is null.
FormatException	The protocol parameter was not specified. -or- The multipart is malformed in some way.
NotSupportedException	The provided OpenPgpContext does not support the protocol parameter.
PrivateKeyNotFoundException	The private key could not be found to decrypt the encrypted data.
ObjectDisposedException	The IMultipartEncrypted has been disposed.
OperationCanceledException	The user chose to cancel the password prompt. -or- The operation was cancelled via the cancellation token.
UnauthorizedAccessException	3 bad attempts were made to unlock the secret key.

Remarks

Decrypts the IMultipartEncrypted and extracts any digital signatures in cases where the content was also signed.