Documentation

Google_Service_Gmail_Resource_UsersMessages extends Google_Service_Resource
in package

Application

The "messages" collection of methods.

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

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
batchDelete() : mixed: Deletes many messages by message ID. Provides no guarantees that messages were not already deleted or even existed at all. (messages.batchDelete)
batchModify() : mixed: Modifies the labels on the specified messages. (messages.batchModify)
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : mixed: Immediately and permanently deletes the specified message. This operation cannot be undone. Prefer `messages.trash` instead. (messages.delete)
get() : Google_Service_Gmail_Message: Gets the specified message. (messages.get)
import() : Google_Service_Gmail_Message: Imports a message into only this user's mailbox, with standard email delivery scanning and classification similar to receiving via SMTP. Does not send a message. Note: This function doesn't trigger forwarding rules or filters set up by the user. (messages.import)
insert() : Google_Service_Gmail_Message: Directly inserts a message into only this user's mailbox similar to `IMAP APPEND`, bypassing most scanning and classification. Does not send a message.
listUsersMessages() : Google_Service_Gmail_ListMessagesResponse: Lists the messages in the user's mailbox. (messages.listUsersMessages)
modify() : Google_Service_Gmail_Message: Modifies the labels on the specified message. (messages.modify)
send() : Google_Service_Gmail_Message: Sends the specified message to the recipients in the `To`, `Cc`, and `Bcc` headers. (messages.send)
trash() : Google_Service_Gmail_Message: Moves the specified message to the trash. (messages.trash)
untrash() : Google_Service_Gmail_Message: Removes the specified message from the trash. (messages.untrash)
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 —

batchDelete()

Deletes many messages by message ID. Provides no guarantees that messages were not already deleted or even existed at all. (messages.batchDelete)


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

Parameters

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

Return values

mixed —

batchModify()

Modifies the labels on the specified messages. (messages.batchModify)


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

Parameters

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

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

delete()

Immediately and permanently deletes the specified message. This operation cannot be undone. Prefer `messages.trash` instead. (messages.delete)


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

Parameters

$userId : string: The user's email address. The special value me can be used to indicate the authenticated user.
$id : string: The ID of the message to delete.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

mixed —

get()

Gets the specified message. (messages.get)


    public
                get(string $userId, string $id[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Gmail_Message

Parameters

$userId : string: The user's email address. The special value me can be used to indicate the authenticated user.
$id : string: The ID of the message to retrieve.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Gmail_Message —

import()

Imports a message into only this user's mailbox, with standard email delivery scanning and classification similar to receiving via SMTP. Does not send a message. Note: This function doesn't trigger forwarding rules or filters set up by the user. (messages.import)


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

Parameters

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

Return values

Google_Service_Gmail_Message —

insert()

Directly inserts a message into only this user's mailbox similar to `IMAP APPEND`, bypassing most scanning and classification. Does not send a message.


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

(messages.insert)

Parameters

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

Return values

Google_Service_Gmail_Message —

listUsersMessages()

Lists the messages in the user's mailbox. (messages.listUsersMessages)


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

Parameters

$userId : string: The 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_ListMessagesResponse —

modify()

Modifies the labels on the specified message. (messages.modify)


    public
                modify(string $userId, string $id, Google_Service_Gmail_ModifyMessageRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Gmail_Message

Parameters

$userId : string: The user's email address. The special value me can be used to indicate the authenticated user.
$id : string: The ID of the message to modify.
$postBody : Google_Service_Gmail_ModifyMessageRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Gmail_Message —

send()

Sends the specified message to the recipients in the `To`, `Cc`, and `Bcc` headers. (messages.send)


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

Parameters

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

Return values

Google_Service_Gmail_Message —

trash()

Moves the specified message to the trash. (messages.trash)


    public
                trash(string $userId, string $id[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Gmail_Message

Parameters

$userId : string: The user's email address. The special value me can be used to indicate the authenticated user.
$id : string: The ID of the message to Trash.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Gmail_Message —

untrash()

Removes the specified message from the trash. (messages.untrash)


    public
                untrash(string $userId, string $id[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Gmail_Message

Parameters

$userId : string: The user's email address. The special value me can be used to indicate the authenticated user.
$id : string: The ID of the message to remove from Trash.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Gmail_Message —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —