120 lines
4.5 KiB
PHP
120 lines
4.5 KiB
PHP
<?php
|
|
/*
|
|
* Copyright 2014 Google Inc.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
|
|
* use this file except in compliance with the License. You may obtain a copy of
|
|
* the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
* License for the specific language governing permissions and limitations under
|
|
* the License.
|
|
*/
|
|
|
|
/**
|
|
* The "labels" collection of methods.
|
|
* Typical usage is:
|
|
* <code>
|
|
* $gmailService = new Google_Service_Gmail(...);
|
|
* $labels = $gmailService->labels;
|
|
* </code>
|
|
*/
|
|
class Google_Service_Gmail_Resource_UsersLabels extends Google_Service_Resource
|
|
{
|
|
/**
|
|
* Creates a new label. (labels.create)
|
|
*
|
|
* @param string $userId The user's email address. The special value me can be
|
|
* used to indicate the authenticated user.
|
|
* @param Google_Service_Gmail_Label $postBody
|
|
* @param array $optParams Optional parameters.
|
|
* @return Google_Service_Gmail_Label
|
|
*/
|
|
public function create($userId, Google_Service_Gmail_Label $postBody, $optParams = array())
|
|
{
|
|
$params = array('userId' => $userId, 'postBody' => $postBody);
|
|
$params = array_merge($params, $optParams);
|
|
return $this->call('create', array($params), "Google_Service_Gmail_Label");
|
|
}
|
|
/**
|
|
* Immediately and permanently deletes the specified label and removes it from
|
|
* any messages and threads that it is applied to. (labels.delete)
|
|
*
|
|
* @param string $userId The user's email address. The special value me can be
|
|
* used to indicate the authenticated user.
|
|
* @param string $id The ID of the label to delete.
|
|
* @param array $optParams Optional parameters.
|
|
*/
|
|
public function delete($userId, $id, $optParams = array())
|
|
{
|
|
$params = array('userId' => $userId, 'id' => $id);
|
|
$params = array_merge($params, $optParams);
|
|
return $this->call('delete', array($params));
|
|
}
|
|
/**
|
|
* Gets the specified label. (labels.get)
|
|
*
|
|
* @param string $userId The user's email address. The special value me can be
|
|
* used to indicate the authenticated user.
|
|
* @param string $id The ID of the label to retrieve.
|
|
* @param array $optParams Optional parameters.
|
|
* @return Google_Service_Gmail_Label
|
|
*/
|
|
public function get($userId, $id, $optParams = array())
|
|
{
|
|
$params = array('userId' => $userId, 'id' => $id);
|
|
$params = array_merge($params, $optParams);
|
|
return $this->call('get', array($params), "Google_Service_Gmail_Label");
|
|
}
|
|
/**
|
|
* Lists all labels in the user's mailbox. (labels.listUsersLabels)
|
|
*
|
|
* @param string $userId The user's email address. The special value me can be
|
|
* used to indicate the authenticated user.
|
|
* @param array $optParams Optional parameters.
|
|
* @return Google_Service_Gmail_ListLabelsResponse
|
|
*/
|
|
public function listUsersLabels($userId, $optParams = array())
|
|
{
|
|
$params = array('userId' => $userId);
|
|
$params = array_merge($params, $optParams);
|
|
return $this->call('list', array($params), "Google_Service_Gmail_ListLabelsResponse");
|
|
}
|
|
/**
|
|
* Patch the specified label. (labels.patch)
|
|
*
|
|
* @param string $userId The user's email address. The special value me can be
|
|
* used to indicate the authenticated user.
|
|
* @param string $id The ID of the label to update.
|
|
* @param Google_Service_Gmail_Label $postBody
|
|
* @param array $optParams Optional parameters.
|
|
* @return Google_Service_Gmail_Label
|
|
*/
|
|
public function patch($userId, $id, Google_Service_Gmail_Label $postBody, $optParams = array())
|
|
{
|
|
$params = array('userId' => $userId, 'id' => $id, 'postBody' => $postBody);
|
|
$params = array_merge($params, $optParams);
|
|
return $this->call('patch', array($params), "Google_Service_Gmail_Label");
|
|
}
|
|
/**
|
|
* Updates the specified label. (labels.update)
|
|
*
|
|
* @param string $userId The user's email address. The special value me can be
|
|
* used to indicate the authenticated user.
|
|
* @param string $id The ID of the label to update.
|
|
* @param Google_Service_Gmail_Label $postBody
|
|
* @param array $optParams Optional parameters.
|
|
* @return Google_Service_Gmail_Label
|
|
*/
|
|
public function update($userId, $id, Google_Service_Gmail_Label $postBody, $optParams = array())
|
|
{
|
|
$params = array('userId' => $userId, 'id' => $id, 'postBody' => $postBody);
|
|
$params = array_merge($params, $optParams);
|
|
return $this->call('update', array($params), "Google_Service_Gmail_Label");
|
|
}
|
|
}
|