API Documentation

Zend/Gdata/Gapps/EmailListQuery.php

Show: inherited
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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Gdata  
Subpackage
Gapps  
Version
$Id: EmailListQuery.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Gdata_Gapps_EmailListQuery

Package: Zend\Gdata\Gapps

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.

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

Properties

Propertyprotectedstring  $_emailListName= 'null'

A string which, if not null, indicates which email list should be retrieved by this query.

Default valuenullDetails
Type
string

Methods

methodpublic__construct( string $domain = null, string $emailListName = null, string $recipient = null, string $startEmailListName = 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.

$recipient string

(optional) Value for the recipient property.

$startEmailListName string

(optional) Value for the startEmailListName property.

methodpublicgetEmailListName( ) : 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  
methodpublicgetQueryUrl( ) : 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
methodpublicgetRecipient( ) : 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  
methodpublicgetStartEmailListName( ) : 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.
methodpublicsetEmailListName( 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.

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

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

Documentation was generated by DocBlox 0.15.1.