Gdata/Gapps/EmailListRecipientQuery.php

Show:

inherited

Classes
- \Zend_Gdata_Gapps_EmailListRecipientQuery

Table of Contents

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-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Gdata
Subpackage: Gapps
Version: $Id$

\Zend_Gdata_Gapps_EmailListRecipientQuery
jump to top

Package: Zend_Gdata\Gapps

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.

Parent(s): \Zend_Gdata_Gapps_Query < \Zend_Gdata_Query
Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties

string $_emailListName = null

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

Default valuenullDetails

Type: string

Methods

__construct(string $domain = null, string $emailListName = null, string $startRecipient = null) : void

Create a new instance.

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.`
$startRecipient	string	(optional) Value for the `startRecipient property.`

getEmailListName() : void

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

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

Exception	Description
\Zend_Gdata_App_InvalidArgumentException

getStartRecipient() : string

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

Returns

Type	Description
string	The first recipient to be returned, or null if disabled.

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.

setStartRecipient(string $value) : void

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

Parameters

Name	Type	Description
$value	string	The first recipient to be returned, or null to disable.

Gdata/Gapps/EmailListRecipientQuery.php

\Zend_Gdata_Gapps_EmailListRecipientQueryjump to top

Properties

Methods

\Zend_Gdata_Gapps_EmailListRecipientQuery
jump to top