Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.
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.

__construct(
string $domain
=
null, string $emailListName
=
null, string $recipient
=
null, string $startEmailListName
=
null
)
:
void
Create a new instance.
Name | Type | Description |
---|---|---|
$domain | string | (optional) The Google Apps-hosted domain to use when constructing query URIs. |
$emailListName | string | (optional) Value for the emailListName property. |
$recipient | string | (optional) Value for the recipient property. |
$startEmailListName | string | (optional) Value for the startEmailListName property. |

getEmailListName(
)
:
string
Get the email list name to query for. If no name is set, null will be returned.
Type | Description |
---|---|
string | The email list name to filter search results by, or null if disabled. |

getQueryUrl(
)
:
string
Returns the URL generated for this query, based on it's current parameters.
Type | Description |
---|---|
string | A URL generated based on the state of this query. |
Exception | Description |
---|---|
\Zend_Gdata_App_InvalidArgumentException |

getRecipient(
)
:
string
Get the recipient email address to query for. If no recipient is set, null will be returned.
Type | Description |
---|---|
string | The recipient email address to filter search results by, or null if disabled. |

getStartEmailListName(
)
:
string
Get the first email list which should be displayed when retrieving a list of email lists.
Type | Description |
---|---|
string | The first email list to be returned, or null to disable. |

setEmailListName(
string $value
)
:
void
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.
Name | Type | Description |
---|---|---|
$value | string | The email list name to filter search results by, or null to disable. |

setRecipient(
string $value
)
:
void
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.
Name | Type | Description |
---|---|---|
$value | string | The recipient email address to filter search results by, or null to disable. |