mailinglist.install File Reference

Install, update and uninstall functions for the Mailinglist module. More...

Go to the source code of this file.

Functions
	mailinglist_schema ()
	Implements hook_schema(). More...
	mailinglist_enable ()
	function mailinglist_update_7000() { } More...
	mailinglist_modules_enabled ($modules)
	Implements hook_modules_enabled(). More...

Detailed Description

Install, update and uninstall functions for the Mailinglist module.

Definition in file mailinglist.install.

Function Documentation

mailinglist_enable

(

)

function mailinglist_update_7000() { }

Implements hook_enable().

Definition at line 174 of file mailinglist.install.

                              {
//  cache_clear_all('plugins:feeds:plugins', 'cache');
//  drupal_set_message(t("Now that you've enabled Mailinglist, you need to <a href='@mailbox-add'>add a mailbox</a> corresponding to an IMAP/POP3/mbox mailbox.", array('@mailbox-add' => url('admin/structure/mailinglist/add'))));
}

mailinglist_modules_enabled

(

$modules

)

Implements hook_modules_enabled().

Definition at line 182 of file mailinglist.install.

                                               {
/*  if (in_array('mailinglist', $modules)) {
    $plugins = mailinglist_get_plugins('mailinglist', 'retrieve');
    if (count($plugins) == 1) {
      drupal_set_message(t('You have enabled Mailinglist, but not any modules providing retrieval plugins (such as the Mailinglist PHP IMAP module). Without a retrieval plugin, Mailinglist is basically useless.'), 'warning');
    }
  }
 */
}

mailinglist_schema

(

)

Implements hook_schema().

Definition at line 10 of file mailinglist.install.

                              {
  $schema['mailinglist_list'] = array(
    'description' => 'Table storing Mailinglist Definitions',
    'fields' => array(
      'admin_name' => array(
        'type' => 'varchar',
        'length' => '255',
        'not null' => TRUE,
        'description' => 'Unique name for mailing list Used to identify it programmatically.',
      ),
      'admin_title' => array(
        'type' => 'varchar',
        'length' => '255',
        'description' => 'Human-readable name for this Mailing List.',
      ),
      'object_type' => array(
        'type' => 'varchar',
        'length' => 255,
        'description' => 'Class responsible for list',
        'default' => 'MailinglistGenericList',
      ),
      'email_from' => array(
        'type' => 'varchar',
        'length' => 255,
        'description' => 'Default from address to use to send to list',
        'default' => '',
      ),
      'email_to' => array(
        'type' => 'varchar',
        'length' => 255,
        'description' => 'Email address to send list email to',
        'default' => '',
      ),
      'operations' => array(
        'type' => 'text',
        'size' => 'big',
        'serialize' => TRUE,
        'description' => 'Enabled operations for mailinglist.',
        'object default' => array(
        ),
      ),
      'parameters' => array(
        'type' => 'text',
        'size' => 'big',
        'serialize' => TRUE,
        'description' => 'Stored parameters for mailinglist.',
        'object default' => array(
        ),
      ),
      'settings' => array(
        'type' => 'text',
        'size' => 'big',
        'serialize' => TRUE,
        'description' => 'Configuration of mailinglist',
        'object default' => array(
        ),
      ),
    ),
    'primary key' => array('admin_name'),
    'export' => array(
      'key' => 'admin_name',
      'key name' => 'List Name',
      'primary key' => 'admin_name',
      'identifier' => 'lists',
      'object' => 'MailinglistGenericList',
      'object factory' => '_mailinglist_object_factory',
      'api' => array(
        'owner' => 'mailinglist',
        'api' => 'list',
        'minimum_version' => 1,
        'current_version' => 1,
      ),
    ),
  );

  $schema['mailinglist_retrieve'] = array(
    'description' => 'Table storing mailbox definitions',
    'fields' => array(
      'admin_name' => array(
        'type' => 'varchar',
        'length' => '255',
        'not null' => TRUE,
        'description' => 'Unique email address of this mailbox. Used to identify it programmatically.',
      ),
      'admin_title' => array(
        'type' => 'varchar',
        'length' => '255',
        'description' => 'Human-readable name (email address) of this mailbox.',
      ),
      'object_type' => array(
        'type' => 'varchar',
        'length' => 255,
        'description' => 'Class responsible for mailbox retrieval',
        'default' => 'MailinglistPhpImapRetrieve',
      ),
      'settings' => array(
        'type' => 'text',
        'size' => 'big',
        'serialize' => TRUE,
        'description' => 'Configuration settingss of mailinglist.',
        'object default' => array(
        ),
      ),
    ),
    'primary key' => array('admin_name'),
    'export' => array(
      'key' => 'admin_name',
      'key name' => 'Email address',
      'primary key' => 'admin_name',
      'identifier' => 'mailbox',
      'object' => 'MailinglistPhpImapRetrieve',
      'object factory' => '_mailinglist_object_factory',
      'api' => array(
        'owner' => 'mailinglist',
        'api' => 'retrieve',
        'minimum_version' => 1,
        'current_version' => 1,
      ),
    ),
  );

  $schema['mailinglist_names']= array(
    'description' => 'Table for tracking email address <-> Real name mappings',
    'fields' => array(
      'name_key' => array(
        'type' => 'serial',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'description' => 'Primary ID field for the table. Not used for anything except internal lookups.',
      ),
      'email' => array(
        'type' => 'varchar',
        'length' => '255',
        'description' => 'E-Mail Address',
      ),
      'name' => array(
        'type' => 'varchar',
        'length' => 255,
        'description' => 'Name used',
      ),
      'count' => array(
        'description' => 'Number of messages using this combination',
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
      ),
    ),
    'primary key' => array('name_key'),
  );

  /*
  Note from experience, we can not ask here if the various mailing lists need their own
  tables by calling a hook function, as we can not load the objects until we define this
  schema, or mailinglist_schema will get called again
  */
  return $schema;
}