Users.threads: trash

Requires authorization

Moves the specified thread to the trash. Try it now or see an example.

Request

HTTP request

POST https://www.googleapis.com/gmail/v1/users/userId/threads/id/trash

Parameters

Parameter name Value Description
Path parameters
id string The ID of the thread to Trash.
userId string The user's email address. The special value me can be used to indicate the authenticated user.

Authorization

This request requires authorization with at least one of the following scopes (read more about authentication and authorization).

Scope
https://mail.google.com/
https://www.googleapis.com/auth/gmail.modify

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a Users.threads resource in the response body.

Examples

Note: The code examples available for this method do not represent all supported programming languages (see the client libraries page for a list of supported languages).

Java

Uses the Java client library.

import com.google.api.services.gmail.Gmail;

import java.io.IOException;

// ...

public class MyClass {

  // ...

  /**
   * Trash the specified thread.
   *
   * @param service Authorized Gmail API instance.
   * @param userId User's email address. The special value "me"
   * can be used to indicate the authenticated user.
   * @param threadId ID of Thread to trash.
   * @throws IOException
   */
  public static void trashThread(Gmail service, String userId, String threadId)
      throws IOException {
    service.users().messages().trash(userId, threadId).execute();
    System.out.println("Thread with id: " + threadId + " has been trashed.");
  }

  // ...
}

Try it!

Use the APIs Explorer below to call this method on live data and see the response.

Enviar comentarios sobre…

¿Necesitas ayuda? Visita nuestra página de asistencia.