Class: Message

message~ Message

Class that represents an OpenPGP message. Can be an encrypted message, signed message, compressed message or literal message

new Message(packetlist)

Parameters:
Name Type Description
packetlist module:packet/packetlist The packets that form this message See http://tools.ietf.org/html/rfc4880#section-11.3
Source:

Methods

armor() → {String}

Returns ASCII armored text of message
Source:
Returns:
ASCII armor
Type
String

decrypt(privateKey) → {Array.<module:message~Message>}

Decrypt the message
Parameters:
Name Type Description
privateKey module:key~Key private key with decrypted secret data
Source:
Returns:
new message with decrypted content
Type
Array.<module:message~Message>

encrypt(keys) → {Array.<module:message~Message>}

Encrypt the message
Parameters:
Name Type Description
keys Array.<module:key~Key> array of keys, used to encrypt the message
Source:
Returns:
new message with encrypted content
Type
Array.<module:message~Message>

getEncryptionKeyIds() → {Array.<module:type/keyid>}

Returns the key IDs of the keys to which the session key is encrypted
Source:
Returns:
array of keyid objects
Type
Array.<module:type/keyid>

getLiteralData() → {String|null}

Get literal data that is the body of the message
Source:
Returns:
literal body of the message as string
Type
String | null

getSigningKeyIds() → {Array.<module:type/keyid>}

Returns the key IDs of the keys that signed the message
Source:
Returns:
array of keyid objects
Type
Array.<module:type/keyid>

getText() → {String|null}

Get literal data as text
Source:
Returns:
literal body of the message interpreted as text
Type
String | null

sign(privateKey) → {module:message~Message}

Sign the message (the literal data packet of the message)
Parameters:
Name Type Description
privateKey Array.<module:key~Key> private keys with decrypted secret key data for signing
Source:
Returns:
new message with signed content
Type
module:message~Message

unwrapCompressed() → {module:message~Message}

Unwrap compressed message
Source:
Returns:
message Content of compressed message
Type
module:message~Message

verify(publicKeys) → {Array.<({keyid: module:type/keyid, valid: Boolean})>}

Verify message signatures
Parameters:
Name Type Description
publicKeys Array.<module:key~Key> public keys to verify signatures
Source:
Returns:
list of signer's keyid and validity of signature
Type
Array.<({keyid: module:type/keyid, valid: Boolean})>