CryptographyContext Class

An abstract cryptography context.

Inheritance Hierarchy

SystemObject
  MimeKit.CryptographyCryptographyContext
    MimeKit.CryptographyOpenPgpContext
    MimeKit.CryptographySecureMimeContext

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

Syntax

Copy

public abstract class CryptographyContext : IDisposable

Request Example

The CryptographyContext type exposes the following members.

Constructors

	Name	Description
	CryptographyContext	Initialize a new instance of the CryptographyContext class.

Top

Properties

	Name	Description
	DigestAlgorithmRank	Get the preferred rank order for the digest algorithms; from the most preferred to the least.
	EnabledDigestAlgorithms	Get the enabled digest algorithms in ranked order.
	EnabledEncryptionAlgorithms	Get the enabled encryption algorithms in ranked order.
	EncryptionAlgorithmRank	Get the preferred rank order for the encryption algorithms; from the most preferred to the least.
	EncryptionProtocol	Get the encryption protocol.
	KeyExchangeProtocol	Get the key exchange protocol.
	PrepareBeforeSigning	Get or set whether MimeEntitys should be prepared before signing.
	SignatureProtocol	Get the signature protocol.

Top

Methods

	Name	Description
	CanEncrypt	Check whether or not the cryptography context can encrypt to a particular recipient.
	CanEncryptAsync	Asynchronously check whether or not the cryptography context can encrypt to a particular recipient.
	CanSign	Check whether or not a particular mailbox address can be used for signing.
	CanSignAsync	Asynchronously check whether or not a particular mailbox address can be used for signing.
	Create	Creates a new CryptographyContext for the specified protocol.
	Decrypt	Decrypt the specified encryptedData.
	DecryptAsync	Asynchronously decrypt the specified encryptedData.
	Disable(DigestAlgorithm)	Disable the digest algorithm.
	Disable(EncryptionAlgorithm)	Disable the encryption algorithm.
	Dispose	Releases all resources used by the CryptographyContext object.
	Dispose(Boolean)	Releases the unmanaged resources used by the CryptographyContext and optionally releases the managed resources.
	Enable(DigestAlgorithm)	Enable the digest algorithm.
	Enable(EncryptionAlgorithm)	Enable the encryption algorithm.
	Encrypt	Encrypt the specified content for the specified recipients.
	EncryptAsync	Asynchronously encrypt the specified content for the specified recipients.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	Export	Exports the keys for the specified mailboxes.
	ExportAsync	Asynchronously exports the keys for the specified mailboxes.
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
	GetDigestAlgorithm	Get the digest algorithm from the micalg parameter value in a multipart/signed part.
	GetDigestAlgorithmName	Get the string name of the digest algorithm for use with the micalg parameter of a multipart/signed part.
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	Import	Imports the public certificates or keys from the specified stream.
	ImportAsync	Asynchronously imports the public certificates or keys from the specified stream.
	IsEnabled(DigestAlgorithm)	Check whether the specified digest algorithm is enabled.
	IsEnabled(EncryptionAlgorithm)	Check whether the specified encryption algorithm is enabled.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	Register(FuncOpenPgpContext)	Registers a default OpenPgpContext factory.
	Register(FuncSecureMimeContext)	Registers a default SecureMimeContext factory.
	Register(Type)	Registers a default SecureMimeContext or OpenPgpContext.
	Sign	Sign the content using the specified signer and digest algorithm.
	SignAsync	Asynchronously sign the content using the specified signer and digest algorithm.
	Supports	Check whether or not the specified protocol is supported by the CryptographyContext.
	ToString	Returns a string that represents the current object. (Inherited from Object)
	Verify	Verify the specified content using the detached signatureData.
	VerifyAsync	Asynchronously verify the specified content using the detached signatureData.

Top

Remarks

Generally speaking, applications should not use a CryptographyContext directly, but rather via higher level APIs such as MultipartSigned, MultipartEncrypted and ApplicationPkcs7Mime.

Reference

MimeKit.Cryptography Namespace