List of all members.

Public Member Functions
	__construct ($maillistObj, $parentObj)
	__get ($varName)
	__set ($varName, $varValue)
	addRemoveHeader ($header)
	addUser ($userEmail, $userName)
	configFilters ()
	configLimits ()
	configQuotas ()
	configWebmailData ()
	getMailListObj ()
	getMailListServicesObj ()
	getSessionObj ()
	listRemoveHeaders ()
	listUsers ()
	registryInformation ()
	removeRemoveHeader ($header)
	removeUser ($userEmail)
	save ()
	updateUser ($userEmail, $newName)

---

Member Function Documentation

MailList::__get

(

$

varName

)

Get member.

member	description
name	the name of the list
password	the list's mailbox access password
subscribeRcpt	the RCPT used for subscription
unsubscribeRcpt	the RCPT used for unsubscription
requestRcpt	the RCPT used for making a request
enabledRcpts	the RCPTs enabled for this list
description	the description of the list
adminConfirm	the adminConfirm parameter
senderAllow	the senderAllow parameter
moderate	the moderate parameter
ctypeAllow	the ctypeAllow parameter
adminEmail	the email for the admin
addHeader	the headers that will be added to the mail
bodyBegin	the text that will be inserted before the body
bodyEnd	the text that will be added to the body of the mail
unknownCommand	the description of the error in case of an unknown command
invalidUserName	the description of the error in case of an invalid user name
notAUser	the description of the error in case the user does not belong to the list
badConfirmation	the description of the error in case of a bad confirmation
userAlreadySubscribed	the description of the error in case the user already exists
invalidFormat	the description of the error in case of an invalid format
requestNeedsConfirmation	the template that will ask the user for a confirmation
requestNeedsAdminConfirmation	the template that will tell the user to wait for confirmation from the admin
autoRejectResponse	the template that will tell the user that his mail is rejected
welcome	the template that will tell the user that he has been created
goodbye	the template that will tell the user that he has been deleted
subscribeDenied	the template that will tell the user that he has not been created
publishContactInfo	the enabled/disabled publish contact info
enableSmtpIncoming	the enable/disable status for SMTP Incoming
enableSmtpOutgoing	the enable/disable status for SMTP Outgoing
enablePop3	the enable/disable status for POP3
enableImap	the enable/disable status for IMAP
enableWebmail	the enable/disable status for Webmail
enableRpop	the enable/disable status for RPOP

MailList::__set	(	$	varName,
		$	varValue
	)

Set member.

member	description
name	the name of the list
password	the list's mailbox access password
subscribeRcpt	the RCPT used for subscription
unsubscribeRcpt	the RCPT used for unsubscription
requestRcpt	the RCPT used for making a request
enabledRcpts	the RCPTs enabled for this list
description	the description of the list
adminConfirm	the adminConfirm parameter
senderAllow	the senderAllow parameter
moderate	the moderate parameter
ctypeAllow	the ctypeAllow parameter
adminEmail	the email for the admin
addHeader	the headers that will be added to the mail
bodyBegin	the text that will be inserted before the body
bodyEnd	the text that will be added to the body of the mail
unknownCommand	the description of the error in case of an unknown command
invalidUserName	the description of the error in case of an invalid user name
notAUser	the description of the error in case the user does not belong to the list
badConfirmation	the description of the error in case of a bad confirmation
userAlreadySubscribed	the description of the error in case the user already exists
invalidFormat	the description of the error in case of an invalid format
requestNeedsConfirmation	the template that will ask the user for a confirmation
requestNeedsAdminConfirmation	the template that will tell the user to wait for confirmation from the admin
autoRejectResponse	the template that will tell the user that his mail is rejected
welcome	the template that will tell the user that he has been created
goodbye	the template that will tell the user that he has been deleted
subscribeDenied	the template that will tell the user that he has not been created
publishContactInfo	the enabled/disabled publish contact info
enableSmtpIncoming	the enable/disable status for SMTP Incoming
enableSmtpOutgoing	the enable/disable status for SMTP Outgoing
enablePop3	the enable/disable status for POP3
enableImap	the enable/disable status for IMAP
enableWebmail	the enable/disable status for Webmail
enableRpop	the enable/disable status for RPOP

MailList::addRemoveHeader

(

$

header

)

adds a header to the list of headers to be removed

Returns:

bool

Parameters:

$header

string Header to be added to the list

MailList::addUser	(	$	userEmail,
		$	userName
	)

adds an user to the list

Returns:

bool

Parameters:

	$userEmail	string New user email address
	$userName	string New user name

MailList::configFilters

(

)

this method returns an object of Filters for the selected list

Returns:

object Filters

MailList::configLimits

(

)

this method returns an object of Limits for the selected list

Returns:

object Limits

MailList::configQuotas

(

)

this method returns an object of Quotas for the selected list

Returns:

object Quotas

MailList::configWebmailData

(

)

this method returns an object of WebmailData for the selected list

Returns:

object WebmailData

MailList::listRemoveHeaders

(

)

shows the list of headers that will be removed from a mail

Returns:

array

MailList::listUsers

(

)

lists the available users for this list

Returns:

array

MailList::registryInformation

(

)

shows registry information

Returns:

array

MailList::removeRemoveHeader

(

$

header

)

removes a header from the list of headers to be removed

Returns:

bool

Parameters:

$header

string Header to be removed from the list

MailList::removeUser

(

$

userEmail

)

removes an user from the list

Returns:

bool

Parameters:

$userEmail

string User email address to be removed

MailList::save

(

)

this method must be called if one of the members has been changed

Returns:

bool

MailList::updateUser	(	$	userEmail,
		$	newName
	)

updates a user name

Returns:

bool

Parameters:

	$userEmail	string User email address to be updated
	$newName	string User new name