Gdata/Gapps/EmailListQuery.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: EmailListQuery.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Gdata_Gapps_EmailListQuery

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_EmailListQuery
jump to top

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; setRecipient; getRecipient; setStartEmailListName; getStartEmailListName; getQueryUrl

Description

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.

Properties

$_emailListName
jump to class

string $_emailListName = 'null'

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

Details

$_emailListName: string
visibility: protected
default: null
final: false
static: false

Methods

__construct
jump to class

__construct(
          string $domain
              =
              null, string $emailListName
              =
              null, string $recipient
              =
              null, string $startEmailListName
              =
              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.
$recipient: string
(optional) Value for the recipient property.
$startEmailListName: string
(optional) Value for the startEmailListName property.

Details

visibility: public
final: false
static: false

getEmailListName
jump to class

getEmailListName(
          
          )
        
        :
        string

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

Output

string: The email list name to filter search results by, or null if disabled.

Details

visibility: public
final: false
static: false
see: setEmailListName

getQueryUrl
jump to class

getQueryUrl(
          
          )
        
        :
        string

Returns 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

getRecipient
jump to class

getRecipient(
          
          )
        
        :
        string

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

Output

string: The recipient email address to filter search results by, or null if disabled.

Details

visibility: public
final: false
static: false
see: setRecipient

getStartEmailListName
jump to class

getStartEmailListName(
          
          )
        
        :
        string

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

Output

string: The first email list to be returned, or null to disable.

Details

visibility: public
final: false
static: false

setEmailListName
jump to class

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

setRecipient
jump to class

setRecipient(
          string $value
          )
        
        :

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.

Arguments

$value: string
The recipient email address to filter search results by, or null to disable.

Details

visibility: public
final: false
static: false

setStartEmailListName
jump to class

setStartEmailListName(
          string $value
          )
        
        :

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

Arguments

$value: string
The first email list to be returned, or null to disable.

Details

visibility: public
final: false
static: false

API Documentation

Gdata/Gapps/EmailListQuery.php

Description

Zend_Gdata_Gapps_EmailListQueryjump to top

Description

Properties

$_emailListNamejump to class

Details

Methods

__constructjump to class

Arguments

Details

getEmailListNamejump to class

Output

Details

getQueryUrljump to class

Output

Details

getRecipientjump to class

Output

Details

getStartEmailListNamejump to class

Output

Details

setEmailListNamejump to class

Arguments

Details

setRecipientjump to class

Arguments

Details

setStartEmailListNamejump to class

Arguments

Details

Zend_Gdata_Gapps_EmailListQuery
jump to top

$_emailListName
jump to class

__construct
jump to class

getEmailListName
jump to class

getQueryUrl
jump to class

getRecipient
jump to class

getStartEmailListName
jump to class

setEmailListName
jump to class

setRecipient
jump to class

setStartEmailListName
jump to class