Docs For Class Zend_Gdata

Zend_Gdata_Gapps

Description

Service class for interacting with the Google Apps Provisioning API.

Like other service classes in this module, this class provides access via an HTTP client to Google servers for working with entries and feeds.

Because of the nature of this API, all access must occur over an authenticated connection.

copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
link: http://code.google.com/apis/apps/gdata_provisioning_api_v2.0_reference.html
license: New BSD License

Located in /Gdata/Gapps.php (line 67)

Zend_Gdata_App
   |
   --Zend_Gdata
      |
      --Zend_Gdata_Gapps

Class Constant Summary

APPS_BASE_FEED_URI = 'https://apps-apis.google.com/a/feeds'

APPS_EMAIL_LIST_PATH = '/emailList/2.0'

APPS_EMAIL_LIST_RECIPIENT_POSTFIX = '/recipient'

APPS_NICKNAME_PATH = '/nickname/2.0'

APPS_USER_PATH = '/user/2.0'

AUTH_SERVICE_NAME = 'apps'

Variable Summary

static array $namespaces

string $_domain

Method Summary

static Zend_Gdata_App_Feed import (string $uri, [Zend_Http_Client $client = null], [string $className = 'Zend_Gdata_App_Feed'])

static void throwServiceExceptionIfDetected (Zend_Gdata_Exception $e)

Zend_Gdata_Gapps_EmailListRecipientEntry addRecipientToEmailList (string $recipientAddress, string $emailList)

Zend_Gdata_Gapps __construct ([Zend_Http_Client $client = null], [string $domain = null], [string $applicationId = 'MyCompany-MyApp-1.0'])

Zend_Gdata_Gapps_EmailListEntry createEmailList (string $emailList)

Zend_Gdata_Gapps_NicknameEntry createNickname (string $username, string $nickname)

Zend_Gdata_Gapps_UserEntry createUser (string $username, string $givenName, string $familyName, string $password, [ $passwordHashFunction = null], [string $quotaLimitInMB = null])

void delete (mixed $data, [integer $remainingRedirects = null])

void deleteEmailList (string $emailList)

void deleteNickname (string $nickname)

void deleteUser (string $username)

Zend_Http_Response get (string $uri, [array $extraHeaders = array()])

void getBaseUrl ([string $domain = null])

string getDomain ()

Zend_Gdata_Gapps_EmailListEntry getEmailListEntry (mixed $location)

Zend_Gdata_Gapps_EmailListFeed getEmailListFeed ([mixed $location = null])

Zend_Gdata_Gapps_EmailListRecipientEntry getEmailListRecipientEntry (mixed $location)

Zend_Gdata_Gapps_EmailListRecipientFeed getEmailListRecipientFeed (mixed $location)

Zend_Gdata_Gapps_NicknameEntry getNicknameEntry (mixed $location)

Zend_Gdata_Gapps_NicknameFeed getNicknameFeed ([mixed $location = null])

Zend_Gdata_Gapps_UserEntry getUserEntry (mixed $location)

Zend_Gdata_Gapps_UserFeed getUserFeed ([mixed $location = null])

Zend_Gdata_Gapps_EmailListEntry insertEmailList (Zend_Gdata_Gapps_EmailListEntry $emailList, [string $uri = null])

Zend_Gdata_Gapps_EmailListRecipientEntry insertEmailListRecipient (Zend_Gdata_Gapps_EmailListRecipientEntry $recipient, [string $uri = null])

Zend_Gdata_Gapps_NicknameEntry insertNickname (Zend_Gdata_Gapps_NicknameEntry $nickname, [string $uri = null])

Zend_Gdata_Gapps_UserEntry insertUser (Zend_Gdata_Gapps_UserEntry $user, [string $uri = null])

Zend_Http_Response post (mixed $data, [string $uri = null], [integer $remainingRedirects = null], [string $contentType = null], [ $extraHeaders = null], array $extraHaders)

Zend_Http_Response put (mixed $data, [string $uri = null], [integer $remainingRedirects = null], [string $contentType = null], [ $extraHeaders = null], array $extraHaders)

void removeRecipientFromEmailList (string $recipientAddress, string $emailList)

