File/plugins/gpg/setup.php

Description
Description | Functions

setup.php ----------- GPG plugin setup file

Copyright (c) 1999-2005 The SquirrelMail development team Licensed under the GNU GPL. For full terms see the file COPYING.

Copyright (c) 2002-2005 Braverock Ventures Copyright (c) 2007 The NaSMail Project Licensed under the GNU GPL. For full terms see the file COPYING.

  • version: $Id: setup.php 1380 2008-05-26 16:40:16Z tokul $
Functions
Description | Functions
gpg_compose_bottom (line 102)

This function is called by the main SM plugin_init (above)

at the end of the compose page. This is here because the second send button is not in existance during the button row calls which contain most of the javascript for the compose page

void gpg_compose_bottom ()
gpg_compose_form (line 114)

Adds gpg plugin attributes to compose form

void gpg_compose_form ()
gpg_compose_form_process (line 170)

Function attached to compose_form_process hook

void gpg_compose_form_process (array &$Args)
  • array &$Args: hook arguments. Function is used to process "Encrypt" and "Encrypt&Sign" form actions.
gpg_compose_row (line 138)

This function adds a "Encrypt Now" and "GPG Sign" link to the "Compose" row during message composition.

void gpg_compose_row ()
gpg_compose_send (line 159)

This is where the Encrypt on Send and Encrypt and Sign on Send functions go.

  • return: modified hook arguments
  • todo: is return required? it is modified in reference
array gpg_compose_send (array &$args)
  • array &$args: compose_send hook arguments
gpg_decrypt_attachment (line 90)

This is the MIME handler for decrypting attachments.

void gpg_decrypt_attachment (array &$attachinfo)
  • array &$attachinfo: Array of attachment information defined by the SM API
gpg_handle_octet_stream (line 64)

This is the MIME handler for PGP attachments that are not signed with PGP mime types.

Becasue this is on the octet/stream attachment type, we check the attachment name before invoking the hook function.

void gpg_handle_octet_stream (array &$attachinfo)
  • array &$attachinfo: Array of attachment information defined by the SM API
gpg_handle_pubkeys (line 278)

Function attached to 'attachment application/pgp-keys' hook

  • since: 2.1.nsm
void gpg_handle_pubkeys (array &$args)
  • array &$args: Hook arguments
gpg_handle_signature (line 80)

This function is called by the main SM plugin_init (above)

This is the MIME handler for verifying detached signatures.

void gpg_handle_signature (array &$attachinfo)
  • array &$attachinfo: Array of attachment information defined by the SM API
gpg_help_chapter (line 227)

Function attached to help_chapter hook

void gpg_help_chapter ()
gpg_identity_process (line 253)
void gpg_identity_process ( $args)
  • $args
gpg_identity_renumber (line 258)
void gpg_identity_renumber ( $args)
  • $args
gpg_identity_table (line 267)
string gpg_identity_table (array $args)
  • array $args
gpg_loading_constants (line 221)

Function attached to loading_constants hook

void gpg_loading_constants ()
gpg_loading_prefs (line 239)

Function attached to loading_prefs hook

void gpg_loading_prefs ()
gpg_optpage_register_block (line 148)

This function formats and adds the plugin and its description to the Options screen.

void gpg_optpage_register_block ()
gpg_optpage_set_loadinfo (line 248)

Function attached to optpage_set_loadinfo hook

  • since: 2.1.nsm
void gpg_optpage_set_loadinfo ()
gpg_read_body_header (line 127)

Function attached to read_body_header hook

void gpg_read_body_header ()
gpg_show_menuline (line 233)

Function attached to menuline hook

void gpg_show_menuline ()
gpg_version (line 286)

Shows plugin version

string gpg_version ()
squirrelmail_plugin_init_gpg (line 21)

gpg init function

void squirrelmail_plugin_init_gpg ()

Documentation generated on Sun, 22 Nov 2009 17:36:47 +0200 by phpDocumentor 1.4.3