## API Documentation

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

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 value `null` Details

Type
  string

### Methods

`__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.

`__get( $name ) : void`

Inherited from: \Zend_Gdata_Query::__get()
Parameters

Name | Type | Description
--- | --- | ---
$name |  |

`__set( $name, $val ) : void`

Inherited from: \Zend_Gdata_Query::__set()
Parameters

Name | Type | Description
--- | --- | ---
$name |  |
$val |  |

`getAlt( ) : string`

Inherited from: \Zend_Gdata_Query::getAlt()
Returns

Type | Description
--- | ---
string | rss or atom

`getAuthor( ) : string`

Inherited from: \Zend_Gdata_Query::getAuthor()
Returns

Type | Description
--- | ---
string | author

`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

`getCategory( ) : void`

Inherited from: \Zend_Gdata_Query::getCategory()
`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

`getMaxResults( ) : int`

Inherited from: \Zend_Gdata_Query::getMaxResults()
Returns

Type | Description
--- | ---
int | maxResults

`getParam( string $name ) : void`

Inherited from: \Zend_Gdata_Query::getParam()
Parameters

Name | Type | Description
--- | --- | ---
$name | string |

`getPublishedMax( ) : string`

Inherited from: \Zend_Gdata_Query::getPublishedMax()
Returns

Type | Description
--- | ---
string | publishedMax

`getPublishedMin( ) : string`

Inherited from: \Zend_Gdata_Query::getPublishedMin()
Returns

Type | Description
--- | ---
string | publishedMin

`getQuery( ) : string`

Inherited from: \Zend_Gdata_Query::getQuery()
Returns

Type | Description
--- | ---
string | query

`getQueryString( ) : string`

Inherited from: \Zend_Gdata_Query::getQueryString()
Returns

Type | Description
--- | ---
string | querystring

`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 |

`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.

`getStartIndex( ) : int`

Inherited from: \Zend_Gdata_Query::getStartIndex()
Returns

Type | Description
--- | ---
int | startIndex

`getUpdatedMax( ) : string`

Inherited from: \Zend_Gdata_Query::getUpdatedMax()
Returns

Type | Description
--- | ---
string | updatedMax

`getUpdatedMin( ) : string`

Inherited from: \Zend_Gdata_Query::getUpdatedMin()
Returns

Type | Description
--- | ---
string | updatedMin

`resetParameters( ) : void`

Inherited from: \Zend_Gdata_Query::resetParameters()
`setAlt( string $value ) : \Zend_Gdata_Query`

Inherited from: \Zend_Gdata_Query::setAlt()
Parameters

Name | Type | Description
--- | --- | ---
$value | string |

Returns

Type | Description
--- | ---
\Zend_Gdata_Query | Provides a fluent interface

`setAuthor( string $value ) : \Zend_Gdata_Query`

Inherited from: \Zend_Gdata_Query::setAuthor()
Parameters

Name | Type | Description
--- | --- | ---
$value | string |

Returns

Type | Description
--- | ---
\Zend_Gdata_Query | Provides a fluent interface

`setCategory( string $value ) : \Zend_Gdata_Query`

Inherited from: \Zend_Gdata_Query::setCategory()
Parameters

Name | Type | Description
--- | --- | ---
$value | string |

Returns

Type | Description
--- | ---
\Zend_Gdata_Query | Provides a fluent interface

`setDomain( string $value ) : void`

Set domain for this service instance. This should be a fully qualified domain, such as 'foo.example.com'.

Inherited from: \Zend_Gdata_Gapps_Query::setDomain()

This value is used when calculating URLs for retrieving and posting entries. If no value is specified, a URL will have to be manually constructed prior to using any methods which interact with the Google Apps provisioning service.

Parameters

Name | Type | Description
--- | --- | ---
$value | string | The domain to be used for this session.

`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.

`setMaxResults( int $value ) : \Zend_Gdata_Query`

Inherited from: \Zend_Gdata_Query::setMaxResults()
Parameters

Name | Type | Description
--- | --- | ---
$value | int |

Returns

Type | Description
--- | ---
\Zend_Gdata_Query | Provides a fluent interface

`setParam( string $name, string $value ) : \Zend_Gdata_Query`

Inherited from: \Zend_Gdata_Query::setParam()
Parameters

Name | Type | Description
--- | --- | ---
$name | string |
$value | string |

Returns

Type | Description
--- | ---
\Zend_Gdata_Query | Provides a fluent interface

`setPublishedMax( string $value ) : \Zend_Gdata_Query`

Inherited from: \Zend_Gdata_Query::setPublishedMax()
Parameters

Name | Type | Description
--- | --- | ---
$value | string |

Returns

Type | Description
--- | ---
\Zend_Gdata_Query | Provides a fluent interface

`setPublishedMin( string $value ) : \Zend_Gdata_Query`

Inherited from: \Zend_Gdata_Query::setPublishedMin()
Parameters

Name | Type | Description
--- | --- | ---
$value | string |

Returns

Type | Description
--- | ---
\Zend_Gdata_Query | Provides a fluent interface

`setQuery( string $value ) : \Zend_Gdata_Query`

Inherited from: \Zend_Gdata_Query::setQuery()
Parameters

Name | Type | Description
--- | --- | ---
$value | string |

Returns

Type | Description
--- | ---
\Zend_Gdata_Query | Provides a fluent interface

`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.

`setStartIndex( int $value ) : \Zend_Gdata_Query`

Inherited from: \Zend_Gdata_Query::setStartIndex()
Parameters

Name | Type | Description
--- | --- | ---
$value | int |

Returns

Type | Description
--- | ---
\Zend_Gdata_Query | Provides a fluent interface

`setUpdatedMax( string $value ) : \Zend_Gdata_Query`

Inherited from: \Zend_Gdata_Query::setUpdatedMax()
Parameters

Name | Type | Description
--- | --- | ---
$value | string |

Returns

Type | Description
--- | ---
\Zend_Gdata_Query | Provides a fluent interface

`setUpdatedMin( string $value ) : \Zend_Gdata_Query`

Inherited from: \Zend_Gdata_Query::setUpdatedMin()
Parameters

Name | Type | Description
--- | --- | ---
$value | string |

Returns

Type | Description
--- | ---
\Zend_Gdata_Query | Provides a fluent interface

Documentation was generated by DocBlox 0.13.3.