TElMessagePartHandlerPGPMIME.OnKeyPassphrase property

TElMessagePartHandlerPGPMime.OnKeyPassphrase

This event is fired when a password for the key is required.

Declaration

[C#]
event TSBPGPKeyPassphraseEvent OnKeyPassphrase;
delegate void TSBPGPKeyPassphraseEvent(Object Sender, TElPGPCustomSecretKey Key, ref string Passphrase, ref bool Cancel);

[VB.NET]
Event OnKeyPassphrase As TSBPGPKeyPassphraseEvent
Delegate Sub TSBPGPKeyPassphraseEvent(ByVal Sender As Object, ByVal Key As TElPGPCustomSecretKey, ByRef Passphrase As String, ByRef Cancel As Boolean)

[Pascal]
property OnKeyPassphrase : TSBPGPKeyPassphraseEvent;
TSBPGPKeyPassphraseEvent = procedure(Sender: TObject; Key : TElPGPCustomSecretKey; var Passphrase: string; var Cancel: boolean) of object;

[C++]
    void get_OnKeyPassphrase(TSBPGPKeyPassphraseEvent &pMethodOutResult, void * &pDataOutResult);
    void set_OnKeyPassphrase(TSBPGPKeyPassphraseEvent pMethodValue, void * pDataValue);
    typedef void (SB_CALLBACK *TSBPGPKeyPassphraseEvent)(void * _ObjectData, TObjectHandle Sender, TElPGPCustomSecretKeyHandle Key, char * pcPassphrase, int32_t &szPassphrase, int8_t &Cancel);

[PHP]
    TSBPGPKeyPassphraseEvent|callable|NULL get_OnKeyPassphrase()
    void set_OnKeyPassphrase(TSBPGPKeyPassphraseEvent|callable|NULL $Value)
    callable TSBPGPKeyPassphraseEvent(TObject $Sender, TElPGPCustomSecretKey $Key, string &$Passphrase, bool &$Cancel)

[Java]
    TSBPGPKeyPassphraseEvent getOnKeyPassphrase();
    void setOnKeyPassphrase(TSBPGPKeyPassphraseEvent Value);
    TSBPGPKeyPassphraseEvent.Callback OnKeyPassphrase = new TSBPGPKeyPassphraseEvent.Callback() {
        public void TSBPGPKeyPassphraseEventCallback(TObject Sender, TElPGPCustomSecretKey Key, TSBString Passphrase, TSBBoolean Cancel) {
            //...
        }
    }

Parameters

Key - key which needs password.
Passphrase - password.
Cancel - True if the password can't be provided and processing must be cancelled.
pcPassphrase - password.
szPassphrase - the length of pcPassphrase.

Description

This event is fired by TElMessagePartHandlerPGPMime when it needs a password to access a secret key. The event is fired until correct password is passed or Cancel parameter is set to True.
If the message is encrypted using several keys then OnKeyPassphrase event will be fired as many times as necessary for the first key then for the second one and so on.