Documentation

Google_Service_Gmail_Resource_UsersSettings extends Google_Service_Resource
in package

Application

The "settings" collection of methods.

Typical usage is: $gmailService = new Google_Service_Gmail(...); $settings = $gmailService->settings;

$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.
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
getAutoForwarding() : Google_Service_Gmail_AutoForwarding: Gets the auto-forwarding setting for the specified account.
getImap() : Google_Service_Gmail_ImapSettings: Gets IMAP settings. (settings.getImap)
getLanguage() : Google_Service_Gmail_LanguageSettings: Gets language settings. (settings.getLanguage)
getPop() : Google_Service_Gmail_PopSettings: Gets POP settings. (settings.getPop)
getVacation() : Google_Service_Gmail_VacationSettings: Gets vacation responder settings. (settings.getVacation)
updateAutoForwarding() : Google_Service_Gmail_AutoForwarding: 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)
updateImap() : Google_Service_Gmail_ImapSettings: Updates IMAP settings. (settings.updateImap)
updateLanguage() : Google_Service_Gmail_LanguageSettings: 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.
updatePop() : Google_Service_Gmail_PopSettings: Updates POP settings. (settings.updatePop)
updateVacation() : Google_Service_Gmail_VacationSettings: Updates vacation responder settings. (settings.updateVacation)
convertToArrayAndStripNulls() : mixed

$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'))

__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

$name :

$arguments :

$expectedClass : = null

optional, the expected class name

Return values

Google_Http_Request|expectedClass —

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>

Return values

string —

$requestUrl

getAutoForwarding()

Gets the auto-forwarding setting for the specified account.


    public
                getAutoForwarding(string $userId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Gmail_AutoForwarding

(settings.getAutoForwarding)

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_AutoForwarding —

getImap()

Gets IMAP settings. (settings.getImap)


    public
                getImap(string $userId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Gmail_ImapSettings

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_ImapSettings —

getLanguage()

Gets language settings. (settings.getLanguage)


    public
                getLanguage(string $userId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Gmail_LanguageSettings

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_LanguageSettings —

getPop()

Gets POP settings. (settings.getPop)


    public
                getPop(string $userId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Gmail_PopSettings

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_PopSettings —

getVacation()

Gets vacation responder settings. (settings.getVacation)


    public
                getVacation(string $userId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Gmail_VacationSettings

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_VacationSettings —

updateAutoForwarding()

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)


    public
                updateAutoForwarding(string $userId, Google_Service_Gmail_AutoForwarding $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Gmail_AutoForwarding

Parameters

$userId : string: User's email address. The special value "me" can be used to indicate the authenticated user.
$postBody : Google_Service_Gmail_AutoForwarding
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Gmail_AutoForwarding —

updateImap()

Updates IMAP settings. (settings.updateImap)


    public
                updateImap(string $userId, Google_Service_Gmail_ImapSettings $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Gmail_ImapSettings

Parameters

$userId : string: User's email address. The special value "me" can be used to indicate the authenticated user.
$postBody : Google_Service_Gmail_ImapSettings
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Gmail_ImapSettings —

updateLanguage()

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.


    public
                updateLanguage(string $userId, Google_Service_Gmail_LanguageSettings $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Gmail_LanguageSettings

(settings.updateLanguage)

Parameters

$userId : string: User's email address. The special value "me" can be used to indicate the authenticated user.
$postBody : Google_Service_Gmail_LanguageSettings
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Gmail_LanguageSettings —

updatePop()

Updates POP settings. (settings.updatePop)


    public
                updatePop(string $userId, Google_Service_Gmail_PopSettings $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Gmail_PopSettings

Parameters

$userId : string: User's email address. The special value "me" can be used to indicate the authenticated user.
$postBody : Google_Service_Gmail_PopSettings
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Gmail_PopSettings —

updateVacation()

Updates vacation responder settings. (settings.updateVacation)


    public
                updateVacation(string $userId, Google_Service_Gmail_VacationSettings $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Gmail_VacationSettings

Parameters

$userId : string: User's email address. The special value "me" can be used to indicate the authenticated user.
$postBody : Google_Service_Gmail_VacationSettings
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Gmail_VacationSettings —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —