Interface to a mailing list. More...

Inheritance diagram for MailinglistListInterface:

Public Member Functions
MailinglistListInterface
	checkMessage (MailinglistMessageInterface $message)
	checkMessage() More...

	processMessage (MailinglistMessageInterface $message)
	processMessage() More...

	schema (&$schema, $type)
	schema(); More...

	getMemberInfo ($email)
	getMemberInfo() More...

	getMemberPage ($page)
	getMemberPage() More...

Detailed Description

Interface to a mailing list.

Definition at line 12 of file MailinglistListInterface.php.

Member Function Documentation

checkMessage ( MailinglistMessageInterface $message )

checkMessage()

Todo:: Add code to indicate what operations the list module can support hasOperation($string) Things like subscribe, unsubscribe, options

Called on each message read from a mailbox to see if we want to process it.

Parameters

$message a MailinglistMessage object with the email received

Returns: TRUE if we have processed the message, FALSE if we don't know what to do.

Implemented in Mailman21List, MailinglistGenericList, and MailinglistList.

getMemberInfo ( $email )

getMemberInfo()

Get information about a subscriber

Parameters

$email String with email address of member to look update

Returns: If member does not exist, then returns FALSE, else returns an array with the information about the subcriber.

Implemented in Mailman21List, and MailinglistList.

getMemberPage ( $page )

getMemberPage()

get a page of membership information

Parameters

$page Page to fetch, FALSE is first page, after that repeat call with ['next'] info in the returned array.

Returns: array of information on page. ['next'] Value to use to get the next page. ['members'] Array of members fetched on page. subscript of array is the email address of the member, value is another array with information about the member (see getMemberInfo for details)

Implemented in Mailman21List, and MailinglistList.

processMessage ( MailinglistMessageInterface $message )

processMessage()

Processes the receipt of a message from the list. It is expected that this will call hook_mailinglist_message_alter() and hook_mailinglist_message(). MailinglistList::processMessage() does this for classes derived from it.

Typically called by checkMessage, by may also be called by an importer that knows what list a message is from (and might not pass the chekMessage test).

Parameters

$message a MailinglistMessage object with the email to process.

Implemented in Mailman21List, and MailinglistList.

schema	(	&	$schema,
			$type
	)

schema();

Update schema for a list.

Parameters

$schema	Array with schema for the list.
$type	The operation the schema is to support

Implemented in MailinglistList.

Referenced by _mailinglist_members_list_schema().

Here is the caller graph for this function:

The documentation for this interface was generated from the following file:

mailinglist/plugins/mailinglist/list/MailinglistListInterface.php

Public Member Functions

Detailed Description

Member Function Documentation