## Zend_Gdata_Gapps_EmailListQuery

Description

Assists in constructing queries for Google Apps email list 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/EmailListQuery.php (line 43)

    Zend_Gdata_Query
       |
       --Zend_Gdata_Gapps_Query
          |
          --Zend_Gdata_Gapps_EmailListQuery

Variable Summary
string $_emailListName
Method Summary
Zend_Gdata_Gapps_EmailListQuery __construct ([string $domain = null], [string $emailListName = null], [string $recipient = null], [string $startEmailListName = null])
string getEmailListName ()
string getQueryUrl ()
string getRecipient ()
string getStartEmailListName ()
void setEmailListName (string $value)
void setRecipient (string $value)
void setStartEmailListName (string $value)
Variables
string $_emailListName = null (line 52)

A string which, if not null, indicates which email list should be retrieved 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 66)

Create a new instance.

- access: public

Zend_Gdata_Gapps_EmailListQuery __construct ([string $domain = null], [string $emailListName = null], [string $recipient = null], [string $startEmailListName = null])

- 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.

Redefinition of:

Zend_Gdata_Gapps_Query::__construct()
  Create a new instance.

getEmailListName (line 96)

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

- return: The email list name to filter search results by, or null if disabled.
- see: Zend_Gdata_Gapps_EmailListQuery::setEmailListName()
- access: public

string getEmailListName ()
getQueryUrl (line 175)

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()

getRecipient (line 127)

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

- return: The recipient email address to filter search results by, or null if disabled.
- see: Zend_Gdata_Gapps_EmailListQuery::setRecipient()
- access: public

string getRecipient ()
getStartEmailListName (line 159)

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

- return: The first email list to be returned, or null to disable.
- access: public

string getStartEmailListName ()
setEmailListName (line 83)

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.

setRecipient (line 109)

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.

- access: public

void setRecipient (string $value)

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

setStartEmailListName (line 143)

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

- access: public

void setStartEmailListName (string $value)

- string $value: The first email list 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:36 +0400 by phpDocumentor 1.4.2