[ Index ]

PHP Cross Reference of moodle-2.8

title

Body

[close]

/lib/zend/Zend/Gdata/Gapps/ -> EmailListQuery.php (summary)

Zend Framework LICENSE

Copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
License: http://framework.zend.com/license/new-bsd New BSD License
Version: $Id$
File Size: 187 lines (6 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Zend_Gdata_Gapps_EmailListQuery:: (8 methods):
  __construct()
  setEmailListName()
  getEmailListName()
  setRecipient()
  getRecipient()
  setStartEmailListName()
  getStartEmailListName()
  getQueryUrl()


Class: Zend_Gdata_Gapps_EmailListQuery  - X-Ref

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.

__construct($domain = null, $emailListName = null,$recipient = null, $startEmailListName = null)   X-Ref
Create a new instance.

param: string $domain (optional) The Google Apps-hosted domain to use
param: string $emailListName (optional) Value for the emailListName
param: string $recipient (optional) Value for the recipient
param: string $startEmailListName (optional) Value for the

setEmailListName($value)   X-Ref
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.

param: string $value The email list name to filter search results by,

getEmailListName()   X-Ref
Get the email list name to query for. If no name is set, null will be
returned.

return: string The email list name to filter search results by, or null

setRecipient($value)   X-Ref
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.

param: string $value The recipient email address to filter search

getRecipient()   X-Ref
Get the recipient email address to query for. If no recipient is set,
null will be returned.

return: string The recipient email address to filter search results by,

setStartEmailListName($value)   X-Ref
Set the first email list which should be displayed when retrieving
a list of email lists.

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

getStartEmailListName()   X-Ref
Get the first email list which should be displayed when retrieving
a list of email lists.

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

getQueryUrl()   X-Ref
Returns the URL generated for this query, based on it's current
parameters.

return: string A URL generated based on the state of this query.



Generated: Fri Nov 28 20:29:05 2014 Cross-referenced by PHPXref 0.7.1