Interface PasswordRequestFunc

Hierarchy

PasswordRequestFunc

Callable

PasswordRequestFunc(ctx: CryptoContext, userId: string, prompt: string, reprompt: boolean, response: GMime.Stream): boolean

- Defined in GMime-3.0.d.ts:1370
A password request callback allowing a #GMimeCryptoContext to prompt the user for a password for a given key.

Parameters
- ctx: CryptoContext
  
  the #GMimeCryptoContext making the request
- userId: string
  
  the user_id of the password being requested
- prompt: string
  
  a string containing some helpful context for the prompt
- reprompt: boolean
  
  %TRUE if this password request is a reprompt due to a previously bad password response
- response: GMime.Stream
  
  a stream for the application to write the password to (followed by a newline '\n' character)
Returns boolean