Zend_Gdata_Gapps_UserEntry restoreUser (string $username)

Zend_Gdata_Gapps_EmailListFeed retrieveAllEmailLists ()

Zend_Gdata_Gapps_NicknameFeed retrieveAllNicknames ()

Zend_Gdata_Gapps_EmailListRecipientFeed retrieveAllRecipients ( $emailList, string $emaiList)

Zend_Gdata_Gapps_UserFeed retrieveAllUsers ()

Zend_Gdata_Gapps_EmailListFeed retrieveEmailLists ( $recipient, string $username)

Zend_Gdata_Gapps_NicknameEntry retrieveNickname (string $nickname)

Zend_Gdata_Gapps_NicknameFeed retrieveNicknames (string $username)

Zend_Gdata_Gapps_EmailListFeed retrievePageOfEmailLists ([ $startNickname = null], string $startEmailListName)

Zend_Gdata_Gapps_NicknameFeed retrievePageOfNicknames ([string $startNickname = null])

Zend_Gdata_Gapps_EmailListRecipientFeed retrievePageOfRecipients ( $emailList, [string $startRecipient = null], string $emaiList)

Zend_Gdata_Gapps_UserFeed retrievePageOfUsers ([string $startUsername = null])

Zend_Gdata_Gapps_UserEntry retrieveUser (string $username)

void setDomain (string $value)

Zend_Gdata_Gapps_UserEntry suspendUser (string $username)

Zend_Gdata_Gapps_UserEntry updateUser (string $username, Zend_Gdata_Gapps_UserEntry $userEntry)

void __call (string $method, array $args)

Variables

static array $namespaces = array(
array('apps', 'http://schemas.google.com/apps/2006', 1, 0)) (line 105)

Namespaces used for Zend_Gdata_Gapps

access: public

Redefinition of:

Zend_Gdata::$namespaces: Namespaces used for Gdata data

string $_domain = null (line 98)

The domain which is being administered via the Provisioning API.

access: protected

Inherited Variables

Inherited from Zend_Gdata

Zend_Gdata::$_defaultPostUri
Zend_Gdata::$_httpClient
Zend_Gdata::$_registeredPackages
Zend_Gdata::$_staticHttpClient

Inherited from Zend_Gdata_App

Zend_Gdata_App::$_gzipEnabled
Zend_Gdata_App::$_httpMethodOverride
Zend_Gdata_App::$_majorProtocolVersion
Zend_Gdata_App::$_maxRedirects
Zend_Gdata_App::$_minorProtocolVersion
Zend_Gdata_App::$_useObjectMapping
Zend_Gdata_App::$_verboseExceptionMessages

Methods

static import (line 178)

Imports a feed located at $uri.

This method overrides the default behavior of Zend_Gdata_App, providing support for Zend_Gdata_Gapps_ServiceException.

throws: Zend_Gdata_Gapps_ServiceException
throws: Zend_Gdata_App_Exception
throws: Zend_Gdata_App_HttpException
access: public

static Zend_Gdata_App_Feed import (string $uri, [Zend_Http_Client $client = null], [string $className = 'Zend_Gdata_App_Feed'])

string $uri
Zend_Http_Client $client: (optional) The client used for communication
string $className: (optional) The class which is used as the return type

Redefinition of:

Zend_Gdata::import(): Imports a feed located at $uri.

static throwServiceExceptionIfDetected (line 136)

Convert an exception to an ServiceException if an AppsForYourDomain XML document is contained within the original exception's HTTP response. If conversion fails, throw the original error.

throws: Zend_Gdata_Gapps_ServiceException
throws: mixed
access: public

static void throwServiceExceptionIfDetected (Zend_Gdata_Exception $e)

Zend_Gdata_Exception $e: The exception to convert.

addRecipientToEmailList (line 1030)

Add a specified recipient to an existing emailList.

return: The recipient entry created by the server.
throws: Zend_Gdata_App_Exception
throws: Zend_Gdata_App_HttpException
throws: Zend_Gdata_Gapps_ServiceException
access: public

Zend_Gdata_Gapps_EmailListRecipientEntry addRecipientToEmailList (string $recipientAddress, string $emailList)

