Gdata/Gapps/EmailListQuery.php
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.
- category
- Zend
- copyright
- Copyright (c) 2005-2011 Zend Technologies USA Inc.
(http://www.zend.com)
- license
- New
BSD License
- package
- Zend_Gdata
- subpackage
- Gapps
- version
- $Id: EmailListQuery.php 23775 2011-03-01 17:25:24Z ralph $
\Zend_Gdata_Gapps_EmailListQuery
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.
- Extends from
- \Zend_Gdata_Gapps_Query
- category
- Zend
- copyright
- Copyright (c) 2005-2011 Zend Technologies USA Inc.
(http://www.zend.com)
- license
- New
BSD License
- package
- Zend_Gdata
- subpackage
- Gapps
Properties



string $_emailListName=
'null'
A string which, if not null, indicates
which email list should be retrieved by this query.
Default valuenull
Details
- Type
- string
Methods



__construct( string $domain = null,
string $emailListName = null, string $recipient = null,
string $startEmailListName = null ) : void
Parameters
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.
|



getBaseUrl( string $domain = null ) : void
Returns the base URL used to access the
Google Apps service, based on the current domain. The current domain can
be temporarily overridden by providing a fully qualified domain as
$domain.
Inherited from: \Zend_Gdata_Gapps_Query::getBaseUrl()
Parameters
Name |
Type |
Description |
$domain |
string |
(optional) A fully-qualified domain to use instead of the
default domain for this service instance.
|
Details
- see
- \setDomain



getDomain( ) : string
Get domain for this service instance.
This should be a fully qualified domain, such as 'foo.example.com'. If
no domain is set, null will be returned.
Inherited from: \Zend_Gdata_Gapps_Query::getDomain()
Returns
Type |
Description |
string |
The domain to be used for this session, or null if not set. |
Details
- see
- \setDomain



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



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



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



getStartEmailListName( ) : string
Get the first email list which should
be displayed when retrieving a list of email lists.
Returns
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.
Parameters
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.
Parameters
Name |
Type |
Description |
$value |
string |
The recipient email address to filter search results
by, or null to disable. |



setStartEmailListName( string $value ) : void
Set the first email list which should
be displayed when retrieving a list of email lists.
Parameters
Name |
Type |
Description |
$value |
string |
The first email list to be returned, or null to
disable. |