RecipientInfo Event

Fired for each recipient key of the encrypted message.

Syntax

pimap.on('RecipientInfo', [callback])

Callback

The 'callback' is called when the 'RecipientInfo' event is emited.

function(e){ }

The argument 'e' has the following properties:

e.keyId
e.publicKeyAlgorithm

Remarks

This event fires when the Decrypt or DecryptAndVerifySignature method is called.

KeyId is the Id of the key used to encrypt the message. If a subkey was used to encrypt the message this will be the Id of that subkey. It is the hex-encoded, 4- or 8-byte Id of the key. It is the same as the last 4 or 8 bytes of the fingerprint. For instance:

BF52A0AB

This can be used to identify the correct key to specify in Keys. Keys can be set from within this event as this event fires directly before the decryption process begins.

IPWorks OpenPGP 2020 Node.js Edition Website Download Support Questions / Feedback?
IPWorks OpenPGP 2020 Node.js Edition Introduction Licensing Instructions CertMgr Class Introduction Properties CertEffectiveDate CertEncoded CertExpirationDate CertExtendedKeyUsage CertFingerprint CertIssuer CertKeyPassword CertPrivateKey CertPrivateKeyAvailable CertPrivateKeyContainer CertPublicKey CertPublicKeyAlgorithm CertPublicKeyLength CertSerialNumber CertSignatureAlgorithm CertSubject CertSubjectAltNames CertThumbprintMD5 CertThumbprintSHA1 CertThumbprintSHA256 CertUsage CertUsageFlags CertVersion CertExtensionCount CertExtensionCritical CertExtensionOID CertExtensionValue CertStore CertStorePassword CertStoreType ExportedCert ExportFormat ExportPrivateKey Methods Config CreateCertificate CreateKey DeleteCertificate DeleteKey ExportCertificate GenerateCSR ImportCertificate ImportSignedCSR IssueCertificate ListCertificateStores ListKeys ListMachineStores ListStoreCertificates ReadCertificate ReadCSR Reset SaveCertificate ShowCertificateChain SignCSR Events CertChain CertList Error KeyList Log StoreList Configuration Error Codes KeyMgr Class Introduction Properties KeyCurve KeyEffectiveDate KeyEncoded KeyExpirationDate KeyFingerprint KeyId KeyOtherUserIds KeyPassphrase KeyPublicKey KeyPublicKeyAlgorithm KeyPublicKeyLength KeyRevoked KeySecretKey KeySecretKeyAvailable KeyUsage KeyUsageFlags KeyUserId Keyring Methods AddRevoker AddUserId ChangeExpirationDate ChangePassphrase Config CreateKey CreateSubKey DeleteKey ExportPublicKey ExportSecretKey ImportKey ImportKeyB ListKeys ListSignatures ListSubkeys LoadKeyring Reset RevokeKey SaveKeyring SignUserId VerifyPassphrase Events Error KeyList KeyPassphrase SignatureList Status SubkeyList Configuration Error Codes MIME Class Introduction Properties Boundary ContentType ContentTypeAttr Message MessageHeaderCount MessageHeaderField MessageHeaderValue MessageHeadersString PartCount PartContentDisposition PartContentDispositionAttr PartContentId PartContentType PartContentTypeAttr PartDecodedFile PartDecodedString PartEncoding PartFilename PartHeaders PartName PartSize Methods Config DecodeFromFile DecodeFromString EncodeToFile EncodeToString Reset ResetData Events Error Header Progress Configuration Error Codes OpenPGP Class Introduction Properties ASCIIArmor AutoSelectAlgorithms ClearSignature CompressionMethod DetachedSignature EncryptingAlgorithm InputFile InputMessage KeyCount KeyEncoded KeyKeyring KeyPassphrase KeyUserId MessageHeaderCount MessageHeaderField MessageHeaderValue OutputFile OutputMessage Overwrite RecipientKeyCount RecipientKeyEncoded RecipientKeyKeyring RecipientKeyUserId SignerKeyCount SignerKeyEncoded SignerKeyKeyring SignerKeyUserId SigningAlgorithm Methods Config Decrypt DecryptAndVerifySignature Encrypt GetRecipientInfo Reset Sign SignAndEncrypt VerifySignature Events Error KeyPassphrase Progress RecipientInfo SignatureInfo Status VerificationStatus Configuration Error Codes PFileMailer Class Introduction Properties AttachmentCount AttachmentFile AttachmentName AuthMechanism BCc Cc Command CompressionMethod Connected DeliveryNotificationTo EncryptingAlgorithm FirewallAutoDetect FirewallType FirewallHost FirewallPassword FirewallPort FirewallUser From Idle Importance KeyCount KeyEncoded KeyKeyring KeyPassphrase KeyUserId LastReply LocalHost MailPort MailServer MessageDate MessageId MessageRecipientCount MessageRecipientAddress MessageRecipientName MessageRecipientOptions MessageRecipientType MessageText OtherHeaders Password Priority ReadReceiptTo RecipientKeyCount RecipientKeyEncoded RecipientKeyKeyring RecipientKeyUserId ReplyTo SendTo Sensitivity SigningAlgorithm SSLAcceptServerCertEncoded SSLCertEncoded SSLCertStore SSLCertStorePassword SSLCertStoreType SSLCertSubject SSLEnabled SSLServerCertEncoded SSLStartMode Subject Timeout User Methods AddAttachment Config Connect Disconnect DoEvents Encrypt Interrupt ProcessQueue Queue ResetHeaders Send Sign SignAndEncrypt Events ConnectionStatus EndTransfer Error KeyPassphrase PITrail Progress SSLServerAuthentication SSLStatus StartTransfer Status Transfer Configuration Error Codes PHTMLMailer Class Introduction Properties AttachmentCount AttachmentFile AttachmentName AuthMechanism BCc Cc Command CompressionMethod Connected DeliveryNotificationTo EncryptingAlgorithm FirewallAutoDetect FirewallType FirewallHost FirewallPassword FirewallPort FirewallUser From HTMLFile Idle ImageCount ImageData ImageFile ImageId ImageType Importance KeyCount KeyEncoded KeyKeyring KeyPassphrase KeyUserId LastReply LocalHost MailPort MailServer MessageDate MessageHTML MessageId MessageRecipientCount MessageRecipientAddress MessageRecipientName MessageRecipientOptions MessageRecipientType MessageText OtherHeaders ParseHTML Password Priority ReadReceiptTo RecipientKeyCount RecipientKeyEncoded RecipientKeyKeyring RecipientKeyUserId ReplyTo SendTo Sensitivity SigningAlgorithm SSLAcceptServerCertEncoded SSLCertEncoded SSLCertStore SSLCertStorePassword SSLCertStoreType SSLCertSubject SSLEnabled SSLServerCertEncoded SSLStartMode Subject Timeout User Methods AddAttachment Config Connect Disconnect DoEvents Encrypt Interrupt ProcessQueue Queue ResetHeaders Send Sign SignAndEncrypt Events ConnectionStatus EndTransfer Error KeyPassphrase PITrail Progress SSLServerAuthentication SSLStatus StartTransfer Status Transfer Configuration Error Codes PIMAP Class Introduction Properties AuthMechanism AutoDecodeParts Command Connected EndByte FirewallAutoDetect FirewallType FirewallHost FirewallPassword FirewallPort FirewallUser Idle KeyCount KeyEncoded KeyKeyring KeyPassphrase KeyUserId LastReply LocalHost Mailbox MailboxFlags MailboxListCount MailboxListFlags MailboxListName MailboxListSeparator MailPort MailServer Message MessageContentEncoding MessageContentType MessageCount MessageDate MessageDeliveryTime MessageFlags MessageFrom MessageHeaderCount MessageHeaderField MessageHeaderValue MessageHeadersString MessageId MessageInfoCount MessageInfoDate MessageInfoFlags MessageInfoFrom MessageInfoMessageId MessageInfoSize MessageInfoSubject MessageInReplyTo MessageNetId MessagePartCount MessagePartContentDisposition MessagePartContentEncoding MessagePartContentId MessagePartContentType MessagePartFilename MessagePartId MessagePartMultipartMode MessagePartParameters MessagePartSize MessageRecipientCount MessageRecipientAddress MessageRecipientName MessageRecipientOptions MessageRecipientType MessageReplyTo MessageSender MessageSet MessageSize MessageSubject MessageText Overwrite Password PeekMode RecentMessageCount SignerKeyCount SignerKeyEncoded SignerKeyKeyring SignerKeyUserId SortCriteria SSLAcceptServerCertEncoded SSLCertEncoded SSLCertStore SSLCertStorePassword SSLCertStoreType SSLCertSubject SSLEnabled SSLServerCertEncoded SSLStartMode StartByte Timeout UIDMode UIDValidity User Methods AddMessageFlags AppendToMailbox CheckMailbox CloseMailbox Config Connect CopyToMailbox CreateMailbox Decrypt DecryptAndVerifySignature DeleteFromMailbox DeleteMailbox DeleteMailboxACL Disconnect DoEvents ExamineMailbox ExpungeMailbox FetchMessageHeaders FetchMessageInfo FetchMessagePart FetchMessagePartHeaders FetchMessageText GetMailboxACL Interrupt ListMailboxes ListSubscribedMailboxes LocalizeDate MoveToMailbox Noop RenameMailbox ResetMessageFlags SearchMailbox SelectMailbox SetMailboxACL StartIdle StopIdle SubscribeMailbox UnsetMessageFlags UnsubscribeMailbox VerifySignature Events ConnectionStatus EndTransfer Error Header IdleInfo KeyPassphrase MailboxACL MailboxList MessageInfo MessagePart PITrail Progress RecipientInfo SignatureInfo SSLServerAuthentication SSLStatus StartTransfer Status Transfer VerificationStatus Configuration Error Codes PPOP Class Introduction Properties AuthMechanism Command Connected FirewallAutoDetect FirewallType FirewallHost FirewallPassword FirewallPort FirewallUser Idle IncludeHeaders KeyCount KeyEncoded KeyKeyring KeyPassphrase KeyUserId LastReply LocalHost MailPort MailServer MaxLines Message MessageCc MessageCount MessageDate MessageFrom MessageHeaderCount MessageHeaderField MessageHeaderValue MessageHeadersString MessageNumber MessageRecipientCount MessageRecipientAddress MessageRecipientName MessageRecipientOptions MessageRecipientType MessageReplyTo MessageSize MessageSubject MessageText MessageTo MessageUID Password SignerKeyCount SignerKeyEncoded SignerKeyKeyring SignerKeyUserId SSLAcceptServerCertEncoded SSLCertEncoded SSLCertStore SSLCertStorePassword SSLCertStoreType SSLCertSubject SSLEnabled SSLServerCertEncoded SSLStartMode Timeout TotalSize User Methods Config Connect Decrypt DecryptAndVerifySignature Delete Disconnect DoEvents Interrupt ListMessageSizes ListMessageUIDs LocalizeDate Reset Retrieve RetrieveHeaders VerifySignature Events ConnectionStatus EndTransfer Error Header KeyPassphrase MessageList PITrail Progress RecipientInfo SignatureInfo SSLServerAuthentication SSLStatus StartTransfer Status Transfer VerificationStatus Configuration Error Codes PSMTP Class Introduction Properties AllowExtensions AuthMechanism BCc Cc Command CompressionMethod Connected DeliveryNotificationTo EncryptingAlgorithm FirewallAutoDetect FirewallType FirewallHost FirewallPassword FirewallPort FirewallUser From Idle Importance KeyCount KeyEncoded KeyKeyring KeyPassphrase KeyUserId LastReply LocalHost MailPort MailServer Message MessageDate MessageHeaderCount MessageHeaderField MessageHeaderValue MessageHeadersString MessageId MessageRecipientCount MessageRecipientAddress MessageRecipientName MessageRecipientOptions MessageRecipientType MessageText OtherHeaders Password Priority ReadReceiptTo RecipientKeyCount RecipientKeyEncoded RecipientKeyKeyring RecipientKeyUserId ReplyTo ReturnPath SendTo Sensitivity SigningAlgorithm SSLAcceptServerCertEncoded SSLCertEncoded SSLCertStore SSLCertStorePassword SSLCertStoreType SSLCertSubject SSLEnabled SSLServerCertEncoded SSLStartMode Subject Timeout User Methods Config Connect Disconnect DoEvents Encrypt Expand Interrupt ProcessQueue Queue ResetHeaders Send SendToTerminalAndEmail SendToTerminalOnly SendToTerminalOrEmail Sign SignAndEncrypt Verify Events ConnectionStatus EndTransfer Error Expand KeyPassphrase PITrail Progress SSLServerAuthentication SSLStatus StartTransfer Status Transfer Configuration Error Codes Software License	RecipientInfo Event Fired for each recipient key of the encrypted message. Syntax pimap.on('RecipientInfo', [callback]) Callback The 'callback' is called when the 'RecipientInfo' event is emited. function(e){ } The argument 'e' has the following properties: e.keyId e.publicKeyAlgorithm Remarks This event fires when the Decrypt or DecryptAndVerifySignature method is called. `KeyId` is the Id of the key used to encrypt the message. If a subkey was used to encrypt the message this will be the Id of that subkey. It is the hex-encoded, 4- or 8-byte Id of the key. It is the same as the last 4 or 8 bytes of the fingerprint. For instance: view source `BF52A0AB` This can be used to identify the correct key to specify in Keys. Keys can be set from within this event as this event fires directly before the decryption process begins.
Copyright (c) 2022 /n software inc. - All rights reserved. IPWorks OpenPGP 2020 Node.js Edition - Version 20.0 [Build 8249]

IPWorks OpenPGP 2020 Node.js Edition

RecipientInfo Event

Syntax

Callback

Remarks

Questions / Feedback?