lockfile again

This commit is contained in:
Tim Bendt
2025-11-26 11:50:55 -05:00
parent af3c23cb6e
commit 6ceecaa69e
4461 changed files with 641349 additions and 10 deletions

203
vendor/google/apiclient-services/LICENSE vendored Normal file
View File

@@ -0,0 +1,203 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
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.

View File

@@ -0,0 +1,7 @@
# Security Policy
To report a security issue, please use [g.co/vulnz](https://g.co/vulnz).
The Google Security Team will respond within 5 working days of your report on g.co/vulnz.
We use g.co/vulnz for our intake, and do coordination and disclosure here using GitHub Security Advisory to privately discuss and fix the issue.

View File

@@ -0,0 +1,36 @@
<?php
// For older (pre-2.7.2) verions of google/apiclient
if (
file_exists(__DIR__ . '/../apiclient/src/Google/Client.php')
&& !class_exists('Google_Client', false)
) {
require_once(__DIR__ . '/../apiclient/src/Google/Client.php');
if (
defined('Google_Client::LIBVER')
&& version_compare(Google_Client::LIBVER, '2.7.2', '<=')
) {
$servicesClassMap = [
'Google\\Client' => 'Google_Client',
'Google\\Service' => 'Google_Service',
'Google\\Service\\Resource' => 'Google_Service_Resource',
'Google\\Model' => 'Google_Model',
'Google\\Collection' => 'Google_Collection',
];
foreach ($servicesClassMap as $alias => $class) {
class_alias($class, $alias);
}
}
}
spl_autoload_register(function ($class) {
if (0 === strpos($class, 'Google_Service_')) {
// Autoload the new class, which will also create an alias for the
// old class by changing underscores to namespaces:
// Google_Service_Speech_Resource_Operations
// => Google\Service\Speech\Resource\Operations
$classExists = class_exists($newClass = str_replace('_', '\\', $class));
if ($classExists) {
return true;
}
}
}, true, true);

View File

@@ -0,0 +1,27 @@
{
"name": "google/apiclient-services",
"type": "library",
"description": "Client library for Google APIs",
"keywords": ["google"],
"homepage": "http://developers.google.com/api-client-library/php",
"license": "Apache-2.0",
"require": {
"php": "^8.1"
},
"require-dev": {
"phpunit/phpunit": "^9.6"
},
"autoload": {
"psr-4": {
"Google\\Service\\": "src"
},
"files": [
"autoload.php"
]
},
"autoload-dev": {
"psr-4": {
"Google\\": "tests/mocks"
}
}
}

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,117 @@
<?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.
*/
namespace Google\Service\Gmail;
class AutoForwarding extends \Google\Model
{
/**
* Unspecified disposition.
*/
public const DISPOSITION_dispositionUnspecified = 'dispositionUnspecified';
/**
* Leave the message in the `INBOX`.
*/
public const DISPOSITION_leaveInInbox = 'leaveInInbox';
/**
* Archive the message.
*/
public const DISPOSITION_archive = 'archive';
/**
* Move the message to the `TRASH`.
*/
public const DISPOSITION_trash = 'trash';
/**
* Leave the message in the `INBOX` and mark it as read.
*/
public const DISPOSITION_markRead = 'markRead';
/**
* The state that a message should be left in after it has been forwarded.
*
* @var string
*/
public $disposition;
/**
* Email address to which all incoming messages are forwarded. This email
* address must be a verified member of the forwarding addresses.
*
* @var string
*/
public $emailAddress;
/**
* Whether all incoming mail is automatically forwarded to another address.
*
* @var bool
*/
public $enabled;
/**
* The state that a message should be left in after it has been forwarded.
*
* Accepted values: dispositionUnspecified, leaveInInbox, archive, trash,
* markRead
*
* @param self::DISPOSITION_* $disposition
*/
public function setDisposition($disposition)
{
$this->disposition = $disposition;
}
/**
* @return self::DISPOSITION_*
*/
public function getDisposition()
{
return $this->disposition;
}
/**
* Email address to which all incoming messages are forwarded. This email
* address must be a verified member of the forwarding addresses.
*
* @param string $emailAddress
*/
public function setEmailAddress($emailAddress)
{
$this->emailAddress = $emailAddress;
}
/**
* @return string
*/
public function getEmailAddress()
{
return $this->emailAddress;
}
/**
* Whether all incoming mail is automatically forwarded to another address.
*
* @param bool $enabled
*/
public function setEnabled($enabled)
{
$this->enabled = $enabled;
}
/**
* @return bool
*/
public function getEnabled()
{
return $this->enabled;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(AutoForwarding::class, 'Google_Service_Gmail_AutoForwarding');

View File

@@ -0,0 +1,49 @@
<?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.
*/
namespace Google\Service\Gmail;
class BatchDeleteMessagesRequest extends \Google\Collection
{
protected $collection_key = 'ids';
/**
* The IDs of the messages to delete.
*
* @var string[]
*/
public $ids;
/**
* The IDs of the messages to delete.
*
* @param string[] $ids
*/
public function setIds($ids)
{
$this->ids = $ids;
}
/**
* @return string[]
*/
public function getIds()
{
return $this->ids;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(BatchDeleteMessagesRequest::class, 'Google_Service_Gmail_BatchDeleteMessagesRequest');

View File

@@ -0,0 +1,95 @@
<?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.
*/
namespace Google\Service\Gmail;
class BatchModifyMessagesRequest extends \Google\Collection
{
protected $collection_key = 'removeLabelIds';
/**
* A list of label IDs to add to messages.
*
* @var string[]
*/
public $addLabelIds;
/**
* The IDs of the messages to modify. There is a limit of 1000 ids per
* request.
*
* @var string[]
*/
public $ids;
/**
* A list of label IDs to remove from messages.
*
* @var string[]
*/
public $removeLabelIds;
/**
* A list of label IDs to add to messages.
*
* @param string[] $addLabelIds
*/
public function setAddLabelIds($addLabelIds)
{
$this->addLabelIds = $addLabelIds;
}
/**
* @return string[]
*/
public function getAddLabelIds()
{
return $this->addLabelIds;
}
/**
* The IDs of the messages to modify. There is a limit of 1000 ids per
* request.
*
* @param string[] $ids
*/
public function setIds($ids)
{
$this->ids = $ids;
}
/**
* @return string[]
*/
public function getIds()
{
return $this->ids;
}
/**
* A list of label IDs to remove from messages.
*
* @param string[] $removeLabelIds
*/
public function setRemoveLabelIds($removeLabelIds)
{
$this->removeLabelIds = $removeLabelIds;
}
/**
* @return string[]
*/
public function getRemoveLabelIds()
{
return $this->removeLabelIds;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(BatchModifyMessagesRequest::class, 'Google_Service_Gmail_BatchModifyMessagesRequest');

View File

@@ -0,0 +1,76 @@
<?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.
*/
namespace Google\Service\Gmail;
class ClassificationLabelFieldValue extends \Google\Model
{
/**
* Required. The field ID for the Classification Label Value. Maps to the ID
* field of the Google Drive `Label.Field` object.
*
* @var string
*/
public $fieldId;
/**
* Selection choice ID for the selection option. Should only be set if the
* field type is `SELECTION` in the Google Drive `Label.Field` object. Maps to
* the id field of the Google Drive `Label.Field.SelectionOptions` resource.
*
* @var string
*/
public $selection;
/**
* Required. The field ID for the Classification Label Value. Maps to the ID
* field of the Google Drive `Label.Field` object.
*
* @param string $fieldId
*/
public function setFieldId($fieldId)
{
$this->fieldId = $fieldId;
}
/**
* @return string
*/
public function getFieldId()
{
return $this->fieldId;
}
/**
* Selection choice ID for the selection option. Should only be set if the
* field type is `SELECTION` in the Google Drive `Label.Field` object. Maps to
* the id field of the Google Drive `Label.Field.SelectionOptions` resource.
*
* @param string $selection
*/
public function setSelection($selection)
{
$this->selection = $selection;
}
/**
* @return string
*/
public function getSelection()
{
return $this->selection;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ClassificationLabelFieldValue::class, 'Google_Service_Gmail_ClassificationLabelFieldValue');

View File

@@ -0,0 +1,69 @@
<?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.
*/
namespace Google\Service\Gmail;
class ClassificationLabelValue extends \Google\Collection
{
protected $collection_key = 'fields';
protected $fieldsType = ClassificationLabelFieldValue::class;
protected $fieldsDataType = 'array';
/**
* Required. The canonical or raw alphanumeric classification label ID. Maps
* to the ID field of the Google Drive Label resource.
*
* @var string
*/
public $labelId;
/**
* Field values for the given classification label ID.
*
* @param ClassificationLabelFieldValue[] $fields
*/
public function setFields($fields)
{
$this->fields = $fields;
}
/**
* @return ClassificationLabelFieldValue[]
*/
public function getFields()
{
return $this->fields;
}
/**
* Required. The canonical or raw alphanumeric classification label ID. Maps
* to the ID field of the Google Drive Label resource.
*
* @param string $labelId
*/
public function setLabelId($labelId)
{
$this->labelId = $labelId;
}
/**
* @return string
*/
public function getLabelId()
{
return $this->labelId;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ClassificationLabelValue::class, 'Google_Service_Gmail_ClassificationLabelValue');

View File

@@ -0,0 +1,91 @@
<?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.
*/
namespace Google\Service\Gmail;
class CseIdentity extends \Google\Model
{
/**
* The email address for the sending identity. The email address must be the
* primary email address of the authenticated user.
*
* @var string
*/
public $emailAddress;
/**
* If a key pair is associated, the ID of the key pair, CseKeyPair.
*
* @var string
*/
public $primaryKeyPairId;
protected $signAndEncryptKeyPairsType = SignAndEncryptKeyPairs::class;
protected $signAndEncryptKeyPairsDataType = '';
/**
* The email address for the sending identity. The email address must be the
* primary email address of the authenticated user.
*
* @param string $emailAddress
*/
public function setEmailAddress($emailAddress)
{
$this->emailAddress = $emailAddress;
}
/**
* @return string
*/
public function getEmailAddress()
{
return $this->emailAddress;
}
/**
* If a key pair is associated, the ID of the key pair, CseKeyPair.
*
* @param string $primaryKeyPairId
*/
public function setPrimaryKeyPairId($primaryKeyPairId)
{
$this->primaryKeyPairId = $primaryKeyPairId;
}
/**
* @return string
*/
public function getPrimaryKeyPairId()
{
return $this->primaryKeyPairId;
}
/**
* The configuration of a CSE identity that uses different key pairs for
* signing and encryption.
*
* @param SignAndEncryptKeyPairs $signAndEncryptKeyPairs
*/
public function setSignAndEncryptKeyPairs(SignAndEncryptKeyPairs $signAndEncryptKeyPairs)
{
$this->signAndEncryptKeyPairs = $signAndEncryptKeyPairs;
}
/**
* @return SignAndEncryptKeyPairs
*/
public function getSignAndEncryptKeyPairs()
{
return $this->signAndEncryptKeyPairs;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(CseIdentity::class, 'Google_Service_Gmail_CseIdentity');

View File

@@ -0,0 +1,211 @@
<?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.
*/
namespace Google\Service\Gmail;
class CseKeyPair extends \Google\Collection
{
/**
* The current state of the key pair is not set. The key pair is neither
* turned on nor turned off.
*/
public const ENABLEMENT_STATE_stateUnspecified = 'stateUnspecified';
/**
* The key pair is turned on. For any email messages that this key pair
* encrypts, Gmail decrypts the messages and signs any outgoing mail with the
* private key. To turn on a key pair, use the EnableCseKeyPair method.
*/
public const ENABLEMENT_STATE_enabled = 'enabled';
/**
* The key pair is turned off. Authenticated users cannot decrypt email
* messages nor sign outgoing messages. If a key pair is turned off for more
* than 30 days, you can permanently delete it. To turn off a key pair, use
* the DisableCseKeyPair method.
*/
public const ENABLEMENT_STATE_disabled = 'disabled';
protected $collection_key = 'subjectEmailAddresses';
/**
* Output only. If a key pair is set to `DISABLED`, the time that the key
* pair's state changed from `ENABLED` to `DISABLED`. This field is present
* only when the key pair is in state `DISABLED`.
*
* @var string
*/
public $disableTime;
/**
* Output only. The current state of the key pair.
*
* @var string
*/
public $enablementState;
/**
* Output only. The immutable ID for the client-side encryption S/MIME key
* pair.
*
* @var string
*/
public $keyPairId;
/**
* Output only. The public key and its certificate chain, in
* [PEM](https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail) format.
*
* @var string
*/
public $pem;
/**
* Input only. The public key and its certificate chain. The chain must be in
* [PKCS#7](https://en.wikipedia.org/wiki/PKCS_7) format and use PEM encoding
* and ASCII armor.
*
* @var string
*/
public $pkcs7;
protected $privateKeyMetadataType = CsePrivateKeyMetadata::class;
protected $privateKeyMetadataDataType = 'array';
/**
* Output only. The email address identities that are specified on the leaf
* certificate.
*
* @var string[]
*/
public $subjectEmailAddresses;
/**
* Output only. If a key pair is set to `DISABLED`, the time that the key
* pair's state changed from `ENABLED` to `DISABLED`. This field is present
* only when the key pair is in state `DISABLED`.
*
* @param string $disableTime
*/
public function setDisableTime($disableTime)
{
$this->disableTime = $disableTime;
}
/**
* @return string
*/
public function getDisableTime()
{
return $this->disableTime;
}
/**
* Output only. The current state of the key pair.
*
* Accepted values: stateUnspecified, enabled, disabled
*
* @param self::ENABLEMENT_STATE_* $enablementState
*/
public function setEnablementState($enablementState)
{
$this->enablementState = $enablementState;
}
/**
* @return self::ENABLEMENT_STATE_*
*/
public function getEnablementState()
{
return $this->enablementState;
}
/**
* Output only. The immutable ID for the client-side encryption S/MIME key
* pair.
*
* @param string $keyPairId
*/
public function setKeyPairId($keyPairId)
{
$this->keyPairId = $keyPairId;
}
/**
* @return string
*/
public function getKeyPairId()
{
return $this->keyPairId;
}
/**
* Output only. The public key and its certificate chain, in
* [PEM](https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail) format.
*
* @param string $pem
*/
public function setPem($pem)
{
$this->pem = $pem;
}
/**
* @return string
*/
public function getPem()
{
return $this->pem;
}
/**
* Input only. The public key and its certificate chain. The chain must be in
* [PKCS#7](https://en.wikipedia.org/wiki/PKCS_7) format and use PEM encoding
* and ASCII armor.
*
* @param string $pkcs7
*/
public function setPkcs7($pkcs7)
{
$this->pkcs7 = $pkcs7;
}
/**
* @return string
*/
public function getPkcs7()
{
return $this->pkcs7;
}
/**
* Metadata for instances of this key pair's private key.
*
* @param CsePrivateKeyMetadata[] $privateKeyMetadata
*/
public function setPrivateKeyMetadata($privateKeyMetadata)
{
$this->privateKeyMetadata = $privateKeyMetadata;
}
/**
* @return CsePrivateKeyMetadata[]
*/
public function getPrivateKeyMetadata()
{
return $this->privateKeyMetadata;
}
/**
* Output only. The email address identities that are specified on the leaf
* certificate.
*
* @param string[] $subjectEmailAddresses
*/
public function setSubjectEmailAddresses($subjectEmailAddresses)
{
$this->subjectEmailAddresses = $subjectEmailAddresses;
}
/**
* @return string[]
*/
public function getSubjectEmailAddresses()
{
return $this->subjectEmailAddresses;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(CseKeyPair::class, 'Google_Service_Gmail_CseKeyPair');

View File

@@ -0,0 +1,85 @@
<?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.
*/
namespace Google\Service\Gmail;
class CsePrivateKeyMetadata extends \Google\Model
{
protected $hardwareKeyMetadataType = HardwareKeyMetadata::class;
protected $hardwareKeyMetadataDataType = '';
protected $kaclsKeyMetadataType = KaclsKeyMetadata::class;
protected $kaclsKeyMetadataDataType = '';
/**
* Output only. The immutable ID for the private key metadata instance.
*
* @var string
*/
public $privateKeyMetadataId;
/**
* Metadata for hardware keys.
*
* @param HardwareKeyMetadata $hardwareKeyMetadata
*/
public function setHardwareKeyMetadata(HardwareKeyMetadata $hardwareKeyMetadata)
{
$this->hardwareKeyMetadata = $hardwareKeyMetadata;
}
/**
* @return HardwareKeyMetadata
*/
public function getHardwareKeyMetadata()
{
return $this->hardwareKeyMetadata;
}
/**
* Metadata for a private key instance managed by an external key access
* control list service.
*
* @param KaclsKeyMetadata $kaclsKeyMetadata
*/
public function setKaclsKeyMetadata(KaclsKeyMetadata $kaclsKeyMetadata)
{
$this->kaclsKeyMetadata = $kaclsKeyMetadata;
}
/**
* @return KaclsKeyMetadata
*/
public function getKaclsKeyMetadata()
{
return $this->kaclsKeyMetadata;
}
/**
* Output only. The immutable ID for the private key metadata instance.
*
* @param string $privateKeyMetadataId
*/
public function setPrivateKeyMetadataId($privateKeyMetadataId)
{
$this->privateKeyMetadataId = $privateKeyMetadataId;
}
/**
* @return string
*/
public function getPrivateKeyMetadataId()
{
return $this->privateKeyMetadataId;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(CsePrivateKeyMetadata::class, 'Google_Service_Gmail_CsePrivateKeyMetadata');

View File

@@ -0,0 +1,98 @@
<?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.
*/
namespace Google\Service\Gmail;
class Delegate extends \Google\Model
{
/**
* Unspecified verification status.
*/
public const VERIFICATION_STATUS_verificationStatusUnspecified = 'verificationStatusUnspecified';
/**
* The address can act a delegate for the account.
*/
public const VERIFICATION_STATUS_accepted = 'accepted';
/**
* A verification request was mailed to the address, and the owner has not yet
* accepted it.
*/
public const VERIFICATION_STATUS_pending = 'pending';
/**
* A verification request was mailed to the address, and the owner rejected
* it.
*/
public const VERIFICATION_STATUS_rejected = 'rejected';
/**
* A verification request was mailed to the address, and it expired without
* verification.
*/
public const VERIFICATION_STATUS_expired = 'expired';
/**
* The email address of the delegate.
*
* @var string
*/
public $delegateEmail;
/**
* Indicates whether this address has been verified and can act as a delegate
* for the account. Read-only.
*
* @var string
*/
public $verificationStatus;
/**
* The email address of the delegate.
*
* @param string $delegateEmail
*/
public function setDelegateEmail($delegateEmail)
{
$this->delegateEmail = $delegateEmail;
}
/**
* @return string
*/
public function getDelegateEmail()
{
return $this->delegateEmail;
}
/**
* Indicates whether this address has been verified and can act as a delegate
* for the account. Read-only.
*
* Accepted values: verificationStatusUnspecified, accepted, pending,
* rejected, expired
*
* @param self::VERIFICATION_STATUS_* $verificationStatus
*/
public function setVerificationStatus($verificationStatus)
{
$this->verificationStatus = $verificationStatus;
}
/**
* @return self::VERIFICATION_STATUS_*
*/
public function getVerificationStatus()
{
return $this->verificationStatus;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Delegate::class, 'Google_Service_Gmail_Delegate');

View File

@@ -0,0 +1,25 @@
<?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.
*/
namespace Google\Service\Gmail;
class DisableCseKeyPairRequest extends \Google\Model
{
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(DisableCseKeyPairRequest::class, 'Google_Service_Gmail_DisableCseKeyPairRequest');

View File

@@ -0,0 +1,66 @@
<?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.
*/
namespace Google\Service\Gmail;
class Draft extends \Google\Model
{
/**
* The immutable ID of the draft.
*
* @var string
*/
public $id;
protected $messageType = Message::class;
protected $messageDataType = '';
/**
* The immutable ID of the draft.
*
* @param string $id
*/
public function setId($id)
{
$this->id = $id;
}
/**
* @return string
*/
public function getId()
{
return $this->id;
}
/**
* The message content of the draft.
*
* @param Message $message
*/
public function setMessage(Message $message)
{
$this->message = $message;
}
/**
* @return Message
*/
public function getMessage()
{
return $this->message;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Draft::class, 'Google_Service_Gmail_Draft');

View File

@@ -0,0 +1,25 @@
<?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.
*/
namespace Google\Service\Gmail;
class EnableCseKeyPairRequest extends \Google\Model
{
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(EnableCseKeyPairRequest::class, 'Google_Service_Gmail_EnableCseKeyPairRequest');

View File

@@ -0,0 +1,84 @@
<?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.
*/
namespace Google\Service\Gmail;
class Filter extends \Google\Model
{
protected $actionType = FilterAction::class;
protected $actionDataType = '';
protected $criteriaType = FilterCriteria::class;
protected $criteriaDataType = '';
/**
* The server assigned ID of the filter.
*
* @var string
*/
public $id;
/**
* Action that the filter performs.
*
* @param FilterAction $action
*/
public function setAction(FilterAction $action)
{
$this->action = $action;
}
/**
* @return FilterAction
*/
public function getAction()
{
return $this->action;
}
/**
* Matching criteria for the filter.
*
* @param FilterCriteria $criteria
*/
public function setCriteria(FilterCriteria $criteria)
{
$this->criteria = $criteria;
}
/**
* @return FilterCriteria
*/
public function getCriteria()
{
return $this->criteria;
}
/**
* The server assigned ID of the filter.
*
* @param string $id
*/
public function setId($id)
{
$this->id = $id;
}
/**
* @return string
*/
public function getId()
{
return $this->id;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Filter::class, 'Google_Service_Gmail_Filter');

View File

@@ -0,0 +1,93 @@
<?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.
*/
namespace Google\Service\Gmail;
class FilterAction extends \Google\Collection
{
protected $collection_key = 'removeLabelIds';
/**
* List of labels to add to the message.
*
* @var string[]
*/
public $addLabelIds;
/**
* Email address that the message should be forwarded to.
*
* @var string
*/
public $forward;
/**
* List of labels to remove from the message.
*
* @var string[]
*/
public $removeLabelIds;
/**
* List of labels to add to the message.
*
* @param string[] $addLabelIds
*/
public function setAddLabelIds($addLabelIds)
{
$this->addLabelIds = $addLabelIds;
}
/**
* @return string[]
*/
public function getAddLabelIds()
{
return $this->addLabelIds;
}
/**
* Email address that the message should be forwarded to.
*
* @param string $forward
*/
public function setForward($forward)
{
$this->forward = $forward;
}
/**
* @return string
*/
public function getForward()
{
return $this->forward;
}
/**
* List of labels to remove from the message.
*
* @param string[] $removeLabelIds
*/
public function setRemoveLabelIds($removeLabelIds)
{
$this->removeLabelIds = $removeLabelIds;
}
/**
* @return string[]
*/
public function getRemoveLabelIds()
{
return $this->removeLabelIds;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(FilterAction::class, 'Google_Service_Gmail_FilterAction');

View File

@@ -0,0 +1,253 @@
<?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.
*/
namespace Google\Service\Gmail;
class FilterCriteria extends \Google\Model
{
public const SIZE_COMPARISON_unspecified = 'unspecified';
/**
* Find messages smaller than the given size.
*/
public const SIZE_COMPARISON_smaller = 'smaller';
/**
* Find messages larger than the given size.
*/
public const SIZE_COMPARISON_larger = 'larger';
/**
* Whether the response should exclude chats.
*
* @var bool
*/
public $excludeChats;
/**
* The sender's display name or email address.
*
* @var string
*/
public $from;
/**
* Whether the message has any attachment.
*
* @var bool
*/
public $hasAttachment;
/**
* Only return messages not matching the specified query. Supports the same
* query format as the Gmail search box. For example,
* `"from:someuser@example.com rfc822msgid: is:unread"`.
*
* @var string
*/
public $negatedQuery;
/**
* Only return messages matching the specified query. Supports the same query
* format as the Gmail search box. For example, `"from:someuser@example.com
* rfc822msgid: is:unread"`.
*
* @var string
*/
public $query;
/**
* The size of the entire RFC822 message in bytes, including all headers and
* attachments.
*
* @var int
*/
public $size;
/**
* How the message size in bytes should be in relation to the size field.
*
* @var string
*/
public $sizeComparison;
/**
* Case-insensitive phrase found in the message's subject. Trailing and
* leading whitespace are be trimmed and adjacent spaces are collapsed.
*
* @var string
*/
public $subject;
/**
* The recipient's display name or email address. Includes recipients in the
* "to", "cc", and "bcc" header fields. You can use simply the local part of
* the email address. For example, "example" and "example@" both match
* "example@gmail.com". This field is case-insensitive.
*
* @var string
*/
public $to;
/**
* Whether the response should exclude chats.
*
* @param bool $excludeChats
*/
public function setExcludeChats($excludeChats)
{
$this->excludeChats = $excludeChats;
}
/**
* @return bool
*/
public function getExcludeChats()
{
return $this->excludeChats;
}
/**
* The sender's display name or email address.
*
* @param string $from
*/
public function setFrom($from)
{
$this->from = $from;
}
/**
* @return string
*/
public function getFrom()
{
return $this->from;
}
/**
* Whether the message has any attachment.
*
* @param bool $hasAttachment
*/
public function setHasAttachment($hasAttachment)
{
$this->hasAttachment = $hasAttachment;
}
/**
* @return bool
*/
public function getHasAttachment()
{
return $this->hasAttachment;
}
/**
* Only return messages not matching the specified query. Supports the same
* query format as the Gmail search box. For example,
* `"from:someuser@example.com rfc822msgid: is:unread"`.
*
* @param string $negatedQuery
*/
public function setNegatedQuery($negatedQuery)
{
$this->negatedQuery = $negatedQuery;
}
/**
* @return string
*/
public function getNegatedQuery()
{
return $this->negatedQuery;
}
/**
* Only return messages matching the specified query. Supports the same query
* format as the Gmail search box. For example, `"from:someuser@example.com
* rfc822msgid: is:unread"`.
*
* @param string $query
*/
public function setQuery($query)
{
$this->query = $query;
}
/**
* @return string
*/
public function getQuery()
{
return $this->query;
}
/**
* The size of the entire RFC822 message in bytes, including all headers and
* attachments.
*
* @param int $size
*/
public function setSize($size)
{
$this->size = $size;
}
/**
* @return int
*/
public function getSize()
{
return $this->size;
}
/**
* How the message size in bytes should be in relation to the size field.
*
* Accepted values: unspecified, smaller, larger
*
* @param self::SIZE_COMPARISON_* $sizeComparison
*/
public function setSizeComparison($sizeComparison)
{
$this->sizeComparison = $sizeComparison;
}
/**
* @return self::SIZE_COMPARISON_*
*/
public function getSizeComparison()
{
return $this->sizeComparison;
}
/**
* Case-insensitive phrase found in the message's subject. Trailing and
* leading whitespace are be trimmed and adjacent spaces are collapsed.
*
* @param string $subject
*/
public function setSubject($subject)
{
$this->subject = $subject;
}
/**
* @return string
*/
public function getSubject()
{
return $this->subject;
}
/**
* The recipient's display name or email address. Includes recipients in the
* "to", "cc", and "bcc" header fields. You can use simply the local part of
* the email address. For example, "example" and "example@" both match
* "example@gmail.com". This field is case-insensitive.
*
* @param string $to
*/
public function setTo($to)
{
$this->to = $to;
}
/**
* @return string
*/
public function getTo()
{
return $this->to;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(FilterCriteria::class, 'Google_Service_Gmail_FilterCriteria');

View File

@@ -0,0 +1,86 @@
<?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.
*/
namespace Google\Service\Gmail;
class ForwardingAddress extends \Google\Model
{
/**
* Unspecified verification status.
*/
public const VERIFICATION_STATUS_verificationStatusUnspecified = 'verificationStatusUnspecified';
/**
* The address is ready to use for forwarding.
*/
public const VERIFICATION_STATUS_accepted = 'accepted';
/**
* The address is awaiting verification by the owner.
*/
public const VERIFICATION_STATUS_pending = 'pending';
/**
* An email address to which messages can be forwarded.
*
* @var string
*/
public $forwardingEmail;
/**
* Indicates whether this address has been verified and is usable for
* forwarding. Read-only.
*
* @var string
*/
public $verificationStatus;
/**
* An email address to which messages can be forwarded.
*
* @param string $forwardingEmail
*/
public function setForwardingEmail($forwardingEmail)
{
$this->forwardingEmail = $forwardingEmail;
}
/**
* @return string
*/
public function getForwardingEmail()
{
return $this->forwardingEmail;
}
/**
* Indicates whether this address has been verified and is usable for
* forwarding. Read-only.
*
* Accepted values: verificationStatusUnspecified, accepted, pending
*
* @param self::VERIFICATION_STATUS_* $verificationStatus
*/
public function setVerificationStatus($verificationStatus)
{
$this->verificationStatus = $verificationStatus;
}
/**
* @return self::VERIFICATION_STATUS_*
*/
public function getVerificationStatus()
{
return $this->verificationStatus;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ForwardingAddress::class, 'Google_Service_Gmail_ForwardingAddress');

View File

@@ -0,0 +1,48 @@
<?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.
*/
namespace Google\Service\Gmail;
class HardwareKeyMetadata extends \Google\Model
{
/**
* Description about the hardware key.
*
* @var string
*/
public $description;
/**
* Description about the hardware key.
*
* @param string $description
*/
public function setDescription($description)
{
$this->description = $description;
}
/**
* @return string
*/
public function getDescription()
{
return $this->description;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(HardwareKeyMetadata::class, 'Google_Service_Gmail_HardwareKeyMetadata');

View File

@@ -0,0 +1,141 @@
<?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.
*/
namespace Google\Service\Gmail;
class History extends \Google\Collection
{
protected $collection_key = 'messagesDeleted';
/**
* The mailbox sequence ID.
*
* @var string
*/
public $id;
protected $labelsAddedType = HistoryLabelAdded::class;
protected $labelsAddedDataType = 'array';
protected $labelsRemovedType = HistoryLabelRemoved::class;
protected $labelsRemovedDataType = 'array';
protected $messagesType = Message::class;
protected $messagesDataType = 'array';
protected $messagesAddedType = HistoryMessageAdded::class;
protected $messagesAddedDataType = 'array';
protected $messagesDeletedType = HistoryMessageDeleted::class;
protected $messagesDeletedDataType = 'array';
/**
* The mailbox sequence ID.
*
* @param string $id
*/
public function setId($id)
{
$this->id = $id;
}
/**
* @return string
*/
public function getId()
{
return $this->id;
}
/**
* Labels added to messages in this history record.
*
* @param HistoryLabelAdded[] $labelsAdded
*/
public function setLabelsAdded($labelsAdded)
{
$this->labelsAdded = $labelsAdded;
}
/**
* @return HistoryLabelAdded[]
*/
public function getLabelsAdded()
{
return $this->labelsAdded;
}
/**
* Labels removed from messages in this history record.
*
* @param HistoryLabelRemoved[] $labelsRemoved
*/
public function setLabelsRemoved($labelsRemoved)
{
$this->labelsRemoved = $labelsRemoved;
}
/**
* @return HistoryLabelRemoved[]
*/
public function getLabelsRemoved()
{
return $this->labelsRemoved;
}
/**
* List of messages changed in this history record. The fields for specific
* change types, such as `messagesAdded` may duplicate messages in this field.
* We recommend using the specific change-type fields instead of this.
*
* @param Message[] $messages
*/
public function setMessages($messages)
{
$this->messages = $messages;
}
/**
* @return Message[]
*/
public function getMessages()
{
return $this->messages;
}
/**
* Messages added to the mailbox in this history record.
*
* @param HistoryMessageAdded[] $messagesAdded
*/
public function setMessagesAdded($messagesAdded)
{
$this->messagesAdded = $messagesAdded;
}
/**
* @return HistoryMessageAdded[]
*/
public function getMessagesAdded()
{
return $this->messagesAdded;
}
/**
* Messages deleted (not Trashed) from the mailbox in this history record.
*
* @param HistoryMessageDeleted[] $messagesDeleted
*/
public function setMessagesDeleted($messagesDeleted)
{
$this->messagesDeleted = $messagesDeleted;
}
/**
* @return HistoryMessageDeleted[]
*/
public function getMessagesDeleted()
{
return $this->messagesDeleted;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(History::class, 'Google_Service_Gmail_History');

View File

@@ -0,0 +1,65 @@
<?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.
*/
namespace Google\Service\Gmail;
class HistoryLabelAdded extends \Google\Collection
{
protected $collection_key = 'labelIds';
/**
* Label IDs added to the message.
*
* @var string[]
*/
public $labelIds;
protected $messageType = Message::class;
protected $messageDataType = '';
/**
* Label IDs added to the message.
*
* @param string[] $labelIds
*/
public function setLabelIds($labelIds)
{
$this->labelIds = $labelIds;
}
/**
* @return string[]
*/
public function getLabelIds()
{
return $this->labelIds;
}
/**
* @param Message $message
*/
public function setMessage(Message $message)
{
$this->message = $message;
}
/**
* @return Message
*/
public function getMessage()
{
return $this->message;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(HistoryLabelAdded::class, 'Google_Service_Gmail_HistoryLabelAdded');

View File

@@ -0,0 +1,65 @@
<?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.
*/
namespace Google\Service\Gmail;
class HistoryLabelRemoved extends \Google\Collection
{
protected $collection_key = 'labelIds';
/**
* Label IDs removed from the message.
*
* @var string[]
*/
public $labelIds;
protected $messageType = Message::class;
protected $messageDataType = '';
/**
* Label IDs removed from the message.
*
* @param string[] $labelIds
*/
public function setLabelIds($labelIds)
{
$this->labelIds = $labelIds;
}
/**
* @return string[]
*/
public function getLabelIds()
{
return $this->labelIds;
}
/**
* @param Message $message
*/
public function setMessage(Message $message)
{
$this->message = $message;
}
/**
* @return Message
*/
public function getMessage()
{
return $this->message;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(HistoryLabelRemoved::class, 'Google_Service_Gmail_HistoryLabelRemoved');

View File

@@ -0,0 +1,42 @@
<?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.
*/
namespace Google\Service\Gmail;
class HistoryMessageAdded extends \Google\Model
{
protected $messageType = Message::class;
protected $messageDataType = '';
/**
* @param Message $message
*/
public function setMessage(Message $message)
{
$this->message = $message;
}
/**
* @return Message
*/
public function getMessage()
{
return $this->message;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(HistoryMessageAdded::class, 'Google_Service_Gmail_HistoryMessageAdded');

View File

@@ -0,0 +1,42 @@
<?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.
*/
namespace Google\Service\Gmail;
class HistoryMessageDeleted extends \Google\Model
{
protected $messageType = Message::class;
protected $messageDataType = '';
/**
* @param Message $message
*/
public function setMessage(Message $message)
{
$this->message = $message;
}
/**
* @return Message
*/
public function getMessage()
{
return $this->message;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(HistoryMessageDeleted::class, 'Google_Service_Gmail_HistoryMessageDeleted');

View File

@@ -0,0 +1,143 @@
<?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.
*/
namespace Google\Service\Gmail;
class ImapSettings extends \Google\Model
{
/**
* Unspecified behavior.
*/
public const EXPUNGE_BEHAVIOR_expungeBehaviorUnspecified = 'expungeBehaviorUnspecified';
/**
* Archive messages marked as deleted.
*/
public const EXPUNGE_BEHAVIOR_archive = 'archive';
/**
* Move messages marked as deleted to the trash.
*/
public const EXPUNGE_BEHAVIOR_trash = 'trash';
/**
* Immediately and permanently delete messages marked as deleted. The expunged
* messages cannot be recovered.
*/
public const EXPUNGE_BEHAVIOR_deleteForever = 'deleteForever';
/**
* If this value is true, Gmail will immediately expunge a message when it is
* marked as deleted in IMAP. Otherwise, Gmail will wait for an update from
* the client before expunging messages marked as deleted.
*
* @var bool
*/
public $autoExpunge;
/**
* Whether IMAP is enabled for the account.
*
* @var bool
*/
public $enabled;
/**
* The action that will be executed on a message when it is marked as deleted
* and expunged from the last visible IMAP folder.
*
* @var string
*/
public $expungeBehavior;
/**
* An optional limit on the number of messages that an IMAP folder may
* contain. Legal values are 0, 1000, 2000, 5000 or 10000. A value of zero is
* interpreted to mean that there is no limit.
*
* @var int
*/
public $maxFolderSize;
/**
* If this value is true, Gmail will immediately expunge a message when it is
* marked as deleted in IMAP. Otherwise, Gmail will wait for an update from
* the client before expunging messages marked as deleted.
*
* @param bool $autoExpunge
*/
public function setAutoExpunge($autoExpunge)
{
$this->autoExpunge = $autoExpunge;
}
/**
* @return bool
*/
public function getAutoExpunge()
{
return $this->autoExpunge;
}
/**
* Whether IMAP is enabled for the account.
*
* @param bool $enabled
*/
public function setEnabled($enabled)
{
$this->enabled = $enabled;
}
/**
* @return bool
*/
public function getEnabled()
{
return $this->enabled;
}
/**
* The action that will be executed on a message when it is marked as deleted
* and expunged from the last visible IMAP folder.
*
* Accepted values: expungeBehaviorUnspecified, archive, trash, deleteForever
*
* @param self::EXPUNGE_BEHAVIOR_* $expungeBehavior
*/
public function setExpungeBehavior($expungeBehavior)
{
$this->expungeBehavior = $expungeBehavior;
}
/**
* @return self::EXPUNGE_BEHAVIOR_*
*/
public function getExpungeBehavior()
{
return $this->expungeBehavior;
}
/**
* An optional limit on the number of messages that an IMAP folder may
* contain. Legal values are 0, 1000, 2000, 5000 or 10000. A value of zero is
* interpreted to mean that there is no limit.
*
* @param int $maxFolderSize
*/
public function setMaxFolderSize($maxFolderSize)
{
$this->maxFolderSize = $maxFolderSize;
}
/**
* @return int
*/
public function getMaxFolderSize()
{
return $this->maxFolderSize;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ImapSettings::class, 'Google_Service_Gmail_ImapSettings');

View File

@@ -0,0 +1,74 @@
<?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.
*/
namespace Google\Service\Gmail;
class KaclsKeyMetadata extends \Google\Model
{
/**
* Opaque data generated and used by the key access control list service.
* Maximum size: 8 KiB.
*
* @var string
*/
public $kaclsData;
/**
* The URI of the key access control list service that manages the private
* key.
*
* @var string
*/
public $kaclsUri;
/**
* Opaque data generated and used by the key access control list service.
* Maximum size: 8 KiB.
*
* @param string $kaclsData
*/
public function setKaclsData($kaclsData)
{
$this->kaclsData = $kaclsData;
}
/**
* @return string
*/
public function getKaclsData()
{
return $this->kaclsData;
}
/**
* The URI of the key access control list service that manages the private
* key.
*
* @param string $kaclsUri
*/
public function setKaclsUri($kaclsUri)
{
$this->kaclsUri = $kaclsUri;
}
/**
* @return string
*/
public function getKaclsUri()
{
return $this->kaclsUri;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(KaclsKeyMetadata::class, 'Google_Service_Gmail_KaclsKeyMetadata');

View File

@@ -0,0 +1,293 @@
<?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.
*/
namespace Google\Service\Gmail;
class Label extends \Google\Model
{
/**
* Show the label in the label list.
*/
public const LABEL_LIST_VISIBILITY_labelShow = 'labelShow';
/**
* Show the label if there are any unread messages with that label.
*/
public const LABEL_LIST_VISIBILITY_labelShowIfUnread = 'labelShowIfUnread';
/**
* Do not show the label in the label list.
*/
public const LABEL_LIST_VISIBILITY_labelHide = 'labelHide';
/**
* Show the label in the message list.
*/
public const MESSAGE_LIST_VISIBILITY_show = 'show';
/**
* Do not show the label in the message list.
*/
public const MESSAGE_LIST_VISIBILITY_hide = 'hide';
/**
* Labels created by Gmail.
*/
public const TYPE_system = 'system';
/**
* Custom labels created by the user or application.
*/
public const TYPE_user = 'user';
protected $colorType = LabelColor::class;
protected $colorDataType = '';
/**
* The immutable ID of the label.
*
* @var string
*/
public $id;
/**
* The visibility of the label in the label list in the Gmail web interface.
*
* @var string
*/
public $labelListVisibility;
/**
* The visibility of messages with this label in the message list in the Gmail
* web interface.
*
* @var string
*/
public $messageListVisibility;
/**
* The total number of messages with the label.
*
* @var int
*/
public $messagesTotal;
/**
* The number of unread messages with the label.
*
* @var int
*/
public $messagesUnread;
/**
* The display name of the label.
*
* @var string
*/
public $name;
/**
* The total number of threads with the label.
*
* @var int
*/
public $threadsTotal;
/**
* The number of unread threads with the label.
*
* @var int
*/
public $threadsUnread;
/**
* The owner type for the label. User labels are created by the user and can
* be modified and deleted by the user and can be applied to any message or
* thread. System labels are internally created and cannot be added, modified,
* or deleted. System labels may be able to be applied to or removed from
* messages and threads under some circumstances but this is not guaranteed.
* For example, users can apply and remove the `INBOX` and `UNREAD` labels
* from messages and threads, but cannot apply or remove the `DRAFTS` or
* `SENT` labels from messages or threads.
*
* @var string
*/
public $type;
/**
* The color to assign to the label. Color is only available for labels that
* have their `type` set to `user`.
*
* @param LabelColor $color
*/
public function setColor(LabelColor $color)
{
$this->color = $color;
}
/**
* @return LabelColor
*/
public function getColor()
{
return $this->color;
}
/**
* The immutable ID of the label.
*
* @param string $id
*/
public function setId($id)
{
$this->id = $id;
}
/**
* @return string
*/
public function getId()
{
return $this->id;
}
/**
* The visibility of the label in the label list in the Gmail web interface.
*
* Accepted values: labelShow, labelShowIfUnread, labelHide
*
* @param self::LABEL_LIST_VISIBILITY_* $labelListVisibility
*/
public function setLabelListVisibility($labelListVisibility)
{
$this->labelListVisibility = $labelListVisibility;
}
/**
* @return self::LABEL_LIST_VISIBILITY_*
*/
public function getLabelListVisibility()
{
return $this->labelListVisibility;
}
/**
* The visibility of messages with this label in the message list in the Gmail
* web interface.
*
* Accepted values: show, hide
*
* @param self::MESSAGE_LIST_VISIBILITY_* $messageListVisibility
*/
public function setMessageListVisibility($messageListVisibility)
{
$this->messageListVisibility = $messageListVisibility;
}
/**
* @return self::MESSAGE_LIST_VISIBILITY_*
*/
public function getMessageListVisibility()
{
return $this->messageListVisibility;
}
/**
* The total number of messages with the label.
*
* @param int $messagesTotal
*/
public function setMessagesTotal($messagesTotal)
{
$this->messagesTotal = $messagesTotal;
}
/**
* @return int
*/
public function getMessagesTotal()
{
return $this->messagesTotal;
}
/**
* The number of unread messages with the label.
*
* @param int $messagesUnread
*/
public function setMessagesUnread($messagesUnread)
{
$this->messagesUnread = $messagesUnread;
}
/**
* @return int
*/
public function getMessagesUnread()
{
return $this->messagesUnread;
}
/**
* The display name of the label.
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* The total number of threads with the label.
*
* @param int $threadsTotal
*/
public function setThreadsTotal($threadsTotal)
{
$this->threadsTotal = $threadsTotal;
}
/**
* @return int
*/
public function getThreadsTotal()
{
return $this->threadsTotal;
}
/**
* The number of unread threads with the label.
*
* @param int $threadsUnread
*/
public function setThreadsUnread($threadsUnread)
{
$this->threadsUnread = $threadsUnread;
}
/**
* @return int
*/
public function getThreadsUnread()
{
return $this->threadsUnread;
}
/**
* The owner type for the label. User labels are created by the user and can
* be modified and deleted by the user and can be applied to any message or
* thread. System labels are internally created and cannot be added, modified,
* or deleted. System labels may be able to be applied to or removed from
* messages and threads under some circumstances but this is not guaranteed.
* For example, users can apply and remove the `INBOX` and `UNREAD` labels
* from messages and threads, but cannot apply or remove the `DRAFTS` or
* `SENT` labels from messages or threads.
*
* Accepted values: system, user
*
* @param self::TYPE_* $type
*/
public function setType($type)
{
$this->type = $type;
}
/**
* @return self::TYPE_*
*/
public function getType()
{
return $this->type;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Label::class, 'Google_Service_Gmail_Label');

View File

@@ -0,0 +1,130 @@
<?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.
*/
namespace Google\Service\Gmail;
class LabelColor extends \Google\Model
{
/**
* The background color represented as hex string #RRGGBB (ex #000000). This
* field is required in order to set the color of a label. Only the following
* predefined set of color values are allowed: \#000000, #434343, #666666,
* #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165,
* #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1,
* #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3,
* #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83,
* #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960,
* #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49,
* #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831,
* #076239, #1a764d, #1c4587, #41236d, #83334c \#464646, #e7e7e7, #0d3472,
* #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a,
* #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07,
* #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb,
* #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac,
* #094228, #42d692, #16a765
*
* @var string
*/
public $backgroundColor;
/**
* The text color of the label, represented as hex string. This field is
* required in order to set the color of a label. Only the following
* predefined set of color values are allowed: \#000000, #434343, #666666,
* #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165,
* #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1,
* #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3,
* #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83,
* #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960,
* #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49,
* #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831,
* #076239, #1a764d, #1c4587, #41236d, #83334c \#464646, #e7e7e7, #0d3472,
* #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a,
* #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07,
* #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb,
* #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac,
* #094228, #42d692, #16a765
*
* @var string
*/
public $textColor;
/**
* The background color represented as hex string #RRGGBB (ex #000000). This
* field is required in order to set the color of a label. Only the following
* predefined set of color values are allowed: \#000000, #434343, #666666,
* #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165,
* #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1,
* #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3,
* #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83,
* #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960,
* #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49,
* #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831,
* #076239, #1a764d, #1c4587, #41236d, #83334c \#464646, #e7e7e7, #0d3472,
* #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a,
* #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07,
* #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb,
* #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac,
* #094228, #42d692, #16a765
*
* @param string $backgroundColor
*/
public function setBackgroundColor($backgroundColor)
{
$this->backgroundColor = $backgroundColor;
}
/**
* @return string
*/
public function getBackgroundColor()
{
return $this->backgroundColor;
}
/**
* The text color of the label, represented as hex string. This field is
* required in order to set the color of a label. Only the following
* predefined set of color values are allowed: \#000000, #434343, #666666,
* #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165,
* #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1,
* #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3,
* #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83,
* #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960,
* #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49,
* #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831,
* #076239, #1a764d, #1c4587, #41236d, #83334c \#464646, #e7e7e7, #0d3472,
* #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a,
* #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07,
* #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb,
* #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac,
* #094228, #42d692, #16a765
*
* @param string $textColor
*/
public function setTextColor($textColor)
{
$this->textColor = $textColor;
}
/**
* @return string
*/
public function getTextColor()
{
return $this->textColor;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(LabelColor::class, 'Google_Service_Gmail_LabelColor');

View File

@@ -0,0 +1,68 @@
<?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.
*/
namespace Google\Service\Gmail;
class LanguageSettings extends \Google\Model
{
/**
* The language to display Gmail in, formatted as an RFC 3066 Language Tag
* (for example `en-GB`, `fr` or `ja` for British English, French, or Japanese
* respectively). The set of languages supported by Gmail evolves over time,
* so please refer to the "Language" dropdown in the Gmail settings for all
* available options, as described in the language settings help article. For
* a table of sample values, see [Manage language settings](https://developers
* .google.com/workspace/gmail/api/guides/language-settings). Not all Gmail
* clients can display the same set of languages. In the case that a user's
* display language is not available for use on a particular client, said
* client automatically chooses to display in the closest supported variant
* (or a reasonable default).
*
* @var string
*/
public $displayLanguage;
/**
* The language to display Gmail in, formatted as an RFC 3066 Language Tag
* (for example `en-GB`, `fr` or `ja` for British English, French, or Japanese
* respectively). The set of languages supported by Gmail evolves over time,
* so please refer to the "Language" dropdown in the Gmail settings for all
* available options, as described in the language settings help article. For
* a table of sample values, see [Manage language settings](https://developers
* .google.com/workspace/gmail/api/guides/language-settings). Not all Gmail
* clients can display the same set of languages. In the case that a user's
* display language is not available for use on a particular client, said
* client automatically chooses to display in the closest supported variant
* (or a reasonable default).
*
* @param string $displayLanguage
*/
public function setDisplayLanguage($displayLanguage)
{
$this->displayLanguage = $displayLanguage;
}
/**
* @return string
*/
public function getDisplayLanguage()
{
return $this->displayLanguage;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(LanguageSettings::class, 'Google_Service_Gmail_LanguageSettings');

View File

@@ -0,0 +1,71 @@
<?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.
*/
namespace Google\Service\Gmail;
class ListCseIdentitiesResponse extends \Google\Collection
{
protected $collection_key = 'cseIdentities';
protected $cseIdentitiesType = CseIdentity::class;
protected $cseIdentitiesDataType = 'array';
/**
* Pagination token to be passed to a subsequent ListCseIdentities call in
* order to retrieve the next page of identities. If this value is not
* returned or is the empty string, then no further pages remain.
*
* @var string
*/
public $nextPageToken;
/**
* One page of the list of CSE identities configured for the user.
*
* @param CseIdentity[] $cseIdentities
*/
public function setCseIdentities($cseIdentities)
{
$this->cseIdentities = $cseIdentities;
}
/**
* @return CseIdentity[]
*/
public function getCseIdentities()
{
return $this->cseIdentities;
}
/**
* Pagination token to be passed to a subsequent ListCseIdentities call in
* order to retrieve the next page of identities. If this value is not
* returned or is the empty string, then no further pages remain.
*
* @param string $nextPageToken
*/
public function setNextPageToken($nextPageToken)
{
$this->nextPageToken = $nextPageToken;
}
/**
* @return string
*/
public function getNextPageToken()
{
return $this->nextPageToken;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ListCseIdentitiesResponse::class, 'Google_Service_Gmail_ListCseIdentitiesResponse');

View File

@@ -0,0 +1,71 @@
<?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.
*/
namespace Google\Service\Gmail;
class ListCseKeyPairsResponse extends \Google\Collection
{
protected $collection_key = 'cseKeyPairs';
protected $cseKeyPairsType = CseKeyPair::class;
protected $cseKeyPairsDataType = 'array';
/**
* Pagination token to be passed to a subsequent ListCseKeyPairs call in order
* to retrieve the next page of key pairs. If this value is not returned, then
* no further pages remain.
*
* @var string
*/
public $nextPageToken;
/**
* One page of the list of CSE key pairs installed for the user.
*
* @param CseKeyPair[] $cseKeyPairs
*/
public function setCseKeyPairs($cseKeyPairs)
{
$this->cseKeyPairs = $cseKeyPairs;
}
/**
* @return CseKeyPair[]
*/
public function getCseKeyPairs()
{
return $this->cseKeyPairs;
}
/**
* Pagination token to be passed to a subsequent ListCseKeyPairs call in order
* to retrieve the next page of key pairs. If this value is not returned, then
* no further pages remain.
*
* @param string $nextPageToken
*/
public function setNextPageToken($nextPageToken)
{
$this->nextPageToken = $nextPageToken;
}
/**
* @return string
*/
public function getNextPageToken()
{
return $this->nextPageToken;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ListCseKeyPairsResponse::class, 'Google_Service_Gmail_ListCseKeyPairsResponse');

View File

@@ -0,0 +1,46 @@
<?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.
*/
namespace Google\Service\Gmail;
class ListDelegatesResponse extends \Google\Collection
{
protected $collection_key = 'delegates';
protected $delegatesType = Delegate::class;
protected $delegatesDataType = 'array';
/**
* List of the user's delegates (with any verification status). If an account
* doesn't have delegates, this field doesn't appear.
*
* @param Delegate[] $delegates
*/
public function setDelegates($delegates)
{
$this->delegates = $delegates;
}
/**
* @return Delegate[]
*/
public function getDelegates()
{
return $this->delegates;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ListDelegatesResponse::class, 'Google_Service_Gmail_ListDelegatesResponse');

View File

@@ -0,0 +1,92 @@
<?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.
*/
namespace Google\Service\Gmail;
class ListDraftsResponse extends \Google\Collection
{
protected $collection_key = 'drafts';
protected $draftsType = Draft::class;
protected $draftsDataType = 'array';
/**
* Token to retrieve the next page of results in the list.
*
* @var string
*/
public $nextPageToken;
/**
* Estimated total number of results.
*
* @var string
*/
public $resultSizeEstimate;
/**
* List of drafts. Note that the `Message` property in each `Draft` resource
* only contains an `id` and a `threadId`. The [`messages.get`](https://develo
* pers.google.com/workspace/gmail/api/v1/reference/users/messages/get) method
* can fetch additional message details.
*
* @param Draft[] $drafts
*/
public function setDrafts($drafts)
{
$this->drafts = $drafts;
}
/**
* @return Draft[]
*/
public function getDrafts()
{
return $this->drafts;
}
/**
* Token to retrieve the next page of results in the list.
*
* @param string $nextPageToken
*/
public function setNextPageToken($nextPageToken)
{
$this->nextPageToken = $nextPageToken;
}
/**
* @return string
*/
public function getNextPageToken()
{
return $this->nextPageToken;
}
/**
* Estimated total number of results.
*
* @param string $resultSizeEstimate
*/
public function setResultSizeEstimate($resultSizeEstimate)
{
$this->resultSizeEstimate = $resultSizeEstimate;
}
/**
* @return string
*/
public function getResultSizeEstimate()
{
return $this->resultSizeEstimate;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ListDraftsResponse::class, 'Google_Service_Gmail_ListDraftsResponse');

View File

@@ -0,0 +1,45 @@
<?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.
*/
namespace Google\Service\Gmail;
class ListFiltersResponse extends \Google\Collection
{
protected $collection_key = 'filter';
protected $filterType = Filter::class;
protected $filterDataType = 'array';
/**
* List of a user's filters.
*
* @param Filter[] $filter
*/
public function setFilter($filter)
{
$this->filter = $filter;
}
/**
* @return Filter[]
*/
public function getFilter()
{
return $this->filter;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ListFiltersResponse::class, 'Google_Service_Gmail_ListFiltersResponse');

View File

@@ -0,0 +1,45 @@
<?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.
*/
namespace Google\Service\Gmail;
class ListForwardingAddressesResponse extends \Google\Collection
{
protected $collection_key = 'forwardingAddresses';
protected $forwardingAddressesType = ForwardingAddress::class;
protected $forwardingAddressesDataType = 'array';
/**
* List of addresses that may be used for forwarding.
*
* @param ForwardingAddress[] $forwardingAddresses
*/
public function setForwardingAddresses($forwardingAddresses)
{
$this->forwardingAddresses = $forwardingAddresses;
}
/**
* @return ForwardingAddress[]
*/
public function getForwardingAddresses()
{
return $this->forwardingAddresses;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ListForwardingAddressesResponse::class, 'Google_Service_Gmail_ListForwardingAddressesResponse');

View File

@@ -0,0 +1,90 @@
<?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.
*/
namespace Google\Service\Gmail;
class ListHistoryResponse extends \Google\Collection
{
protected $collection_key = 'history';
protected $historyType = History::class;
protected $historyDataType = 'array';
/**
* The ID of the mailbox's current history record.
*
* @var string
*/
public $historyId;
/**
* Page token to retrieve the next page of results in the list.
*
* @var string
*/
public $nextPageToken;
/**
* List of history records. Any `messages` contained in the response will
* typically only have `id` and `threadId` fields populated.
*
* @param History[] $history
*/
public function setHistory($history)
{
$this->history = $history;
}
/**
* @return History[]
*/
public function getHistory()
{
return $this->history;
}
/**
* The ID of the mailbox's current history record.
*
* @param string $historyId
*/
public function setHistoryId($historyId)
{
$this->historyId = $historyId;
}
/**
* @return string
*/
public function getHistoryId()
{
return $this->historyId;
}
/**
* Page token to retrieve the next page of results in the list.
*
* @param string $nextPageToken
*/
public function setNextPageToken($nextPageToken)
{
$this->nextPageToken = $nextPageToken;
}
/**
* @return string
*/
public function getNextPageToken()
{
return $this->nextPageToken;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ListHistoryResponse::class, 'Google_Service_Gmail_ListHistoryResponse');

View File

@@ -0,0 +1,48 @@
<?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.
*/
namespace Google\Service\Gmail;
class ListLabelsResponse extends \Google\Collection
{
protected $collection_key = 'labels';
protected $labelsType = Label::class;
protected $labelsDataType = 'array';
/**
* List of labels. Note that each label resource only contains an `id`,
* `name`, `messageListVisibility`, `labelListVisibility`, and `type`. The [`l
* abels.get`](https://developers.google.com/workspace/gmail/api/v1/reference/
* users/labels/get) method can fetch additional label details.
*
* @param Label[] $labels
*/
public function setLabels($labels)
{
$this->labels = $labels;
}
/**
* @return Label[]
*/
public function getLabels()
{
return $this->labels;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ListLabelsResponse::class, 'Google_Service_Gmail_ListLabelsResponse');

View File

@@ -0,0 +1,91 @@
<?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.
*/
namespace Google\Service\Gmail;
class ListMessagesResponse extends \Google\Collection
{
protected $collection_key = 'messages';
protected $messagesType = Message::class;
protected $messagesDataType = 'array';
/**
* Token to retrieve the next page of results in the list.
*
* @var string
*/
public $nextPageToken;
/**
* Estimated total number of results.
*
* @var string
*/
public $resultSizeEstimate;
/**
* List of messages. Note that each message resource contains only an `id` and
* a `threadId`. Additional message details can be fetched using the
* messages.get method.
*
* @param Message[] $messages
*/
public function setMessages($messages)
{
$this->messages = $messages;
}
/**
* @return Message[]
*/
public function getMessages()
{
return $this->messages;
}
/**
* Token to retrieve the next page of results in the list.
*
* @param string $nextPageToken
*/
public function setNextPageToken($nextPageToken)
{
$this->nextPageToken = $nextPageToken;
}
/**
* @return string
*/
public function getNextPageToken()
{
return $this->nextPageToken;
}
/**
* Estimated total number of results.
*
* @param string $resultSizeEstimate
*/
public function setResultSizeEstimate($resultSizeEstimate)
{
$this->resultSizeEstimate = $resultSizeEstimate;
}
/**
* @return string
*/
public function getResultSizeEstimate()
{
return $this->resultSizeEstimate;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ListMessagesResponse::class, 'Google_Service_Gmail_ListMessagesResponse');

View File

@@ -0,0 +1,45 @@
<?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.
*/
namespace Google\Service\Gmail;
class ListSendAsResponse extends \Google\Collection
{
protected $collection_key = 'sendAs';
protected $sendAsType = SendAs::class;
protected $sendAsDataType = 'array';
/**
* List of send-as aliases.
*
* @param SendAs[] $sendAs
*/
public function setSendAs($sendAs)
{
$this->sendAs = $sendAs;
}
/**
* @return SendAs[]
*/
public function getSendAs()
{
return $this->sendAs;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ListSendAsResponse::class, 'Google_Service_Gmail_ListSendAsResponse');

View File

@@ -0,0 +1,45 @@
<?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.
*/
namespace Google\Service\Gmail;
class ListSmimeInfoResponse extends \Google\Collection
{
protected $collection_key = 'smimeInfo';
protected $smimeInfoType = SmimeInfo::class;
protected $smimeInfoDataType = 'array';
/**
* List of SmimeInfo.
*
* @param SmimeInfo[] $smimeInfo
*/
public function setSmimeInfo($smimeInfo)
{
$this->smimeInfo = $smimeInfo;
}
/**
* @return SmimeInfo[]
*/
public function getSmimeInfo()
{
return $this->smimeInfo;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ListSmimeInfoResponse::class, 'Google_Service_Gmail_ListSmimeInfoResponse');

View File

@@ -0,0 +1,92 @@
<?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.
*/
namespace Google\Service\Gmail;
class ListThreadsResponse extends \Google\Collection
{
protected $collection_key = 'threads';
/**
* Page token to retrieve the next page of results in the list.
*
* @var string
*/
public $nextPageToken;
/**
* Estimated total number of results.
*
* @var string
*/
public $resultSizeEstimate;
protected $threadsType = Thread::class;
protected $threadsDataType = 'array';
/**
* Page token to retrieve the next page of results in the list.
*
* @param string $nextPageToken
*/
public function setNextPageToken($nextPageToken)
{
$this->nextPageToken = $nextPageToken;
}
/**
* @return string
*/
public function getNextPageToken()
{
return $this->nextPageToken;
}
/**
* Estimated total number of results.
*
* @param string $resultSizeEstimate
*/
public function setResultSizeEstimate($resultSizeEstimate)
{
$this->resultSizeEstimate = $resultSizeEstimate;
}
/**
* @return string
*/
public function getResultSizeEstimate()
{
return $this->resultSizeEstimate;
}
/**
* List of threads. Note that each thread resource does not contain a list of
* `messages`. The list of `messages` for a given thread can be fetched using
* the [`threads.get`](https://developers.google.com/workspace/gmail/api/v1/re
* ference/users/threads/get) method.
*
* @param Thread[] $threads
*/
public function setThreads($threads)
{
$this->threads = $threads;
}
/**
* @return Thread[]
*/
public function getThreads()
{
return $this->threads;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ListThreadsResponse::class, 'Google_Service_Gmail_ListThreadsResponse');

View File

@@ -0,0 +1,265 @@
<?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.
*/
namespace Google\Service\Gmail;
class Message extends \Google\Collection
{
protected $collection_key = 'labelIds';
protected $classificationLabelValuesType = ClassificationLabelValue::class;
protected $classificationLabelValuesDataType = 'array';
/**
* The ID of the last history record that modified this message.
*
* @var string
*/
public $historyId;
/**
* The immutable ID of the message.
*
* @var string
*/
public $id;
/**
* The internal message creation timestamp (epoch ms), which determines
* ordering in the inbox. For normal SMTP-received email, this represents the
* time the message was originally accepted by Google, which is more reliable
* than the `Date` header. However, for API-migrated mail, it can be
* configured by client to be based on the `Date` header.
*
* @var string
*/
public $internalDate;
/**
* List of IDs of labels applied to this message.
*
* @var string[]
*/
public $labelIds;
protected $payloadType = MessagePart::class;
protected $payloadDataType = '';
/**
* The entire email message in an RFC 2822 formatted and base64url encoded
* string. Returned in `messages.get` and `drafts.get` responses when the
* `format=RAW` parameter is supplied.
*
* @var string
*/
public $raw;
/**
* Estimated size in bytes of the message.
*
* @var int
*/
public $sizeEstimate;
/**
* A short part of the message text.
*
* @var string
*/
public $snippet;
/**
* The ID of the thread the message belongs to. To add a message or draft to a
* thread, the following criteria must be met: 1. The requested `threadId`
* must be specified on the `Message` or `Draft.Message` you supply with your
* request. 2. The `References` and `In-Reply-To` headers must be set in
* compliance with the [RFC 2822](https://tools.ietf.org/html/rfc2822)
* standard. 3. The `Subject` headers must match.
*
* @var string
*/
public $threadId;
/**
* Classification Label values on the message. Available Classification Label
* schemas can be queried using the Google Drive Labels API. Each
* classification label ID must be unique. If duplicate IDs are provided, only
* one will be retained, and the selection is arbitrary. Only used for Google
* Workspace accounts.
*
* @param ClassificationLabelValue[] $classificationLabelValues
*/
public function setClassificationLabelValues($classificationLabelValues)
{
$this->classificationLabelValues = $classificationLabelValues;
}
/**
* @return ClassificationLabelValue[]
*/
public function getClassificationLabelValues()
{
return $this->classificationLabelValues;
}
/**
* The ID of the last history record that modified this message.
*
* @param string $historyId
*/
public function setHistoryId($historyId)
{
$this->historyId = $historyId;
}
/**
* @return string
*/
public function getHistoryId()
{
return $this->historyId;
}
/**
* The immutable ID of the message.
*
* @param string $id
*/
public function setId($id)
{
$this->id = $id;
}
/**
* @return string
*/
public function getId()
{
return $this->id;
}
/**
* The internal message creation timestamp (epoch ms), which determines
* ordering in the inbox. For normal SMTP-received email, this represents the
* time the message was originally accepted by Google, which is more reliable
* than the `Date` header. However, for API-migrated mail, it can be
* configured by client to be based on the `Date` header.
*
* @param string $internalDate
*/
public function setInternalDate($internalDate)
{
$this->internalDate = $internalDate;
}
/**
* @return string
*/
public function getInternalDate()
{
return $this->internalDate;
}
/**
* List of IDs of labels applied to this message.
*
* @param string[] $labelIds
*/
public function setLabelIds($labelIds)
{
$this->labelIds = $labelIds;
}
/**
* @return string[]
*/
public function getLabelIds()
{
return $this->labelIds;
}
/**
* The parsed email structure in the message parts.
*
* @param MessagePart $payload
*/
public function setPayload(MessagePart $payload)
{
$this->payload = $payload;
}
/**
* @return MessagePart
*/
public function getPayload()
{
return $this->payload;
}
/**
* The entire email message in an RFC 2822 formatted and base64url encoded
* string. Returned in `messages.get` and `drafts.get` responses when the
* `format=RAW` parameter is supplied.
*
* @param string $raw
*/
public function setRaw($raw)
{
$this->raw = $raw;
}
/**
* @return string
*/
public function getRaw()
{
return $this->raw;
}
/**
* Estimated size in bytes of the message.
*
* @param int $sizeEstimate
*/
public function setSizeEstimate($sizeEstimate)
{
$this->sizeEstimate = $sizeEstimate;
}
/**
* @return int
*/
public function getSizeEstimate()
{
return $this->sizeEstimate;
}
/**
* A short part of the message text.
*
* @param string $snippet
*/
public function setSnippet($snippet)
{
$this->snippet = $snippet;
}
/**
* @return string
*/
public function getSnippet()
{
return $this->snippet;
}
/**
* The ID of the thread the message belongs to. To add a message or draft to a
* thread, the following criteria must be met: 1. The requested `threadId`
* must be specified on the `Message` or `Draft.Message` you supply with your
* request. 2. The `References` and `In-Reply-To` headers must be set in
* compliance with the [RFC 2822](https://tools.ietf.org/html/rfc2822)
* standard. 3. The `Subject` headers must match.
*
* @param string $threadId
*/
public function setThreadId($threadId)
{
$this->threadId = $threadId;
}
/**
* @return string
*/
public function getThreadId()
{
return $this->threadId;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Message::class, 'Google_Service_Gmail_Message');

View File

@@ -0,0 +1,155 @@
<?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.
*/
namespace Google\Service\Gmail;
class MessagePart extends \Google\Collection
{
protected $collection_key = 'parts';
protected $bodyType = MessagePartBody::class;
protected $bodyDataType = '';
/**
* The filename of the attachment. Only present if this message part
* represents an attachment.
*
* @var string
*/
public $filename;
protected $headersType = MessagePartHeader::class;
protected $headersDataType = 'array';
/**
* The MIME type of the message part.
*
* @var string
*/
public $mimeType;
/**
* The immutable ID of the message part.
*
* @var string
*/
public $partId;
protected $partsType = MessagePart::class;
protected $partsDataType = 'array';
/**
* The message part body for this part, which may be empty for container MIME
* message parts.
*
* @param MessagePartBody $body
*/
public function setBody(MessagePartBody $body)
{
$this->body = $body;
}
/**
* @return MessagePartBody
*/
public function getBody()
{
return $this->body;
}
/**
* The filename of the attachment. Only present if this message part
* represents an attachment.
*
* @param string $filename
*/
public function setFilename($filename)
{
$this->filename = $filename;
}
/**
* @return string
*/
public function getFilename()
{
return $this->filename;
}
/**
* List of headers on this message part. For the top-level message part,
* representing the entire message payload, it will contain the standard RFC
* 2822 email headers such as `To`, `From`, and `Subject`.
*
* @param MessagePartHeader[] $headers
*/
public function setHeaders($headers)
{
$this->headers = $headers;
}
/**
* @return MessagePartHeader[]
*/
public function getHeaders()
{
return $this->headers;
}
/**
* The MIME type of the message part.
*
* @param string $mimeType
*/
public function setMimeType($mimeType)
{
$this->mimeType = $mimeType;
}
/**
* @return string
*/
public function getMimeType()
{
return $this->mimeType;
}
/**
* The immutable ID of the message part.
*
* @param string $partId
*/
public function setPartId($partId)
{
$this->partId = $partId;
}
/**
* @return string
*/
public function getPartId()
{
return $this->partId;
}
/**
* The child MIME message parts of this part. This only applies to container
* MIME message parts, for example `multipart`. For non- container MIME
* message part types, such as `text/plain`, this field is empty. For more
* information, see RFC 1521.
*
* @param MessagePart[] $parts
*/
public function setParts($parts)
{
$this->parts = $parts;
}
/**
* @return MessagePart[]
*/
public function getParts()
{
return $this->parts;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(MessagePart::class, 'Google_Service_Gmail_MessagePart');

View File

@@ -0,0 +1,104 @@
<?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.
*/
namespace Google\Service\Gmail;
class MessagePartBody extends \Google\Model
{
/**
* When present, contains the ID of an external attachment that can be
* retrieved in a separate `messages.attachments.get` request. When not
* present, the entire content of the message part body is contained in the
* data field.
*
* @var string
*/
public $attachmentId;
/**
* The body data of a MIME message part as a base64url encoded string. May be
* empty for MIME container types that have no message body or when the body
* data is sent as a separate attachment. An attachment ID is present if the
* body data is contained in a separate attachment.
*
* @var string
*/
public $data;
/**
* Number of bytes for the message part data (encoding notwithstanding).
*
* @var int
*/
public $size;
/**
* When present, contains the ID of an external attachment that can be
* retrieved in a separate `messages.attachments.get` request. When not
* present, the entire content of the message part body is contained in the
* data field.
*
* @param string $attachmentId
*/
public function setAttachmentId($attachmentId)
{
$this->attachmentId = $attachmentId;
}
/**
* @return string
*/
public function getAttachmentId()
{
return $this->attachmentId;
}
/**
* The body data of a MIME message part as a base64url encoded string. May be
* empty for MIME container types that have no message body or when the body
* data is sent as a separate attachment. An attachment ID is present if the
* body data is contained in a separate attachment.
*
* @param string $data
*/
public function setData($data)
{
$this->data = $data;
}
/**
* @return string
*/
public function getData()
{
return $this->data;
}
/**
* Number of bytes for the message part data (encoding notwithstanding).
*
* @param int $size
*/
public function setSize($size)
{
$this->size = $size;
}
/**
* @return int
*/
public function getSize()
{
return $this->size;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(MessagePartBody::class, 'Google_Service_Gmail_MessagePartBody');

View File

@@ -0,0 +1,72 @@
<?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.
*/
namespace Google\Service\Gmail;
class MessagePartHeader extends \Google\Model
{
/**
* The name of the header before the `:` separator. For example, `To`.
*
* @var string
*/
public $name;
/**
* The value of the header after the `:` separator. For example,
* `someuser@example.com`.
*
* @var string
*/
public $value;
/**
* The name of the header before the `:` separator. For example, `To`.
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* The value of the header after the `:` separator. For example,
* `someuser@example.com`.
*
* @param string $value
*/
public function setValue($value)
{
$this->value = $value;
}
/**
* @return string
*/
public function getValue()
{
return $this->value;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(MessagePartHeader::class, 'Google_Service_Gmail_MessagePartHeader');

View File

@@ -0,0 +1,75 @@
<?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.
*/
namespace Google\Service\Gmail;
class ModifyMessageRequest extends \Google\Collection
{
protected $collection_key = 'removeLabelIds';
/**
* A list of IDs of labels to add to this message. You can add up to 100
* labels with each update.
*
* @var string[]
*/
public $addLabelIds;
/**
* A list IDs of labels to remove from this message. You can remove up to 100
* labels with each update.
*
* @var string[]
*/
public $removeLabelIds;
/**
* A list of IDs of labels to add to this message. You can add up to 100
* labels with each update.
*
* @param string[] $addLabelIds
*/
public function setAddLabelIds($addLabelIds)
{
$this->addLabelIds = $addLabelIds;
}
/**
* @return string[]
*/
public function getAddLabelIds()
{
return $this->addLabelIds;
}
/**
* A list IDs of labels to remove from this message. You can remove up to 100
* labels with each update.
*
* @param string[] $removeLabelIds
*/
public function setRemoveLabelIds($removeLabelIds)
{
$this->removeLabelIds = $removeLabelIds;
}
/**
* @return string[]
*/
public function getRemoveLabelIds()
{
return $this->removeLabelIds;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ModifyMessageRequest::class, 'Google_Service_Gmail_ModifyMessageRequest');

View File

@@ -0,0 +1,75 @@
<?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.
*/
namespace Google\Service\Gmail;
class ModifyThreadRequest extends \Google\Collection
{
protected $collection_key = 'removeLabelIds';
/**
* A list of IDs of labels to add to this thread. You can add up to 100 labels
* with each update.
*
* @var string[]
*/
public $addLabelIds;
/**
* A list of IDs of labels to remove from this thread. You can remove up to
* 100 labels with each update.
*
* @var string[]
*/
public $removeLabelIds;
/**
* A list of IDs of labels to add to this thread. You can add up to 100 labels
* with each update.
*
* @param string[] $addLabelIds
*/
public function setAddLabelIds($addLabelIds)
{
$this->addLabelIds = $addLabelIds;
}
/**
* @return string[]
*/
public function getAddLabelIds()
{
return $this->addLabelIds;
}
/**
* A list of IDs of labels to remove from this thread. You can remove up to
* 100 labels with each update.
*
* @param string[] $removeLabelIds
*/
public function setRemoveLabelIds($removeLabelIds)
{
$this->removeLabelIds = $removeLabelIds;
}
/**
* @return string[]
*/
public function getRemoveLabelIds()
{
return $this->removeLabelIds;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ModifyThreadRequest::class, 'Google_Service_Gmail_ModifyThreadRequest');

View File

@@ -0,0 +1,25 @@
<?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.
*/
namespace Google\Service\Gmail;
class ObliterateCseKeyPairRequest extends \Google\Model
{
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ObliterateCseKeyPairRequest::class, 'Google_Service_Gmail_ObliterateCseKeyPairRequest');

View File

@@ -0,0 +1,44 @@
<?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.
*/
namespace Google\Service\Gmail;
class PivKeyMetadata extends \Google\Model
{
/**
* @var string
*/
public $description;
/**
* @param string
*/
public function setDescription($description)
{
$this->description = $description;
}
/**
* @return string
*/
public function getDescription()
{
return $this->description;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(PivKeyMetadata::class, 'Google_Service_Gmail_PivKeyMetadata');

View File

@@ -0,0 +1,114 @@
<?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.
*/
namespace Google\Service\Gmail;
class PopSettings extends \Google\Model
{
/**
* Unspecified range.
*/
public const ACCESS_WINDOW_accessWindowUnspecified = 'accessWindowUnspecified';
/**
* Indicates that no messages are accessible via POP.
*/
public const ACCESS_WINDOW_disabled = 'disabled';
/**
* Indicates that unfetched messages received after some past point in time
* are accessible via POP.
*/
public const ACCESS_WINDOW_fromNowOn = 'fromNowOn';
/**
* Indicates that all unfetched messages are accessible via POP.
*/
public const ACCESS_WINDOW_allMail = 'allMail';
/**
* Unspecified disposition.
*/
public const DISPOSITION_dispositionUnspecified = 'dispositionUnspecified';
/**
* Leave the message in the `INBOX`.
*/
public const DISPOSITION_leaveInInbox = 'leaveInInbox';
/**
* Archive the message.
*/
public const DISPOSITION_archive = 'archive';
/**
* Move the message to the `TRASH`.
*/
public const DISPOSITION_trash = 'trash';
/**
* Leave the message in the `INBOX` and mark it as read.
*/
public const DISPOSITION_markRead = 'markRead';
/**
* The range of messages which are accessible via POP.
*
* @var string
*/
public $accessWindow;
/**
* The action that will be executed on a message after it has been fetched via
* POP.
*
* @var string
*/
public $disposition;
/**
* The range of messages which are accessible via POP.
*
* Accepted values: accessWindowUnspecified, disabled, fromNowOn, allMail
*
* @param self::ACCESS_WINDOW_* $accessWindow
*/
public function setAccessWindow($accessWindow)
{
$this->accessWindow = $accessWindow;
}
/**
* @return self::ACCESS_WINDOW_*
*/
public function getAccessWindow()
{
return $this->accessWindow;
}
/**
* The action that will be executed on a message after it has been fetched via
* POP.
*
* Accepted values: dispositionUnspecified, leaveInInbox, archive, trash,
* markRead
*
* @param self::DISPOSITION_* $disposition
*/
public function setDisposition($disposition)
{
$this->disposition = $disposition;
}
/**
* @return self::DISPOSITION_*
*/
public function getDisposition()
{
return $this->disposition;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(PopSettings::class, 'Google_Service_Gmail_PopSettings');

View File

@@ -0,0 +1,114 @@
<?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.
*/
namespace Google\Service\Gmail;
class Profile extends \Google\Model
{
/**
* The user's email address.
*
* @var string
*/
public $emailAddress;
/**
* The ID of the mailbox's current history record.
*
* @var string
*/
public $historyId;
/**
* The total number of messages in the mailbox.
*
* @var int
*/
public $messagesTotal;
/**
* The total number of threads in the mailbox.
*
* @var int
*/
public $threadsTotal;
/**
* The user's email address.
*
* @param string $emailAddress
*/
public function setEmailAddress($emailAddress)
{
$this->emailAddress = $emailAddress;
}
/**
* @return string
*/
public function getEmailAddress()
{
return $this->emailAddress;
}
/**
* The ID of the mailbox's current history record.
*
* @param string $historyId
*/
public function setHistoryId($historyId)
{
$this->historyId = $historyId;
}
/**
* @return string
*/
public function getHistoryId()
{
return $this->historyId;
}
/**
* The total number of messages in the mailbox.
*
* @param int $messagesTotal
*/
public function setMessagesTotal($messagesTotal)
{
$this->messagesTotal = $messagesTotal;
}
/**
* @return int
*/
public function getMessagesTotal()
{
return $this->messagesTotal;
}
/**
* The total number of threads in the mailbox.
*
* @param int $threadsTotal
*/
public function setThreadsTotal($threadsTotal)
{
$this->threadsTotal = $threadsTotal;
}
/**
* @return int
*/
public function getThreadsTotal()
{
return $this->threadsTotal;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Profile::class, 'Google_Service_Gmail_Profile');

View File

@@ -0,0 +1,83 @@
<?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.
*/
namespace Google\Service\Gmail\Resource;
use Google\Service\Gmail\Profile;
use Google\Service\Gmail\WatchRequest;
use Google\Service\Gmail\WatchResponse;
/**
* The "users" collection of methods.
* Typical usage is:
* <code>
* $gmailService = new Google\Service\Gmail(...);
* $users = $gmailService->users;
* </code>
*/
class Users extends \Google\Service\Resource
{
/**
* Gets the current user's Gmail profile. (users.getProfile)
*
* @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 Profile
* @throws \Google\Service\Exception
*/
public function getProfile($userId, $optParams = [])
{
$params = ['userId' => $userId];
$params = array_merge($params, $optParams);
return $this->call('getProfile', [$params], Profile::class);
}
/**
* Stop receiving push notifications for the given user mailbox. (users.stop)
*
* @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.
* @throws \Google\Service\Exception
*/
public function stop($userId, $optParams = [])
{
$params = ['userId' => $userId];
$params = array_merge($params, $optParams);
return $this->call('stop', [$params]);
}
/**
* Set up or update a push notification watch on the given user mailbox.
* (users.watch)
*
* @param string $userId The user's email address. The special value `me` can be
* used to indicate the authenticated user.
* @param WatchRequest $postBody
* @param array $optParams Optional parameters.
* @return WatchResponse
* @throws \Google\Service\Exception
*/
public function watch($userId, WatchRequest $postBody, $optParams = [])
{
$params = ['userId' => $userId, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('watch', [$params], WatchResponse::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Users::class, 'Google_Service_Gmail_Resource_Users');

View File

@@ -0,0 +1,146 @@
<?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.
*/
namespace Google\Service\Gmail\Resource;
use Google\Service\Gmail\Draft;
use Google\Service\Gmail\ListDraftsResponse;
use Google\Service\Gmail\Message;
/**
* The "drafts" collection of methods.
* Typical usage is:
* <code>
* $gmailService = new Google\Service\Gmail(...);
* $drafts = $gmailService->users_drafts;
* </code>
*/
class UsersDrafts extends \Google\Service\Resource
{
/**
* Creates a new draft with the `DRAFT` label. (drafts.create)
*
* @param string $userId The user's email address. The special value `me` can be
* used to indicate the authenticated user.
* @param Draft $postBody
* @param array $optParams Optional parameters.
* @return Draft
* @throws \Google\Service\Exception
*/
public function create($userId, Draft $postBody, $optParams = [])
{
$params = ['userId' => $userId, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('create', [$params], Draft::class);
}
/**
* Immediately and permanently deletes the specified draft. Does not simply
* trash it. (drafts.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 draft to delete.
* @param array $optParams Optional parameters.
* @throws \Google\Service\Exception
*/
public function delete($userId, $id, $optParams = [])
{
$params = ['userId' => $userId, 'id' => $id];
$params = array_merge($params, $optParams);
return $this->call('delete', [$params]);
}
/**
* Gets the specified draft. (drafts.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 draft to retrieve.
* @param array $optParams Optional parameters.
*
* @opt_param string format The format to return the draft in.
* @return Draft
* @throws \Google\Service\Exception
*/
public function get($userId, $id, $optParams = [])
{
$params = ['userId' => $userId, 'id' => $id];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], Draft::class);
}
/**
* Lists the drafts in the user's mailbox. (drafts.listUsersDrafts)
*
* @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.
*
* @opt_param bool includeSpamTrash Include drafts from `SPAM` and `TRASH` in
* the results.
* @opt_param string maxResults Maximum number of drafts to return. This field
* defaults to 100. The maximum allowed value for this field is 500.
* @opt_param string pageToken Page token to retrieve a specific page of results
* in the list.
* @opt_param string q Only return draft messages matching the specified query.
* Supports the same query format as the Gmail search box. For example,
* `"from:someuser@example.com rfc822msgid: is:unread"`.
* @return ListDraftsResponse
* @throws \Google\Service\Exception
*/
public function listUsersDrafts($userId, $optParams = [])
{
$params = ['userId' => $userId];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListDraftsResponse::class);
}
/**
* Sends the specified, existing draft to the recipients in the `To`, `Cc`, and
* `Bcc` headers. (drafts.send)
*
* @param string $userId The user's email address. The special value `me` can be
* used to indicate the authenticated user.
* @param Draft $postBody
* @param array $optParams Optional parameters.
* @return Message
* @throws \Google\Service\Exception
*/
public function send($userId, Draft $postBody, $optParams = [])
{
$params = ['userId' => $userId, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('send', [$params], Message::class);
}
/**
* Replaces a draft's content. (drafts.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 draft to update.
* @param Draft $postBody
* @param array $optParams Optional parameters.
* @return Draft
* @throws \Google\Service\Exception
*/
public function update($userId, $id, Draft $postBody, $optParams = [])
{
$params = ['userId' => $userId, 'id' => $id, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('update', [$params], Draft::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(UsersDrafts::class, 'Google_Service_Gmail_Resource_UsersDrafts');

View File

@@ -0,0 +1,70 @@
<?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.
*/
namespace Google\Service\Gmail\Resource;
use Google\Service\Gmail\ListHistoryResponse;
/**
* The "history" collection of methods.
* Typical usage is:
* <code>
* $gmailService = new Google\Service\Gmail(...);
* $history = $gmailService->users_history;
* </code>
*/
class UsersHistory extends \Google\Service\Resource
{
/**
* Lists the history of all changes to the given mailbox. History results are
* returned in chronological order (increasing `historyId`).
* (history.listUsersHistory)
*
* @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.
*
* @opt_param string historyTypes History types to be returned by the function
* @opt_param string labelId Only return messages with a label matching the ID.
* @opt_param string maxResults Maximum number of history records to return.
* This field defaults to 100. The maximum allowed value for this field is 500.
* @opt_param string pageToken Page token to retrieve a specific page of results
* in the list.
* @opt_param string startHistoryId Required. Returns history records after the
* specified `startHistoryId`. The supplied `startHistoryId` should be obtained
* from the `historyId` of a message, thread, or previous `list` response.
* History IDs increase chronologically but are not contiguous with random gaps
* in between valid IDs. Supplying an invalid or out of date `startHistoryId`
* typically returns an `HTTP 404` error code. A `historyId` is typically valid
* for at least a week, but in some rare circumstances may be valid for only a
* few hours. If you receive an `HTTP 404` error response, your application
* should perform a full sync. If you receive no `nextPageToken` in the
* response, there are no updates to retrieve and you can store the returned
* `historyId` for a future request.
* @return ListHistoryResponse
* @throws \Google\Service\Exception
*/
public function listUsersHistory($userId, $optParams = [])
{
$params = ['userId' => $userId];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListHistoryResponse::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(UsersHistory::class, 'Google_Service_Gmail_Resource_UsersHistory');

View File

@@ -0,0 +1,133 @@
<?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.
*/
namespace Google\Service\Gmail\Resource;
use Google\Service\Gmail\Label;
use Google\Service\Gmail\ListLabelsResponse;
/**
* The "labels" collection of methods.
* Typical usage is:
* <code>
* $gmailService = new Google\Service\Gmail(...);
* $labels = $gmailService->users_labels;
* </code>
*/
class 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 Label $postBody
* @param array $optParams Optional parameters.
* @return Label
* @throws \Google\Service\Exception
*/
public function create($userId, Label $postBody, $optParams = [])
{
$params = ['userId' => $userId, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('create', [$params], Label::class);
}
/**
* 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.
* @throws \Google\Service\Exception
*/
public function delete($userId, $id, $optParams = [])
{
$params = ['userId' => $userId, 'id' => $id];
$params = array_merge($params, $optParams);
return $this->call('delete', [$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 Label
* @throws \Google\Service\Exception
*/
public function get($userId, $id, $optParams = [])
{
$params = ['userId' => $userId, 'id' => $id];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], Label::class);
}
/**
* 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 ListLabelsResponse
* @throws \Google\Service\Exception
*/
public function listUsersLabels($userId, $optParams = [])
{
$params = ['userId' => $userId];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListLabelsResponse::class);
}
/**
* 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 Label $postBody
* @param array $optParams Optional parameters.
* @return Label
* @throws \Google\Service\Exception
*/
public function patch($userId, $id, Label $postBody, $optParams = [])
{
$params = ['userId' => $userId, 'id' => $id, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('patch', [$params], Label::class);
}
/**
* 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 Label $postBody
* @param array $optParams Optional parameters.
* @return Label
* @throws \Google\Service\Exception
*/
public function update($userId, $id, Label $postBody, $optParams = [])
{
$params = ['userId' => $userId, 'id' => $id, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('update', [$params], Label::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(UsersLabels::class, 'Google_Service_Gmail_Resource_UsersLabels');

View File

@@ -0,0 +1,263 @@
<?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.
*/
namespace Google\Service\Gmail\Resource;
use Google\Service\Gmail\BatchDeleteMessagesRequest;
use Google\Service\Gmail\BatchModifyMessagesRequest;
use Google\Service\Gmail\ListMessagesResponse;
use Google\Service\Gmail\Message;
use Google\Service\Gmail\ModifyMessageRequest;
/**
* The "messages" collection of methods.
* Typical usage is:
* <code>
* $gmailService = new Google\Service\Gmail(...);
* $messages = $gmailService->users_messages;
* </code>
*/
class UsersMessages extends \Google\Service\Resource
{
/**
* Deletes many messages by message ID. Provides no guarantees that messages
* were not already deleted or even existed at all. (messages.batchDelete)
*
* @param string $userId The user's email address. The special value `me` can be
* used to indicate the authenticated user.
* @param BatchDeleteMessagesRequest $postBody
* @param array $optParams Optional parameters.
* @throws \Google\Service\Exception
*/
public function batchDelete($userId, BatchDeleteMessagesRequest $postBody, $optParams = [])
{
$params = ['userId' => $userId, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('batchDelete', [$params]);
}
/**
* Modifies the labels on the specified messages. (messages.batchModify)
*
* @param string $userId The user's email address. The special value `me` can be
* used to indicate the authenticated user.
* @param BatchModifyMessagesRequest $postBody
* @param array $optParams Optional parameters.
* @throws \Google\Service\Exception
*/
public function batchModify($userId, BatchModifyMessagesRequest $postBody, $optParams = [])
{
$params = ['userId' => $userId, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('batchModify', [$params]);
}
/**
* Immediately and permanently deletes the specified message. This operation
* cannot be undone. Prefer `messages.trash` instead. (messages.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 message to delete.
* @param array $optParams Optional parameters.
* @throws \Google\Service\Exception
*/
public function delete($userId, $id, $optParams = [])
{
$params = ['userId' => $userId, 'id' => $id];
$params = array_merge($params, $optParams);
return $this->call('delete', [$params]);
}
/**
* Gets the specified message. (messages.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 message to retrieve. This ID is usually
* retrieved using `messages.list`. The ID is also contained in the result when
* a message is inserted (`messages.insert`) or imported (`messages.import`).
* @param array $optParams Optional parameters.
*
* @opt_param string format The format to return the message in.
* @opt_param string metadataHeaders When given and format is `METADATA`, only
* include headers specified.
* @return Message
* @throws \Google\Service\Exception
*/
public function get($userId, $id, $optParams = [])
{
$params = ['userId' => $userId, 'id' => $id];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], Message::class);
}
/**
* Imports a message into only this user's mailbox, with standard email delivery
* scanning and classification similar to receiving via SMTP. This method
* doesn't perform SPF checks, so it might not work for some spam messages, such
* as those attempting to perform domain spoofing. This method does not send a
* message. (messages.import)
*
* @param string $userId The user's email address. The special value `me` can be
* used to indicate the authenticated user.
* @param Message $postBody
* @param array $optParams Optional parameters.
*
* @opt_param bool deleted Mark the email as permanently deleted (not TRASH) and
* only visible in Google Vault to a Vault administrator. Only used for Google
* Workspace accounts.
* @opt_param string internalDateSource Source for Gmail's internal date of the
* message.
* @opt_param bool neverMarkSpam Ignore the Gmail spam classifier decision and
* never mark this email as SPAM in the mailbox.
* @opt_param bool processForCalendar Process calendar invites in the email and
* add any extracted meetings to the Google Calendar for this user.
* @return Message
* @throws \Google\Service\Exception
*/
public function import($userId, Message $postBody, $optParams = [])
{
$params = ['userId' => $userId, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('import', [$params], Message::class);
}
/**
* Directly inserts a message into only this user's mailbox similar to `IMAP
* APPEND`, bypassing most scanning and classification. Does not send a message.
* (messages.insert)
*
* @param string $userId The user's email address. The special value `me` can be
* used to indicate the authenticated user.
* @param Message $postBody
* @param array $optParams Optional parameters.
*
* @opt_param bool deleted Mark the email as permanently deleted (not TRASH) and
* only visible in Google Vault to a Vault administrator. Only used for Google
* Workspace accounts.
* @opt_param string internalDateSource Source for Gmail's internal date of the
* message.
* @return Message
* @throws \Google\Service\Exception
*/
public function insert($userId, Message $postBody, $optParams = [])
{
$params = ['userId' => $userId, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('insert', [$params], Message::class);
}
/**
* Lists the messages in the user's mailbox. For example usage, see [List Gmail
* messages](https://developers.google.com/workspace/gmail/api/guides/list-
* messages). (messages.listUsersMessages)
*
* @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.
*
* @opt_param bool includeSpamTrash Include messages from `SPAM` and `TRASH` in
* the results.
* @opt_param string labelIds Only return messages with labels that match all of
* the specified label IDs. Messages in a thread might have labels that other
* messages in the same thread don't have. To learn more, see [Manage labels on
* messages and threads](https://developers.google.com/workspace/gmail/api/guide
* s/labels#manage_labels_on_messages_threads).
* @opt_param string maxResults Maximum number of messages to return. This field
* defaults to 100. The maximum allowed value for this field is 500.
* @opt_param string pageToken Page token to retrieve a specific page of results
* in the list.
* @opt_param string q Only return messages matching the specified query.
* Supports the same query format as the Gmail search box. For example,
* `"from:someuser@example.com rfc822msgid: is:unread"`. Parameter cannot be
* used when accessing the api using the gmail.metadata scope.
* @return ListMessagesResponse
* @throws \Google\Service\Exception
*/
public function listUsersMessages($userId, $optParams = [])
{
$params = ['userId' => $userId];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListMessagesResponse::class);
}
/**
* Modifies the labels on the specified message. (messages.modify)
*
* @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 message to modify.
* @param ModifyMessageRequest $postBody
* @param array $optParams Optional parameters.
* @return Message
* @throws \Google\Service\Exception
*/
public function modify($userId, $id, ModifyMessageRequest $postBody, $optParams = [])
{
$params = ['userId' => $userId, 'id' => $id, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('modify', [$params], Message::class);
}
/**
* Sends the specified message to the recipients in the `To`, `Cc`, and `Bcc`
* headers. For example usage, see [Sending
* email](https://developers.google.com/workspace/gmail/api/guides/sending).
* (messages.send)
*
* @param string $userId The user's email address. The special value `me` can be
* used to indicate the authenticated user.
* @param Message $postBody
* @param array $optParams Optional parameters.
* @return Message
* @throws \Google\Service\Exception
*/
public function send($userId, Message $postBody, $optParams = [])
{
$params = ['userId' => $userId, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('send', [$params], Message::class);
}
/**
* Moves the specified message to the trash. (messages.trash)
*
* @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 message to Trash.
* @param array $optParams Optional parameters.
* @return Message
* @throws \Google\Service\Exception
*/
public function trash($userId, $id, $optParams = [])
{
$params = ['userId' => $userId, 'id' => $id];
$params = array_merge($params, $optParams);
return $this->call('trash', [$params], Message::class);
}
/**
* Removes the specified message from the trash. (messages.untrash)
*
* @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 message to remove from Trash.
* @param array $optParams Optional parameters.
* @return Message
* @throws \Google\Service\Exception
*/
public function untrash($userId, $id, $optParams = [])
{
$params = ['userId' => $userId, 'id' => $id];
$params = array_merge($params, $optParams);
return $this->call('untrash', [$params], Message::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(UsersMessages::class, 'Google_Service_Gmail_Resource_UsersMessages');

View File

@@ -0,0 +1,52 @@
<?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.
*/
namespace Google\Service\Gmail\Resource;
use Google\Service\Gmail\MessagePartBody;
/**
* The "attachments" collection of methods.
* Typical usage is:
* <code>
* $gmailService = new Google\Service\Gmail(...);
* $attachments = $gmailService->users_messages_attachments;
* </code>
*/
class UsersMessagesAttachments extends \Google\Service\Resource
{
/**
* Gets the specified message attachment. (attachments.get)
*
* @param string $userId The user's email address. The special value `me` can be
* used to indicate the authenticated user.
* @param string $messageId The ID of the message containing the attachment.
* @param string $id The ID of the attachment.
* @param array $optParams Optional parameters.
* @return MessagePartBody
* @throws \Google\Service\Exception
*/
public function get($userId, $messageId, $id, $optParams = [])
{
$params = ['userId' => $userId, 'messageId' => $messageId, 'id' => $id];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], MessagePartBody::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(UsersMessagesAttachments::class, 'Google_Service_Gmail_Resource_UsersMessagesAttachments');

View File

@@ -0,0 +1,203 @@
<?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.
*/
namespace Google\Service\Gmail\Resource;
use Google\Service\Gmail\AutoForwarding;
use Google\Service\Gmail\ImapSettings;
use Google\Service\Gmail\LanguageSettings;
use Google\Service\Gmail\PopSettings;
use Google\Service\Gmail\VacationSettings;
/**
* The "settings" collection of methods.
* Typical usage is:
* <code>
* $gmailService = new Google\Service\Gmail(...);
* $settings = $gmailService->users_settings;
* </code>
*/
class UsersSettings extends \Google\Service\Resource
{
/**
* Gets the auto-forwarding setting for the specified account.
* (settings.getAutoForwarding)
*
* @param string $userId User's email address. The special value "me" can be
* used to indicate the authenticated user.
* @param array $optParams Optional parameters.
* @return AutoForwarding
* @throws \Google\Service\Exception
*/
public function getAutoForwarding($userId, $optParams = [])
{
$params = ['userId' => $userId];
$params = array_merge($params, $optParams);
return $this->call('getAutoForwarding', [$params], AutoForwarding::class);
}
/**
* Gets IMAP settings. (settings.getImap)
*
* @param string $userId User's email address. The special value "me" can be
* used to indicate the authenticated user.
* @param array $optParams Optional parameters.
* @return ImapSettings
* @throws \Google\Service\Exception
*/
public function getImap($userId, $optParams = [])
{
$params = ['userId' => $userId];
$params = array_merge($params, $optParams);
return $this->call('getImap', [$params], ImapSettings::class);
}
/**
* Gets language settings. (settings.getLanguage)
*
* @param string $userId User's email address. The special value "me" can be
* used to indicate the authenticated user.
* @param array $optParams Optional parameters.
* @return LanguageSettings
* @throws \Google\Service\Exception
*/
public function getLanguage($userId, $optParams = [])
{
$params = ['userId' => $userId];
$params = array_merge($params, $optParams);
return $this->call('getLanguage', [$params], LanguageSettings::class);
}
/**
* Gets POP settings. (settings.getPop)
*
* @param string $userId User's email address. The special value "me" can be
* used to indicate the authenticated user.
* @param array $optParams Optional parameters.
* @return PopSettings
* @throws \Google\Service\Exception
*/
public function getPop($userId, $optParams = [])
{
$params = ['userId' => $userId];
$params = array_merge($params, $optParams);
return $this->call('getPop', [$params], PopSettings::class);
}
/**
* Gets vacation responder settings. (settings.getVacation)
*
* @param string $userId User's email address. The special value "me" can be
* used to indicate the authenticated user.
* @param array $optParams Optional parameters.
* @return VacationSettings
* @throws \Google\Service\Exception
*/
public function getVacation($userId, $optParams = [])
{
$params = ['userId' => $userId];
$params = array_merge($params, $optParams);
return $this->call('getVacation', [$params], VacationSettings::class);
}
/**
* Updates the auto-forwarding setting for the specified account. A verified
* forwarding address must be specified when auto-forwarding is enabled. This
* method is only available to service account clients that have been delegated
* domain-wide authority. (settings.updateAutoForwarding)
*
* @param string $userId User's email address. The special value "me" can be
* used to indicate the authenticated user.
* @param AutoForwarding $postBody
* @param array $optParams Optional parameters.
* @return AutoForwarding
* @throws \Google\Service\Exception
*/
public function updateAutoForwarding($userId, AutoForwarding $postBody, $optParams = [])
{
$params = ['userId' => $userId, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('updateAutoForwarding', [$params], AutoForwarding::class);
}
/**
* Updates IMAP settings. (settings.updateImap)
*
* @param string $userId User's email address. The special value "me" can be
* used to indicate the authenticated user.
* @param ImapSettings $postBody
* @param array $optParams Optional parameters.
* @return ImapSettings
* @throws \Google\Service\Exception
*/
public function updateImap($userId, ImapSettings $postBody, $optParams = [])
{
$params = ['userId' => $userId, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('updateImap', [$params], ImapSettings::class);
}
/**
* Updates language settings. If successful, the return object contains the
* `displayLanguage` that was saved for the user, which may differ from the
* value passed into the request. This is because the requested
* `displayLanguage` may not be directly supported by Gmail but have a close
* variant that is, and so the variant may be chosen and saved instead.
* (settings.updateLanguage)
*
* @param string $userId User's email address. The special value "me" can be
* used to indicate the authenticated user.
* @param LanguageSettings $postBody
* @param array $optParams Optional parameters.
* @return LanguageSettings
* @throws \Google\Service\Exception
*/
public function updateLanguage($userId, LanguageSettings $postBody, $optParams = [])
{
$params = ['userId' => $userId, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('updateLanguage', [$params], LanguageSettings::class);
}
/**
* Updates POP settings. (settings.updatePop)
*
* @param string $userId User's email address. The special value "me" can be
* used to indicate the authenticated user.
* @param PopSettings $postBody
* @param array $optParams Optional parameters.
* @return PopSettings
* @throws \Google\Service\Exception
*/
public function updatePop($userId, PopSettings $postBody, $optParams = [])
{
$params = ['userId' => $userId, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('updatePop', [$params], PopSettings::class);
}
/**
* Updates vacation responder settings. (settings.updateVacation)
*
* @param string $userId User's email address. The special value "me" can be
* used to indicate the authenticated user.
* @param VacationSettings $postBody
* @param array $optParams Optional parameters.
* @return VacationSettings
* @throws \Google\Service\Exception
*/
public function updateVacation($userId, VacationSettings $postBody, $optParams = [])
{
$params = ['userId' => $userId, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('updateVacation', [$params], VacationSettings::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(UsersSettings::class, 'Google_Service_Gmail_Resource_UsersSettings');

View File

@@ -0,0 +1,33 @@
<?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.
*/
namespace Google\Service\Gmail\Resource;
/**
* The "cse" collection of methods.
* Typical usage is:
* <code>
* $gmailService = new Google\Service\Gmail(...);
* $cse = $gmailService->users_settings_cse;
* </code>
*/
class UsersSettingsCse extends \Google\Service\Resource
{
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(UsersSettingsCse::class, 'Google_Service_Gmail_Resource_UsersSettingsCse');

View File

@@ -0,0 +1,177 @@
<?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.
*/
namespace Google\Service\Gmail\Resource;
use Google\Service\Gmail\CseIdentity;
use Google\Service\Gmail\ListCseIdentitiesResponse;
/**
* The "identities" collection of methods.
* Typical usage is:
* <code>
* $gmailService = new Google\Service\Gmail(...);
* $identities = $gmailService->users_settings_cse_identities;
* </code>
*/
class UsersSettingsCseIdentities extends \Google\Service\Resource
{
/**
* Creates and configures a client-side encryption identity that's authorized to
* send mail from the user account. Google publishes the S/MIME certificate to a
* shared domain-wide directory so that people within a Google Workspace
* organization can encrypt and send mail to the identity. For administrators
* managing identities and keypairs for users in their organization, requests
* require authorization with a [service account](https://developers.google.com/
* identity/protocols/OAuth2ServiceAccount) that has [domain-wide delegation aut
* hority](https://developers.google.com/identity/protocols/OAuth2ServiceAccount
* #delegatingauthority) to impersonate users with the
* `https://www.googleapis.com/auth/gmail.settings.basic` scope. For users
* managing their own identities and keypairs, requests require [hardware key
* encryption](https://support.google.com/a/answer/14153163) turned on and
* configured. (identities.create)
*
* @param string $userId The requester's primary email address. To indicate the
* authenticated user, you can use the special value `me`.
* @param CseIdentity $postBody
* @param array $optParams Optional parameters.
* @return CseIdentity
* @throws \Google\Service\Exception
*/
public function create($userId, CseIdentity $postBody, $optParams = [])
{
$params = ['userId' => $userId, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('create', [$params], CseIdentity::class);
}
/**
* Deletes a client-side encryption identity. The authenticated user can no
* longer use the identity to send encrypted messages. You cannot restore the
* identity after you delete it. Instead, use the CreateCseIdentity method to
* create another identity with the same configuration. For administrators
* managing identities and keypairs for users in their organization, requests
* require authorization with a [service account](https://developers.google.com/
* identity/protocols/OAuth2ServiceAccount) that has [domain-wide delegation aut
* hority](https://developers.google.com/identity/protocols/OAuth2ServiceAccount
* #delegatingauthority) to impersonate users with the
* `https://www.googleapis.com/auth/gmail.settings.basic` scope. For users
* managing their own identities and keypairs, requests require [hardware key
* encryption](https://support.google.com/a/answer/14153163) turned on and
* configured. (identities.delete)
*
* @param string $userId The requester's primary email address. To indicate the
* authenticated user, you can use the special value `me`.
* @param string $cseEmailAddress The primary email address associated with the
* client-side encryption identity configuration that's removed.
* @param array $optParams Optional parameters.
* @throws \Google\Service\Exception
*/
public function delete($userId, $cseEmailAddress, $optParams = [])
{
$params = ['userId' => $userId, 'cseEmailAddress' => $cseEmailAddress];
$params = array_merge($params, $optParams);
return $this->call('delete', [$params]);
}
/**
* Retrieves a client-side encryption identity configuration. For administrators
* managing identities and keypairs for users in their organization, requests
* require authorization with a [service account](https://developers.google.com/
* identity/protocols/OAuth2ServiceAccount) that has [domain-wide delegation aut
* hority](https://developers.google.com/identity/protocols/OAuth2ServiceAccount
* #delegatingauthority) to impersonate users with the
* `https://www.googleapis.com/auth/gmail.settings.basic` scope. For users
* managing their own identities and keypairs, requests require [hardware key
* encryption](https://support.google.com/a/answer/14153163) turned on and
* configured. (identities.get)
*
* @param string $userId The requester's primary email address. To indicate the
* authenticated user, you can use the special value `me`.
* @param string $cseEmailAddress The primary email address associated with the
* client-side encryption identity configuration that's retrieved.
* @param array $optParams Optional parameters.
* @return CseIdentity
* @throws \Google\Service\Exception
*/
public function get($userId, $cseEmailAddress, $optParams = [])
{
$params = ['userId' => $userId, 'cseEmailAddress' => $cseEmailAddress];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], CseIdentity::class);
}
/**
* Lists the client-side encrypted identities for an authenticated user. For
* administrators managing identities and keypairs for users in their
* organization, requests require authorization with a [service account](https:/
* /developers.google.com/identity/protocols/OAuth2ServiceAccount) that has
* [domain-wide delegation authority](https://developers.google.com/identity/pro
* tocols/OAuth2ServiceAccount#delegatingauthority) to impersonate users with
* the `https://www.googleapis.com/auth/gmail.settings.basic` scope. For users
* managing their own identities and keypairs, requests require [hardware key
* encryption](https://support.google.com/a/answer/14153163) turned on and
* configured. (identities.listUsersSettingsCseIdentities)
*
* @param string $userId The requester's primary email address. To indicate the
* authenticated user, you can use the special value `me`.
* @param array $optParams Optional parameters.
*
* @opt_param int pageSize The number of identities to return. If not provided,
* the page size will default to 20 entries.
* @opt_param string pageToken Pagination token indicating which page of
* identities to return. If the token is not supplied, then the API will return
* the first page of results.
* @return ListCseIdentitiesResponse
* @throws \Google\Service\Exception
*/
public function listUsersSettingsCseIdentities($userId, $optParams = [])
{
$params = ['userId' => $userId];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListCseIdentitiesResponse::class);
}
/**
* Associates a different key pair with an existing client-side encryption
* identity. The updated key pair must validate against Google's [S/MIME
* certificate profiles](https://support.google.com/a/answer/7300887). For
* administrators managing identities and keypairs for users in their
* organization, requests require authorization with a [service account](https:/
* /developers.google.com/identity/protocols/OAuth2ServiceAccount) that has
* [domain-wide delegation authority](https://developers.google.com/identity/pro
* tocols/OAuth2ServiceAccount#delegatingauthority) to impersonate users with
* the `https://www.googleapis.com/auth/gmail.settings.basic` scope. For users
* managing their own identities and keypairs, requests require [hardware key
* encryption](https://support.google.com/a/answer/14153163) turned on and
* configured. (identities.patch)
*
* @param string $userId The requester's primary email address. To indicate the
* authenticated user, you can use the special value `me`.
* @param string $emailAddress The email address of the client-side encryption
* identity to update.
* @param CseIdentity $postBody
* @param array $optParams Optional parameters.
* @return CseIdentity
* @throws \Google\Service\Exception
*/
public function patch($userId, $emailAddress, CseIdentity $postBody, $optParams = [])
{
$params = ['userId' => $userId, 'emailAddress' => $emailAddress, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('patch', [$params], CseIdentity::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(UsersSettingsCseIdentities::class, 'Google_Service_Gmail_Resource_UsersSettingsCseIdentities');

View File

@@ -0,0 +1,207 @@
<?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.
*/
namespace Google\Service\Gmail\Resource;
use Google\Service\Gmail\CseKeyPair;
use Google\Service\Gmail\DisableCseKeyPairRequest;
use Google\Service\Gmail\EnableCseKeyPairRequest;
use Google\Service\Gmail\ListCseKeyPairsResponse;
use Google\Service\Gmail\ObliterateCseKeyPairRequest;
/**
* The "keypairs" collection of methods.
* Typical usage is:
* <code>
* $gmailService = new Google\Service\Gmail(...);
* $keypairs = $gmailService->users_settings_cse_keypairs;
* </code>
*/
class UsersSettingsCseKeypairs extends \Google\Service\Resource
{
/**
* Creates and uploads a client-side encryption S/MIME public key certificate
* chain and private key metadata for the authenticated user. For administrators
* managing identities and keypairs for users in their organization, requests
* require authorization with a [service account](https://developers.google.com/
* identity/protocols/OAuth2ServiceAccount) that has [domain-wide delegation aut
* hority](https://developers.google.com/identity/protocols/OAuth2ServiceAccount
* #delegatingauthority) to impersonate users with the
* `https://www.googleapis.com/auth/gmail.settings.basic` scope. For users
* managing their own identities and keypairs, requests require [hardware key
* encryption](https://support.google.com/a/answer/14153163) turned on and
* configured. (keypairs.create)
*
* @param string $userId The requester's primary email address. To indicate the
* authenticated user, you can use the special value `me`.
* @param CseKeyPair $postBody
* @param array $optParams Optional parameters.
* @return CseKeyPair
* @throws \Google\Service\Exception
*/
public function create($userId, CseKeyPair $postBody, $optParams = [])
{
$params = ['userId' => $userId, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('create', [$params], CseKeyPair::class);
}
/**
* Turns off a client-side encryption key pair. The authenticated user can no
* longer use the key pair to decrypt incoming CSE message texts or sign
* outgoing CSE mail. To regain access, use the EnableCseKeyPair to turn on the
* key pair. After 30 days, you can permanently delete the key pair by using the
* ObliterateCseKeyPair method. For administrators managing identities and
* keypairs for users in their organization, requests require authorization with
* a [service account](https://developers.google.com/identity/protocols/OAuth2Se
* rviceAccount) that has [domain-wide delegation authority](https://developers.
* google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority) to
* impersonate users with the
* `https://www.googleapis.com/auth/gmail.settings.basic` scope. For users
* managing their own identities and keypairs, requests require [hardware key
* encryption](https://support.google.com/a/answer/14153163) turned on and
* configured. (keypairs.disable)
*
* @param string $userId The requester's primary email address. To indicate the
* authenticated user, you can use the special value `me`.
* @param string $keyPairId The identifier of the key pair to turn off.
* @param DisableCseKeyPairRequest $postBody
* @param array $optParams Optional parameters.
* @return CseKeyPair
* @throws \Google\Service\Exception
*/
public function disable($userId, $keyPairId, DisableCseKeyPairRequest $postBody, $optParams = [])
{
$params = ['userId' => $userId, 'keyPairId' => $keyPairId, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('disable', [$params], CseKeyPair::class);
}
/**
* Turns on a client-side encryption key pair that was turned off. The key pair
* becomes active again for any associated client-side encryption identities.
* For administrators managing identities and keypairs for users in their
* organization, requests require authorization with a [service account](https:/
* /developers.google.com/identity/protocols/OAuth2ServiceAccount) that has
* [domain-wide delegation authority](https://developers.google.com/identity/pro
* tocols/OAuth2ServiceAccount#delegatingauthority) to impersonate users with
* the `https://www.googleapis.com/auth/gmail.settings.basic` scope. For users
* managing their own identities and keypairs, requests require [hardware key
* encryption](https://support.google.com/a/answer/14153163) turned on and
* configured. (keypairs.enable)
*
* @param string $userId The requester's primary email address. To indicate the
* authenticated user, you can use the special value `me`.
* @param string $keyPairId The identifier of the key pair to turn on.
* @param EnableCseKeyPairRequest $postBody
* @param array $optParams Optional parameters.
* @return CseKeyPair
* @throws \Google\Service\Exception
*/
public function enable($userId, $keyPairId, EnableCseKeyPairRequest $postBody, $optParams = [])
{
$params = ['userId' => $userId, 'keyPairId' => $keyPairId, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('enable', [$params], CseKeyPair::class);
}
/**
* Retrieves an existing client-side encryption key pair. For administrators
* managing identities and keypairs for users in their organization, requests
* require authorization with a [service account](https://developers.google.com/
* identity/protocols/OAuth2ServiceAccount) that has [domain-wide delegation aut
* hority](https://developers.google.com/identity/protocols/OAuth2ServiceAccount
* #delegatingauthority) to impersonate users with the
* `https://www.googleapis.com/auth/gmail.settings.basic` scope. For users
* managing their own identities and keypairs, requests require [hardware key
* encryption](https://support.google.com/a/answer/14153163) turned on and
* configured. (keypairs.get)
*
* @param string $userId The requester's primary email address. To indicate the
* authenticated user, you can use the special value `me`.
* @param string $keyPairId The identifier of the key pair to retrieve.
* @param array $optParams Optional parameters.
* @return CseKeyPair
* @throws \Google\Service\Exception
*/
public function get($userId, $keyPairId, $optParams = [])
{
$params = ['userId' => $userId, 'keyPairId' => $keyPairId];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], CseKeyPair::class);
}
/**
* Lists client-side encryption key pairs for an authenticated user. For
* administrators managing identities and keypairs for users in their
* organization, requests require authorization with a [service account](https:/
* /developers.google.com/identity/protocols/OAuth2ServiceAccount) that has
* [domain-wide delegation authority](https://developers.google.com/identity/pro
* tocols/OAuth2ServiceAccount#delegatingauthority) to impersonate users with
* the `https://www.googleapis.com/auth/gmail.settings.basic` scope. For users
* managing their own identities and keypairs, requests require [hardware key
* encryption](https://support.google.com/a/answer/14153163) turned on and
* configured. (keypairs.listUsersSettingsCseKeypairs)
*
* @param string $userId The requester's primary email address. To indicate the
* authenticated user, you can use the special value `me`.
* @param array $optParams Optional parameters.
*
* @opt_param int pageSize The number of key pairs to return. If not provided,
* the page size will default to 20 entries.
* @opt_param string pageToken Pagination token indicating which page of key
* pairs to return. If the token is not supplied, then the API will return the
* first page of results.
* @return ListCseKeyPairsResponse
* @throws \Google\Service\Exception
*/
public function listUsersSettingsCseKeypairs($userId, $optParams = [])
{
$params = ['userId' => $userId];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListCseKeyPairsResponse::class);
}
/**
* Deletes a client-side encryption key pair permanently and immediately. You
* can only permanently delete key pairs that have been turned off for more than
* 30 days. To turn off a key pair, use the DisableCseKeyPair method. Gmail
* can't restore or decrypt any messages that were encrypted by an obliterated
* key. Authenticated users and Google Workspace administrators lose access to
* reading the encrypted messages. For administrators managing identities and
* keypairs for users in their organization, requests require authorization with
* a [service account](https://developers.google.com/identity/protocols/OAuth2Se
* rviceAccount) that has [domain-wide delegation authority](https://developers.
* google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority) to
* impersonate users with the
* `https://www.googleapis.com/auth/gmail.settings.basic` scope. For users
* managing their own identities and keypairs, requests require [hardware key
* encryption](https://support.google.com/a/answer/14153163) turned on and
* configured. (keypairs.obliterate)
*
* @param string $userId The requester's primary email address. To indicate the
* authenticated user, you can use the special value `me`.
* @param string $keyPairId The identifier of the key pair to obliterate.
* @param ObliterateCseKeyPairRequest $postBody
* @param array $optParams Optional parameters.
* @throws \Google\Service\Exception
*/
public function obliterate($userId, $keyPairId, ObliterateCseKeyPairRequest $postBody, $optParams = [])
{
$params = ['userId' => $userId, 'keyPairId' => $keyPairId, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('obliterate', [$params]);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(UsersSettingsCseKeypairs::class, 'Google_Service_Gmail_Resource_UsersSettingsCseKeypairs');

View File

@@ -0,0 +1,119 @@
<?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.
*/
namespace Google\Service\Gmail\Resource;
use Google\Service\Gmail\Delegate;
use Google\Service\Gmail\ListDelegatesResponse;
/**
* The "delegates" collection of methods.
* Typical usage is:
* <code>
* $gmailService = new Google\Service\Gmail(...);
* $delegates = $gmailService->users_settings_delegates;
* </code>
*/
class UsersSettingsDelegates extends \Google\Service\Resource
{
/**
* Adds a delegate with its verification status set directly to `accepted`,
* without sending any verification email. The delegate user must be a member of
* the same Google Workspace organization as the delegator user. Gmail imposes
* limitations on the number of delegates and delegators each user in a Google
* Workspace organization can have. These limits depend on your organization,
* but in general each user can have up to 25 delegates and up to 10 delegators.
* Note that a delegate user must be referred to by their primary email address,
* and not an email alias. Also note that when a new delegate is created, there
* may be up to a one minute delay before the new delegate is available for use.
* This method is only available to service account clients that have been
* delegated domain-wide authority. (delegates.create)
*
* @param string $userId User's email address. The special value "me" can be
* used to indicate the authenticated user.
* @param Delegate $postBody
* @param array $optParams Optional parameters.
* @return Delegate
* @throws \Google\Service\Exception
*/
public function create($userId, Delegate $postBody, $optParams = [])
{
$params = ['userId' => $userId, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('create', [$params], Delegate::class);
}
/**
* Removes the specified delegate (which can be of any verification status), and
* revokes any verification that may have been required for using it. Note that
* a delegate user must be referred to by their primary email address, and not
* an email alias. This method is only available to service account clients that
* have been delegated domain-wide authority. (delegates.delete)
*
* @param string $userId User's email address. The special value "me" can be
* used to indicate the authenticated user.
* @param string $delegateEmail The email address of the user to be removed as a
* delegate.
* @param array $optParams Optional parameters.
* @throws \Google\Service\Exception
*/
public function delete($userId, $delegateEmail, $optParams = [])
{
$params = ['userId' => $userId, 'delegateEmail' => $delegateEmail];
$params = array_merge($params, $optParams);
return $this->call('delete', [$params]);
}
/**
* Gets the specified delegate. Note that a delegate user must be referred to by
* their primary email address, and not an email alias. This method is only
* available to service account clients that have been delegated domain-wide
* authority. (delegates.get)
*
* @param string $userId User's email address. The special value "me" can be
* used to indicate the authenticated user.
* @param string $delegateEmail The email address of the user whose delegate
* relationship is to be retrieved.
* @param array $optParams Optional parameters.
* @return Delegate
* @throws \Google\Service\Exception
*/
public function get($userId, $delegateEmail, $optParams = [])
{
$params = ['userId' => $userId, 'delegateEmail' => $delegateEmail];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], Delegate::class);
}
/**
* Lists the delegates for the specified account. This method is only available
* to service account clients that have been delegated domain-wide authority.
* (delegates.listUsersSettingsDelegates)
*
* @param string $userId User's email address. The special value "me" can be
* used to indicate the authenticated user.
* @param array $optParams Optional parameters.
* @return ListDelegatesResponse
* @throws \Google\Service\Exception
*/
public function listUsersSettingsDelegates($userId, $optParams = [])
{
$params = ['userId' => $userId];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListDelegatesResponse::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(UsersSettingsDelegates::class, 'Google_Service_Gmail_Resource_UsersSettingsDelegates');

View File

@@ -0,0 +1,99 @@
<?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.
*/
namespace Google\Service\Gmail\Resource;
use Google\Service\Gmail\Filter;
use Google\Service\Gmail\ListFiltersResponse;
/**
* The "filters" collection of methods.
* Typical usage is:
* <code>
* $gmailService = new Google\Service\Gmail(...);
* $filters = $gmailService->users_settings_filters;
* </code>
*/
class UsersSettingsFilters extends \Google\Service\Resource
{
/**
* Creates a filter. Note: you can only create a maximum of 1,000 filters.
* (filters.create)
*
* @param string $userId User's email address. The special value "me" can be
* used to indicate the authenticated user.
* @param Filter $postBody
* @param array $optParams Optional parameters.
* @return Filter
* @throws \Google\Service\Exception
*/
public function create($userId, Filter $postBody, $optParams = [])
{
$params = ['userId' => $userId, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('create', [$params], Filter::class);
}
/**
* Immediately and permanently deletes the specified filter. (filters.delete)
*
* @param string $userId User's email address. The special value "me" can be
* used to indicate the authenticated user.
* @param string $id The ID of the filter to be deleted.
* @param array $optParams Optional parameters.
* @throws \Google\Service\Exception
*/
public function delete($userId, $id, $optParams = [])
{
$params = ['userId' => $userId, 'id' => $id];
$params = array_merge($params, $optParams);
return $this->call('delete', [$params]);
}
/**
* Gets a filter. (filters.get)
*
* @param string $userId User's email address. The special value "me" can be
* used to indicate the authenticated user.
* @param string $id The ID of the filter to be fetched.
* @param array $optParams Optional parameters.
* @return Filter
* @throws \Google\Service\Exception
*/
public function get($userId, $id, $optParams = [])
{
$params = ['userId' => $userId, 'id' => $id];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], Filter::class);
}
/**
* Lists the message filters of a Gmail user. (filters.listUsersSettingsFilters)
*
* @param string $userId User's email address. The special value "me" can be
* used to indicate the authenticated user.
* @param array $optParams Optional parameters.
* @return ListFiltersResponse
* @throws \Google\Service\Exception
*/
public function listUsersSettingsFilters($userId, $optParams = [])
{
$params = ['userId' => $userId];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListFiltersResponse::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(UsersSettingsFilters::class, 'Google_Service_Gmail_Resource_UsersSettingsFilters');

View File

@@ -0,0 +1,107 @@
<?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.
*/
namespace Google\Service\Gmail\Resource;
use Google\Service\Gmail\ForwardingAddress;
use Google\Service\Gmail\ListForwardingAddressesResponse;
/**
* The "forwardingAddresses" collection of methods.
* Typical usage is:
* <code>
* $gmailService = new Google\Service\Gmail(...);
* $forwardingAddresses = $gmailService->users_settings_forwardingAddresses;
* </code>
*/
class UsersSettingsForwardingAddresses extends \Google\Service\Resource
{
/**
* Creates a forwarding address. If ownership verification is required, a
* message will be sent to the recipient and the resource's verification status
* will be set to `pending`; otherwise, the resource will be created with
* verification status set to `accepted`. This method is only available to
* service account clients that have been delegated domain-wide authority.
* (forwardingAddresses.create)
*
* @param string $userId User's email address. The special value "me" can be
* used to indicate the authenticated user.
* @param ForwardingAddress $postBody
* @param array $optParams Optional parameters.
* @return ForwardingAddress
* @throws \Google\Service\Exception
*/
public function create($userId, ForwardingAddress $postBody, $optParams = [])
{
$params = ['userId' => $userId, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('create', [$params], ForwardingAddress::class);
}
/**
* Deletes the specified forwarding address and revokes any verification that
* may have been required. This method is only available to service account
* clients that have been delegated domain-wide authority.
* (forwardingAddresses.delete)
*
* @param string $userId User's email address. The special value "me" can be
* used to indicate the authenticated user.
* @param string $forwardingEmail The forwarding address to be deleted.
* @param array $optParams Optional parameters.
* @throws \Google\Service\Exception
*/
public function delete($userId, $forwardingEmail, $optParams = [])
{
$params = ['userId' => $userId, 'forwardingEmail' => $forwardingEmail];
$params = array_merge($params, $optParams);
return $this->call('delete', [$params]);
}
/**
* Gets the specified forwarding address. (forwardingAddresses.get)
*
* @param string $userId User's email address. The special value "me" can be
* used to indicate the authenticated user.
* @param string $forwardingEmail The forwarding address to be retrieved.
* @param array $optParams Optional parameters.
* @return ForwardingAddress
* @throws \Google\Service\Exception
*/
public function get($userId, $forwardingEmail, $optParams = [])
{
$params = ['userId' => $userId, 'forwardingEmail' => $forwardingEmail];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], ForwardingAddress::class);
}
/**
* Lists the forwarding addresses for the specified account.
* (forwardingAddresses.listUsersSettingsForwardingAddresses)
*
* @param string $userId User's email address. The special value "me" can be
* used to indicate the authenticated user.
* @param array $optParams Optional parameters.
* @return ListForwardingAddressesResponse
* @throws \Google\Service\Exception
*/
public function listUsersSettingsForwardingAddresses($userId, $optParams = [])
{
$params = ['userId' => $userId];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListForwardingAddressesResponse::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(UsersSettingsForwardingAddresses::class, 'Google_Service_Gmail_Resource_UsersSettingsForwardingAddresses');

View File

@@ -0,0 +1,166 @@
<?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.
*/
namespace Google\Service\Gmail\Resource;
use Google\Service\Gmail\ListSendAsResponse;
use Google\Service\Gmail\SendAs;
/**
* The "sendAs" collection of methods.
* Typical usage is:
* <code>
* $gmailService = new Google\Service\Gmail(...);
* $sendAs = $gmailService->users_settings_sendAs;
* </code>
*/
class UsersSettingsSendAs extends \Google\Service\Resource
{
/**
* Creates a custom "from" send-as alias. If an SMTP MSA is specified, Gmail
* will attempt to connect to the SMTP service to validate the configuration
* before creating the alias. If ownership verification is required for the
* alias, a message will be sent to the email address and the resource's
* verification status will be set to `pending`; otherwise, the resource will be
* created with verification status set to `accepted`. If a signature is
* provided, Gmail will sanitize the HTML before saving it with the alias. This
* method is only available to service account clients that have been delegated
* domain-wide authority. (sendAs.create)
*
* @param string $userId User's email address. The special value "me" can be
* used to indicate the authenticated user.
* @param SendAs $postBody
* @param array $optParams Optional parameters.
* @return SendAs
* @throws \Google\Service\Exception
*/
public function create($userId, SendAs $postBody, $optParams = [])
{
$params = ['userId' => $userId, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('create', [$params], SendAs::class);
}
/**
* Deletes the specified send-as alias. Revokes any verification that may have
* been required for using it. This method is only available to service account
* clients that have been delegated domain-wide authority. (sendAs.delete)
*
* @param string $userId User's email address. The special value "me" can be
* used to indicate the authenticated user.
* @param string $sendAsEmail The send-as alias to be deleted.
* @param array $optParams Optional parameters.
* @throws \Google\Service\Exception
*/
public function delete($userId, $sendAsEmail, $optParams = [])
{
$params = ['userId' => $userId, 'sendAsEmail' => $sendAsEmail];
$params = array_merge($params, $optParams);
return $this->call('delete', [$params]);
}
/**
* Gets the specified send-as alias. Fails with an HTTP 404 error if the
* specified address is not a member of the collection. (sendAs.get)
*
* @param string $userId User's email address. The special value "me" can be
* used to indicate the authenticated user.
* @param string $sendAsEmail The send-as alias to be retrieved.
* @param array $optParams Optional parameters.
* @return SendAs
* @throws \Google\Service\Exception
*/
public function get($userId, $sendAsEmail, $optParams = [])
{
$params = ['userId' => $userId, 'sendAsEmail' => $sendAsEmail];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], SendAs::class);
}
/**
* Lists the send-as aliases for the specified account. The result includes the
* primary send-as address associated with the account as well as any custom
* "from" aliases. (sendAs.listUsersSettingsSendAs)
*
* @param string $userId User's email address. The special value "me" can be
* used to indicate the authenticated user.
* @param array $optParams Optional parameters.
* @return ListSendAsResponse
* @throws \Google\Service\Exception
*/
public function listUsersSettingsSendAs($userId, $optParams = [])
{
$params = ['userId' => $userId];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListSendAsResponse::class);
}
/**
* Patch the specified send-as alias. (sendAs.patch)
*
* @param string $userId User's email address. The special value "me" can be
* used to indicate the authenticated user.
* @param string $sendAsEmail The send-as alias to be updated.
* @param SendAs $postBody
* @param array $optParams Optional parameters.
* @return SendAs
* @throws \Google\Service\Exception
*/
public function patch($userId, $sendAsEmail, SendAs $postBody, $optParams = [])
{
$params = ['userId' => $userId, 'sendAsEmail' => $sendAsEmail, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('patch', [$params], SendAs::class);
}
/**
* Updates a send-as alias. If a signature is provided, Gmail will sanitize the
* HTML before saving it with the alias. Addresses other than the primary
* address for the account can only be updated by service account clients that
* have been delegated domain-wide authority. (sendAs.update)
*
* @param string $userId User's email address. The special value "me" can be
* used to indicate the authenticated user.
* @param string $sendAsEmail The send-as alias to be updated.
* @param SendAs $postBody
* @param array $optParams Optional parameters.
* @return SendAs
* @throws \Google\Service\Exception
*/
public function update($userId, $sendAsEmail, SendAs $postBody, $optParams = [])
{
$params = ['userId' => $userId, 'sendAsEmail' => $sendAsEmail, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('update', [$params], SendAs::class);
}
/**
* Sends a verification email to the specified send-as alias address. The
* verification status must be `pending`. This method is only available to
* service account clients that have been delegated domain-wide authority.
* (sendAs.verify)
*
* @param string $userId User's email address. The special value "me" can be
* used to indicate the authenticated user.
* @param string $sendAsEmail The send-as alias to be verified.
* @param array $optParams Optional parameters.
* @throws \Google\Service\Exception
*/
public function verify($userId, $sendAsEmail, $optParams = [])
{
$params = ['userId' => $userId, 'sendAsEmail' => $sendAsEmail];
$params = array_merge($params, $optParams);
return $this->call('verify', [$params]);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(UsersSettingsSendAs::class, 'Google_Service_Gmail_Resource_UsersSettingsSendAs');

View File

@@ -0,0 +1,128 @@
<?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.
*/
namespace Google\Service\Gmail\Resource;
use Google\Service\Gmail\ListSmimeInfoResponse;
use Google\Service\Gmail\SmimeInfo;
/**
* The "smimeInfo" collection of methods.
* Typical usage is:
* <code>
* $gmailService = new Google\Service\Gmail(...);
* $smimeInfo = $gmailService->users_settings_sendAs_smimeInfo;
* </code>
*/
class UsersSettingsSendAsSmimeInfo extends \Google\Service\Resource
{
/**
* Deletes the specified S/MIME config for the specified send-as alias.
* (smimeInfo.delete)
*
* @param string $userId The user's email address. The special value `me` can be
* used to indicate the authenticated user.
* @param string $sendAsEmail The email address that appears in the "From:"
* header for mail sent using this alias.
* @param string $id The immutable ID for the SmimeInfo.
* @param array $optParams Optional parameters.
* @throws \Google\Service\Exception
*/
public function delete($userId, $sendAsEmail, $id, $optParams = [])
{
$params = ['userId' => $userId, 'sendAsEmail' => $sendAsEmail, 'id' => $id];
$params = array_merge($params, $optParams);
return $this->call('delete', [$params]);
}
/**
* Gets the specified S/MIME config for the specified send-as alias.
* (smimeInfo.get)
*
* @param string $userId The user's email address. The special value `me` can be
* used to indicate the authenticated user.
* @param string $sendAsEmail The email address that appears in the "From:"
* header for mail sent using this alias.
* @param string $id The immutable ID for the SmimeInfo.
* @param array $optParams Optional parameters.
* @return SmimeInfo
* @throws \Google\Service\Exception
*/
public function get($userId, $sendAsEmail, $id, $optParams = [])
{
$params = ['userId' => $userId, 'sendAsEmail' => $sendAsEmail, 'id' => $id];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], SmimeInfo::class);
}
/**
* Insert (upload) the given S/MIME config for the specified send-as alias. Note
* that pkcs12 format is required for the key. (smimeInfo.insert)
*
* @param string $userId The user's email address. The special value `me` can be
* used to indicate the authenticated user.
* @param string $sendAsEmail The email address that appears in the "From:"
* header for mail sent using this alias.
* @param SmimeInfo $postBody
* @param array $optParams Optional parameters.
* @return SmimeInfo
* @throws \Google\Service\Exception
*/
public function insert($userId, $sendAsEmail, SmimeInfo $postBody, $optParams = [])
{
$params = ['userId' => $userId, 'sendAsEmail' => $sendAsEmail, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('insert', [$params], SmimeInfo::class);
}
/**
* Lists S/MIME configs for the specified send-as alias.
* (smimeInfo.listUsersSettingsSendAsSmimeInfo)
*
* @param string $userId The user's email address. The special value `me` can be
* used to indicate the authenticated user.
* @param string $sendAsEmail The email address that appears in the "From:"
* header for mail sent using this alias.
* @param array $optParams Optional parameters.
* @return ListSmimeInfoResponse
* @throws \Google\Service\Exception
*/
public function listUsersSettingsSendAsSmimeInfo($userId, $sendAsEmail, $optParams = [])
{
$params = ['userId' => $userId, 'sendAsEmail' => $sendAsEmail];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListSmimeInfoResponse::class);
}
/**
* Sets the default S/MIME config for the specified send-as alias.
* (smimeInfo.setDefault)
*
* @param string $userId The user's email address. The special value `me` can be
* used to indicate the authenticated user.
* @param string $sendAsEmail The email address that appears in the "From:"
* header for mail sent using this alias.
* @param string $id The immutable ID for the SmimeInfo.
* @param array $optParams Optional parameters.
* @throws \Google\Service\Exception
*/
public function setDefault($userId, $sendAsEmail, $id, $optParams = [])
{
$params = ['userId' => $userId, 'sendAsEmail' => $sendAsEmail, 'id' => $id];
$params = array_merge($params, $optParams);
return $this->call('setDefault', [$params]);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(UsersSettingsSendAsSmimeInfo::class, 'Google_Service_Gmail_Resource_UsersSettingsSendAsSmimeInfo');

View File

@@ -0,0 +1,154 @@
<?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.
*/
namespace Google\Service\Gmail\Resource;
use Google\Service\Gmail\ListThreadsResponse;
use Google\Service\Gmail\ModifyThreadRequest;
use Google\Service\Gmail\Thread;
/**
* The "threads" collection of methods.
* Typical usage is:
* <code>
* $gmailService = new Google\Service\Gmail(...);
* $threads = $gmailService->users_threads;
* </code>
*/
class UsersThreads extends \Google\Service\Resource
{
/**
* Immediately and permanently deletes the specified thread. Any messages that
* belong to the thread are also deleted. This operation cannot be undone.
* Prefer `threads.trash` instead. (threads.delete)
*
* @param string $userId The user's email address. The special value `me` can be
* used to indicate the authenticated user.
* @param string $id ID of the Thread to delete.
* @param array $optParams Optional parameters.
* @throws \Google\Service\Exception
*/
public function delete($userId, $id, $optParams = [])
{
$params = ['userId' => $userId, 'id' => $id];
$params = array_merge($params, $optParams);
return $this->call('delete', [$params]);
}
/**
* Gets the specified thread. (threads.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 thread to retrieve.
* @param array $optParams Optional parameters.
*
* @opt_param string format The format to return the messages in.
* @opt_param string metadataHeaders When given and format is METADATA, only
* include headers specified.
* @return Thread
* @throws \Google\Service\Exception
*/
public function get($userId, $id, $optParams = [])
{
$params = ['userId' => $userId, 'id' => $id];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], Thread::class);
}
/**
* Lists the threads in the user's mailbox. (threads.listUsersThreads)
*
* @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.
*
* @opt_param bool includeSpamTrash Include threads from `SPAM` and `TRASH` in
* the results.
* @opt_param string labelIds Only return threads with labels that match all of
* the specified label IDs.
* @opt_param string maxResults Maximum number of threads to return. This field
* defaults to 100. The maximum allowed value for this field is 500.
* @opt_param string pageToken Page token to retrieve a specific page of results
* in the list.
* @opt_param string q Only return threads matching the specified query.
* Supports the same query format as the Gmail search box. For example,
* `"from:someuser@example.com rfc822msgid: is:unread"`. Parameter cannot be
* used when accessing the api using the gmail.metadata scope.
* @return ListThreadsResponse
* @throws \Google\Service\Exception
*/
public function listUsersThreads($userId, $optParams = [])
{
$params = ['userId' => $userId];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListThreadsResponse::class);
}
/**
* Modifies the labels applied to the thread. This applies to all messages in
* the thread. (threads.modify)
*
* @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 thread to modify.
* @param ModifyThreadRequest $postBody
* @param array $optParams Optional parameters.
* @return Thread
* @throws \Google\Service\Exception
*/
public function modify($userId, $id, ModifyThreadRequest $postBody, $optParams = [])
{
$params = ['userId' => $userId, 'id' => $id, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('modify', [$params], Thread::class);
}
/**
* Moves the specified thread to the trash. Any messages that belong to the
* thread are also moved to the trash. (threads.trash)
*
* @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 thread to Trash.
* @param array $optParams Optional parameters.
* @return Thread
* @throws \Google\Service\Exception
*/
public function trash($userId, $id, $optParams = [])
{
$params = ['userId' => $userId, 'id' => $id];
$params = array_merge($params, $optParams);
return $this->call('trash', [$params], Thread::class);
}
/**
* Removes the specified thread from the trash. Any messages that belong to the
* thread are also removed from the trash. (threads.untrash)
*
* @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 thread to remove from Trash.
* @param array $optParams Optional parameters.
* @return Thread
* @throws \Google\Service\Exception
*/
public function untrash($userId, $id, $optParams = [])
{
$params = ['userId' => $userId, 'id' => $id];
$params = array_merge($params, $optParams);
return $this->call('untrash', [$params], Thread::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(UsersThreads::class, 'Google_Service_Gmail_Resource_UsersThreads');

View File

@@ -0,0 +1,273 @@
<?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.
*/
namespace Google\Service\Gmail;
class SendAs extends \Google\Model
{
/**
* Unspecified verification status.
*/
public const VERIFICATION_STATUS_verificationStatusUnspecified = 'verificationStatusUnspecified';
/**
* The address is ready to use as a send-as alias.
*/
public const VERIFICATION_STATUS_accepted = 'accepted';
/**
* The address is awaiting verification by the owner.
*/
public const VERIFICATION_STATUS_pending = 'pending';
/**
* A name that appears in the "From:" header for mail sent using this alias.
* For custom "from" addresses, when this is empty, Gmail will populate the
* "From:" header with the name that is used for the primary address
* associated with the account. If the admin has disabled the ability for
* users to update their name format, requests to update this field for the
* primary login will silently fail.
*
* @var string
*/
public $displayName;
/**
* Whether this address is selected as the default "From:" address in
* situations such as composing a new message or sending a vacation auto-
* reply. Every Gmail account has exactly one default send-as address, so the
* only legal value that clients may write to this field is `true`. Changing
* this from `false` to `true` for an address will result in this field
* becoming `false` for the other previous default address.
*
* @var bool
*/
public $isDefault;
/**
* Whether this address is the primary address used to login to the account.
* Every Gmail account has exactly one primary address, and it cannot be
* deleted from the collection of send-as aliases. This field is read-only.
*
* @var bool
*/
public $isPrimary;
/**
* An optional email address that is included in a "Reply-To:" header for mail
* sent using this alias. If this is empty, Gmail will not generate a "Reply-
* To:" header.
*
* @var string
*/
public $replyToAddress;
/**
* The email address that appears in the "From:" header for mail sent using
* this alias. This is read-only for all operations except create.
*
* @var string
*/
public $sendAsEmail;
/**
* An optional HTML signature that is included in messages composed with this
* alias in the Gmail web UI. This signature is added to new emails only.
*
* @var string
*/
public $signature;
protected $smtpMsaType = SmtpMsa::class;
protected $smtpMsaDataType = '';
/**
* Whether Gmail should treat this address as an alias for the user's primary
* email address. This setting only applies to custom "from" aliases.
*
* @var bool
*/
public $treatAsAlias;
/**
* Indicates whether this address has been verified for use as a send-as
* alias. Read-only. This setting only applies to custom "from" aliases.
*
* @var string
*/
public $verificationStatus;
/**
* A name that appears in the "From:" header for mail sent using this alias.
* For custom "from" addresses, when this is empty, Gmail will populate the
* "From:" header with the name that is used for the primary address
* associated with the account. If the admin has disabled the ability for
* users to update their name format, requests to update this field for the
* primary login will silently fail.
*
* @param string $displayName
*/
public function setDisplayName($displayName)
{
$this->displayName = $displayName;
}
/**
* @return string
*/
public function getDisplayName()
{
return $this->displayName;
}
/**
* Whether this address is selected as the default "From:" address in
* situations such as composing a new message or sending a vacation auto-
* reply. Every Gmail account has exactly one default send-as address, so the
* only legal value that clients may write to this field is `true`. Changing
* this from `false` to `true` for an address will result in this field
* becoming `false` for the other previous default address.
*
* @param bool $isDefault
*/
public function setIsDefault($isDefault)
{
$this->isDefault = $isDefault;
}
/**
* @return bool
*/
public function getIsDefault()
{
return $this->isDefault;
}
/**
* Whether this address is the primary address used to login to the account.
* Every Gmail account has exactly one primary address, and it cannot be
* deleted from the collection of send-as aliases. This field is read-only.
*
* @param bool $isPrimary
*/
public function setIsPrimary($isPrimary)
{
$this->isPrimary = $isPrimary;
}
/**
* @return bool
*/
public function getIsPrimary()
{
return $this->isPrimary;
}
/**
* An optional email address that is included in a "Reply-To:" header for mail
* sent using this alias. If this is empty, Gmail will not generate a "Reply-
* To:" header.
*
* @param string $replyToAddress
*/
public function setReplyToAddress($replyToAddress)
{
$this->replyToAddress = $replyToAddress;
}
/**
* @return string
*/
public function getReplyToAddress()
{
return $this->replyToAddress;
}
/**
* The email address that appears in the "From:" header for mail sent using
* this alias. This is read-only for all operations except create.
*
* @param string $sendAsEmail
*/
public function setSendAsEmail($sendAsEmail)
{
$this->sendAsEmail = $sendAsEmail;
}
/**
* @return string
*/
public function getSendAsEmail()
{
return $this->sendAsEmail;
}
/**
* An optional HTML signature that is included in messages composed with this
* alias in the Gmail web UI. This signature is added to new emails only.
*
* @param string $signature
*/
public function setSignature($signature)
{
$this->signature = $signature;
}
/**
* @return string
*/
public function getSignature()
{
return $this->signature;
}
/**
* An optional SMTP service that will be used as an outbound relay for mail
* sent using this alias. If this is empty, outbound mail will be sent
* directly from Gmail's servers to the destination SMTP service. This setting
* only applies to custom "from" aliases.
*
* @param SmtpMsa $smtpMsa
*/
public function setSmtpMsa(SmtpMsa $smtpMsa)
{
$this->smtpMsa = $smtpMsa;
}
/**
* @return SmtpMsa
*/
public function getSmtpMsa()
{
return $this->smtpMsa;
}
/**
* Whether Gmail should treat this address as an alias for the user's primary
* email address. This setting only applies to custom "from" aliases.
*
* @param bool $treatAsAlias
*/
public function setTreatAsAlias($treatAsAlias)
{
$this->treatAsAlias = $treatAsAlias;
}
/**
* @return bool
*/
public function getTreatAsAlias()
{
return $this->treatAsAlias;
}
/**
* Indicates whether this address has been verified for use as a send-as
* alias. Read-only. This setting only applies to custom "from" aliases.
*
* Accepted values: verificationStatusUnspecified, accepted, pending
*
* @param self::VERIFICATION_STATUS_* $verificationStatus
*/
public function setVerificationStatus($verificationStatus)
{
$this->verificationStatus = $verificationStatus;
}
/**
* @return self::VERIFICATION_STATUS_*
*/
public function getVerificationStatus()
{
return $this->verificationStatus;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(SendAs::class, 'Google_Service_Gmail_SendAs');

View File

@@ -0,0 +1,70 @@
<?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.
*/
namespace Google\Service\Gmail;
class SignAndEncryptKeyPairs extends \Google\Model
{
/**
* The ID of the CseKeyPair that encrypts signed outgoing mail.
*
* @var string
*/
public $encryptionKeyPairId;
/**
* The ID of the CseKeyPair that signs outgoing mail.
*
* @var string
*/
public $signingKeyPairId;
/**
* The ID of the CseKeyPair that encrypts signed outgoing mail.
*
* @param string $encryptionKeyPairId
*/
public function setEncryptionKeyPairId($encryptionKeyPairId)
{
$this->encryptionKeyPairId = $encryptionKeyPairId;
}
/**
* @return string
*/
public function getEncryptionKeyPairId()
{
return $this->encryptionKeyPairId;
}
/**
* The ID of the CseKeyPair that signs outgoing mail.
*
* @param string $signingKeyPairId
*/
public function setSigningKeyPairId($signingKeyPairId)
{
$this->signingKeyPairId = $signingKeyPairId;
}
/**
* @return string
*/
public function getSigningKeyPairId()
{
return $this->signingKeyPairId;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(SignAndEncryptKeyPairs::class, 'Google_Service_Gmail_SignAndEncryptKeyPairs');

View File

@@ -0,0 +1,192 @@
<?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.
*/
namespace Google\Service\Gmail;
class SmimeInfo extends \Google\Model
{
/**
* Encrypted key password, when key is encrypted.
*
* @var string
*/
public $encryptedKeyPassword;
/**
* When the certificate expires (in milliseconds since epoch).
*
* @var string
*/
public $expiration;
/**
* The immutable ID for the SmimeInfo.
*
* @var string
*/
public $id;
/**
* Whether this SmimeInfo is the default one for this user's send-as address.
*
* @var bool
*/
public $isDefault;
/**
* The S/MIME certificate issuer's common name.
*
* @var string
*/
public $issuerCn;
/**
* PEM formatted X509 concatenated certificate string (standard base64
* encoding). Format used for returning key, which includes public key as well
* as certificate chain (not private key).
*
* @var string
*/
public $pem;
/**
* PKCS#12 format containing a single private/public key pair and certificate
* chain. This format is only accepted from client for creating a new
* SmimeInfo and is never returned, because the private key is not intended to
* be exported. PKCS#12 may be encrypted, in which case encryptedKeyPassword
* should be set appropriately.
*
* @var string
*/
public $pkcs12;
/**
* Encrypted key password, when key is encrypted.
*
* @param string $encryptedKeyPassword
*/
public function setEncryptedKeyPassword($encryptedKeyPassword)
{
$this->encryptedKeyPassword = $encryptedKeyPassword;
}
/**
* @return string
*/
public function getEncryptedKeyPassword()
{
return $this->encryptedKeyPassword;
}
/**
* When the certificate expires (in milliseconds since epoch).
*
* @param string $expiration
*/
public function setExpiration($expiration)
{
$this->expiration = $expiration;
}
/**
* @return string
*/
public function getExpiration()
{
return $this->expiration;
}
/**
* The immutable ID for the SmimeInfo.
*
* @param string $id
*/
public function setId($id)
{
$this->id = $id;
}
/**
* @return string
*/
public function getId()
{
return $this->id;
}
/**
* Whether this SmimeInfo is the default one for this user's send-as address.
*
* @param bool $isDefault
*/
public function setIsDefault($isDefault)
{
$this->isDefault = $isDefault;
}
/**
* @return bool
*/
public function getIsDefault()
{
return $this->isDefault;
}
/**
* The S/MIME certificate issuer's common name.
*
* @param string $issuerCn
*/
public function setIssuerCn($issuerCn)
{
$this->issuerCn = $issuerCn;
}
/**
* @return string
*/
public function getIssuerCn()
{
return $this->issuerCn;
}
/**
* PEM formatted X509 concatenated certificate string (standard base64
* encoding). Format used for returning key, which includes public key as well
* as certificate chain (not private key).
*
* @param string $pem
*/
public function setPem($pem)
{
$this->pem = $pem;
}
/**
* @return string
*/
public function getPem()
{
return $this->pem;
}
/**
* PKCS#12 format containing a single private/public key pair and certificate
* chain. This format is only accepted from client for creating a new
* SmimeInfo and is never returned, because the private key is not intended to
* be exported. PKCS#12 may be encrypted, in which case encryptedKeyPassword
* should be set appropriately.
*
* @param string $pkcs12
*/
public function setPkcs12($pkcs12)
{
$this->pkcs12 = $pkcs12;
}
/**
* @return string
*/
public function getPkcs12()
{
return $this->pkcs12;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(SmimeInfo::class, 'Google_Service_Gmail_SmimeInfo');

View File

@@ -0,0 +1,164 @@
<?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.
*/
namespace Google\Service\Gmail;
class SmtpMsa extends \Google\Model
{
/**
* Unspecified security mode.
*/
public const SECURITY_MODE_securityModeUnspecified = 'securityModeUnspecified';
/**
* Communication with the remote SMTP service is unsecured. Requires port 25.
*/
public const SECURITY_MODE_none = 'none';
/**
* Communication with the remote SMTP service is secured using SSL.
*/
public const SECURITY_MODE_ssl = 'ssl';
/**
* Communication with the remote SMTP service is secured using STARTTLS.
*/
public const SECURITY_MODE_starttls = 'starttls';
/**
* The hostname of the SMTP service. Required.
*
* @var string
*/
public $host;
/**
* The password that will be used for authentication with the SMTP service.
* This is a write-only field that can be specified in requests to create or
* update SendAs settings; it is never populated in responses.
*
* @var string
*/
public $password;
/**
* The port of the SMTP service. Required.
*
* @var int
*/
public $port;
/**
* The protocol that will be used to secure communication with the SMTP
* service. Required.
*
* @var string
*/
public $securityMode;
/**
* The username that will be used for authentication with the SMTP service.
* This is a write-only field that can be specified in requests to create or
* update SendAs settings; it is never populated in responses.
*
* @var string
*/
public $username;
/**
* The hostname of the SMTP service. Required.
*
* @param string $host
*/
public function setHost($host)
{
$this->host = $host;
}
/**
* @return string
*/
public function getHost()
{
return $this->host;
}
/**
* The password that will be used for authentication with the SMTP service.
* This is a write-only field that can be specified in requests to create or
* update SendAs settings; it is never populated in responses.
*
* @param string $password
*/
public function setPassword($password)
{
$this->password = $password;
}
/**
* @return string
*/
public function getPassword()
{
return $this->password;
}
/**
* The port of the SMTP service. Required.
*
* @param int $port
*/
public function setPort($port)
{
$this->port = $port;
}
/**
* @return int
*/
public function getPort()
{
return $this->port;
}
/**
* The protocol that will be used to secure communication with the SMTP
* service. Required.
*
* Accepted values: securityModeUnspecified, none, ssl, starttls
*
* @param self::SECURITY_MODE_* $securityMode
*/
public function setSecurityMode($securityMode)
{
$this->securityMode = $securityMode;
}
/**
* @return self::SECURITY_MODE_*
*/
public function getSecurityMode()
{
return $this->securityMode;
}
/**
* The username that will be used for authentication with the SMTP service.
* This is a write-only field that can be specified in requests to create or
* update SendAs settings; it is never populated in responses.
*
* @param string $username
*/
public function setUsername($username)
{
$this->username = $username;
}
/**
* @return string
*/
public function getUsername()
{
return $this->username;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(SmtpMsa::class, 'Google_Service_Gmail_SmtpMsa');

View File

@@ -0,0 +1,111 @@
<?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.
*/
namespace Google\Service\Gmail;
class Thread extends \Google\Collection
{
protected $collection_key = 'messages';
/**
* The ID of the last history record that modified this thread.
*
* @var string
*/
public $historyId;
/**
* The unique ID of the thread.
*
* @var string
*/
public $id;
protected $messagesType = Message::class;
protected $messagesDataType = 'array';
/**
* A short part of the message text.
*
* @var string
*/
public $snippet;
/**
* The ID of the last history record that modified this thread.
*
* @param string $historyId
*/
public function setHistoryId($historyId)
{
$this->historyId = $historyId;
}
/**
* @return string
*/
public function getHistoryId()
{
return $this->historyId;
}
/**
* The unique ID of the thread.
*
* @param string $id
*/
public function setId($id)
{
$this->id = $id;
}
/**
* @return string
*/
public function getId()
{
return $this->id;
}
/**
* The list of messages in the thread.
*
* @param Message[] $messages
*/
public function setMessages($messages)
{
$this->messages = $messages;
}
/**
* @return Message[]
*/
public function getMessages()
{
return $this->messages;
}
/**
* A short part of the message text.
*
* @param string $snippet
*/
public function setSnippet($snippet)
{
$this->snippet = $snippet;
}
/**
* @return string
*/
public function getSnippet()
{
return $this->snippet;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Thread::class, 'Google_Service_Gmail_Thread');

View File

@@ -0,0 +1,230 @@
<?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.
*/
namespace Google\Service\Gmail;
class VacationSettings extends \Google\Model
{
/**
* Flag that controls whether Gmail automatically replies to messages.
*
* @var bool
*/
public $enableAutoReply;
/**
* An optional end time for sending auto-replies (epoch ms). When this is
* specified, Gmail will automatically reply only to messages that it receives
* before the end time. If both `startTime` and `endTime` are specified,
* `startTime` must precede `endTime`.
*
* @var string
*/
public $endTime;
/**
* Response body in HTML format. Gmail will sanitize the HTML before storing
* it. If both `response_body_plain_text` and `response_body_html` are
* specified, `response_body_html` will be used.
*
* @var string
*/
public $responseBodyHtml;
/**
* Response body in plain text format. If both `response_body_plain_text` and
* `response_body_html` are specified, `response_body_html` will be used.
*
* @var string
*/
public $responseBodyPlainText;
/**
* Optional text to prepend to the subject line in vacation responses. In
* order to enable auto-replies, either the response subject or the response
* body must be nonempty.
*
* @var string
*/
public $responseSubject;
/**
* Flag that determines whether responses are sent to recipients who are not
* in the user's list of contacts.
*
* @var bool
*/
public $restrictToContacts;
/**
* Flag that determines whether responses are sent to recipients who are
* outside of the user's domain. This feature is only available for Google
* Workspace users.
*
* @var bool
*/
public $restrictToDomain;
/**
* An optional start time for sending auto-replies (epoch ms). When this is
* specified, Gmail will automatically reply only to messages that it receives
* after the start time. If both `startTime` and `endTime` are specified,
* `startTime` must precede `endTime`.
*
* @var string
*/
public $startTime;
/**
* Flag that controls whether Gmail automatically replies to messages.
*
* @param bool $enableAutoReply
*/
public function setEnableAutoReply($enableAutoReply)
{
$this->enableAutoReply = $enableAutoReply;
}
/**
* @return bool
*/
public function getEnableAutoReply()
{
return $this->enableAutoReply;
}
/**
* An optional end time for sending auto-replies (epoch ms). When this is
* specified, Gmail will automatically reply only to messages that it receives
* before the end time. If both `startTime` and `endTime` are specified,
* `startTime` must precede `endTime`.
*
* @param string $endTime
*/
public function setEndTime($endTime)
{
$this->endTime = $endTime;
}
/**
* @return string
*/
public function getEndTime()
{
return $this->endTime;
}
/**
* Response body in HTML format. Gmail will sanitize the HTML before storing
* it. If both `response_body_plain_text` and `response_body_html` are
* specified, `response_body_html` will be used.
*
* @param string $responseBodyHtml
*/
public function setResponseBodyHtml($responseBodyHtml)
{
$this->responseBodyHtml = $responseBodyHtml;
}
/**
* @return string
*/
public function getResponseBodyHtml()
{
return $this->responseBodyHtml;
}
/**
* Response body in plain text format. If both `response_body_plain_text` and
* `response_body_html` are specified, `response_body_html` will be used.
*
* @param string $responseBodyPlainText
*/
public function setResponseBodyPlainText($responseBodyPlainText)
{
$this->responseBodyPlainText = $responseBodyPlainText;
}
/**
* @return string
*/
public function getResponseBodyPlainText()
{
return $this->responseBodyPlainText;
}
/**
* Optional text to prepend to the subject line in vacation responses. In
* order to enable auto-replies, either the response subject or the response
* body must be nonempty.
*
* @param string $responseSubject
*/
public function setResponseSubject($responseSubject)
{
$this->responseSubject = $responseSubject;
}
/**
* @return string
*/
public function getResponseSubject()
{
return $this->responseSubject;
}
/**
* Flag that determines whether responses are sent to recipients who are not
* in the user's list of contacts.
*
* @param bool $restrictToContacts
*/
public function setRestrictToContacts($restrictToContacts)
{
$this->restrictToContacts = $restrictToContacts;
}
/**
* @return bool
*/
public function getRestrictToContacts()
{
return $this->restrictToContacts;
}
/**
* Flag that determines whether responses are sent to recipients who are
* outside of the user's domain. This feature is only available for Google
* Workspace users.
*
* @param bool $restrictToDomain
*/
public function setRestrictToDomain($restrictToDomain)
{
$this->restrictToDomain = $restrictToDomain;
}
/**
* @return bool
*/
public function getRestrictToDomain()
{
return $this->restrictToDomain;
}
/**
* An optional start time for sending auto-replies (epoch ms). When this is
* specified, Gmail will automatically reply only to messages that it receives
* after the start time. If both `startTime` and `endTime` are specified,
* `startTime` must precede `endTime`.
*
* @param string $startTime
*/
public function setStartTime($startTime)
{
$this->startTime = $startTime;
}
/**
* @return string
*/
public function getStartTime()
{
return $this->startTime;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(VacationSettings::class, 'Google_Service_Gmail_VacationSettings');

View File

@@ -0,0 +1,164 @@
<?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.
*/
namespace Google\Service\Gmail;
class WatchRequest extends \Google\Collection
{
/**
* Only get push notifications for message changes relating to labelIds
* specified.
*/
public const LABEL_FILTER_ACTION_include = 'include';
/**
* Get push notifications for all message changes except those relating to
* labelIds specified.
*/
public const LABEL_FILTER_ACTION_exclude = 'exclude';
/**
* Only get push notifications for message changes relating to labelIds
* specified.
*/
public const LABEL_FILTER_BEHAVIOR_include = 'include';
/**
* Get push notifications for all message changes except those relating to
* labelIds specified.
*/
public const LABEL_FILTER_BEHAVIOR_exclude = 'exclude';
protected $collection_key = 'labelIds';
/**
* Filtering behavior of `labelIds list` specified. This field is deprecated
* because it caused incorrect behavior in some cases; use
* `label_filter_behavior` instead.
*
* @deprecated
* @var string
*/
public $labelFilterAction;
/**
* Filtering behavior of `labelIds list` specified. This field replaces
* `label_filter_action`; if set, `label_filter_action` is ignored.
*
* @var string
*/
public $labelFilterBehavior;
/**
* List of label_ids to restrict notifications about. By default, if
* unspecified, all changes are pushed out. If specified then dictates which
* labels are required for a push notification to be generated.
*
* @var string[]
*/
public $labelIds;
/**
* A fully qualified Google Cloud Pub/Sub API topic name to publish the events
* to. This topic name **must** already exist in Cloud Pub/Sub and you
* **must** have already granted gmail "publish" permission on it. For
* example, "projects/my-project-identifier/topics/my-topic-name" (using the
* Cloud Pub/Sub "v1" topic naming format). Note that the "my-project-
* identifier" portion must exactly match your Google developer project id
* (the one executing this watch request).
*
* @var string
*/
public $topicName;
/**
* Filtering behavior of `labelIds list` specified. This field is deprecated
* because it caused incorrect behavior in some cases; use
* `label_filter_behavior` instead.
*
* Accepted values: include, exclude
*
* @deprecated
* @param self::LABEL_FILTER_ACTION_* $labelFilterAction
*/
public function setLabelFilterAction($labelFilterAction)
{
$this->labelFilterAction = $labelFilterAction;
}
/**
* @deprecated
* @return self::LABEL_FILTER_ACTION_*
*/
public function getLabelFilterAction()
{
return $this->labelFilterAction;
}
/**
* Filtering behavior of `labelIds list` specified. This field replaces
* `label_filter_action`; if set, `label_filter_action` is ignored.
*
* Accepted values: include, exclude
*
* @param self::LABEL_FILTER_BEHAVIOR_* $labelFilterBehavior
*/
public function setLabelFilterBehavior($labelFilterBehavior)
{
$this->labelFilterBehavior = $labelFilterBehavior;
}
/**
* @return self::LABEL_FILTER_BEHAVIOR_*
*/
public function getLabelFilterBehavior()
{
return $this->labelFilterBehavior;
}
/**
* List of label_ids to restrict notifications about. By default, if
* unspecified, all changes are pushed out. If specified then dictates which
* labels are required for a push notification to be generated.
*
* @param string[] $labelIds
*/
public function setLabelIds($labelIds)
{
$this->labelIds = $labelIds;
}
/**
* @return string[]
*/
public function getLabelIds()
{
return $this->labelIds;
}
/**
* A fully qualified Google Cloud Pub/Sub API topic name to publish the events
* to. This topic name **must** already exist in Cloud Pub/Sub and you
* **must** have already granted gmail "publish" permission on it. For
* example, "projects/my-project-identifier/topics/my-topic-name" (using the
* Cloud Pub/Sub "v1" topic naming format). Note that the "my-project-
* identifier" portion must exactly match your Google developer project id
* (the one executing this watch request).
*
* @param string $topicName
*/
public function setTopicName($topicName)
{
$this->topicName = $topicName;
}
/**
* @return string
*/
public function getTopicName()
{
return $this->topicName;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(WatchRequest::class, 'Google_Service_Gmail_WatchRequest');

View File

@@ -0,0 +1,72 @@
<?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.
*/
namespace Google\Service\Gmail;
class WatchResponse extends \Google\Model
{
/**
* When Gmail will stop sending notifications for mailbox updates (epoch
* millis). Call `watch` again before this time to renew the watch.
*
* @var string
*/
public $expiration;
/**
* The ID of the mailbox's current history record.
*
* @var string
*/
public $historyId;
/**
* When Gmail will stop sending notifications for mailbox updates (epoch
* millis). Call `watch` again before this time to renew the watch.
*
* @param string $expiration
*/
public function setExpiration($expiration)
{
$this->expiration = $expiration;
}
/**
* @return string
*/
public function getExpiration()
{
return $this->expiration;
}
/**
* The ID of the mailbox's current history record.
*
* @param string $historyId
*/
public function setHistoryId($historyId)
{
$this->historyId = $historyId;
}
/**
* @return string
*/
public function getHistoryId()
{
return $this->historyId;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(WatchResponse::class, 'Google_Service_Gmail_WatchResponse');

203
vendor/google/apiclient/LICENSE vendored Normal file
View File

@@ -0,0 +1,203 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
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.

7
vendor/google/apiclient/SECURITY.md vendored Normal file
View File

@@ -0,0 +1,7 @@
# Security Policy
To report a security issue, please use [g.co/vulnz](https://g.co/vulnz).
The Google Security Team will respond within 5 working days of your report on g.co/vulnz.
We use g.co/vulnz for our intake, and do coordination and disclosure here using GitHub Security Advisory to privately discuss and fix the issue.

47
vendor/google/apiclient/composer.json vendored Normal file
View File

@@ -0,0 +1,47 @@
{
"name": "google/apiclient",
"type": "library",
"description": "Client library for Google APIs",
"keywords": ["google"],
"homepage": "http://developers.google.com/api-client-library/php",
"license": "Apache-2.0",
"require": {
"php": "^8.1",
"google/auth": "^1.37",
"google/apiclient-services": "~0.350",
"firebase/php-jwt": "^6.0",
"monolog/monolog": "^2.9||^3.0",
"phpseclib/phpseclib": "^3.0.36",
"guzzlehttp/guzzle": "^7.4.5",
"guzzlehttp/psr7": "^2.6"
},
"require-dev": {
"squizlabs/php_codesniffer": "^3.8",
"symfony/dom-crawler": "~2.1",
"symfony/css-selector": "~2.1",
"cache/filesystem-adapter": "^1.1",
"phpcompatibility/php-compatibility": "^9.2",
"composer/composer": "^1.10.23",
"phpspec/prophecy-phpunit": "^2.1",
"phpunit/phpunit": "^9.6"
},
"suggest": {
"cache/filesystem-adapter": "For caching certs and tokens (using Google\\Client::setCache)"
},
"autoload": {
"psr-4": {
"Google\\": "src/"
},
"files": [
"src/aliases.php"
],
"classmap": [
"src/aliases.php"
]
},
"extra": {
"branch-alias": {
"dev-main": "2.x-dev"
}
}
}

View File

@@ -0,0 +1,81 @@
<?php
/*
* Copyright 2008 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.
*/
namespace Google\AccessToken;
use Google\Auth\HttpHandler\HttpHandlerFactory;
use Google\Client;
use GuzzleHttp\ClientInterface;
use GuzzleHttp\Psr7;
use GuzzleHttp\Psr7\Request;
/**
* Wrapper around Google Access Tokens which provides convenience functions
*
*/
class Revoke
{
/**
* @var ClientInterface The http client
*/
private $http;
/**
* Instantiates the class, but does not initiate the login flow, leaving it
* to the discretion of the caller.
*/
public function __construct(?ClientInterface $http = null)
{
$this->http = $http;
}
/**
* Revoke an OAuth2 access token or refresh token. This method will revoke the current access
* token, if a token isn't provided.
*
* @param string|array $token The token (access token or a refresh token) that should be revoked.
* @return boolean Returns True if the revocation was successful, otherwise False.
*/
public function revokeToken($token)
{
if (is_array($token)) {
if (isset($token['refresh_token'])) {
$token = $token['refresh_token'];
} else {
$token = $token['access_token'];
}
}
$body = Psr7\Utils::streamFor(http_build_query(['token' => $token]));
$request = new Request(
'POST',
Client::OAUTH2_REVOKE_URI,
[
'Cache-Control' => 'no-store',
'Content-Type' => 'application/x-www-form-urlencoded',
],
$body
);
$httpHandler = HttpHandlerFactory::build($this->http);
$response = $httpHandler($request);
return $response->getStatusCode() == 200;
}
}

View File

@@ -0,0 +1,264 @@
<?php
/*
* Copyright 2008 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.
*/
namespace Google\AccessToken;
use DateTime;
use DomainException;
use Exception;
use ExpiredException;
use Firebase\JWT\ExpiredException as ExpiredExceptionV3;
use Firebase\JWT\JWT;
use Firebase\JWT\Key;
use Firebase\JWT\SignatureInvalidException;
use Google\Auth\Cache\MemoryCacheItemPool;
use Google\Exception as GoogleException;
use GuzzleHttp\Client;
use GuzzleHttp\ClientInterface;
use InvalidArgumentException;
use LogicException;
use phpseclib3\Crypt\AES;
use phpseclib3\Crypt\PublicKeyLoader;
use phpseclib3\Math\BigInteger;
use Psr\Cache\CacheItemPoolInterface;
/**
* Wrapper around Google Access Tokens which provides convenience functions
*
*/
class Verify
{
const FEDERATED_SIGNON_CERT_URL = 'https://www.googleapis.com/oauth2/v3/certs';
const OAUTH2_ISSUER = 'accounts.google.com';
const OAUTH2_ISSUER_HTTPS = 'https://accounts.google.com';
/**
* @var ClientInterface The http client
*/
private $http;
/**
* @var CacheItemPoolInterface cache class
*/
private $cache;
/**
* @var \Firebase\JWT\JWT
*/
public $jwt;
/**
* Instantiates the class, but does not initiate the login flow, leaving it
* to the discretion of the caller.
*/
public function __construct(
?ClientInterface $http = null,
?CacheItemPoolInterface $cache = null,
?JWT $jwt = null
) {
if (null === $http) {
$http = new Client();
}
if (null === $cache) {
$cache = new MemoryCacheItemPool();
}
$this->http = $http;
$this->cache = $cache;
$this->jwt = $jwt ?: $this->getJwtService();
}
/**
* Verifies an id token and returns the authenticated apiLoginTicket.
* Throws an exception if the id token is not valid.
* The audience parameter can be used to control which id tokens are
* accepted. By default, the id token must have been issued to this OAuth2 client.
*
* @param string $idToken the ID token in JWT format
* @param string $audience Optional. The audience to verify against JWt "aud"
* @return array|false the token payload, if successful
*/
public function verifyIdToken($idToken, $audience = null)
{
if (empty($idToken)) {
throw new LogicException('id_token cannot be null');
}
// set phpseclib constants if applicable
$this->setPhpsecConstants();
// Check signature
$certs = $this->getFederatedSignOnCerts();
foreach ($certs as $cert) {
try {
$args = [$idToken];
$publicKey = $this->getPublicKey($cert);
if (class_exists(Key::class)) {
$args[] = new Key($publicKey, 'RS256');
} else {
$args[] = $publicKey;
$args[] = ['RS256'];
}
$payload = \call_user_func_array([$this->jwt, 'decode'], $args);
if (property_exists($payload, 'aud')) {
if ($audience && $payload->aud != $audience) {
return false;
}
}
// support HTTP and HTTPS issuers
// @see https://developers.google.com/identity/sign-in/web/backend-auth
$issuers = [self::OAUTH2_ISSUER, self::OAUTH2_ISSUER_HTTPS];
if (!isset($payload->iss) || !in_array($payload->iss, $issuers)) {
return false;
}
return (array)$payload;
} catch (ExpiredException $e) { // @phpstan-ignore-line
return false;
} catch (ExpiredExceptionV3 $e) {
return false;
} catch (SignatureInvalidException $e) {
// continue
} catch (DomainException $e) {
// continue
}
}
return false;
}
private function getCache()
{
return $this->cache;
}
/**
* Retrieve and cache a certificates file.
*
* @param string $url location
* @return array certificates
* @throws \Google\Exception
*/
private function retrieveCertsFromLocation($url)
{
// If we're retrieving a local file, just grab it.
if (0 !== strpos($url, 'http')) {
if (!$file = file_get_contents($url)) {
throw new GoogleException(
"Failed to retrieve verification certificates: '".
$url."'."
);
}
return json_decode($file, true);
}
// @phpstan-ignore-next-line
$response = $this->http->get($url);
if ($response->getStatusCode() == 200) {
return json_decode((string)$response->getBody(), true);
}
throw new GoogleException(
sprintf(
'Failed to retrieve verification certificates: "%s".',
$response->getBody()->getContents()
),
$response->getStatusCode()
);
}
// Gets federated sign-on certificates to use for verifying identity tokens.
// Returns certs as array structure, where keys are key ids, and values
// are PEM encoded certificates.
private function getFederatedSignOnCerts()
{
$certs = null;
if ($cache = $this->getCache()) {
$cacheItem = $cache->getItem('federated_signon_certs_v3');
$certs = $cacheItem->get();
}
if (!$certs) {
$certs = $this->retrieveCertsFromLocation(
self::FEDERATED_SIGNON_CERT_URL
);
if ($cache) {
$cacheItem->expiresAt(new DateTime('+1 hour'));
$cacheItem->set($certs);
$cache->save($cacheItem);
}
}
if (!isset($certs['keys'])) {
throw new InvalidArgumentException(
'federated sign-on certs expects "keys" to be set'
);
}
return $certs['keys'];
}
private function getJwtService()
{
$jwt = new JWT();
if ($jwt::$leeway < 1) {
// Ensures JWT leeway is at least 1
// @see https://github.com/google/google-api-php-client/issues/827
$jwt::$leeway = 1;
}
return $jwt;
}
private function getPublicKey($cert)
{
$modulus = new BigInteger($this->jwt->urlsafeB64Decode($cert['n']), 256);
$exponent = new BigInteger($this->jwt->urlsafeB64Decode($cert['e']), 256);
$component = ['n' => $modulus, 'e' => $exponent];
$loader = PublicKeyLoader::load($component);
return $loader->toString('PKCS8');
}
/**
* phpseclib calls "phpinfo" by default, which requires special
* whitelisting in the AppEngine VM environment. This function
* sets constants to bypass the need for phpseclib to check phpinfo
*
* @see phpseclib/Math/BigInteger
* @see https://github.com/GoogleCloudPlatform/getting-started-php/issues/85
*/
private function setPhpsecConstants()
{
if (filter_var(getenv('GAE_VM'), FILTER_VALIDATE_BOOLEAN)) {
if (!defined('MATH_BIGINTEGER_OPENSSL_ENABLED')) {
define('MATH_BIGINTEGER_OPENSSL_ENABLED', true);
}
if (!defined('CRYPT_RSA_MODE')) {
define('CRYPT_RSA_MODE', AES::ENGINE_OPENSSL);
}
}
}
}

View File

@@ -0,0 +1,49 @@
<?php
/**
* Copyright 2015 Google Inc. All Rights Reserved.
*
* 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.
*/
namespace Google\AuthHandler;
use Exception;
use GuzzleHttp\ClientInterface;
class AuthHandlerFactory
{
/**
* Builds out a default http handler for the installed version of guzzle.
*
* @return Guzzle6AuthHandler|Guzzle7AuthHandler
* @throws Exception
*/
public static function build($cache = null, array $cacheConfig = [])
{
$guzzleVersion = null;
if (defined('\GuzzleHttp\ClientInterface::MAJOR_VERSION')) {
$guzzleVersion = ClientInterface::MAJOR_VERSION;
} elseif (defined('\GuzzleHttp\ClientInterface::VERSION')) {
$guzzleVersion = (int) substr(ClientInterface::VERSION, 0, 1);
}
switch ($guzzleVersion) {
case 6:
return new Guzzle6AuthHandler($cache, $cacheConfig);
case 7:
return new Guzzle7AuthHandler($cache, $cacheConfig);
default:
throw new Exception('Version not supported');
}
}
}

View File

@@ -0,0 +1,124 @@
<?php
namespace Google\AuthHandler;
use Google\Auth\FetchAuthTokenCache;
use Google\Auth\FetchAuthTokenInterface;
use Google\Auth\HttpHandler\HttpHandlerFactory;
use Google\Auth\Middleware\AuthTokenMiddleware;
use Google\Auth\Middleware\ScopedAccessTokenMiddleware;
use Google\Auth\Middleware\SimpleMiddleware;
use GuzzleHttp\Client;
use GuzzleHttp\ClientInterface;
use Psr\Cache\CacheItemPoolInterface;
/**
* This supports Guzzle 6
*/
class Guzzle6AuthHandler
{
protected $cache;
protected $cacheConfig;
public function __construct(?CacheItemPoolInterface $cache = null, array $cacheConfig = [])
{
$this->cache = $cache;
$this->cacheConfig = $cacheConfig;
}
public function attachCredentials(
ClientInterface $http,
FetchAuthTokenInterface $credentials,
?callable $tokenCallback = null
) {
// use the provided cache
if ($this->cache) {
$credentials = new FetchAuthTokenCache(
$credentials,
$this->cacheConfig,
$this->cache
);
}
return $this->attachToHttp($http, $credentials, $tokenCallback);
}
public function attachCredentialsCache(
ClientInterface $http,
FetchAuthTokenCache $credentials,
?callable $tokenCallback = null
) {
return $this->attachToHttp($http, $credentials, $tokenCallback);
}
private function attachToHttp(
ClientInterface $http,
FetchAuthTokenInterface $credentials,
?callable $tokenCallback = null
) {
// if we end up needing to make an HTTP request to retrieve credentials, we
// can use our existing one, but we need to throw exceptions so the error
// bubbles up.
$authHttp = $this->createAuthHttp($http);
$authHttpHandler = HttpHandlerFactory::build($authHttp);
$middleware = new AuthTokenMiddleware(
$credentials,
$authHttpHandler,
$tokenCallback
);
$config = $http->getConfig();
$config['handler']->remove('google_auth');
$config['handler']->push($middleware, 'google_auth');
$config['auth'] = 'google_auth';
return new Client($config);
}
public function attachToken(ClientInterface $http, array $token, array $scopes)
{
$tokenFunc = function ($scopes) use ($token) {
return $token['access_token'];
};
// Derive a cache prefix from the token, to ensure setting a new token
// results in a cache-miss.
// Note: Supplying a custom "prefix" will bust this behavior.
$cacheConfig = $this->cacheConfig;
if (!isset($cacheConfig['prefix']) && isset($token['access_token'])) {
$cacheConfig['prefix'] = substr(sha1($token['access_token']), -10);
}
$middleware = new ScopedAccessTokenMiddleware(
$tokenFunc,
$scopes,
$cacheConfig,
$this->cache
);
$config = $http->getConfig();
$config['handler']->remove('google_auth');
$config['handler']->push($middleware, 'google_auth');
$config['auth'] = 'scoped';
$http = new Client($config);
return $http;
}
public function attachKey(ClientInterface $http, $key)
{
$middleware = new SimpleMiddleware(['key' => $key]);
$config = $http->getConfig();
$config['handler']->remove('google_auth');
$config['handler']->push($middleware, 'google_auth');
$config['auth'] = 'simple';
$http = new Client($config);
return $http;
}
private function createAuthHttp(ClientInterface $http)
{
return new Client(['http_errors' => true] + $http->getConfig());
}
}

View File

@@ -0,0 +1,25 @@
<?php
/**
* Copyright 2020 Google LLC
*
* 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.
*/
namespace Google\AuthHandler;
/**
* This supports Guzzle 7
*/
class Guzzle7AuthHandler extends Guzzle6AuthHandler
{
}

1368
vendor/google/apiclient/src/Client.php vendored Normal file

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,122 @@
<?php
namespace Google;
/**
* Extension to the regular Google\Model that automatically
* exposes the items array for iteration, so you can just
* iterate over the object rather than a reference inside.
*/
class Collection extends Model implements \Iterator, \Countable
{
protected $collection_key = 'items';
/** @return void */
#[\ReturnTypeWillChange]
public function rewind()
{
if (
isset($this->{$this->collection_key})
&& is_array($this->{$this->collection_key})
) {
reset($this->{$this->collection_key});
}
}
/** @return mixed */
#[\ReturnTypeWillChange]
public function current()
{
$this->coerceType($this->key());
if (is_array($this->{$this->collection_key})) {
return current($this->{$this->collection_key});
}
}
/** @return mixed */
#[\ReturnTypeWillChange]
public function key()
{
if (
isset($this->{$this->collection_key})
&& is_array($this->{$this->collection_key})
) {
return key($this->{$this->collection_key});
}
}
/** @return mixed */
#[\ReturnTypeWillChange]
public function next()
{
return next($this->{$this->collection_key});
}
/** @return bool */
#[\ReturnTypeWillChange]
public function valid()
{
$key = $this->key();
return $key !== null && $key !== false;
}
/** @return int */
#[\ReturnTypeWillChange]
public function count()
{
if (!isset($this->{$this->collection_key})) {
return 0;
}
return count($this->{$this->collection_key});
}
/** @return bool */
#[\ReturnTypeWillChange]
public function offsetExists($offset)
{
if (!is_numeric($offset)) {
return parent::offsetExists($offset);
}
return isset($this->{$this->collection_key}[$offset]);
}
/** @return mixed */
#[\ReturnTypeWillChange]
public function offsetGet($offset)
{
if (!is_numeric($offset)) {
return parent::offsetGet($offset);
}
$this->coerceType($offset);
return $this->{$this->collection_key}[$offset];
}
/** @return void */
#[\ReturnTypeWillChange]
public function offsetSet($offset, $value)
{
if (!is_numeric($offset)) {
parent::offsetSet($offset, $value);
}
$this->{$this->collection_key}[$offset] = $value;
}
/** @return void */
#[\ReturnTypeWillChange]
public function offsetUnset($offset)
{
if (!is_numeric($offset)) {
parent::offsetUnset($offset);
}
unset($this->{$this->collection_key}[$offset]);
}
private function coerceType($offset)
{
$keyType = $this->keyType($this->collection_key);
if ($keyType && !is_object($this->{$this->collection_key}[$offset])) {
$this->{$this->collection_key}[$offset] =
new $keyType($this->{$this->collection_key}[$offset]);
}
}
}

View File

@@ -0,0 +1,24 @@
<?php
/*
* Copyright 2013 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.
*/
namespace Google;
use Exception as BaseException;
class Exception extends BaseException
{
}

View File

@@ -0,0 +1,261 @@
<?php
/*
* Copyright 2012 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.
*/
namespace Google\Http;
use Google\Client;
use Google\Service\Exception as GoogleServiceException;
use GuzzleHttp\Psr7;
use GuzzleHttp\Psr7\Request;
use GuzzleHttp\Psr7\Response;
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ResponseInterface;
/**
* Class to handle batched requests to the Google API service.
*
* Note that calls to `Google\Http\Batch::execute()` do not clear the queued
* requests. To start a new batch, be sure to create a new instance of this
* class.
*/
class Batch
{
const BATCH_PATH = 'batch';
private static $CONNECTION_ESTABLISHED_HEADERS = [
"HTTP/1.0 200 Connection established\r\n\r\n",
"HTTP/1.1 200 Connection established\r\n\r\n",
];
/** @var string Multipart Boundary. */
private $boundary;
/** @var array service requests to be executed. */
private $requests = [];
/** @var Client */
private $client;
private $rootUrl;
private $batchPath;
public function __construct(
Client $client,
$boundary = false,
$rootUrl = null,
$batchPath = null
) {
$this->client = $client;
$this->boundary = $boundary ?: mt_rand();
$rootUrl = rtrim($rootUrl ?: $this->client->getConfig('base_path'), '/');
$this->rootUrl = str_replace(
'UNIVERSE_DOMAIN',
$this->client->getUniverseDomain(),
$rootUrl
);
$this->batchPath = $batchPath ?: self::BATCH_PATH;
}
public function add(RequestInterface $request, $key = false)
{
if (false == $key) {
$key = mt_rand();
}
$this->requests[$key] = $request;
}
public function execute()
{
$body = '';
$classes = [];
$batchHttpTemplate = <<<EOF
--%s
Content-Type: application/http
Content-Transfer-Encoding: binary
MIME-Version: 1.0
Content-ID: %s
%s
%s%s
EOF;
/** @var RequestInterface $request */
foreach ($this->requests as $key => $request) {
$firstLine = sprintf(
'%s %s HTTP/%s',
$request->getMethod(),
$request->getRequestTarget(),
$request->getProtocolVersion()
);
$content = (string) $request->getBody();
$headers = '';
foreach ($request->getHeaders() as $name => $values) {
$headers .= sprintf("%s:%s\r\n", $name, implode(', ', $values));
}
$body .= sprintf(
$batchHttpTemplate,
$this->boundary,
$key,
$firstLine,
$headers,
$content ? "\n" . $content : ''
);
$classes['response-' . $key] = $request->getHeaderLine('X-Php-Expected-Class');
}
$body .= "--{$this->boundary}--";
$body = trim($body);
$url = $this->rootUrl . '/' . $this->batchPath;
$headers = [
'Content-Type' => sprintf('multipart/mixed; boundary=%s', $this->boundary),
'Content-Length' => (string) strlen($body),
];
$request = new Request(
'POST',
$url,
$headers,
$body
);
$response = $this->client->execute($request);
return $this->parseResponse($response, $classes);
}
public function parseResponse(ResponseInterface $response, $classes = [])
{
$contentType = $response->getHeaderLine('content-type');
$contentType = explode(';', $contentType);
$boundary = false;
foreach ($contentType as $part) {
$part = explode('=', $part, 2);
if (isset($part[0]) && 'boundary' == trim($part[0])) {
$boundary = $part[1];
}
}
$body = (string) $response->getBody();
if (!empty($body)) {
$body = str_replace("--$boundary--", "--$boundary", $body);
$parts = explode("--$boundary", $body);
$responses = [];
$requests = array_values($this->requests);
foreach ($parts as $i => $part) {
$part = trim($part);
if (!empty($part)) {
list($rawHeaders, $part) = explode("\r\n\r\n", $part, 2);
$headers = $this->parseRawHeaders($rawHeaders);
$status = substr($part, 0, strpos($part, "\n"));
$status = explode(" ", $status);
$status = $status[1];
list($partHeaders, $partBody) = $this->parseHttpResponse($part, 0);
$response = new Response(
(int) $status,
$partHeaders,
Psr7\Utils::streamFor($partBody)
);
// Need content id.
$key = $headers['content-id'];
try {
$response = REST::decodeHttpResponse($response, $requests[$i-1]);
} catch (GoogleServiceException $e) {
// Store the exception as the response, so successful responses
// can be processed.
$response = $e;
}
$responses[$key] = $response;
}
}
return $responses;
}
return null;
}
private function parseRawHeaders($rawHeaders)
{
$headers = [];
$responseHeaderLines = explode("\r\n", $rawHeaders);
foreach ($responseHeaderLines as $headerLine) {
if ($headerLine && strpos($headerLine, ':') !== false) {
list($header, $value) = explode(': ', $headerLine, 2);
$header = strtolower($header);
if (isset($headers[$header])) {
$headers[$header] = array_merge((array)$headers[$header], (array)$value);
} else {
$headers[$header] = $value;
}
}
}
return $headers;
}
/**
* Used by the IO lib and also the batch processing.
*
* @param string $respData
* @param int $headerSize
* @return array
*/
private function parseHttpResponse($respData, $headerSize)
{
// check proxy header
foreach (self::$CONNECTION_ESTABLISHED_HEADERS as $established_header) {
if (stripos($respData, $established_header) !== false) {
// existed, remove it
$respData = str_ireplace($established_header, '', $respData);
// Subtract the proxy header size unless the cURL bug prior to 7.30.0
// is present which prevented the proxy header size from being taken into
// account.
// @TODO look into this
// if (!$this->needsQuirk()) {
// $headerSize -= strlen($established_header);
// }
break;
}
}
if ($headerSize) {
$responseBody = substr($respData, $headerSize);
$responseHeaders = substr($respData, 0, $headerSize);
} else {
$responseSegments = explode("\r\n\r\n", $respData, 2);
$responseHeaders = $responseSegments[0];
$responseBody = isset($responseSegments[1]) ? $responseSegments[1] : null;
}
$responseHeaders = $this->parseRawHeaders($responseHeaders);
return [$responseHeaders, $responseBody];
}
}

View File

@@ -0,0 +1,353 @@
<?php
/**
* Copyright 2012 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.
*/
namespace Google\Http;
use Google\Client;
use Google\Exception as GoogleException;
use GuzzleHttp\Psr7;
use GuzzleHttp\Psr7\Request;
use GuzzleHttp\Psr7\Uri;
use Psr\Http\Message\RequestInterface;
/**
* Manage large file uploads, which may be media but can be any type
* of sizable data.
*/
class MediaFileUpload
{
const UPLOAD_MEDIA_TYPE = 'media';
const UPLOAD_MULTIPART_TYPE = 'multipart';
const UPLOAD_RESUMABLE_TYPE = 'resumable';
/** @var string $mimeType */
private $mimeType;
/** @var string $data */
private $data;
/** @var bool $resumable */
private $resumable;
/** @var int $chunkSize */
private $chunkSize;
/** @var int $size */
private $size;
/** @var string $resumeUri */
private $resumeUri;
/** @var int $progress */
private $progress;
/** @var Client */
private $client;
/** @var RequestInterface */
private $request;
/** @var string */
private $boundary; // @phpstan-ignore-line
/**
* Result code from last HTTP call
* @var int
*/
private $httpResultCode;
/**
* @param Client $client
* @param RequestInterface $request
* @param string $mimeType
* @param string $data The bytes you want to upload.
* @param bool $resumable
* @param int $chunkSize File will be uploaded in chunks of this many bytes.
* only used if resumable=True
*/
public function __construct(
Client $client,
RequestInterface $request,
$mimeType,
$data,
$resumable = false,
$chunkSize = 0
) {
$this->client = $client;
$this->request = $request;
$this->mimeType = $mimeType;
$this->data = $data;
$this->resumable = $resumable;
$this->chunkSize = $chunkSize;
$this->progress = 0;
$this->process();
}
/**
* Set the size of the file that is being uploaded.
* @param int $size - int file size in bytes
*/
public function setFileSize($size)
{
$this->size = $size;
}
/**
* Return the progress on the upload
* @return int progress in bytes uploaded.
*/
public function getProgress()
{
return $this->progress;
}
/**
* Send the next part of the file to upload.
* @param string|bool $chunk Optional. The next set of bytes to send. If false will
* use $data passed at construct time.
*/
public function nextChunk($chunk = false)
{
$resumeUri = $this->getResumeUri();
if (false == $chunk) {
$chunk = substr($this->data, $this->progress, $this->chunkSize);
}
$lastBytePos = $this->progress + strlen($chunk) - 1;
$headers = [
'content-range' => "bytes $this->progress-$lastBytePos/$this->size",
'content-length' => (string) strlen($chunk),
'expect' => '',
];
$request = new Request(
'PUT',
$resumeUri,
$headers,
Psr7\Utils::streamFor($chunk)
);
return $this->makePutRequest($request);
}
/**
* Return the HTTP result code from the last call made.
* @return int code
*/
public function getHttpResultCode()
{
return $this->httpResultCode;
}
/**
* Sends a PUT-Request to google drive and parses the response,
* setting the appropiate variables from the response()
*
* @param RequestInterface $request the Request which will be send
*
* @return false|mixed false when the upload is unfinished or the decoded http response
*
*/
private function makePutRequest(RequestInterface $request)
{
$response = $this->client->execute($request);
$this->httpResultCode = $response->getStatusCode();
if (308 == $this->httpResultCode) {
// Track the amount uploaded.
$range = $response->getHeaderLine('range');
if ($range) {
$range_array = explode('-', $range);
$this->progress = ((int) $range_array[1]) + 1;
}
// Allow for changing upload URLs.
$location = $response->getHeaderLine('location');
if ($location) {
$this->resumeUri = $location;
}
// No problems, but upload not complete.
return false;
}
return REST::decodeHttpResponse($response, $this->request);
}
/**
* Resume a previously unfinished upload
* @param string $resumeUri the resume-URI of the unfinished, resumable upload.
*/
public function resume($resumeUri)
{
$this->resumeUri = $resumeUri;
$headers = [
'content-range' => "bytes */$this->size",
'content-length' => '0',
];
$httpRequest = new Request(
'PUT',
$this->resumeUri,
$headers
);
return $this->makePutRequest($httpRequest);
}
/**
* @return RequestInterface
* @visible for testing
*/
private function process()
{
$this->transformToUploadUrl();
$request = $this->request;
$postBody = '';
$contentType = false;
$meta = json_decode((string) $request->getBody(), true);
$uploadType = $this->getUploadType($meta);
$request = $request->withUri(
Uri::withQueryValue($request->getUri(), 'uploadType', $uploadType)
);
$mimeType = $this->mimeType ?: $request->getHeaderLine('content-type');
if (self::UPLOAD_RESUMABLE_TYPE == $uploadType) {
$contentType = $mimeType;
$postBody = is_string($meta) ? $meta : json_encode($meta);
} elseif (self::UPLOAD_MEDIA_TYPE == $uploadType) {
$contentType = $mimeType;
$postBody = $this->data;
} elseif (self::UPLOAD_MULTIPART_TYPE == $uploadType) {
// This is a multipart/related upload.
$boundary = $this->boundary ?: mt_rand();
$boundary = str_replace('"', '', $boundary);
$contentType = 'multipart/related; boundary=' . $boundary;
$related = "--$boundary\r\n";
$related .= "Content-Type: application/json; charset=UTF-8\r\n";
$related .= "\r\n" . json_encode($meta) . "\r\n";
$related .= "--$boundary\r\n";
$related .= "Content-Type: $mimeType\r\n";
$related .= "Content-Transfer-Encoding: base64\r\n";
$related .= "\r\n" . base64_encode($this->data) . "\r\n";
$related .= "--$boundary--";
$postBody = $related;
}
$request = $request->withBody(Psr7\Utils::streamFor($postBody));
if ($contentType) {
$request = $request->withHeader('content-type', $contentType);
}
return $this->request = $request;
}
/**
* Valid upload types:
* - resumable (UPLOAD_RESUMABLE_TYPE)
* - media (UPLOAD_MEDIA_TYPE)
* - multipart (UPLOAD_MULTIPART_TYPE)
* @param string|false $meta
* @return string
* @visible for testing
*/
public function getUploadType($meta)
{
if ($this->resumable) {
return self::UPLOAD_RESUMABLE_TYPE;
}
if (false == $meta && $this->data) {
return self::UPLOAD_MEDIA_TYPE;
}
return self::UPLOAD_MULTIPART_TYPE;
}
public function getResumeUri()
{
if (null === $this->resumeUri) {
$this->resumeUri = $this->fetchResumeUri();
}
return $this->resumeUri;
}
private function fetchResumeUri()
{
$body = $this->request->getBody();
$headers = [
'content-type' => 'application/json; charset=UTF-8',
'content-length' => $body->getSize(),
'x-upload-content-type' => $this->mimeType,
'x-upload-content-length' => $this->size,
'expect' => '',
];
foreach ($headers as $key => $value) {
$this->request = $this->request->withHeader($key, $value);
}
$response = $this->client->execute($this->request, false);
$location = $response->getHeaderLine('location');
$code = $response->getStatusCode();
if (200 == $code && true == $location) {
return $location;
}
$message = $code;
$body = json_decode((string) $this->request->getBody(), true);
if (isset($body['error']['errors'])) {
$message .= ': ';
foreach ($body['error']['errors'] as $error) {
$message .= "{$error['domain']}, {$error['message']};";
}
$message = rtrim($message, ';');
}
$error = "Failed to start the resumable upload (HTTP {$message})";
$this->client->getLogger()->error($error);
throw new GoogleException($error);
}
private function transformToUploadUrl()
{
$parts = parse_url((string) $this->request->getUri());
if (!isset($parts['path'])) {
$parts['path'] = '';
}
$parts['path'] = '/upload' . $parts['path'];
$uri = Uri::fromParts($parts);
$this->request = $this->request->withUri($uri);
}
public function setChunkSize($chunkSize)
{
$this->chunkSize = $chunkSize;
}
public function getRequest()
{
return $this->request;
}
}

View File

@@ -0,0 +1,198 @@
<?php
/*
* Copyright 2010 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.
*/
namespace Google\Http;
use Google\Auth\HttpHandler\HttpHandlerFactory;
use Google\Service\Exception as GoogleServiceException;
use Google\Task\Runner;
use GuzzleHttp\ClientInterface;
use GuzzleHttp\Exception\RequestException;
use GuzzleHttp\Psr7\Response;
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ResponseInterface;
/**
* This class implements the RESTful transport of apiServiceRequest()'s
*/
class REST
{
/**
* Executes a Psr\Http\Message\RequestInterface and (if applicable) automatically retries
* when errors occur.
*
* @template T
* @param ClientInterface $client
* @param RequestInterface $request
* @param class-string<T>|false|null $expectedClass
* @param array $config
* @param array $retryMap
* @return mixed|T|null
* @throws \Google\Service\Exception on server side error (ie: not authenticated,
* invalid or malformed post body, invalid url)
*/
public static function execute(
ClientInterface $client,
RequestInterface $request,
$expectedClass = null,
$config = [],
$retryMap = null
) {
$runner = new Runner(
$config,
sprintf('%s %s', $request->getMethod(), (string)$request->getUri()),
[self::class, 'doExecute'],
[$client, $request, $expectedClass]
);
if (null !== $retryMap) {
$runner->setRetryMap($retryMap);
}
return $runner->run();
}
/**
* Executes a Psr\Http\Message\RequestInterface
*
* @template T
* @param ClientInterface $client
* @param RequestInterface $request
* @param class-string<T>|false|null $expectedClass
* @return mixed|T|null
* @throws \Google\Service\Exception on server side error (ie: not authenticated,
* invalid or malformed post body, invalid url)
*/
public static function doExecute(ClientInterface $client, RequestInterface $request, $expectedClass = null)
{
try {
$httpHandler = HttpHandlerFactory::build($client);
$response = $httpHandler($request);
} catch (RequestException $e) {
// if Guzzle throws an exception, catch it and handle the response
if (!$e->hasResponse()) {
throw $e;
}
$response = $e->getResponse();
// specific checking for Guzzle 5: convert to PSR7 response
if (
interface_exists('\GuzzleHttp\Message\ResponseInterface')
&& $response instanceof \GuzzleHttp\Message\ResponseInterface
) {
$response = new Response(
$response->getStatusCode(),
$response->getHeaders() ?: [],
$response->getBody(),
$response->getProtocolVersion(),
$response->getReasonPhrase()
);
}
}
return self::decodeHttpResponse($response, $request, $expectedClass);
}
/**
* Decode an HTTP Response.
* @static
*
* @template T
* @param RequestInterface $response The http response to be decoded.
* @param ResponseInterface $response
* @param class-string<T>|false|null $expectedClass
* @return mixed|T|null
* @throws \Google\Service\Exception
*/
public static function decodeHttpResponse(
ResponseInterface $response,
?RequestInterface $request = null,
$expectedClass = null
) {
$code = $response->getStatusCode();
// retry strategy
if (intVal($code) >= 400) {
// if we errored out, it should be safe to grab the response body
$body = (string)$response->getBody();
// Check if we received errors, and add those to the Exception for convenience
throw new GoogleServiceException($body, $code, null, self::getResponseErrors($body));
}
// Ensure we only pull the entire body into memory if the request is not
// of media type
$body = self::decodeBody($response, $request);
if ($expectedClass = self::determineExpectedClass($expectedClass, $request)) {
$json = json_decode($body, true);
return new $expectedClass($json);
}
return $response;
}
private static function decodeBody(ResponseInterface $response, ?RequestInterface $request = null)
{
if (self::isAltMedia($request)) {
// don't decode the body, it's probably a really long string
return '';
}
return (string)$response->getBody();
}
private static function determineExpectedClass($expectedClass, ?RequestInterface $request = null)
{
// "false" is used to explicitly prevent an expected class from being returned
if (false === $expectedClass) {
return null;
}
// if we don't have a request, we just use what's passed in
if (null === $request) {
return $expectedClass;
}
// return what we have in the request header if one was not supplied
return $expectedClass ?: $request->getHeaderLine('X-Php-Expected-Class');
}
private static function getResponseErrors($body)
{
$json = json_decode($body, true);
if (isset($json['error']['errors'])) {
return $json['error']['errors'];
}
return null;
}
private static function isAltMedia(?RequestInterface $request = null)
{
if ($request && $qs = $request->getUri()->getQuery()) {
parse_str($qs, $query);
if (isset($query['alt']) && $query['alt'] == 'media') {
return true;
}
}
return false;
}
}

333
vendor/google/apiclient/src/Model.php vendored Normal file
View File

@@ -0,0 +1,333 @@
<?php
/*
* Copyright 2011 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.
*/
namespace Google;
use Google\Exception as GoogleException;
use ReflectionObject;
use ReflectionProperty;
use stdClass;
/**
* This class defines attributes, valid values, and usage which is generated
* from a given json schema.
* http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5
*
*/
#[\AllowDynamicProperties]
class Model implements \ArrayAccess
{
/**
* If you need to specify a NULL JSON value, use Google\Model::NULL_VALUE
* instead - it will be replaced when converting to JSON with a real null.
*/
const NULL_VALUE = "{}gapi-php-null";
protected $internal_gapi_mappings = [];
protected $modelData = [];
protected $processed = [];
/**
* Polymorphic - accepts a variable number of arguments dependent
* on the type of the model subclass.
*/
final public function __construct()
{
if (func_num_args() == 1 && is_array(func_get_arg(0))) {
// Initialize the model with the array's contents.
$array = func_get_arg(0);
$this->mapTypes($array);
}
$this->gapiInit();
}
/**
* Getter that handles passthrough access to the data array, and lazy object creation.
* @param string $key Property name.
* @return mixed The value if any, or null.
*/
public function __get($key)
{
$keyType = $this->keyType($key);
$keyDataType = $this->dataType($key);
if ($keyType && !isset($this->processed[$key])) {
if (isset($this->modelData[$key])) {
$val = $this->modelData[$key];
} elseif ($keyDataType == 'array' || $keyDataType == 'map') {
$val = [];
} else {
$val = null;
}
if ($this->isAssociativeArray($val)) {
if ($keyDataType && 'map' == $keyDataType) {
foreach ($val as $arrayKey => $arrayItem) {
$this->modelData[$key][$arrayKey] =
new $keyType($arrayItem);
}
} else {
$this->modelData[$key] = new $keyType($val);
}
} elseif (is_array($val)) {
$arrayObject = [];
foreach ($val as $arrayIndex => $arrayItem) {
$arrayObject[$arrayIndex] = new $keyType($arrayItem);
}
$this->modelData[$key] = $arrayObject;
}
$this->processed[$key] = true;
}
return isset($this->modelData[$key]) ? $this->modelData[$key] : null;
}
/**
* Initialize this object's properties from an array.
*
* @param array $array Used to seed this object's properties.
* @return void
*/
protected function mapTypes($array)
{
// Hard initialise simple types, lazy load more complex ones.
foreach ($array as $key => $val) {
if ($keyType = $this->keyType($key)) {
$dataType = $this->dataType($key);
if ($dataType == 'array' || $dataType == 'map') {
$this->$key = [];
foreach ($val as $itemKey => $itemVal) {
if ($itemVal instanceof $keyType) {
$this->{$key}[$itemKey] = $itemVal;
} else {
$this->{$key}[$itemKey] = new $keyType($itemVal);
}
}
} elseif ($val instanceof $keyType) {
$this->$key = $val;
} else {
$this->$key = new $keyType($val);
}
unset($array[$key]);
} elseif (property_exists($this, $key)) {
$this->$key = $val;
unset($array[$key]);
} elseif (property_exists($this, $camelKey = $this->camelCase($key))) {
// This checks if property exists as camelCase, leaving it in array as snake_case
// in case of backwards compatibility issues.
$this->$camelKey = $val;
}
}
$this->modelData = $array;
}
/**
* Blank initialiser to be used in subclasses to do post-construction initialisation - this
* avoids the need for subclasses to have to implement the variadics handling in their
* constructors.
*/
protected function gapiInit()
{
return;
}
/**
* Create a simplified object suitable for straightforward
* conversion to JSON. This is relatively expensive
* due to the usage of reflection, but shouldn't be called
* a whole lot, and is the most straightforward way to filter.
*/
public function toSimpleObject()
{
$object = new stdClass();
// Process all other data.
foreach ($this->modelData as $key => $val) {
$result = $this->getSimpleValue($val);
if ($result !== null) {
$object->$key = $this->nullPlaceholderCheck($result);
}
}
// Process all public properties.
$reflect = new ReflectionObject($this);
$props = $reflect->getProperties(ReflectionProperty::IS_PUBLIC);
foreach ($props as $member) {
$name = $member->getName();
$result = $this->getSimpleValue($this->$name);
if ($result !== null) {
$name = $this->getMappedName($name);
$object->$name = $this->nullPlaceholderCheck($result);
}
}
return $object;
}
/**
* Handle different types of values, primarily
* other objects and map and array data types.
*/
private function getSimpleValue($value)
{
if ($value instanceof Model) {
return $value->toSimpleObject();
} elseif (is_array($value)) {
$return = [];
foreach ($value as $key => $a_value) {
$a_value = $this->getSimpleValue($a_value);
if ($a_value !== null) {
$key = $this->getMappedName($key);
$return[$key] = $this->nullPlaceholderCheck($a_value);
}
}
return $return;
}
return $value;
}
/**
* Check whether the value is the null placeholder and return true null.
*/
private function nullPlaceholderCheck($value)
{
if ($value === self::NULL_VALUE) {
return null;
}
return $value;
}
/**
* If there is an internal name mapping, use that.
*/
private function getMappedName($key)
{
if (isset($this->internal_gapi_mappings, $this->internal_gapi_mappings[$key])) {
$key = $this->internal_gapi_mappings[$key];
}
return $key;
}
/**
* Returns true only if the array is associative.
* @param array $array
* @return bool True if the array is associative.
*/
protected function isAssociativeArray($array)
{
if (!is_array($array)) {
return false;
}
$keys = array_keys($array);
foreach ($keys as $key) {
if (is_string($key)) {
return true;
}
}
return false;
}
/**
* Verify if $obj is an array.
* @throws \Google\Exception Thrown if $obj isn't an array.
* @param array $obj Items that should be validated.
* @param string $method Method expecting an array as an argument.
*/
public function assertIsArray($obj, $method)
{
if ($obj && !is_array($obj)) {
throw new GoogleException(
"Incorrect parameter type passed to $method(). Expected an array."
);
}
}
/** @return bool */
#[\ReturnTypeWillChange]
public function offsetExists($offset)
{
return isset($this->$offset) || isset($this->modelData[$offset]);
}
/** @return mixed */
#[\ReturnTypeWillChange]
public function offsetGet($offset)
{
return isset($this->$offset) ?
$this->$offset :
$this->__get($offset);
}
/** @return void */
#[\ReturnTypeWillChange]
public function offsetSet($offset, $value)
{
if (property_exists($this, $offset)) {
$this->$offset = $value;
} else {
$this->modelData[$offset] = $value;
$this->processed[$offset] = true;
}
}
/** @return void */
#[\ReturnTypeWillChange]
public function offsetUnset($offset)
{
unset($this->modelData[$offset]);
}
protected function keyType($key)
{
$keyType = $key . "Type";
// ensure keyType is a valid class
if (property_exists($this, $keyType) && $this->$keyType !== null && class_exists($this->$keyType)) {
return $this->$keyType;
}
}
protected function dataType($key)
{
$dataType = $key . "DataType";
if (property_exists($this, $dataType)) {
return $this->$dataType;
}
}
public function __isset($key)
{
return isset($this->modelData[$key]);
}
public function __unset($key)
{
unset($this->modelData[$key]);
}
/**
* Convert a string to camelCase
* @param string $value
* @return string
*/
private function camelCase($value)
{
$value = ucwords(str_replace(['-', '_'], ' ', $value));
$value = str_replace(' ', '', $value);
$value[0] = strtolower($value[0]);
return $value;
}
}

76
vendor/google/apiclient/src/Service.php vendored Normal file
View File

@@ -0,0 +1,76 @@
<?php
/*
* Copyright 2010 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.
*/
namespace Google;
use Google\Http\Batch;
use TypeError;
class Service
{
public $batchPath;
/**
* Only used in getBatch
*/
public $rootUrl;
public $rootUrlTemplate;
public $version;
public $servicePath;
public $serviceName;
public $availableScopes;
public $resource;
private $client;
public function __construct($clientOrConfig = [])
{
if ($clientOrConfig instanceof Client) {
$this->client = $clientOrConfig;
} elseif (is_array($clientOrConfig)) {
$this->client = new Client($clientOrConfig ?: []);
} else {
$errorMessage = 'constructor must be array or instance of Google\Client';
if (class_exists('TypeError')) {
throw new TypeError($errorMessage);
}
trigger_error($errorMessage, E_USER_ERROR);
}
}
/**
* Return the associated Google\Client class.
* @return \Google\Client
*/
public function getClient()
{
return $this->client;
}
/**
* Create a new HTTP Batch handler for this service
*
* @return Batch
*/
public function createBatch()
{
return new Batch(
$this->client,
false,
$this->rootUrlTemplate ?? $this->rootUrl,
$this->batchPath
);
}
}

View File

@@ -0,0 +1,73 @@
<?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.
*/
namespace Google\Service;
use Google\Exception as GoogleException;
class Exception extends GoogleException
{
/**
* Optional list of errors returned in a JSON body of an HTTP error response.
*/
protected $errors = [];
/**
* Override default constructor to add the ability to set $errors and a retry
* map.
*
* @param string $message
* @param int $code
* @param Exception|null $previous
* @param array<array<string,string>>|null $errors List of errors returned in an HTTP
* response or null. Defaults to [].
*/
public function __construct(
$message,
$code = 0,
?Exception $previous = null,
$errors = []
) {
if (version_compare(PHP_VERSION, '5.3.0') >= 0) {
parent::__construct($message, $code, $previous);
} else {
parent::__construct($message, $code);
}
$this->errors = $errors;
}
/**
* An example of the possible errors returned.
*
* [
* {
* "domain": "global",
* "reason": "authError",
* "message": "Invalid Credentials",
* "locationType": "header",
* "location": "Authorization",
* }
* ]
*
* @return array<array<string,string>>|null List of errors returned in an HTTP response or null.
*/
public function getErrors()
{
return $this->errors;
}
}

View File

@@ -0,0 +1,320 @@
<?php
/**
* Copyright 2010 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.
*/
namespace Google\Service;
use Google\Exception as GoogleException;
use Google\Http\MediaFileUpload;
use Google\Model;
use Google\Utils\UriTemplate;
use GuzzleHttp\Psr7\Request;
/**
* Implements the actual methods/resources of the discovered Google API using magic function
* calling overloading (__call()), which on call will see if the method name (plus.activities.list)
* is available in this service, and if so construct an apiHttpRequest representing it.
*
*/
class Resource
{
// Valid query parameters that work, but don't appear in discovery.
private $stackParameters = [
'alt' => ['type' => 'string', 'location' => 'query'],
'fields' => ['type' => 'string', 'location' => 'query'],
'trace' => ['type' => 'string', 'location' => 'query'],
'userIp' => ['type' => 'string', 'location' => 'query'],
'quotaUser' => ['type' => 'string', 'location' => 'query'],
'data' => ['type' => 'string', 'location' => 'body'],
'mimeType' => ['type' => 'string', 'location' => 'header'],
'uploadType' => ['type' => 'string', 'location' => 'query'],
'mediaUpload' => ['type' => 'complex', 'location' => 'query'],
'prettyPrint' => ['type' => 'string', 'location' => 'query'],
];
/** @var string $rootUrlTemplate */
private $rootUrlTemplate;
/** @var string $apiVersion */
protected $apiVersion;
/** @var \Google\Client $client */
private $client;
/** @var string $serviceName */
private $serviceName;
/** @var string $servicePath */
private $servicePath;
/** @var string $resourceName */
private $resourceName;
/** @var array $methods */
private $methods;
public function __construct($service, $serviceName, $resourceName, $resource)
{
$this->rootUrlTemplate = $service->rootUrlTemplate ?? $service->rootUrl;
$this->client = $service->getClient();
$this->servicePath = $service->servicePath;
$this->serviceName = $serviceName;
$this->resourceName = $resourceName;
$this->methods = is_array($resource) && isset($resource['methods']) ?
$resource['methods'] :
[$resourceName => $resource];
}
/**
* TODO: This function needs simplifying.
*
* @template T
* @param string $name
* @param array $arguments
* @param class-string<T> $expectedClass - optional, the expected class name
* @return mixed|T|ResponseInterface|RequestInterface
* @throws \Google\Exception
*/
public function call($name, $arguments, $expectedClass = null)
{
if (! isset($this->methods[$name])) {
$this->client->getLogger()->error(
'Service method unknown',
[
'service' => $this->serviceName,
'resource' => $this->resourceName,
'method' => $name
]
);
throw new GoogleException(
"Unknown function: " .
"{$this->serviceName}->{$this->resourceName}->{$name}()"
);
}
$method = $this->methods[$name];
$parameters = $arguments[0];
// postBody is a special case since it's not defined in the discovery
// document as parameter, but we abuse the param entry for storing it.
$postBody = null;
if (isset($parameters['postBody'])) {
if ($parameters['postBody'] instanceof Model) {
// In the cases the post body is an existing object, we want
// to use the smart method to create a simple object for
// for JSONification.
$parameters['postBody'] = $parameters['postBody']->toSimpleObject();
} elseif (is_object($parameters['postBody'])) {
// If the post body is another kind of object, we will try and
// wrangle it into a sensible format.
$parameters['postBody'] =
$this->convertToArrayAndStripNulls($parameters['postBody']);
}
$postBody = (array) $parameters['postBody'];
unset($parameters['postBody']);
}
// TODO: optParams here probably should have been
// handled already - this may well be redundant code.
if (isset($parameters['optParams'])) {
$optParams = $parameters['optParams'];
unset($parameters['optParams']);
$parameters = array_merge($parameters, $optParams);
}
if (!isset($method['parameters'])) {
$method['parameters'] = [];
}
$method['parameters'] = array_merge(
$this->stackParameters,
$method['parameters']
);
foreach ($parameters as $key => $val) {
if ($key != 'postBody' && !isset($method['parameters'][$key])) {
$this->client->getLogger()->error(
'Service parameter unknown',
[
'service' => $this->serviceName,
'resource' => $this->resourceName,
'method' => $name,
'parameter' => $key
]
);
throw new GoogleException("($name) unknown parameter: '$key'");
}
}
foreach ($method['parameters'] as $paramName => $paramSpec) {
if (
isset($paramSpec['required']) &&
$paramSpec['required'] &&
! isset($parameters[$paramName])
) {
$this->client->getLogger()->error(
'Service parameter missing',
[
'service' => $this->serviceName,
'resource' => $this->resourceName,
'method' => $name,
'parameter' => $paramName
]
);
throw new GoogleException("($name) missing required param: '$paramName'");
}
if (isset($parameters[$paramName])) {
$value = $parameters[$paramName];
$parameters[$paramName] = $paramSpec;
$parameters[$paramName]['value'] = $value;
unset($parameters[$paramName]['required']);
} else {
// Ensure we don't pass nulls.
unset($parameters[$paramName]);
}
}
$this->client->getLogger()->info(
'Service Call',
[
'service' => $this->serviceName,
'resource' => $this->resourceName,
'method' => $name,
'arguments' => $parameters,
]
);
// build the service uri
$url = $this->createRequestUri($method['path'], $parameters);
// NOTE: because we're creating the request by hand,
// and because the service has a rootUrl property
// the "base_uri" of the Http Client is not accounted for
$request = new Request(
$method['httpMethod'],
$url,
$postBody ? ['content-type' => 'application/json'] : [],
$postBody ? json_encode($postBody) : ''
);
// support uploads
if (isset($parameters['data'])) {
$mimeType = isset($parameters['mimeType'])
? $parameters['mimeType']['value']
: 'application/octet-stream';
$data = $parameters['data']['value'];
$upload = new MediaFileUpload($this->client, $request, $mimeType, $data);
// pull down the modified request
$request = $upload->getRequest();
}
// if this is a media type, we will return the raw response
// rather than using an expected class
if (isset($parameters['alt']) && $parameters['alt']['value'] == 'media') {
$expectedClass = null;
}
// If the class which is extending from this one contains
// an Api Version, add it to the header
if ($this->apiVersion) {
$request = $request
->withHeader('X-Goog-Api-Version', $this->apiVersion);
}
// if the client is marked for deferring, rather than
// execute the request, return the response
if ($this->client->shouldDefer()) {
// @TODO find a better way to do this
$request = $request
->withHeader('X-Php-Expected-Class', $expectedClass);
return $request;
}
return $this->client->execute($request, $expectedClass);
}
protected function convertToArrayAndStripNulls($o)
{
$o = (array) $o;
foreach ($o as $k => $v) {
if ($v === null) {
unset($o[$k]);
} elseif (is_object($v) || is_array($v)) {
$o[$k] = $this->convertToArrayAndStripNulls($o[$k]);
}
}
return $o;
}
/**
* Parse/expand request parameters and create a fully qualified
* request uri.
* @static
* @param string $restPath
* @param array $params
* @return string $requestUrl
*/
public function createRequestUri($restPath, $params)
{
// Override the default servicePath address if the $restPath use a /
if ('/' == substr($restPath, 0, 1)) {
$requestUrl = substr($restPath, 1);
} else {
$requestUrl = $this->servicePath . $restPath;
}
if ($this->rootUrlTemplate) {
// code for universe domain
$rootUrl = str_replace('UNIVERSE_DOMAIN', $this->client->getUniverseDomain(), $this->rootUrlTemplate);
// code for leading slash
if ('/' !== substr($rootUrl, -1) && '/' !== substr($requestUrl, 0, 1)) {
$requestUrl = '/' . $requestUrl;
}
$requestUrl = $rootUrl . $requestUrl;
}
$uriTemplateVars = [];
$queryVars = [];
foreach ($params as $paramName => $paramSpec) {
if ($paramSpec['type'] == 'boolean') {
$paramSpec['value'] = $paramSpec['value'] ? 'true' : 'false';
}
if ($paramSpec['location'] == 'path') {
$uriTemplateVars[$paramName] = $paramSpec['value'];
} elseif ($paramSpec['location'] == 'query') {
if (is_array($paramSpec['value'])) {
foreach ($paramSpec['value'] as $value) {
$queryVars[] = $paramName . '=' . rawurlencode(rawurldecode($value));
}
} else {
$queryVars[] = $paramName . '=' . rawurlencode(rawurldecode($paramSpec['value']));
}
}
}
if (count($uriTemplateVars)) {
$uriTemplateParser = new UriTemplate();
$requestUrl = $uriTemplateParser->parse($requestUrl, $uriTemplateVars);
}
if (count($queryVars)) {
$requestUrl .= '?' . implode('&', $queryVars);
}
return $requestUrl;
}
}

View File

@@ -0,0 +1,115 @@
<?php
/*
* Copyright 2020 Google LLC
*
* 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.
*/
namespace Google\Task;
use Composer\Script\Event;
use InvalidArgumentException;
use Symfony\Component\Filesystem\Filesystem;
use Symfony\Component\Finder\Finder;
class Composer
{
/**
* @param Event $event Composer event passed in for any script method
* @param Filesystem $filesystem Optional. Used for testing.
*/
public static function cleanup(
Event $event,
?Filesystem $filesystem = null
) {
$composer = $event->getComposer();
$extra = $composer->getPackage()->getExtra();
$servicesToKeep = $extra['google/apiclient-services'] ?? [];
if (empty($servicesToKeep)) {
return;
}
$vendorDir = $composer->getConfig()->get('vendor-dir');
$serviceDir = sprintf(
'%s/google/apiclient-services/src/Google/Service',
$vendorDir
);
if (!is_dir($serviceDir)) {
// path for google/apiclient-services >= 0.200.0
$serviceDir = sprintf(
'%s/google/apiclient-services/src',
$vendorDir
);
}
self::verifyServicesToKeep($serviceDir, $servicesToKeep);
$finder = self::getServicesToRemove($serviceDir, $servicesToKeep);
$filesystem = $filesystem ?: new Filesystem();
$servicesToRemoveCount = $finder->count();
if (0 === $servicesToRemoveCount) {
return;
}
$event->getIO()->write(
sprintf('Removing %d google services', $servicesToRemoveCount)
);
$pathsToRemove = iterator_to_array($finder);
foreach ($pathsToRemove as $pathToRemove) {
$realpath = $pathToRemove->getRealPath();
$filesystem->remove($realpath);
$filesystem->remove($realpath . '.php');
}
}
/**
* @throws InvalidArgumentException when the service doesn't exist
*/
private static function verifyServicesToKeep(
$serviceDir,
array $servicesToKeep
) {
$finder = (new Finder())
->directories()
->depth('== 0');
foreach ($servicesToKeep as $service) {
if (!preg_match('/^[a-zA-Z0-9]*$/', $service)) {
throw new InvalidArgumentException(
sprintf(
'Invalid Google service name "%s"',
$service
)
);
}
try {
$finder->in($serviceDir . '/' . $service);
} catch (InvalidArgumentException $e) {
throw new InvalidArgumentException(
sprintf(
'Google service "%s" does not exist or was removed previously',
$service
)
);
}
}
}
private static function getServicesToRemove(
$serviceDir,
array $servicesToKeep
) {
// find all files in the current directory
return (new Finder())
->directories()
->depth('== 0')
->in($serviceDir)
->exclude($servicesToKeep);
}
}

View File

@@ -0,0 +1,24 @@
<?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.
*/
namespace Google\Task;
use Google\Exception as GoogleException;
class Exception extends GoogleException
{
}

View File

@@ -0,0 +1,26 @@
<?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.
*/
namespace Google\Task;
/**
* Interface for checking how many times a given task can be retried following
* a failure.
*/
interface Retryable
{
}

View File

@@ -0,0 +1,293 @@
<?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.
*/
namespace Google\Task;
use Google\Service\Exception as GoogleServiceException;
use Google\Task\Exception as GoogleTaskException;
/**
* A task runner with exponential backoff support.
*
* @see https://developers.google.com/drive/web/handle-errors#implementing_exponential_backoff
*/
class Runner
{
const TASK_RETRY_NEVER = 0;
const TASK_RETRY_ONCE = 1;
const TASK_RETRY_ALWAYS = -1;
/**
* @var integer $maxDelay The max time (in seconds) to wait before a retry.
*/
private $maxDelay = 60;
/**
* @var integer $delay The previous delay from which the next is calculated.
*/
private $delay = 1;
/**
* @var integer $factor The base number for the exponential back off.
*/
private $factor = 2;
/**
* @var float $jitter A random number between -$jitter and $jitter will be
* added to $factor on each iteration to allow for a better distribution of
* retries.
*/
private $jitter = 0.5;
/**
* @var integer $attempts The number of attempts that have been tried so far.
*/
private $attempts = 0;
/**
* @var integer $maxAttempts The max number of attempts allowed.
*/
private $maxAttempts = 1;
/**
* @var callable $action The task to run and possibly retry.
*/
private $action;
/**
* @var array $arguments The task arguments.
*/
private $arguments;
/**
* @var array $retryMap Map of errors with retry counts.
*/
protected $retryMap = [
'500' => self::TASK_RETRY_ALWAYS,
'503' => self::TASK_RETRY_ALWAYS,
'rateLimitExceeded' => self::TASK_RETRY_ALWAYS,
'userRateLimitExceeded' => self::TASK_RETRY_ALWAYS,
6 => self::TASK_RETRY_ALWAYS, // CURLE_COULDNT_RESOLVE_HOST
7 => self::TASK_RETRY_ALWAYS, // CURLE_COULDNT_CONNECT
28 => self::TASK_RETRY_ALWAYS, // CURLE_OPERATION_TIMEOUTED
35 => self::TASK_RETRY_ALWAYS, // CURLE_SSL_CONNECT_ERROR
52 => self::TASK_RETRY_ALWAYS, // CURLE_GOT_NOTHING
'lighthouseError' => self::TASK_RETRY_NEVER
];
/**
* Creates a new task runner with exponential backoff support.
*
* @param array $config The task runner config
* @param string $name The name of the current task (used for logging)
* @param callable $action The task to run and possibly retry
* @param array $arguments The task arguments
* @throws \Google\Task\Exception when misconfigured
*/
// @phpstan-ignore-next-line
public function __construct(
$config,
$name,
$action,
array $arguments = []
) {
if (isset($config['initial_delay'])) {
if ($config['initial_delay'] < 0) {
throw new GoogleTaskException(
'Task configuration `initial_delay` must not be negative.'
);
}
$this->delay = $config['initial_delay'];
}
if (isset($config['max_delay'])) {
if ($config['max_delay'] <= 0) {
throw new GoogleTaskException(
'Task configuration `max_delay` must be greater than 0.'
);
}
$this->maxDelay = $config['max_delay'];
}
if (isset($config['factor'])) {
if ($config['factor'] <= 0) {
throw new GoogleTaskException(
'Task configuration `factor` must be greater than 0.'
);
}
$this->factor = $config['factor'];
}
if (isset($config['jitter'])) {
if ($config['jitter'] <= 0) {
throw new GoogleTaskException(
'Task configuration `jitter` must be greater than 0.'
);
}
$this->jitter = $config['jitter'];
}
if (isset($config['retries'])) {
if ($config['retries'] < 0) {
throw new GoogleTaskException(
'Task configuration `retries` must not be negative.'
);
}
$this->maxAttempts += $config['retries'];
}
if (!is_callable($action)) {
throw new GoogleTaskException(
'Task argument `$action` must be a valid callable.'
);
}
$this->action = $action;
$this->arguments = $arguments;
}
/**
* Checks if a retry can be attempted.
*
* @return boolean
*/
public function canAttempt()
{
return $this->attempts < $this->maxAttempts;
}
/**
* Runs the task and (if applicable) automatically retries when errors occur.
*
* @return mixed
* @throws \Google\Service\Exception on failure when no retries are available.
*/
public function run()
{
while ($this->attempt()) {
try {
return call_user_func_array($this->action, $this->arguments);
} catch (GoogleServiceException $exception) {
$allowedRetries = $this->allowedRetries(
$exception->getCode(),
$exception->getErrors()
);
if (!$this->canAttempt() || !$allowedRetries) {
throw $exception;
}
if ($allowedRetries > 0) {
$this->maxAttempts = min(
$this->maxAttempts,
$this->attempts + $allowedRetries
);
}
}
}
}
/**
* Runs a task once, if possible. This is useful for bypassing the `run()`
* loop.
*
* NOTE: If this is not the first attempt, this function will sleep in
* accordance to the backoff configurations before running the task.
*
* @return boolean
*/
public function attempt()
{
if (!$this->canAttempt()) {
return false;
}
if ($this->attempts > 0) {
$this->backOff();
}
$this->attempts++;
return true;
}
/**
* Sleeps in accordance to the backoff configurations.
*/
private function backOff()
{
$delay = $this->getDelay();
usleep((int) ($delay * 1000000));
}
/**
* Gets the delay (in seconds) for the current backoff period.
*
* @return int
*/
private function getDelay()
{
$jitter = $this->getJitter();
$factor = $this->attempts > 1 ? $this->factor + $jitter : 1 + abs($jitter);
return $this->delay = min($this->maxDelay, $this->delay * $factor);
}
/**
* Gets the current jitter (random number between -$this->jitter and
* $this->jitter).
*
* @return float
*/
private function getJitter()
{
return $this->jitter * 2 * mt_rand() / mt_getrandmax() - $this->jitter;
}
/**
* Gets the number of times the associated task can be retried.
*
* NOTE: -1 is returned if the task can be retried indefinitely
*
* @return integer
*/
public function allowedRetries($code, $errors = [])
{
if (isset($this->retryMap[$code])) {
return $this->retryMap[$code];
}
if (
!empty($errors) &&
isset($errors[0]['reason'], $this->retryMap[$errors[0]['reason']])
) {
return $this->retryMap[$errors[0]['reason']];
}
return 0;
}
public function setRetryMap($retryMap)
{
$this->retryMap = $retryMap;
}
}

Some files were not shown because too many files have changed in this diff Show More