Overview

Classes

  • Google_Service_Gmail
  • Google_Service_Gmail_AutoForwarding
  • Google_Service_Gmail_BatchDeleteMessagesRequest
  • Google_Service_Gmail_BatchModifyMessagesRequest
  • Google_Service_Gmail_Delegate
  • Google_Service_Gmail_Draft
  • Google_Service_Gmail_Filter
  • Google_Service_Gmail_FilterAction
  • Google_Service_Gmail_FilterCriteria
  • Google_Service_Gmail_ForwardingAddress
  • Google_Service_Gmail_History
  • Google_Service_Gmail_HistoryLabelAdded
  • Google_Service_Gmail_HistoryLabelRemoved
  • Google_Service_Gmail_HistoryMessageAdded
  • Google_Service_Gmail_HistoryMessageDeleted
  • Google_Service_Gmail_ImapSettings
  • Google_Service_Gmail_Label
  • Google_Service_Gmail_LabelColor
  • Google_Service_Gmail_LanguageSettings
  • Google_Service_Gmail_ListDelegatesResponse
  • Google_Service_Gmail_ListDraftsResponse
  • Google_Service_Gmail_ListFiltersResponse
  • Google_Service_Gmail_ListForwardingAddressesResponse
  • Google_Service_Gmail_ListHistoryResponse
  • Google_Service_Gmail_ListLabelsResponse
  • Google_Service_Gmail_ListMessagesResponse
  • Google_Service_Gmail_ListSendAsResponse
  • Google_Service_Gmail_ListSmimeInfoResponse
  • Google_Service_Gmail_ListThreadsResponse
  • Google_Service_Gmail_Message
  • Google_Service_Gmail_MessagePart
  • Google_Service_Gmail_MessagePartBody
  • Google_Service_Gmail_MessagePartHeader
  • Google_Service_Gmail_ModifyMessageRequest
  • Google_Service_Gmail_ModifyThreadRequest
  • Google_Service_Gmail_PopSettings
  • Google_Service_Gmail_Profile
  • Google_Service_Gmail_SendAs
  • Google_Service_Gmail_SmimeInfo
  • Google_Service_Gmail_SmtpMsa
  • Google_Service_Gmail_Thread
  • Google_Service_Gmail_Users_Resource
  • Google_Service_Gmail_UsersDrafts_Resource
  • Google_Service_Gmail_UsersHistory_Resource
  • Google_Service_Gmail_UsersLabels_Resource
  • Google_Service_Gmail_UsersMessages_Resource
  • Google_Service_Gmail_UsersMessagesAttachments_Resource
  • Google_Service_Gmail_UsersSettings_Resource
  • Google_Service_Gmail_UsersSettingsDelegates_Resource
  • Google_Service_Gmail_UsersSettingsFilters_Resource
  • Google_Service_Gmail_UsersSettingsForwardingAddresses_Resource
  • Google_Service_Gmail_UsersSettingsSendAs_Resource
  • Google_Service_Gmail_UsersSettingsSendAsSmimeInfo_Resource
  • Google_Service_Gmail_UsersThreads_Resource
  • Google_Service_Gmail_VacationSettings
  • Google_Service_Gmail_WatchRequest
  • Google_Service_Gmail_WatchResponse
  • Overview
  • Class
  • Tree

Class Google_Service_Gmail_UsersMessages_Resource

The "messages" collection of methods. Typical usage is:

 $gmailService = new Google_Service_Gmail(...);
 $messages = $gmailService->messages;
Google_Service_Resource
Extended by Google_Service_Gmail_UsersMessages_Resource
Located at Gmail.php
Methods summary
public
# batchDelete( string $userId, Google_Service_Gmail_BatchDeleteMessagesRequest $postBody, array $optParams = array() )

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

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

Parameters

$userId
The user's email address. The special value me can be used to indicate the authenticated user.
$postBody
$optParams
Optional parameters.
public
# batchModify( string $userId, Google_Service_Gmail_BatchModifyMessagesRequest $postBody, array $optParams = array() )

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

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

Parameters

$userId
The user's email address. The special value me can be used to indicate the authenticated user.
$postBody
$optParams
Optional parameters.
public
# delete( string $userId, string $id, array $optParams = array() )

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

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

Parameters

