Click or drag to resize
MimeKit

MultipartSignedCreateAsync(PgpSecretKey, DigestAlgorithm, MimeEntity, CancellationToken) Method

Asynchronously create a new MultipartSigned.

Namespace: MimeKit.Cryptography
Assembly: MimeKit (in MimeKit.dll) Version: 4.7.1
Syntax
C#
Copy
public static Task<MultipartSigned> CreateAsync(
	PgpSecretKey signer,
	DigestAlgorithm digestAlgo,
	MimeEntity entity,
	CancellationToken cancellationToken = default
)

Parameters

signer  PgpSecretKey
The signer.
digestAlgo  DigestAlgorithm
The digest algorithm to use for signing.
entity  MimeEntity
The entity to sign.
cancellationToken  CancellationToken  (Optional)
The cancellation token.

Return Value

TaskMultipartSigned
A new MultipartSigned instance.
Exceptions
ExceptionCondition
ArgumentNullException

signer is null.

-or-

entity is null.

ArgumentExceptionsigner cannot be used for signing.
ArgumentOutOfRangeException The digestAlgo was out of range.
NotSupportedException

A cryptography context suitable for signing could not be found.

-or-

The digestAlgo is not supported.

ObjectDisposedExceptionentity has been disposed.
OperationCanceledException The operation was canceled via the cancellation token.
PgpException An error occurred in the OpenPGP subsystem.
Remarks
Cryptographically signs the entity using the supplied signer and digest algorithm in order to generate a detached signature and then adds the entity along with the detached signature data to a new multipart/signed part.
See Also