## Zend_Gdata_Gapps_EmailListRecipientQuery

Description

Assists in constructing queries for Google Apps email list recipient entries. Instances of this class can be provided in many places where a URL is required.

For information on submitting queries to a server, see the Google Apps service class, Zend_Gdata_Gapps.

- copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
- license: New BSD License

Located in /Gdata/Gapps/EmailListRecipientQuery.php (line 43)

    Zend_Gdata_Query
       |
       --Zend_Gdata_Gapps_Query
          |
          --Zend_Gdata_Gapps_EmailListRecipientQuery

Variable Summary
string $_emailListName
Method Summary
Zend_Gdata_Gapps_EmailListRecipientQuery __construct ([string $domain = null], [string $emailListName = null], [string $startRecipient = null])
void getEmailListName (string $value)
string getQueryUrl ()
string getStartRecipient ()
void setEmailListName (string $value)
void setStartRecipient (string $value)
Variables
string $_emailListName = null (line 52)

If not null, specifies the name of the email list which should be requested by this query.

- access: protected

#### Inherited Variables

Inherited from Zend_Gdata_Gapps_Query

> Zend_Gdata_Gapps_Query::$_domain

Inherited from Zend_Gdata_Query

> Zend_Gdata_Query::$_category
> Zend_Gdata_Query::$_defaultFeedUri
> Zend_Gdata_Query::$_params
> Zend_Gdata_Query::$_url

Methods
Constructor __construct (line 64)

Create a new instance.

- access: public

Zend_Gdata_Gapps_EmailListRecipientQuery __construct ([string $domain = null], [string $emailListName = null], [string $startRecipient = null])

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

Redefinition of:

Zend_Gdata_Gapps_Query::__construct()
  Create a new instance.

getEmailListName (line 92)

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

- access: public

void getEmailListName (string $value)

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

getQueryUrl (line 136)

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

- return: A URL generated based on the state of this query.
- throws: Zend_Gdata_App_InvalidArgumentException
- access: public

string getQueryUrl ()

Redefinition of:

Zend_Gdata_Query::getQueryUrl()

getStartRecipient (line 120)

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

- return: The first recipient to be returned, or null if disabled.
- access: public

string getStartRecipient ()
setEmailListName (line 80)

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.

- access: public

void setEmailListName (string $value)

- string $value: The email list name to filter search results by, or null to disable.

setStartRecipient (line 104)

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

- access: public

void setStartRecipient (string $value)

- string $value: The first recipient to be returned, or null to disable.

#### Inherited Methods

Inherited From Zend_Gdata_Gapps_Query

> Zend_Gdata_Gapps_Query::__construct()
> Zend_Gdata_Gapps_Query::getBaseUrl()
> Zend_Gdata_Gapps_Query::getDomain()
> Zend_Gdata_Gapps_Query::setDomain()

Inherited From Zend_Gdata_Query

> Zend_Gdata_Query::__construct()
> Zend_Gdata_Query::getAlt()
> Zend_Gdata_Query::getAuthor()
> Zend_Gdata_Query::getCategory()
> Zend_Gdata_Query::getMaxResults()
> Zend_Gdata_Query::getParam()
> Zend_Gdata_Query::getPublishedMax()
> Zend_Gdata_Query::getPublishedMin()
> Zend_Gdata_Query::getQuery()
> Zend_Gdata_Query::getQueryString()
> Zend_Gdata_Query::getQueryUrl()
> Zend_Gdata_Query::getStartIndex()
> Zend_Gdata_Query::getUpdatedMax()
> Zend_Gdata_Query::getUpdatedMin()
> Zend_Gdata_Query::resetParameters()
> Zend_Gdata_Query::setAlt()
> Zend_Gdata_Query::setAuthor()
> Zend_Gdata_Query::setCategory()
> Zend_Gdata_Query::setMaxResults()
> Zend_Gdata_Query::setParam()
> Zend_Gdata_Query::setPublishedMax()
> Zend_Gdata_Query::setPublishedMin()
> Zend_Gdata_Query::setQuery()
> Zend_Gdata_Query::setStartIndex()
> Zend_Gdata_Query::setUpdatedMax()
> Zend_Gdata_Query::setUpdatedMin()
> Zend_Gdata_Query::__get()
> Zend_Gdata_Query::__set()

Documentation generated on Tue, 26 Oct 2010 20:08:37 +0400 by phpDocumentor 1.4.2