mailinglist.module File Reference

Interfaces with a mailinglist. More...

Go to the source code of this file.

Functions
	mailinglist_permission ()
	Implements hook_permission(). More...
	mailinglist_help ($path, $arg)
	Implements hook_help(). More...
	mailinglist_menu ()
	Implements hook_menu(). More...
	mailinglist_cron_queue_info ()
	Implements hook_cron_queue_info(). More...
	mailinglist_cron ()
	Implements hook_cron(). More...
	_mailinglist_file_path ()
	_mailinglist_file_path() gets the file path that we will use to place files in More...
	_mailinglist_base_filename ($path)
	_mailinglist_base_filename(). More...
	_mailinglist_mailbox_scan ()
	Process the configured mailing boxes. More...
	_mailinglist_maildir_scan ()
	_mailinglist_mailbox_scan() More...
	_mailinglist_mailbox_process ($list, $file, $offset)
	_mailinglist_mailbox_process(). More...
	mailinglist_message_callback ($msg)
	Message Queue Callback function. More...
	_mailinglist_encode_password ($pass)
	_mailinglist_encode_password More...
	_mailinglist_decode_password ($code)
	_mailinglist_decode_password More...
	mailinglist_array_merge_recursive_distinct (array &$array1, array &$array2)
	array_merge_recursive does indeed merge arrays, but it converts values with duplicate keys to arrays rather than overwriting the value in the first array with the duplicate value in the second array, as array_merge does. More...
	_mailinglist_datetime_schema ($desc)
	Return the schema for a 'datetime' field. More...
	_mailinglist_datetime_format ($ts)
	Convert a 'timestamp to a 'datetime'. More...
	_mailinglist_datetime_ts ($time)
	Convert a 'datetime' field into a timestamp. More...
	mailinglist_email_name ($email, $name, $count=0)
	Lookup Email <-> Name combination. More...
	mailinglist_init ()
	CTOOLS Hooks More...
	mailinglist_ctools_plugin_directory ($owner, $plugin_type)
	Implements hook_ctools_plugin_directory(). More...
	mailinglist_ctools_plugin_type ()
	Implements hook_ctools_plugin_type(). More...
	mailinglist_plugin_load_class ($module, $type, $plugin, $class_name='handler', $args=NULL)
	Wrapper to load any class type. More...
	mailinglist_get_plugins ($module, $type)
	Wrapper to load plugins. More...
	_mailinglist_build_options ($source, $key_name= 'name')
	Builds a Select control array from a menu form an array from a ctools_get_plugin. More...
	_mailinglist_object_factory ($schema, $data)
	Builds an type variable object from a database table entry. More...
	mailinglist_mailbox_load ($mbox)
	CTools Export UI More...
	mailinglist_mailbox_load_all ($show_disabled=TRUE)
	Load all mailinglists. More...
	_mailinglist_mailbox_test ($form, &$form_state)
	_mailinglist_mailbox_test More...
	_mailinglist_mailbox_test_output ($mailbox)
	_mailinglist_mailbox_test_output() More...
	mailinglist_list_load ($list)
	Load a list definition. More...
	mailinglist_list_load_all ($show_disabled=TRUE)
	Load all mailinglists. More...
	mailinglist_operation_load ($oper)
	@ name CTools Operation/******** operation More...
	mailinglist_operation_load_all ()
	mailinglist_operation_load_all() More...

Detailed Description

Interfaces with a mailinglist.

Todo:

Themeing Functions Message. MessageSummary. MessageSummaryList.

Todo:

Content Type Archived Message?

Todo:

Possible define a FieldType for Messages? as a way to link to Themeing.

Definition in file mailinglist.module.

Function Documentation

_mailinglist_base_filename

(

$path

)

_mailinglist_base_filename().

Converts an absolute file path to a relative path to our directory, primarily for logging.

Definition at line 239 of file mailinglist.module.

References _mailinglist_file_path().

Referenced by _mailinglist_mailbox_process(), _mailinglist_maildir_scan(), and MailinglistArchiveOperation\form().

                                           {
  $base = _mailinglist_file_path() . '/';
  return str_replace($base, '', $path);
}

Here is the call graph for this function:

Here is the caller graph for this function:

_mailinglist_build_options	(		$source,
			$key_name = 'name'
	)

Builds a Select control array from a menu form an array from a ctools_get_plugin.

Parameters

$source	Array - The array defining the options to select from. Key of array will be the value returned for the selected item, text taken from field selected by $key_name. A plugin list obtained from ctools_get_plugins is compatable with this function.
$key_name	String - The key used to access the field that give the Text to use for the option.

Returns

Array - a render array for the select control.

Definition at line 701 of file mailinglist.module.

Referenced by MailinglistListUI\edit_form(), and MailinglistRetrieveUI\edit_form().

                                                                 {
  $options = array();
  foreach ($source as $key => $value) {
    $options[$key] = is_object($value) ? $value->$key_name : $value[$key_name];
  }
  return $options;
}

Here is the caller graph for this function:

_mailinglist_datetime_format

(

$ts

)

Convert a 'timestamp to a 'datetime'.

Definition at line 561 of file mailinglist.module.

Referenced by mailinglist_archive_message_add(), mailinglist_members_scan(), mailinglist_members_seen(), mailinglist_members_subscribe(), mailinglist_members_unseen(), mailinglist_members_unsubscribe(), mailinglist_members_update(), and mailinglist_members_update_ind().

                                           {
  $value = gmdate('Y-m-d H:i:s', $ts);
//  dpm($value . " ... " . date_iso8601($ts)); date_iso uses local timezone
  return $value;
}

Here is the caller graph for this function:

_mailinglist_datetime_schema

(

$desc

)

Return the schema for a 'datetime' field.

Note that because drupal does not directly support a DateTime field standardly, we use these 3 functions to abstract out our decision.

Definition at line 548 of file mailinglist.module.

Referenced by _mailinglist_archives_list_schema(), _mailinglist_members_list_schema(), and mailinglist_archive_schema().

                                             {
  if (!is_array($desc)) {
    $desc = array('description' => 'desc');
  }

  $desc['type'] = 'char';
  $desc['length'] = 19;
  return $desc;
}

Here is the caller graph for this function:

_mailinglist_datetime_ts

(

$time

)

Convert a 'datetime' field into a timestamp.

Definition at line 570 of file mailinglist.module.

Referenced by MailinglistMembersOperation\form(), MailinglistArchiveOperation\form(), and mailinglist_archive_summary_list().

                                         {
  return strtotime($time . " UTC");
}

Here is the caller graph for this function:

_mailinglist_decode_password

(

$code

)

_mailinglist_decode_password

Simple decryption routine to make passwords harder to read in debug messages

Definition at line 481 of file mailinglist.module.

Referenced by MailinglistPop3Retrieve\connect(), MailinglistPhpImapRetrieve\edit_form(), MailinglistPop3Retrieve\edit_form(), Mailman21List\edit_form(), MailinglistMailboxRetrieve\edit_form(), and Mailman21List\getWebPage().

                                             {
  if (empty($code)) return $code;
  $decode = base64_decode($code);
  $seed = ord($decode[0]);
  $pass = '';
  for ($i=1; $i < strlen($decode); $i++) {
    $ch = ord($decode[$i]);
    $seed = $ch - $seed;
    if ($seed < 0) $seed += 256;
    $pass .= chr($seed);
    $seed = $ch;
  }
  return $pass;
}

Here is the caller graph for this function:

_mailinglist_encode_password

(

$pass

)

_mailinglist_encode_password

Simple encryption routine to make passwords harder to read in debug messages

Definition at line 465 of file mailinglist.module.

Referenced by Mailman21List\edit_form_submit().

                                             {
  $seed = mt_rand(0, 255);
  $str = chr($seed);
  for ($i=0; $i < strlen($pass); $i++) {
    $seed = ($seed + ord($pass[$i])) % 256;
    $str .= chr($seed);
  }
  $encode = base64_encode($str);
  return $encode;
}

Here is the caller graph for this function:

_mailinglist_file_path

(

)

_mailinglist_file_path() gets the file path that we will use to place files in

Definition at line 222 of file mailinglist.module.

Referenced by _mailinglist_base_filename(), and _mailinglist_maildir_scan().

                                  {
  // Get path to store files for processing
  $path = variable_get('file_private_path');
  // If we don/t have a private path, get a public one, with defualts
  if (empty($path)) {
    $path = variable_get('file_public_path', conf_path() . '/files');
  }
  // Update to make absolute, and our sub directory
  $path = DRUPAL_ROOT . '/' . $path . '/mailinglist';
  $flag = file_prepare_directory($path, FILE_CREATE_DIRECTORY | FILE_MODIFY_PERMISSIONS);
  return $path;
}

Here is the caller graph for this function:

_mailinglist_mailbox_process	(		$list,
			$file,
			$offset
	)

_mailinglist_mailbox_process().

Process the specified number of messages from a mailbox.

Parameters

$list	The list whose archives to add the messages to.
$file	string: The name of the file to process.
$offset	int: The number of messages to skip at the begining of the file.

Returns

the new value of $offset to continue processing, or FALSE if we finished the file.

Todo:

Unquote >From lines.

Todo:

we can add code to compare "From " line to message here and fix stuff.

Definition at line 352 of file mailinglist.module.

References _mailinglist_base_filename().

Referenced by _mailinglist_maildir_scan().

                                                             {
  $time = time();
  $queue = DrupalQueue::get('mailinglist_message');
  $handle = fopen($file, 'r');
  if (!$handle) {
    // File not found
    watchdog('Mailinglist', 'File not found @file',
      array('@file' => _mailinglist_base_filename($file)),
      WATCHDOG_NOTICE);
    dpm($file, 'File Not found');
    fclose($handle);
    return FALSE;
  }
  fseek($handle, $offset);

  $fromline = fgets($handle);
  $cnt = 0;
  while( time() < $time+20 && $cnt < 1000) {
    $cnt = $cnt + 1;
    $msg = "";
    while (1) {
      // Remember where we were if we are now done.
      $offset = ftell($handle);
      $line = fgets($handle);
      if ($line === FALSE || substr($line, 0, 5) == 'From ') {
        $fromline = $line;
        break; // message done
      }
      $msg .= $line;
    }
    if ($msg == "" && $fromline == FALSE) {
      watchdog('Mailinglist', 'End of File @file',
        array('@file' => _mailinglist_base_filename($file)),
        WATCHDOG_NOTICE);
      dpm('End of File: ' . $file);
      unlink($file);
      return FALSE;
    }
    $msg = new MailinglistMessage($msg);
    $headers = $msg->headers();
    if(!isset($headers['From']) || !isset($headers['Date']) || !isset($headers['Subject'])){

      watchdog('Mailinglist', 'Bad message @file @offset @from MSG: @msg' ,
        array('@file' => _mailinglist_base_filename($file),
          '@offset' => $offset,
          '@from' => $fromline,
          '@msg' => check_plain(print_r($msg, TRUE)),
        ),
        WATCHDOG_ERROR);
      continue;
    }
    $from = $msg->header('From');
    if (is_array($from)) {
      $from = $from[0];
    }
    if (strpos($from, '@') == FALSE) {
      // obfuscated from line from archives
      $from = str_replace(' at ', '@', $from);
      $msg->setHeader('From', $from);
    }

    if ($list) {
      // List Specific, give to that list, assume it is to be archived
      $msg->setHeader('XX-List', $list->admin_name);
      $msg->setHeader('XX-Archive', '1');
      $msg->setHeader('XX-Status', 0);
    }
    $queue->createItem($msg);
  }
  fclose($handle);
  return $offset;
}

Here is the call graph for this function:

Here is the caller graph for this function:

_mailinglist_mailbox_scan

(

)

Process the configured mailing boxes.

Definition at line 247 of file mailinglist.module.

References _mailinglist_maildir_scan(), and mailinglist_mailbox_load_all().

Referenced by MailinglistArchiveOperation\form(), and mailinglist_cron().

                                     {
  _mailinglist_maildir_scan();

  $boxes = mailinglist_mailbox_load_all(false);
  foreach ($boxes as $index => $box) {
//    dpm($box, $index);
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

_mailinglist_mailbox_test	(		$form,
		&	$form_state
	)

_mailinglist_mailbox_test

Definition at line 797 of file mailinglist.module.

References _mailinglist_mailbox_test_output().

                                                        {
  $mailbox = (object)$form_state['values'];
  return _mailinglist_mailbox_test_output($mailbox);
}

Here is the call graph for this function:

_mailinglist_mailbox_test_output

(

$mailbox

)

_mailinglist_mailbox_test_output()

Definition at line 805 of file mailinglist.module.

References mailinglist_plugin_load_class().

Referenced by _mailinglist_mailbox_test(), MailinglistListUI\test_page(), and MailinglistRetrieveUI\test_page().

                                                    {
  $output = '<div id="mailinglist_test_results" class="form-wrapper">';
  // Call the test function.
  if (isset($mailbox->settings['object_type'])) {
    $class = mailinglist_plugin_load_class('mailinglist', 'retrieve', $mailbox->settings['object_type'], 'handler');
    if ($class) {
      $ret = $class->test($mailbox);
      foreach ($ret as $message) {
        $output .= '<div class="messages ' . $message['severity'] . '">' . $message['message'] . '</div>';
      }
    }
  }
  $output .= "</div>";
  return $output;
}

Here is the call graph for this function:

Here is the caller graph for this function:

_mailinglist_maildir_scan

(

)

_mailinglist_mailbox_scan()

Scan our data directory for mailbox files, proecess the messages in them and them delete them. Mailboxes in sub directories are given specifically to the list by the same name, mailboxes in the base directory will be put through the list detection method.

Definition at line 265 of file mailinglist.module.

References _mailinglist_base_filename(), _mailinglist_file_path(), _mailinglist_mailbox_process(), mailinglist_list_load(), and mailinglist_list_load_all().

Referenced by _mailinglist_mailbox_scan().

                                     {
  $queue = DrupalQueue::get('mailinglist_message');
  $path = _mailinglist_file_path();
  // Get the mailbox we are currently processing
  $file = variable_get('mailinglist_mailbox_current', FALSE);

  if ($file == FALSE) {
    if($queue->numberOfItems() > 100) {
      return; // If behind, don't start up a new file
    }
    $files = file_scan_directory($path, '/.*/');
    ksort($files);
    if (empty($files)) {
      dpm('Nothing', 'mailinglist_maildir_scan');
      return; // Nothing to do
    }
    $file = array_keys($files);
    $file = $file[0];

    $handle = fopen($file, 'r');
    fseek($handle, 0, SEEK_END);
    $end = ftell($handle);

    $local = substr($file, strlen($path)+1);
    $pos = strpos($local, '/');
    if ($pos > 0) {
      $listname = substr($local, 0, $pos);
    }
    else {
      $listname = FALSE;
    }
    watchdog('Mailinglist', 'Starting @file (@msg) @list',
      array('@msg' => $end,
            '@file' => _mailinglist_base_filename($file),
            '@list' => $listname),
      WATCHDOG_NOTICE);
    dpm($listname, 'list');
    $offset = 0;
    variable_set('mailinglist_mailbox_current', $file);
    variable_set('mailinglist_mailbox_current_offset', $offset);
    variable_set('mailinglist_mailbox_current_list', $listname);
    variable_set('mailinglist_mailbox_current_max', $end);
  }
  else {
    if($queue->numberOfItems() > 1000) {
      return; // If far behind, don't queue up more from file
    }
    // Continuing with a file, get rest of details.
    $offset = variable_get('mailinglist_mailbox_current_offset');
    $listname = variable_get('mailinglist_mailbox_current_list');
    $msgcnt = variable_get('mailinglist_mailbox_current_max');
  }

  if ($listname) {
    $list = mailinglist_list_load($listname);
  }
  else {
    $list = FALSE;
  }
  if ($list == FALSE) {
    $lists = mailinglist_list_load_all(FALSE);
  }

  $offset = _mailinglist_mailbox_process($list, $file, $offset);

  if ($offset === FALSE) {
    variable_set('mailinglist_mailbox_current', FALSE);
    variable_set('mailinglist_mailbox_current_offset', 0);
  }
 else {
    dpm($offset);
    variable_set('mailinglist_mailbox_current_offset', $offset);
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

_mailinglist_object_factory	(		$schema,
			$data
	)

Builds an type variable object from a database table entry.

Parameters

$schema	Array - The schema for the table being read
$data	Object(StdClass) - The data read from the table for this item

Returns

Object - loaded object of type specified by the data record

Note, the schema must have an field called 'type' which will be filled in with the type of object to be made. The plugin in its description needs to include the line 'object factory' => '_mailinglist_object_factory',

Called from the following code snippet in ctools_export_load_object if (isset($schema['export']['object factory']) && function_exists($schema['export']['object factory'])) { $object = $schema['export']['object factory']($schema, $data); } else { $object = _ctools_export_unpack_object($schema, $data, $export['object']); }

Where we will continue to the call to _ctools_export_unpack_object after determining the class that should be returned.

Definition at line 736 of file mailinglist.module.

Referenced by MailinglistExportUI\edit_form().

                                                     {
  ctools_include('plugins');
  $type = FALSE;
  if (isset($data->object_type)) {
    $object_type = $data->object_type;
    $owner = $schema['export']['api']['owner'];
    $api = $schema['export']['api']['api'];
    $class_name = ctools_plugin_load_class($owner, $api, $object_type, 'handler');
    if (!class_exists($class_name)) {
      $class_name = FALSE;
      $class_name = $schema['fields']['object_type']['default'];
    }
  }
  $object = _ctools_export_unpack_object($schema, $data, $class_name);
  return $object;
}

Here is the caller graph for this function:

mailinglist_array_merge_recursive_distinct	(	array &	$array1,
		array &	$array2
	)

array_merge_recursive does indeed merge arrays, but it converts values with duplicate keys to arrays rather than overwriting the value in the first array with the duplicate value in the second array, as array_merge does.

I.e., with array_merge_recursive, this happens (documented behavior):

array_merge_recursive(array('key' => 'org value'), array('key' => 'new value')); => array('key' => array('org value', 'new value'));

mailinglist_array_merge_recursive_distinct does not change the datatypes of the values in the arrays. Matching keys' values in the second array overwrite those in the first array, as is the case with array_merge, i.e.:

mailinglist_array_merge_recursive_distinct(array('key' => 'org value'), array('key' => 'new value')); => array('key' => array('new value'));

Parameters are passed by reference, though only for performance reasons. They're not altered by this function.

Parameters

$array1	[array]
$array2	[array]

Returns

array

Based on design:

Author

Daniel <daniel (at) danielsmedegaardbuus (dot) dk>

Gabriel Sobrinho <gabriel (dot) sobrinho (at) gmail (dot) com>

Definition at line 523 of file mailinglist.module.

Referenced by MailinglistExportUI\edit_form().

                                                                                    {
  $merged = $array1;

  foreach ( $array2 as $key => &$value ) {
    if ( is_array ( $value ) && isset ( $merged [$key] ) && is_array ( $merged [$key] ) ) {
      $merged [$key] = mailinglist_array_merge_recursive_distinct($merged [$key], $value);
    }
    else {
      $merged [$key] = $value;
    }
  }

  return $merged;
}

Here is the caller graph for this function:

mailinglist_cron

(

)

Implements hook_cron().

Definition at line 156 of file mailinglist.module.

References _mailinglist_mailbox_scan(), and mailinglist_mailbox_load_all().

                            {

  $boxes = mailinglist_mailbox_load_all(false);
  _mailinglist_mailbox_scan();
  foreach ($boxes as $index => $box) {
//    if (isset($list1->operations['members']) && $list1->operations['members']) {
//      mailinglist_members_scan($list1);
//    }
  }
}

Here is the call graph for this function:

mailinglist_cron_queue_info

(

)

Implements hook_cron_queue_info().

Definition at line 142 of file mailinglist.module.

                                       {
  $queue = array(
    'mailinglist_message' => array(
      'worker callback' => 'mailinglist_message_callback',
      'time' => '20',
    ),
  );
  return $queue;
}

mailinglist_ctools_plugin_directory	(		$owner,
			$plugin_type
	)

Implements hook_ctools_plugin_directory().

divides the plugins by owner module

Todo:

Condition to only return directories that we might actually be using.

ctools/export_ui mailinglist/list mailinglist/operation mailinglist/retrieve

Definition at line 620 of file mailinglist.module.

                                                                   {
  return 'plugins/' . $owner . '/' . $plugin_type;
}

mailinglist_ctools_plugin_type

(

)

Implements hook_ctools_plugin_type().

Definition at line 627 of file mailinglist.module.

                                          {
  return array(
    'list' => array(),      // List Personality Modules
    'operation' => array(),    // Extension Modules
    'retrieve' => array(),  // Data Retrieval Modules
  );
}

mailinglist_email_name	(		$email,
			$name,
			$count = 0
	)

Lookup Email <-> Name combination.

Definition at line 576 of file mailinglist.module.

Referenced by _mailinglist_members_lookup(), mailinglist_archive_message_add(), and mailinglist_members_process_memberpage().

                                                           {
  $email = strtolower($email);
  $sql = 'SELECT name_key from {mailinglist_names}
    WHERE email = :email AND name = :name';
  $result = db_query($sql, array(':email' => $email, ':name' => $name));
  $result = $result -> fetchAssoc();
  if (!$result) {
  // New Combo
    $fields = array('email' => $email, 'name' => $name);
    dpm($fields, 'New Combo');
    return (int) db_insert('mailinglist_names') -> fields($fields) -> execute();
  }
  else {
    // Existing Combo
    return (int) $result['name_key'];
  }
}

Here is the caller graph for this function:

mailinglist_get_plugins	(		$module,
			$type
	)

Wrapper to load plugins.

Parameters

$module	String - name of module owning the plugin type.
$type	String - type of plugins to retrieve.

Returns

Array - an array of plugin descriptors, sorted by weight.

Definition at line 669 of file mailinglist.module.

Referenced by MailinglistListUI\edit_form(), MailinglistRetrieveUI\edit_form(), and mailinglist_operation_load_all().

                                                 {
  ctools_include('plugins');
  $plugins = ctools_get_plugins($module, $type);
  $result = array();
  $weights = array();
  foreach ($plugins as $key => $info) {
    if (!empty($info['hidden'])) {
      continue;
    }
    if (!isset($info['weight'])) {
      $info['weight'] = 10;
    }
    $weights[] = $info['weight'];
    $result[$key] = $info;
  }
  array_multisort($weights, $result);
  return $result;
}

Here is the caller graph for this function:

mailinglist_help	(		$path,
			$arg
	)

Implements hook_help().

Help text added to pages specified (in "Help" region)

Todo:

expand to meet help text standards: http://drupal.org/node/632280

Definition at line 68 of file mailinglist.module.

                                       {
  switch ($path) {
    case 'admin/help#mailinglist':
      $help = file_get_contents( dirname(__FILE__) . "/INSTALL.txt");
      return _filter_autop($help);
      break;
    case 'admin/config/system/mailinglist/list/add':
      return t('Add help here');
  }
}

mailinglist_init

(

)

---

CTOOLS Hooks

---

Implements hook_init().

Definition at line 603 of file mailinglist.module.

                            {
  if (strstr(request_uri(), 'system/ajax') && $_POST['form_id'] == 'ctools_export_ui_edit_item_form') {
    ctools_include('export');
  }
}

mailinglist_list_load

(

$list

)

Load a list definition.

Implements hook_load().

Parameters

$list

This mailbox's name value.

Returns

A list object.

Definition at line 832 of file mailinglist.module.

Referenced by _mailinglist_maildir_scan(), mailinglist_members_callback(), and mailinglist_message_callback().

                                      {
  ctools_include('export');
  $obj = ctools_export_crud_load('mailinglist_list', $list);
  return $obj;
}

Here is the caller graph for this function:

mailinglist_list_load_all

(

$show_disabled = TRUE

)

Load all mailinglists.

Implements hook_load_all().

Parameters

$show_disabled

If TRUE, will return disabled mailinglists.

Returns

An array of list definition objects.

Definition at line 848 of file mailinglist.module.

Referenced by _mailinglist_maildir_scan(), _mailinglist_pagecallback(), mailinglist_archive_cron(), mailinglist_archive_schema(), mailinglist_members_cron(), mailinglist_members_modules_enabled(), mailinglist_members_permission(), mailinglist_members_schema(), mailinglist_message_callback(), mailinglist_permission(), and MailinglistRetrieveUI\process_page().

                                                          {
  ctools_include('export');
  $lists = ctools_export_crud_load_all('mailinglist_list');
  foreach ($lists as $list => $listdef) {
    if (isset($listdef->disabled) && $listdef->disabled && !$show_disabled) {
      unset($lists[$list]);
    }
  }
  return $lists;
}

Here is the caller graph for this function:

mailinglist_mailbox_load

(

$mbox

)

---

CTools Export UI

---

Load a mailbox definition.

Parameters

$mbox

This mailbox's name value.

Returns

A list object.

Definition at line 769 of file mailinglist.module.

                                         {
  ctools_include('export');
  $retrieve = ctools_export_crud_load('mailinglist_retrieve', $mbox);
  return $retrieve;
}

mailinglist_mailbox_load_all

(

$show_disabled = TRUE

)

Load all mailinglists.

Parameters

$show_disabled

If TRUE, will return disabled mailinglists.

Returns

An array of list definition objects.

Definition at line 783 of file mailinglist.module.

Referenced by _mailinglist_mailbox_scan(), and mailinglist_cron().

                                                             {
  ctools_include('export');
  $mboxes = ctools_export_crud_load_all('mailinglist_retrieve');
  foreach ($mboxes as $email => $mbox) {
    if (isset($listdef->disabled) && $mbox->disabled && !$show_disabled) {
      unset($mboxes[$email]);
    }
  }
  return $mboxes;
}

Here is the caller graph for this function:

mailinglist_menu

(

)

Implements hook_menu().

Define urls we will respond to

Definition at line 85 of file mailinglist.module.

                            {
  $base = variable_get('mailinglist_base', 'mailinglist');
  $items = array(
  // User Pages
    $base => array(
      'title' => 'Mailing Lists',
      'description' => 'Entry page for Mailinglist Module',
      'type' => MENU_CALLBACK,
      'page callback' => '_mailinglist_pagecallback',
      'page arguments' => array(1, 2, 3, 4, 5, 6, 7, 8, 9, 10),
      'access arguments' => array('access content'),
      'file' => 'mailinglist.pagecallback.inc',
    ),
    $base . '/%mailinglist_list' => array(
      'title' => 'MailingList Page',
      'description' => 'Entry page for Mailinglist Module',
      'type' => MENU_CALLBACK,
      'page callback' => '_mailinglist_list_pagecallback',
      'page arguments' => array(1, 2, 3, 4, 5, 6, 7, 8, 9, 10),
      'access arguments' => array('access content'),
      'file' => 'mailinglist.pagecallback.inc',
    ),
    $base . '/%mailinglist_list/%mailinglist_operation' => array(
      'title' => 'Mailing Lists Operation',
      'description' => 'Manage Mailing Operation Page',
      'type' => MENU_NORMAL_ITEM,
      'page callback' => 'drupal_get_form',
      'page arguments' => array('mailinglist_operation_form', 1, 2, 3, 4, 5, 6, 7, 8, 9, 10),
      'access arguments' => array('access content'),
      'file' => 'mailinglist.pagecallback.inc',
    ),
    // Admin Pages
    'admin/config/system/mailinglist' => array(
      'title' => 'Mailing Lists Configuration',
      'description' => 'Manage Mailing List Interface',
      'type' => MENU_NORMAL_ITEM,
      'page callback' => 'drupal_get_form',
      'page arguments' => array('_mailinglist_config_form'),
      'access arguments' => array('administer mailinglist'),
      'file' => 'mailinglist.admin.inc',
    ),
    'admin/config/system/mailinglist/config' => array(
      'title' => 'Config',
      'type' => MENU_DEFAULT_LOCAL_TASK,
      'page callback' => 'drupal_get_form',
      'page arguments' => array('_mailinglist_config_form'),
      'access arguments' => array('administer mailinglist'),
      'file' => 'mailinglist.admin.inc',
    ),
  );
  return $items;
}

mailinglist_message_callback

(

$msg

)

Message Queue Callback function.

Called by Queue processing

Definition at line 436 of file mailinglist.module.

References mailinglist_list_load(), and mailinglist_list_load_all().

                                            {
  $listname = $msg->header('XX-List');

  if ($listname) {
    $list = mailinglist_list_load($listname);
  }
  else {
    $list = FALSE;
  }
  if($list) {
    $list->processMessage($msg);
  } else {
    // No valid list specified, check all the lists.
    $lists = mailinglist_list_load_all(FALSE);
    foreach ($lists as $list1) {
      $flag = $list1->checkMessage($msg);
    }
  }
}

Here is the call graph for this function:

mailinglist_operation_load

(

$oper

)

@ name CTools Operation/******** operation

mailinglist_operation_load()

Implements hook_load().

Definition at line 869 of file mailinglist.module.

References $plugin.

Referenced by _mailinglist_list_pagecallback(), and mailinglist_operation_load_all().

                                           {
  ctools_include('plugins');
  require_once(drupal_get_path('module', 'mailinglist') . '/plugins/mailinglist/operation/MailinglistOperation.class.php');
  $plugin = ctools_get_plugins('mailinglist', 'operation', $oper);
  $plugin['key'] = $oper;
  $class = ctools_plugin_get_class($plugin, 'handler');
  if (class_exists($class)) {
    $obj = new $class;
    $obj->plugin = $plugin;
  }
  else {
    $obj = NULL;
  }
  return $obj;
}

Here is the caller graph for this function:

mailinglist_operation_load_all

(

)

mailinglist_operation_load_all()

Implements hook_load_all*().

Definition at line 890 of file mailinglist.module.

References $plugin, mailinglist_get_plugins(), and mailinglist_operation_load().

Referenced by MailinglistList\edit_form(), and mailinglist_permission().

                                          {
  $opers = mailinglist_get_plugins('mailinglist', 'operation');
  $ret = array();
  foreach ($opers as $key => $plugin) {
    $ret[$key] = mailinglist_operation_load($key);
  }
  return $ret;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mailinglist_permission

(

)

Implements hook_permission().

Definition at line 41 of file mailinglist.module.

References mailinglist_list_load_all(), and mailinglist_operation_load_all().

                                  {
  $lists = mailinglist_list_load_all(false);
  $opers = mailinglist_operation_load_all();

  $permissions = array(
    'administer mailinglist' => array(
      'title' => t('Administer Mailinglist mailboxes'),
    ),
  );
  foreach ($lists as $index => $list) {
    $permissions['mailinglist ' . $index] = array(
      'title' => t('Access ' . $list->admin_title),
    );
    foreach ($opers as $oindex => $oper) {
      $permissions['mailinglist ' . $index . ' ' . $oindex] = array(
        'title' => t($list->admin_title . ' ' . $oper->plugin['name']),
      );
    }
  }
  return $permissions;
}

Here is the call graph for this function:

mailinglist_plugin_load_class	(		$module,
			$type,
			$plugin,
			$class_name = 'handler',
			$args = NULL
	)

Wrapper to load any class type.

Parameters

$module	String - The module that owns the plugin type.
$type	String - The type of plugin.
$plugin	String - The id of the specific plugin to load.
$class_name	String - The identifier of the class. For example, 'handler'.
$args	Parameter passed to the constructor of the plugin

Returns

An instance of the plugin, created with the supplied arguments.

Definition at line 652 of file mailinglist.module.

References $plugin.

Referenced by _mailinglist_mailbox_test_output().

                                                                                                     {
  ctools_include('plugins');
  $class = ctools_plugin_load_class($module, $type, $plugin, $class_name);
  if ($class) {
    return new $class($args);
  }
}

Here is the caller graph for this function: