Zend_Gdata_Gapps_EmailListQuery Class Reference

Public Member Functions
	__construct ($domain=null, $emailListName=null, $recipient=null, $startEmailListName=null)
	Create a new instance.
	setEmailListName ($value)
	Set the email list name to query for.
	getEmailListName ()
	Get the email list name to query for.
	setRecipient ($value)
	Set the recipient to query for.
	getRecipient ()
	Get the recipient email address to query for.
	setStartEmailListName ($value)
	Set the first email list which should be displayed when retrieving a list of email lists.
	getStartEmailListName ()
	Get the first email list which should be displayed when retrieving a list of email lists.
	getQueryUrl ()
	Returns the URL generated for this query, based on it's current parameters.
Public Member Functions inherited from Zend_Gdata_Gapps_Query
	__construct ($domain=null)
	Create a new instance.
	setDomain ($value)
	Set domain for this service instance.
	getDomain ()
	Get domain for this service instance.
	getBaseUrl ($domain=null)
	Returns the base URL used to access the Google Apps service, based on the current domain.
Public Member Functions inherited from Zend_Gdata_Query
	__construct ($url=null)
	Create Gdata_Query object.
	getQueryString ()
	resetParameters ()
	getQueryUrl ()
	setParam ($name, $value)
	getParam ($name)
	setAlt ($value)
	setMaxResults ($value)
	setQuery ($value)
	setStartIndex ($value)
	setUpdatedMax ($value)
	setUpdatedMin ($value)
	setPublishedMax ($value)
	setPublishedMin ($value)
	setAuthor ($value)
	getAlt ()
	getMaxResults ()
	getQuery ()
	getStartIndex ()
	getUpdatedMax ()
	getUpdatedMin ()
	getPublishedMax ()
	getPublishedMin ()
	getAuthor ()
	setCategory ($value)
	getCategory ()
	__get ($name)
	__set ($name, $val)

Protected Attributes
	$_emailListName = null
Protected Attributes inherited from Zend_Gdata_Gapps_Query
	$_domain = null
Protected Attributes inherited from Zend_Gdata_Query
	$_params = array()
	$_defaultFeedUri = null
	$_url = null
	$_category = null

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.

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.

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

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.

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.

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.

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.

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.

Member Data Documentation

$_emailListName = null

protected