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_UsersDrafts_Resource

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

 $gmailService = new Google_Service_Gmail(...);
 $drafts = $gmailService->drafts;
Google_Service_Resource
Extended by Google_Service_Gmail_UsersDrafts_Resource
Located at Gmail.php
Methods summary
public Google_Service_Gmail_Draft
# create( string $userId, Google_Service_Gmail_Draft $postBody, array $optParams = array() )

Creates a new draft with the DRAFT label. (drafts.create)

Creates a new draft with the DRAFT label. (drafts.create)

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_Draft
Google_Service_Gmail_Draft
public
# delete( string $userId, string $id, array $optParams = array() )

Immediately and permanently deletes the specified draft. Does not simply trash it. (drafts.delete)

Immediately and permanently deletes the specified draft. Does not simply trash it. (drafts.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 draft to delete.
$optParams
Optional parameters.
public Google_Service_Gmail_Draft
# get( string $userId, string $id, array $optParams = array() )

Gets the specified draft. (drafts.get)

Gets the specified draft. (drafts.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 draft to retrieve.
$optParams
Optional parameters.

Returns

Google_Service_Gmail_Draft
Google_Service_Gmail_Draft

Opt_param

string format The format to return the draft in.
public Google_Service_Gmail_ListDraftsResponse
# listUsersDrafts( string $userId, array $optParams = array() )

Lists the drafts in the user's mailbox. (drafts.listUsersDrafts)

Lists the drafts in the user's mailbox. (drafts.listUsersDrafts)

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_ListDraftsResponse
Google_Service_Gmail_ListDraftsResponse

Opt_param

string maxResults Maximum number of drafts to return.
bool includeSpamTrash Include drafts from SPAM and TRASH in the results.
string pageToken Page token to retrieve a specific page of results in the list.
string q Only return draft messages matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid: is:unread".
public Google_Service_Gmail_Message
# send( string $userId, Google_Service_Gmail_Draft $postBody, array $optParams = array() )

Sends the specified, existing draft to the recipients in the To, Cc, and Bcc headers. (drafts.send)

Sends the specified, existing draft to the recipients in the To, Cc, and Bcc headers. (drafts.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_Draft
# update( string $userId, string $id, Google_Service_Gmail_Draft $postBody, array $optParams = array() )

Replaces a draft's content. (drafts.update)

Replaces a draft's content. (drafts.update)

Parameters

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

Returns

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