Services_Mailman
[ class tree: Services_Mailman ] [ index: Services_Mailman ] [ all elements ]

Class: Services_Mailman

Source Location: /Services_Mailman-0.1.0/Services/Mailman.php

Class Overview


Mailman Class


Author(s):

Version:

  • Release: 0.1.0

Copyright:

  • 2011 James Wade

Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 57]
Mailman Class


[ Top ]


Class Variables

$adminPW =

[line 76]

Default admin password for the list

For example: 'my-example-password'

  • Access: protected

Type:   string


[ Top ]

$adminURL =

[line 64]

Default URL to the Mailman "Admin Links" page (no trailing slash)

For example: 'http://www.example.co.uk/mailman/admin'

  • Access: protected

Type:   string


[ Top ]

$list =

[line 70]

Default name of the list

For example: 'test_example.co.uk'

  • Access: protected

Type:   string


[ Top ]

$request =  null

[line 82]

A HTTP request instance
  • Access: public

Type:   HTTP_Request2


[ Top ]



Method Detail

__construct (Constructor)   [line 93]

Services_Mailman __construct( string $adminURL, [string $list = ''], [string $adminPW = ''], [ $request = null])

Constructor
  • Access: public

Parameters:

string   $adminURL     Set the URL to the Mailman "Admin Links" page
string   $list     Set the name of the list
string   $adminPW     Set admin password of the list
HTTP_Request2   $request     Provide your HTTP request instance

[ Top ]

fetch   [line 194]

string fetch( string $url)

Fetches the HTML to be parsed

Parameters:

string   $url     A valid URL to fetch

[ Top ]

lists   [line 220]

array lists( [boolean $assoc = true])

List lists

(ie: <domain.com>/mailman/admin)


Parameters:

boolean   $assoc     Associated array (default) or not

[ Top ]

member   [line 264]

string member( string $string)

Find a member

(ie: <domain.com>/mailman/admin/<listname>/members?findmember=<email-address> &setmemberopts_btn&adminpw=<adminpassword>)


Parameters:

string   $string     A search string for member

[ Top ]

members   [line 526]

array members( )

List members

[ Top ]

setadminPW   [line 159]

Services_Mailman setadminPW( string $string)

Sets the admin password of the list

Parameters:

string   $string     The password string

[ Top ]

setadminURL   [line 130]

Services_Mailman setadminURL( string $string)

Sets the URL to the Mailman "Admin Links" page

Parameters:

string   $string     The URL to the Mailman "Admin Links" page (no trailing slash)

[ Top ]

setDigest   [line 422]

string setDigest( string $email, [bool $digest = 1])

Set digest. Note that the $email needs to be subsribed first (e.g. by using the subscribe() method)

(ie: <domain.com>/mailman/admin/<listname>/members?user=<email-address> &<email-address>_digest=1&setmemberopts_btn=Submit%20Your%20Changes &allmodbit_val=0&<email-address>_language=en&<email-address>_nodupes=1 &adminpw=<adminpassword>)


Parameters:

string   $email     Valid email address of a member
bool   $digest     Set the Digest on (1) or off (0)

[ Top ]

setList   [line 110]

Services_Mailman setList( string $string)

Sets the list name

Parameters:

string   $string     The name of the list

[ Top ]

setOption   [line 440]

string setOption( string $email, string $option, string $value)

Set an option

Parameters:

string   $email     Valid email address of a member
string   $option     A valid option
string   $value     A value for the given option

[ Top ]

setRequest   [line 179]

Services_Mailman setRequest( [ $object = null])

Sets the request object

Parameters:

HTTP_Request2   $object     A HTTP request instance (otherwise one will be created)

[ Top ]

subscribe   [line 374]

Services_Mailman subscribe( string $email, [boolean $invite = false])

Subscribe

(ie: http://example.co.uk/mailman/admin/test_example.co.uk/members/add ?subscribe_or_invite=0&send_welcome_msg_to_this_batch=1 &send_notifications_to_list_owner=0&subscribees=test%40example.co.uk &invitation=&setmemberopts_btn=Submit+Your+Changes)


Parameters:

string   $email     Valid email address to subscribe
boolean   $invite     Send an invite or not (default)

[ Top ]

unsubscribe   [line 325]

Services_Mailman unsubscribe( string $email)

Unsubscribe

(ie: <domain.com>/mailman/admin/<listname>/members/remove?send_unsub_ack_to_this_batch=0 &send_unsub_notifications_to_list_owner=0&unsubscribees=<email-address>&adminpw=<adminpassword>)


Parameters:

string   $email     Valid email address of a member to unsubscribe

[ Top ]

version   [line 588]

string version( )

Version

[ Top ]


Documentation generated on Tue, 31 Jan 2012 17:00:03 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.