Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

OfficeOpenPgpMessageResult

OfficeIMO.Security

Namespace
OfficeIMO.Security
Assembly
OfficeIMO.Core
Source revision
ac7e6e1bad8a with working tree changes
Modifiers
sealed

Result of decrypting and/or reading a signed OpenPGP message.

Inheritance

  • object
  • OfficeOpenPgpMessageResult

Usage

Explore 1 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by 1

Constructors

public OfficeOpenPgpMessageResult(OfficeOpenPgpMessageStatus status, string message, bool isEncrypted = false, bool isIntegrityProtected = false, byte[]? content = null, string? fileName = null, string? symmetricAlgorithm = null, IEnumerable<string>? recipientKeyIds = null, IEnumerable<OfficeOpenPgpSignatureInfo>? signatures = null) #

Creates a message result.

Parameters

status OfficeIMO.Security.OfficeOpenPgpMessageStatus required
message string required
isEncrypted bool = false optional
isIntegrityProtected bool = false optional
content byte[]? = null optional
fileName string? = null optional
symmetricAlgorithm string? = null optional
recipientKeyIds System.Collections.Generic.IEnumerable<string>? = null optional
signatures System.Collections.Generic.IEnumerable<OfficeIMO.Security.OfficeOpenPgpSignatureInfo>? = null optional

Properties

public OfficeOpenPgpMessageStatus Status { get; } #

Overall status.

public string Message { get; } #

Human-readable explanation.

public bool IsEncrypted { get; } #

True when the message was encrypted.

public bool IsIntegrityProtected { get; } #

True when the encrypted data carried a modification detection code that matched.

public byte[]? Content { get; } #

Literal data. Set only when OfficeOpenPgpMessageResult.Status is OfficeOpenPgpMessageStatus.Opened.

public string? FileName { get; } #

File name recorded in the literal data packet.

public string? SymmetricAlgorithm { get; } #

Symmetric algorithm used for the session key.

public IReadOnlyList<string> RecipientKeyIds { get; } #

Recipient key IDs listed in the message, as 16 uppercase hex digits.

public IReadOnlyList<OfficeOpenPgpSignatureInfo> Signatures { get; } #

Signatures over the literal data (signed-then-encrypted or signed-only messages).

public bool IsSignatureValid { get; } #

True when the message carried at least one signature and all of them are valid.