Google_Service_Gmail_Resource_UsersSettingsForwardingAddresses
extends Google_Service_Resource
in package
The "forwardingAddresses" collection of methods.
Typical usage is:
$gmailService = new Google_Service_Gmail(...);
$forwardingAddresses = $gmailService->forwardingAddresses;
Table of Contents
- $client : Google_Client
- $methods : array<string|int, mixed>
- $resourceName : string
- $rootUrl : string
- $serviceName : string
- $servicePath : string
- $stackParameters : mixed
- __construct() : mixed
- call() : Google_Http_Request|expectedClass
- TODO: This function needs simplifying.
- create() : Google_Service_Gmail_ForwardingAddress
- 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.
- createRequestUri() : string
- Parse/expand request parameters and create a fully qualified request uri.
- delete() : mixed
- 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.
- get() : Google_Service_Gmail_ForwardingAddress
- Gets the specified forwarding address. (forwardingAddresses.get)
- listUsersSettingsForwardingAddresses() : Google_Service_Gmail_ListForwardingAddressesResponse
- Lists the forwarding addresses for the specified account.
- convertToArrayAndStripNulls() : mixed
Properties
$client
private
Google_Client
$client
$methods
private
array<string|int, mixed>
$methods
$resourceName
private
string
$resourceName
$rootUrl
private
string
$rootUrl
$serviceName
private
string
$serviceName
$servicePath
private
string
$servicePath
$stackParameters
private
mixed
$stackParameters
= array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))
Methods
__construct()
public
__construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
- $service : mixed
- $serviceName : mixed
- $resourceName : mixed
- $resource : mixed
Return values
mixed —call()
TODO: This function needs simplifying.
public
call( $name, $arguments[, $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
Tags
Return values
Google_Http_Request|expectedClass —create()
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.
public
create(string $userId, Google_Service_Gmail_ForwardingAddress $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Gmail_ForwardingAddress
(forwardingAddresses.create)
Parameters
- $userId : string
-
User's email address. The special value "me" can be used to indicate the authenticated user.
- $postBody : Google_Service_Gmail_ForwardingAddress
- $optParams : array<string|int, mixed> = array()
-
Optional parameters.
Return values
Google_Service_Gmail_ForwardingAddress —createRequestUri()
Parse/expand request parameters and create a fully qualified request uri.
public
createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
- $restPath : string
- $params : array<string|int, mixed>
Tags
Return values
string —$requestUrl
delete()
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.
public
delete(string $userId, string $forwardingEmail[, array<string|int, mixed> $optParams = array() ]) : mixed
(forwardingAddresses.delete)
Parameters
- $userId : string
-
User's email address. The special value "me" can be used to indicate the authenticated user.
- $forwardingEmail : string
-
The forwarding address to be deleted.
- $optParams : array<string|int, mixed> = array()
-
Optional parameters.
Return values
mixed —get()
Gets the specified forwarding address. (forwardingAddresses.get)
public
get(string $userId, string $forwardingEmail[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Gmail_ForwardingAddress
Parameters
- $userId : string
-
User's email address. The special value "me" can be used to indicate the authenticated user.
- $forwardingEmail : string
-
The forwarding address to be retrieved.
- $optParams : array<string|int, mixed> = array()
-
Optional parameters.
Return values
Google_Service_Gmail_ForwardingAddress —listUsersSettingsForwardingAddresses()
Lists the forwarding addresses for the specified account.
public
listUsersSettingsForwardingAddresses(string $userId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Gmail_ListForwardingAddressesResponse
(forwardingAddresses.listUsersSettingsForwardingAddresses)
Parameters
- $userId : string
-
User's email address. The special value "me" can be used to indicate the authenticated user.
- $optParams : array<string|int, mixed> = array()
-
Optional parameters.
Return values
Google_Service_Gmail_ListForwardingAddressesResponse —convertToArrayAndStripNulls()
protected
convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
- $o : mixed