string $recipientAddress: The address of the recipient to be added to the email list.
string $emailList: The name of the email address to which the recipient should be added.

Constructor __construct (line 118)

Create Gdata_Gapps object

access: public

Zend_Gdata_Gapps __construct ([Zend_Http_Client $client = null], [string $domain = null], [string $applicationId = 'MyCompany-MyApp-1.0'])

Zend_Http_Client $client: (optional) The HTTP client to use when when communicating with the Google Apps servers.
string $domain: (optional) The Google Apps domain which is to be accessed.
string $applicationId: The identity of the app in the form of Company-AppName-Version

Redefinition of:

Zend_Gdata::__construct(): Create Gdata object

createEmailList (line 944)

Create a new email list.

return: The email list entry as created on the server.
throws: Zend_Gdata_App_Exception
throws: Zend_Gdata_App_HttpException
throws: Zend_Gdata_Gapps_ServiceException
access: public

Zend_Gdata_Gapps_EmailListEntry createEmailList (string $emailList)

string $emailList: The name of the email list to be created.

createNickname (line 834)

Create a nickname for a given user.

return: The nickname entry which was created by the server.
throws: Zend_Gdata_App_Exception
throws: Zend_Gdata_App_HttpException
throws: Zend_Gdata_Gapps_ServiceException
access: public

Zend_Gdata_Gapps_NicknameEntry createNickname (string $username, string $nickname)

string $username: The username to which the new nickname should be associated.
string $nickname: The new nickname to be created.

createUser (line 675)

Create a new user entry and send it to the Google Apps servers.

return: (optional) The new user entry as returned by server.
throws: Zend_Gdata_App_Exception
throws: Zend_Gdata_App_HttpException
throws: Zend_Gdata_Gapps_ServiceException
access: public

Zend_Gdata_Gapps_UserEntry createUser (string $username, string $givenName, string $familyName, string $password, [ $passwordHashFunction = null], [string $quotaLimitInMB = null])

string $username: The username for the new user.
string $givenName: The given name for the new user.
string $familyName: The family name for the new user.
string $password: The password for the new user as a plaintext string (if $passwordHashFunction is null) or a SHA-1 hashed value (if $passwordHashFunction = 'SHA-1').
string $quotaLimitInMB: (optional) The quota limit for the new user in MB.
$passwordHashFunction

delete (line 270)

DELETE entry with client object This method overrides the default behavior of Zend_Gdata_App, providing support for Zend_Gdata_Gapps_ServiceException.

throws: Zend_Gdata_App_HttpException
throws: Zend_Gdata_App_InvalidArgumentException
throws: Zend_Gdata_Gapps_ServiceException
access: public

void delete (mixed $data, [integer $remainingRedirects = null])

mixed $data: The Zend_Gdata_App_Entry or URL to delete
integer $remainingRedirects: (optional)

Redefinition of:

Zend_Gdata_App::delete(): DELETE entry with client object

deleteEmailList (line 1012)

Delete a specified email list.

throws: Zend_Gdata_App_Exception
throws: Zend_Gdata_App_HttpException
throws: Zend_Gdata_Gapps_ServiceException
access: public

void deleteEmailList (string $emailList)

string $emailList: The name of the emailList to be deleted.

deleteNickname (line 930)

Delete a specified nickname.

throws: Zend_Gdata_App_Exception
throws: Zend_Gdata_App_HttpException
throws: Zend_Gdata_Gapps_ServiceException
access: public

void deleteNickname (string $nickname)

string $nickname: The name of the nickname to be deleted.

deleteUser (line 817)

Delete a user by username.

throws: Zend_Gdata_App_Exception
throws: Zend_Gdata_App_HttpException
throws: Zend_Gdata_Gapps_ServiceException
access: public

void deleteUser (string $username)

string $username: The username associated with the user who should be deleted.

get (line 199)

GET a URI using client object.

This method overrides the default behavior of Zend_Gdata_App, providing support for Zend_Gdata_Gapps_ServiceException.

throws: Zend_Gdata_Gapps_ServiceException
throws: Zend_Gdata_App_HttpException
access: public

