Gdata/Gapps/EmailListRecipientQuery.php
- category
- Zend
- copyright
- Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
- license
- http://framework.zend.com/license/new-bsd New BSD License
- package
- Zend_Gdata
- subpackage
- Gapps
- version
- $Id: EmailListRecipientQuery.php 20096 2010-01-06 02:05:09Z bkarwin $
- Classes
- Zend_Gdata_Gapps_EmailListRecipientQuery
Description
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.
Zend_Gdata_Gapps_EmailListRecipientQuery
- Extends from
- Zend_Gdata_Gapps_Query
- category
- Zend
- copyright
- Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
- license
- http://framework.zend.com/license/new-bsd New BSD License
- package
- Zend_Gdata
- subpackage
- Gapps
- Properties
- $_emailListName
- Methods
- __construct
- setEmailListName
- getEmailListName
- setStartRecipient
- getStartRecipient
- getQueryUrl
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.
Properties
$_emailListName
string $_emailListName = 'null'If not null, specifies the name of the email list which should be requested by this query.
Details
- $_emailListName
- string
- visibility
- protected
- default
- null
- final
- false
- static
- false
Methods
__construct
__construct(
string $domain
=
null, string $emailListName
=
null, string $startRecipient
=
null
)
:
Create a new instance.
Arguments
- $domain
- string
(optional) The Google Apps-hosted domain to use when constructing query URIs. - $emailListName
- string
(optional) Value for the emailListName property. - $startRecipient
- string
(optional) Value for the startRecipient property.
Details
- visibility
- public
- final
- false
- static
- false
getEmailListName
getEmailListName(
)
:
Get the email list name to query for. If no name is set, null will be returned.
Details
- visibility
- public
- final
- false
- static
- false
getQueryUrl
getQueryUrl(
)
:
stringReturns the URL generated for this query, based on it's current parameters.
Output
- string
- A URL generated based on the state of this query.
Details
- visibility
- public
- final
- false
- static
- false
- throws
getStartRecipient
getStartRecipient(
)
:
stringGet the first recipient which should be displayed when retrieving a list of email list recipients.
Output
- string
- The first recipient to be returned, or null if disabled.
Details
- visibility
- public
- final
- false
- static
- false
setEmailListName
setEmailListName(
string $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.
Arguments
- $value
- string
The email list name to filter search results by, or null to disable.
Details
- visibility
- public
- final
- false
- static
- false
setStartRecipient
setStartRecipient(
string $value
)
:
Set the first recipient which should be displayed when retrieving a list of email list recipients.
Arguments
- $value
- string
The first recipient to be returned, or null to disable.
Details
- visibility
- public
- final
- false
- static
- false