Documentation

Google_Service_Gmail extends Google_Service
in package

Application

Service definition for Gmail (v1).

The Gmail API lets you view and manage Gmail mailbox data like threads, messages, and labels.

For more information about this service, see the API Documentation

GMAIL_ADDONS_CURRENT_ACTION_COMPOSE

Manage drafts and send emails when you interact with the add-on.


    public
    mixed
    GMAIL_ADDONS_CURRENT_ACTION_COMPOSE
    = "https://www.googleapis.com/auth/gmail.addons.current.action.compose"

GMAIL_ADDONS_CURRENT_MESSAGE_ACTION

View your email messages when you interact with the add-on.


    public
    mixed
    GMAIL_ADDONS_CURRENT_MESSAGE_ACTION
    = "https://www.googleapis.com/auth/gmail.addons.current.message.action"

GMAIL_ADDONS_CURRENT_MESSAGE_METADATA

View your email message metadata when the add-on is running.


    public
    mixed
    GMAIL_ADDONS_CURRENT_MESSAGE_METADATA
    = "https://www.googleapis.com/auth/gmail.addons.current.message.metadata"

GMAIL_ADDONS_CURRENT_MESSAGE_READONLY

View your email messages when the add-on is running.


    public
    mixed
    GMAIL_ADDONS_CURRENT_MESSAGE_READONLY
    = "https://www.googleapis.com/auth/gmail.addons.current.message.readonly"

GMAIL_COMPOSE

Manage drafts and send emails.


    public
    mixed
    GMAIL_COMPOSE
    = "https://www.googleapis.com/auth/gmail.compose"

GMAIL_INSERT

Insert mail into your mailbox.


    public
    mixed
    GMAIL_INSERT
    = "https://www.googleapis.com/auth/gmail.insert"

GMAIL_LABELS

Manage mailbox labels.


    public
    mixed
    GMAIL_LABELS
    = "https://www.googleapis.com/auth/gmail.labels"

GMAIL_METADATA

View your email message metadata such as labels and headers, but not the email body.


    public
    mixed
    GMAIL_METADATA
    = "https://www.googleapis.com/auth/gmail.metadata"

GMAIL_MODIFY

View and modify but not delete your email.


    public
    mixed
    GMAIL_MODIFY
    = "https://www.googleapis.com/auth/gmail.modify"

GMAIL_READONLY

View your email messages and settings.


    public
    mixed
    GMAIL_READONLY
    = "https://www.googleapis.com/auth/gmail.readonly"

GMAIL_SEND

Send email on your behalf.


    public
    mixed
    GMAIL_SEND
    = "https://www.googleapis.com/auth/gmail.send"

GMAIL_SETTINGS_BASIC

Manage your basic mail settings.


    public
    mixed
    GMAIL_SETTINGS_BASIC
    = "https://www.googleapis.com/auth/gmail.settings.basic"

GMAIL_SETTINGS_SHARING

Manage your sensitive mail settings, including who can manage your mail.


    public
    mixed
    GMAIL_SETTINGS_SHARING
    = "https://www.googleapis.com/auth/gmail.settings.sharing"

MAIL_GOOGLE_COM

Read, compose, send, and permanently delete all your email from Gmail.


    public
    mixed
    MAIL_GOOGLE_COM
    = "https://mail.google.com/"

$availableScopes


    public
        mixed
    $availableScopes

$batchPath


    public
        mixed
    $batchPath

$resource


    public
        mixed
    $resource

$rootUrl


    public
        mixed
    $rootUrl

$servicePath


    public
        mixed
    $servicePath

$users


    public
        mixed
    $users

$users_drafts


    public
        mixed
    $users_drafts

$users_history


    public
        mixed
    $users_history

$users_labels


    public
        mixed
    $users_labels

$users_messages


    public
        mixed
    $users_messages

$users_messages_attachments


    public
        mixed
    $users_messages_attachments

$users_settings


    public
        mixed
    $users_settings

$users_settings_delegates


    public
        mixed
    $users_settings_delegates

$users_settings_filters


    public
        mixed
    $users_settings_filters

$users_settings_forwardingAddresses


    public
        mixed
    $users_settings_forwardingAddresses

$users_settings_sendAs


    public
        mixed
    $users_settings_sendAs

$users_settings_sendAs_smimeInfo


    public
        mixed
    $users_settings_sendAs_smimeInfo

$users_threads


    public
        mixed
    $users_threads

$version


    public
        mixed
    $version

$client


    private
        mixed
    $client

__construct()

Constructs the internal representation of the Gmail service.


    public
                __construct(Google_Client $client[, string $rootUrl = null ]) : mixed

Parameters

$client : Google_Client: The client used to deliver requests.
$rootUrl : string = null: The root URL used for requests to the service.

Return values

mixed —

createBatch()

Create a new HTTP Batch handler for this service


    public
                createBatch() : Google_Http_Batch

Return values

Google_Http_Batch —

getClient()

Return the associated Google_Client class.


    public
                getClient() : Google_Client

Return values

Google_Client —