Zend_Gdata_Gapps_EmailListQuery Class Reference

Inheritance diagram for Zend_Gdata_Gapps_EmailListQuery:

Collaboration diagram for Zend_Gdata_Gapps_EmailListQuery:

Public Member Functions
	__construct ($domain=null, $emailListName=null, $recipient=null, $startEmailListName=null)
	setEmailListName ($value)
	getEmailListName ()
	setRecipient ($value)
	getRecipient ()
	setStartEmailListName ($value)
	getStartEmailListName ()
	getQueryUrl ()
Protected Attributes
	$_emailListName = null

---

Detailed Description

Definition at line 43 of file EmailListQuery.php.

---

Constructor & Destructor Documentation

__construct	(	$	domain = null,
		$	emailListName = null,
		$	recipient = null,
		$	startEmailListName = null
	)

Create a new instance.

Parameters:

string	$domain	(optional) The Google Apps-hosted domain to use when constructing query URIs.
string	$emailListName	(optional) Value for the emailListName property.
string	$recipient	(optional) Value for the recipient property.
string	$startEmailListName	(optional) Value for the startEmailListName property.

Definition at line 66 of file EmailListQuery.php.

Here is the call graph for this function:

---

Member Function Documentation

getEmailListName

(

)

Get the email list name to query for. If no name is set, null will be returned.

See also:

setEmailListName

Returns:

string The email list name to filter search results by, or null if disabled.

Definition at line 96 of file EmailListQuery.php.

getQueryUrl

(

)

Returns the URL generated for this query, based on it's current parameters.

Returns:

string A URL generated based on the state of this query.

Exceptions:

Zend_Gdata_App_InvalidArgumentException

Reimplemented from Zend_Gdata_Query.

Definition at line 175 of file EmailListQuery.php.

Here is the call graph for this function:

getRecipient

(

)

Get the recipient email address to query for. If no recipient is set, null will be returned.

See also:

setRecipient

Returns:

string The recipient email address to filter search results by, or null if disabled.

Definition at line 127 of file EmailListQuery.php.

getStartEmailListName

(

)

Get the first email list which should be displayed when retrieving a list of email lists.

Returns:

string The first email list to be returned, or null to disable.

Definition at line 159 of file EmailListQuery.php.

setEmailListName

(

$

value

)

Set the email list name to query for. When set, only lists with a name matching this value will be returned in search results. Set to null to disable filtering by list name.

Parameters:

string

$value

The email list name to filter search results by, or null to disable.

Definition at line 83 of file EmailListQuery.php.

Here is the caller graph for this function:

setRecipient

(

$

value

)

Set the recipient to query for. When set, only subscribers with an email address matching this value will be returned in search results. Set to null to disable filtering by username.

Parameters:

string

$value

The recipient email address to filter search results by, or null to disable.

Definition at line 109 of file EmailListQuery.php.

Here is the caller graph for this function:

setStartEmailListName

(

$

value

)

Set the first email list which should be displayed when retrieving a list of email lists.

Parameters:

string

$value

The first email list to be returned, or null to disable.

Definition at line 143 of file EmailListQuery.php.

Here is the caller graph for this function:

---

Field Documentation

$_emailListName = null [protected]

Definition at line 52 of file EmailListQuery.php.

---

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

• C:/xampp/htdocs/moodle/lib/zend/Zend/Gdata/Gapps/EmailListQuery.php