Zend_Http_Response get (string $uri, [array $extraHeaders = array()])

string $uri: GET URI
array $extraHeaders: Extra headers to add to the request, as an array of string-based key/value pairs.

Redefinition of:

Zend_Gdata_App::get(): GET a URI using client object.

getBaseUrl (line 317)

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.

throws: Zend_Gdata_App_InvalidArgumentException
access: public

void getBaseUrl ([string $domain = null])

string $domain: (optional) A fully-qualified domain to use instead of the default domain for this service instance.

getDomain (line 303)

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.

return: The domain to be used for this session, or null if not set.
access: public

string getDomain ()

getEmailListEntry (line 476)

Retreive a single EmailListEntry object.

throws: Zend_Gdata_App_Exception
throws: Zend_Gdata_App_HttpException
throws: Zend_Gdata_Gapps_ServiceException
access: public

Zend_Gdata_Gapps_EmailListEntry getEmailListEntry (mixed $location)

mixed $location: The location for the feed, as a URL or Query.

getEmailListFeed (line 385)

Retreive EmailListFeed object containing multiple EmailListEntry objects.

throws: Zend_Gdata_App_Exception
throws: Zend_Gdata_App_HttpException
throws: Zend_Gdata_Gapps_ServiceException
access: public

Zend_Gdata_Gapps_EmailListFeed getEmailListFeed ([mixed $location = null])

mixed $location: (optional) The location for the feed, as a URL or Query.

getEmailListRecipientEntry (line 499)

Retreive a single EmailListRecipientEntry object.

throws: Zend_Gdata_App_Exception
throws: Zend_Gdata_App_HttpException
throws: Zend_Gdata_Gapps_ServiceException
access: public

Zend_Gdata_Gapps_EmailListRecipientEntry getEmailListRecipientEntry (mixed $location)

mixed $location: The location for the feed, as a URL or Query.

getEmailListRecipientFeed (line 407)

Retreive EmailListRecipientFeed object containing multiple EmailListRecipientEntry objects.

throws: Zend_Gdata_App_Exception
throws: Zend_Gdata_App_HttpException
throws: Zend_Gdata_Gapps_ServiceException
access: public

Zend_Gdata_Gapps_EmailListRecipientFeed getEmailListRecipientFeed (mixed $location)

mixed $location: The location for the feed, as a URL or Query.

getNicknameEntry (line 453)

Retreive a single NicknameEntry object.

throws: Zend_Gdata_App_Exception
throws: Zend_Gdata_App_HttpException
throws: Zend_Gdata_Gapps_ServiceException
access: public

Zend_Gdata_Gapps_NicknameEntry getNicknameEntry (mixed $location)

mixed $location: The location for the feed, as a URL or Query.

getNicknameFeed (line 362)

Retreive NicknameFeed object containing multiple NicknameEntry objects.

throws: Zend_Gdata_App_Exception
throws: Zend_Gdata_App_HttpException
throws: Zend_Gdata_Gapps_ServiceException
access: public

Zend_Gdata_Gapps_NicknameFeed getNicknameFeed ([mixed $location = null])

mixed $location: (optional) The location for the feed, as a URL or Query.

getUserEntry (line 430)

Retreive a single UserEntry object.

throws: Zend_Gdata_App_Exception
throws: Zend_Gdata_App_HttpException
throws: Zend_Gdata_Gapps_ServiceException
access: public

Zend_Gdata_Gapps_UserEntry getUserEntry (mixed $location)

mixed $location: The location for the feed, as a URL or Query.

getUserFeed (line 340)

Retrieve a UserFeed containing multiple UserEntry objects.

throws: Zend_Gdata_App_Exception
throws: Zend_Gdata_App_HttpException
throws: Zend_Gdata_Gapps_ServiceException
access: public

Zend_Gdata_Gapps_UserFeed getUserFeed ([mixed $location = null])

mixed $location: (optional) The location for the feed, as a URL or Query.

insertEmailList (line 572)

Create a new email list from an EmailListEntry.

return: The inserted email list entry as returned by the server.
throws: Zend_Gdata_App_Exception
throws: Zend_Gdata_App_HttpException
throws: Zend_Gdata_Gapps_ServiceException
access: public