$userId
The user's email address. The special value me can be used to indicate the authenticated user.
$id
The ID of the message to delete.
$optParams
Optional parameters.
public Google_Service_Gmail_Message
# get( string $userId, string $id, array $optParams = array() )

Gets the specified message. (messages.get)

Gets the specified message. (messages.get)

Parameters

$userId
The user's email address. The special value me can be used to indicate the authenticated user.
$id
The ID of the message to retrieve.
$optParams
Optional parameters.

Returns

Google_Service_Gmail_Message
Google_Service_Gmail_Message

Opt_param

string metadataHeaders When given and format is METADATA, only include headers specified.
string format The format to return the message in.
public Google_Service_Gmail_Message
# import( string $userId, Google_Service_Gmail_Message $postBody, array $optParams = array() )

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. (messages.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. (messages.import)

Parameters

$userId
The user's email address. The special value me can be used to indicate the authenticated user.
$postBody
$optParams
Optional parameters.

Returns

Google_Service_Gmail_Message
Google_Service_Gmail_Message

Opt_param

bool processForCalendar Process calendar invites in the email and add any extracted meetings to the Google Calendar for this user.
string internalDateSource Source for Gmail's internal date of the message.
bool neverMarkSpam Ignore the Gmail spam classifier decision and never mark this email as SPAM in the mailbox.
bool deleted Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for G Suite accounts.
public Google_Service_Gmail_Message
# insert( string $userId, Google_Service_Gmail_Message $postBody, array $optParams = array() )

Directly inserts a message into only this user's mailbox similar to IMAP APPEND, bypassing most scanning and classification. Does not send a message. (messages.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. (messages.insert)

Parameters

$userId
The user's email address. The special value me can be used to indicate the authenticated user.
$postBody
$optParams
Optional parameters.

Returns

Google_Service_Gmail_Message
Google_Service_Gmail_Message

Opt_param

string internalDateSource Source for Gmail's internal date of the message.
bool deleted Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for G Suite accounts.
public Google_Service_Gmail_ListMessagesResponse
# listUsersMessages( string $userId, array $optParams = array() )

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

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

Parameters

$userId
The user's email address. The special value me can be used to indicate the authenticated user.
$optParams
Optional parameters.

Returns

Google_Service_Gmail_ListMessagesResponse
Google_Service_Gmail_ListMessagesResponse

Opt_param

bool includeSpamTrash Include messages from SPAM and TRASH in the results.
string pageToken Page token to retrieve a specific page of results in the list.
string labelIds Only return messages with labels that match all of the specified label IDs.
string q Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid:somemsgid@example.com is:unread". Parameter cannot be used when accessing the api using the gmail.metadata scope.
string maxResults Maximum number of messages to return.
public Google_Service_Gmail_Message
# modify( string $userId, string $id, Google_Service_Gmail_ModifyMessageRequest $postBody, array $optParams = array() )

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

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

Parameters

$userId
The user's email address. The special value me can be used to indicate the authenticated user.
$id
The ID of the message to modify.
$postBody
$optParams
Optional parameters.

Returns

Google_Service_Gmail_Message
Google_Service_Gmail_Message
public Google_Service_Gmail_Message
# send( string $userId, Google_Service_Gmail_Message $postBody, array $optParams = array() )

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

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

Parameters

$userId
The user's email address. The special value me can be used to indicate the authenticated user.
$postBody
$optParams
Optional parameters.

Returns

Google_Service_Gmail_Message
Google_Service_Gmail_Message
public Google_Service_Gmail_Message
# trash( string $userId, string $id, array $optParams = array() )

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

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

Parameters

$userId
The user's email address. The special value me can be used to indicate the authenticated user.
$id
The ID of the message to Trash.
$optParams
Optional parameters.

Returns

Google_Service_Gmail_Message
Google_Service_Gmail_Message
public Google_Service_Gmail_Message
# untrash( string $userId, string $id, array $optParams = array() )

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

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

Parameters

$userId
The user's email address. The special value me can be used to indicate the authenticated user.
$id
The ID of the message to remove from Trash.
$optParams
Optional parameters.

Returns

Google_Service_Gmail_Message
Google_Service_Gmail_Message
© 2020 Google Inc.
Gmail API documentation generated by ApiGen 2.8.0