UsersSettings
class UsersSettings extends Resource (View source)
The "settings" collection of methods.
Typical usage is:
$gmailService = new Google\Service\Gmail(...);
$settings = $gmailService->users_settings;Methods
Gets the auto-forwarding setting for the specified account.
Gets IMAP settings. (settings.getImap)
Gets language settings. (settings.getLanguage)
Gets POP settings. (settings.getPop)
Gets vacation responder settings. (settings.getVacation)
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)
Updates IMAP settings. (settings.updateImap)
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.
Updates POP settings. (settings.updatePop)
Updates vacation responder settings. (settings.updateVacation)
Details
AutoForwarding
getAutoForwarding(string $userId, array $optParams = [])
Gets the auto-forwarding setting for the specified account.
(settings.getAutoForwarding)
ImapSettings
getImap(string $userId, array $optParams = [])
Gets IMAP settings. (settings.getImap)
LanguageSettings
getLanguage(string $userId, array $optParams = [])
Gets language settings. (settings.getLanguage)
PopSettings
getPop(string $userId, array $optParams = [])
Gets POP settings. (settings.getPop)
VacationSettings
getVacation(string $userId, array $optParams = [])
Gets vacation responder settings. (settings.getVacation)
AutoForwarding
updateAutoForwarding(string $userId, AutoForwarding $postBody, array $optParams = [])
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)
ImapSettings
updateImap(string $userId, ImapSettings $postBody, array $optParams = [])
Updates IMAP settings. (settings.updateImap)
LanguageSettings
updateLanguage(string $userId, LanguageSettings $postBody, array $optParams = [])
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)
PopSettings
updatePop(string $userId, PopSettings $postBody, array $optParams = [])
Updates POP settings. (settings.updatePop)
VacationSettings
updateVacation(string $userId, VacationSettings $postBody, array $optParams = [])
Updates vacation responder settings. (settings.updateVacation)