Zend_Gdata_Gapps_EmailListEntry insertEmailList (Zend_Gdata_Gapps_EmailListEntry $emailList, [string $uri = null])

Zend_Gdata_Gapps_EmailListEntry $emailList: The email list entry to insert.
string $uri: (optional) The URI where the email list should be uploaded to. If null, the default email list creation URI for this domain will be used.

insertEmailListRecipient (line 595)

Create a new email list recipient from an EmailListRecipientEntry.

return: The inserted recipient entry as returned by the server.
throws: Zend_Gdata_App_Exception
throws: Zend_Gdata_App_HttpException
throws: Zend_Gdata_Gapps_ServiceException
access: public

Zend_Gdata_Gapps_EmailListRecipientEntry insertEmailListRecipient (Zend_Gdata_Gapps_EmailListRecipientEntry $recipient, [string $uri = null])

Zend_Gdata_Gapps_EmailListRecipientEntry $recipient: The recipient entry to insert.
string $uri: (optional) The URI where the recipient should be uploaded to. If null, the default recipient creation URI for this domain will be used.

insertNickname (line 549)

Create a new nickname from a NicknameEntry.

return: The inserted nickname entry as returned by the server.
throws: Zend_Gdata_App_Exception
throws: Zend_Gdata_App_HttpException
throws: Zend_Gdata_Gapps_ServiceException
access: public

Zend_Gdata_Gapps_NicknameEntry insertNickname (Zend_Gdata_Gapps_NicknameEntry $nickname, [string $uri = null])

Zend_Gdata_Gapps_NicknameEntry $nickname: The nickname entry to insert.
string $uri: (optional) The URI where the nickname should be uploaded to. If null, the default nickname creation URI for this domain will be used.

insertUser (line 526)

Create a new user from a UserEntry.

return: The inserted user entry as returned by the server.
throws: Zend_Gdata_App_Exception
throws: Zend_Gdata_App_HttpException
throws: Zend_Gdata_Gapps_ServiceException
access: public

Zend_Gdata_Gapps_UserEntry insertUser (Zend_Gdata_Gapps_UserEntry $user, [string $uri = null])

Zend_Gdata_Gapps_UserEntry $user: The user entry to insert.
string $uri: (optional) The URI where the user should be uploaded to. If null, the default user creation URI for this domain will be used.

post (line 223)

POST data with client object.

This method overrides the default behavior of Zend_Gdata_App, providing support for Zend_Gdata_Gapps_ServiceException.

throws: Zend_Gdata_App_HttpException
throws: Zend_Gdata_App_InvalidArgumentException
throws: Zend_Gdata_Gapps_ServiceException
access: public

Zend_Http_Response post (mixed $data, [string $uri = null], [integer $remainingRedirects = null], [string $contentType = null], [ $extraHeaders = null], array $extraHaders)

mixed $data: The Zend_Gdata_App_Entry or XML to post
string $uri: (optional) POST URI
integer $remainingRedirects: (optional)
string $contentType: Content-type of the data
array $extraHaders: Extra headers to add tot he request
$extraHeaders

Redefinition of:

Zend_Gdata_App::post(): POST data with client object

put (line 248)

PUT data with client object This method overrides the default behavior of Zend_Gdata_App, providing support for Zend_Gdata_Gapps_ServiceException.

throws: Zend_Gdata_App_HttpException
throws: Zend_Gdata_App_InvalidArgumentException
throws: Zend_Gdata_Gapps_ServiceException
access: public

Zend_Http_Response put (mixed $data, [string $uri = null], [integer $remainingRedirects = null], [string $contentType = null], [ $extraHeaders = null], array $extraHaders)

mixed $data: The Zend_Gdata_App_Entry or XML to post
string $uri: (optional) PUT URI
integer $remainingRedirects: (optional)
string $contentType: Content-type of the data
array $extraHaders: Extra headers to add tot he request
$extraHeaders

Redefinition of:

Zend_Gdata_App::put(): PUT data with client object

removeRecipientFromEmailList (line 1091)

Remove a specified recipient from an email list.

throws: Zend_Gdata_App_Exception
throws: Zend_Gdata_App_HttpException
throws: Zend_Gdata_Gapps_ServiceException
access: public

void removeRecipientFromEmailList (string $recipientAddress, string $emailList)

string $recipientAddress: The recipient to be removed.
string $emailList: The list from which the recipient should be removed.

restoreUser (line 802)

Mark a given user as not suspended.

return: The UserEntry for the modified user.
throws: Zend_Gdata_App_Exception
throws: Zend_Gdata_App_HttpException
throws: Zend_Gdata_Gapps_ServiceException
access: public

Zend_Gdata_Gapps_UserEntry restoreUser (string $username)

string $username: The username associated with the user who should be restored.

retrieveAllEmailLists (line 1000)

Retrieve all email lists associated with the curent domain. Be aware that calling this function on a domain with many email lists will take a signifigant amount of time to complete. On larger domains this may may cause execution to timeout without proper precautions in place.

return: The list of email lists found as Zend_Gdata_Gapps_EmailListEntry objects.
throws: Zend_Gdata_App_Exception
throws: Zend_Gdata_App_HttpException
throws: Zend_Gdata_Gapps_ServiceException
access: public

Zend_Gdata_Gapps_EmailListFeed retrieveAllEmailLists ()

retrieveAllNicknames (line 918)

Retrieve all nicknames in the current domain. Be aware that calling this function on a domain with many nicknames will take a signifigant amount of time to complete. On larger domains this may may cause execution to timeout without proper precautions in place.

return: Collection of Zend_Gdata_NicknameEntry objects representing all nicknames in the domain.
throws: Zend_Gdata_App_Exception
throws: Zend_Gdata_App_HttpException
throws: Zend_Gdata_Gapps_ServiceException
access: public

Zend_Gdata_Gapps_NicknameFeed retrieveAllNicknames ()

retrieveAllRecipients (line 1076)

Retrieve all recipients associated with an email list. Be aware that calling this function on a domain with many email lists will take a signifigant amount of time to complete. On larger domains this may may cause execution to timeout without proper precautions in place.

return: The list of email lists found as Zend_Gdata_Gapps_EmailListRecipientEntry objects.
throws: Zend_Gdata_App_Exception
throws: Zend_Gdata_App_HttpException
throws: Zend_Gdata_Gapps_ServiceException
access: public

Zend_Gdata_Gapps_EmailListRecipientFeed retrieveAllRecipients ( $emailList, string $emaiList)

string $emaiList: The email list which should be searched.
$emailList

retrieveAllUsers (line 747)

Retrieve all users in the current domain. Be aware that calling this function on a domain with many users will take a signifigant amount of time to complete. On larger domains this may may cause execution to timeout without proper precautions in place.

return: Collection of Zend_Gdata_UserEntry objects representing all users in the domain.
throws: Zend_Gdata_App_Exception
throws: Zend_Gdata_App_HttpException
throws: Zend_Gdata_Gapps_ServiceException
access: public

Zend_Gdata_Gapps_UserFeed retrieveAllUsers ()

retrieveEmailLists (line 963)

Retrieve all email lists associated with a recipient.

return: The list of email lists found as Zend_Gdata_EmailListEntry objects.
throws: Zend_Gdata_App_Exception
throws: Zend_Gdata_App_HttpException
throws: Zend_Gdata_Gapps_ServiceException
access: public

Zend_Gdata_Gapps_EmailListFeed retrieveEmailLists ( $recipient, string $username)

string $username: The recipient whose associated email lists should be returned.
$recipient

retrieveNickname (line 852)

Retrieve the entry for a specified nickname.

return: The requested nickname entry.
throws: Zend_Gdata_App_Exception
throws: Zend_Gdata_App_HttpException
throws: Zend_Gdata_Gapps_ServiceException
access: public

Zend_Gdata_Gapps_NicknameEntry retrieveNickname (string $nickname)

string $nickname: The nickname to be retrieved.

retrieveNicknames (line 879)

Retrieve all nicknames associated with a specific username.

return: A feed containing all nicknames for the given user, or null if
throws: Zend_Gdata_App_Exception
throws: Zend_Gdata_App_HttpException
throws: Zend_Gdata_Gapps_ServiceException
access: public

