The "messages" collection of methods. Typical usage is:
$gmailService = new Google_Service_Gmail(...);
$messages = $gmailService->messages;
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
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
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
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
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
|
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
|
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
|
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_UsersMessages_Resource