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