Zend_Gdata_Gapps_NicknameFeed retrieveNicknames (string $username)

string $username: The username whose nicknames should be returned.

retrievePageOfEmailLists (line 982)

Retrieve a page of email lists in alphabetical order, starting with the provided email list.

return: Collection of Zend_Gdata_EmailListEntry objects representing all nicknames in the domain.
throws: Zend_Gdata_App_Exception
throws: Zend_Gdata_App_HttpException
throws: Zend_Gdata_Gapps_ServiceException
access: public

Zend_Gdata_Gapps_EmailListFeed retrievePageOfEmailLists ([ $startNickname = null], string $startEmailListName)

string $startEmailListName: (optional) The first list to retrieve. If null or not defined, the page will begin with the first email list in the domain.
$startNickname

retrievePageOfNicknames (line 900)

Retrieve a page of nicknames in alphabetical order, starting with the provided nickname.

return: Collection of Zend_Gdata_NicknameEntry objects representing all nicknames in the domain.
throws: Zend_Gdata_App_Exception
throws: Zend_Gdata_App_HttpException
throws: Zend_Gdata_Gapps_ServiceException
access: public

Zend_Gdata_Gapps_NicknameFeed retrievePageOfNicknames ([string $startNickname = null])

string $startNickname: (optional) The first nickname to retrieve. If null or not declared, the page will begin with the first nickname in the domain.

retrievePageOfRecipients (line 1055)

Retrieve a page of email list recipients in alphabetical order, starting with the provided email list recipient.

return: Collection of Zend_Gdata_EmailListRecipientEntry objects representing all recpients in the specified list.
throws: Zend_Gdata_App_Exception
throws: Zend_Gdata_App_HttpException
throws: Zend_Gdata_Gapps_ServiceException
access: public

Zend_Gdata_Gapps_EmailListRecipientFeed retrievePageOfRecipients ( $emailList, [string $startRecipient = null], string $emaiList)

string $emaiList: The email list which should be searched.
string $startRecipient: (optinal) The address of the first recipient, or null to start with the first recipient in the list.
$emailList

retrievePageOfUsers (line 729)

Retrieve a page of users in alphabetical order, starting with the provided username.

return: Collection of Zend_Gdata_UserEntry objects representing all users in the domain.
throws: Zend_Gdata_App_Exception
throws: Zend_Gdata_App_HttpException
throws: Zend_Gdata_Gapps_ServiceException
access: public

Zend_Gdata_Gapps_UserFeed retrievePageOfUsers ([string $startUsername = null])

string $startUsername: (optional) The first username to retrieve. If null or not declared, the page will begin with the first user in the domain.

retrieveUser (line 701)

Retrieve a user based on their username.

return: The username to search for, or null if no match found.
throws: Zend_Gdata_App_HttpException
throws: Zend_Gdata_App_InvalidArgumentException
access: public

Zend_Gdata_Gapps_UserEntry retrieveUser (string $username)

string $username: The username to search for.

setDomain (line 290)

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

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.

access: public

void setDomain (string $value)

string $value: The domain to be used for this session.

suspendUser (line 785)

Mark a given user as suspended.

return: The UserEntry for the modified user.
throws: Zend_Gdata_App_Exception
throws: Zend_Gdata_App_HttpException
throws: Zend_Gdata_Gapps_ServiceException
access: public

Zend_Gdata_Gapps_UserEntry suspendUser (string $username)

string $username: The username associated with the user who should be suspended.

updateUser (line 769)

Overwrite a specified username with the provided UserEntry. The UserEntry does not need to contain an edit link.

This method is provided for compliance with the Google Apps Provisioning API specification. Normally users will instead want to call UserEntry::save() instead.

return: The UserEntry returned by the server.
see: Zend_Gdata_App_Entry::save
throws: Zend_Gdata_App_Exception
throws: Zend_Gdata_App_HttpException
throws: Zend_Gdata_Gapps_ServiceException
access: public

Zend_Gdata_Gapps_UserEntry updateUser (string $username, Zend_Gdata_Gapps_UserEntry $userEntry)

string $username: The username whose data will be overwritten.
Zend_Gdata_Gapps_UserEntry $userEntry: The user entry which will be overwritten.

__call (line 622)

Provides a magic factory method to instantiate new objects with shorter syntax than would otherwise be required by the Zend Framework naming conventions. For more information, see Zend_Gdata_App::__call().

This overrides the default behavior of __call() so that query classes do not need to have their domain manually set when created with a magic factory method.

see: Zend_Gdata_App::__call()
throws: Zend_Gdata_App_Exception
access: public

void __call (string $method, array $args)

string $method: The method name being called
array $args: The arguments passed to the call

Redefinition of:

Zend_Gdata_App::__call(): Provides a magic factory method to instantiate new objects with

Inherited Methods

Inherited From Zend_Gdata

Zend_Gdata::__construct()
Zend_Gdata::getEntry()
Zend_Gdata::getFeed()
Zend_Gdata::import()
Zend_Gdata::isAuthenticated()
Zend_Gdata::performHttpRequest()

Inherited From Zend_Gdata_App

Zend_Gdata_App::__construct()
Zend_Gdata_App::delete()
Zend_Gdata_App::enableRequestDebugLogging()
Zend_Gdata_App::generateIfMatchHeaderData()
Zend_Gdata_App::get()
Zend_Gdata_App::getEntry()
Zend_Gdata_App::getFeed()
Zend_Gdata_App::getGzipEnabled()
Zend_Gdata_App::getHttpClient()
Zend_Gdata_App::getHttpMethodOverride()
Zend_Gdata_App::getMajorProtocolVersion()
Zend_Gdata_App::getMaxRedirects()
Zend_Gdata_App::getMinorProtocolVersion()
Zend_Gdata_App::getNextFeed()
Zend_Gdata_App::getPreviousFeed()
Zend_Gdata_App::getStaticHttpClient()
Zend_Gdata_App::getVerboseExceptionMessages()
Zend_Gdata_App::import()
Zend_Gdata_App::importFile()
Zend_Gdata_App::importString()
Zend_Gdata_App::importUrl()
Zend_Gdata_App::insertEntry()
Zend_Gdata_App::performHttpRequest()
Zend_Gdata_App::post()
Zend_Gdata_App::prepareRequest()
Zend_Gdata_App::put()
Zend_Gdata_App::registerPackage()
Zend_Gdata_App::retrieveAllEntriesForFeed()
Zend_Gdata_App::setGzipEnabled()
Zend_Gdata_App::setHttpClient()
Zend_Gdata_App::setHttpMethodOverride()
Zend_Gdata_App::setMajorProtocolVersion()
Zend_Gdata_App::setMaxRedirects()
Zend_Gdata_App::setMinorProtocolVersion()
Zend_Gdata_App::setStaticHttpClient()
Zend_Gdata_App::setVerboseExceptionMessages()
Zend_Gdata_App::updateEntry()
Zend_Gdata_App::useObjectMapping()
Zend_Gdata_App::usingObjectMapping()
Zend_Gdata_App::__call()

Class Constants

APPS_BASE_FEED_URI = 'https://apps-apis.google.com/a/feeds' (line 70)

APPS_EMAIL_LIST_PATH = '/emailList/2.0' (line 86)

Path to email list feeds on the Google Apps server.

APPS_EMAIL_LIST_RECIPIENT_POSTFIX = '/recipient' (line 91)

Path to email list recipient feeds on the Google Apps server.

APPS_NICKNAME_PATH = '/nickname/2.0' (line 81)

Path to nickname feeds on the Google Apps server.

APPS_USER_PATH = '/user/2.0' (line 76)

Path to user feeds on the Google Apps server.

AUTH_SERVICE_NAME = 'apps' (line 71)

Inherited Constants

Inherited from Zend_Gdata

Zend_Gdata::AUTH_SERVICE_NAME

Inherited from Zend_Gdata_App

Zend_Gdata_App::DEFAULT_MAJOR_PROTOCOL_VERSION
Zend_Gdata_App::DEFAULT_MINOR_PROTOCOL_VERSION

Documentation generated on Mon, 21 Jun 2010 15:25:10 -0400 by phpDocumentor 1.4.3