com.google.api.services.gmail

Class Gmail.Users.Threads

java.lang.Object

com.google.api.services.gmail.Gmail.Users.Threads

Enclosing class:

Gmail.Users

public class Gmail.Users.Threads
extends Object

The "threads" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Gmail.Users.Threads.Delete
class	Gmail.Users.Threads.Get
class	Gmail.Users.Threads.List
class	Gmail.Users.Threads.Modify
class	Gmail.Users.Threads.Trash
class	Gmail.Users.Threads.Untrash

Constructor Summary

Constructors

Constructor and Description
Threads()

Method Summary

Modifier and Type	Method and Description
Gmail.Users.Threads.Delete	delete(String userId, String id) Immediately and permanently deletes the specified thread.
Gmail.Users.Threads.Get	get(String userId, String id) Gets the specified thread.
Gmail.Users.Threads.List	list(String userId) Lists the threads in the user's mailbox.
Gmail.Users.Threads.Modify	modify(String userId, String id, ModifyThreadRequest content) Modifies the labels applied to the thread.
Gmail.Users.Threads.Trash	trash(String userId, String id) Moves the specified thread to the trash.
Gmail.Users.Threads.Untrash	untrash(String userId, String id) Removes the specified thread from the trash.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Threads

public Threads()

Method Detail

delete

public Gmail.Users.Threads.Delete delete(String userId,
                                         String id)
                                  throws IOException

Immediately and permanently deletes the specified thread. Any messages that belong to the thread are also deleted. This operation cannot be undone. Prefer `threads.trash` instead. Create a request for the method "threads.delete". This request holds the parameters needed by the gmail server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

userId - The user's email address. The special value `me` can be used to indicate the authenticated user. [default: me]

id - ID of the Thread to delete.

Returns:

the request

Throws:

IOException

get

public Gmail.Users.Threads.Get get(String userId,
                                   String id)
                            throws IOException

Gets the specified thread. Create a request for the method "threads.get". This request holds the parameters needed by the gmail server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

userId - The user's email address. The special value `me` can be used to indicate the authenticated user. [default: me]

id - The ID of the thread to retrieve.

Returns:

the request

Throws:

IOException

list

public Gmail.Users.Threads.List list(String userId)
                              throws IOException

Lists the threads in the user's mailbox. Create a request for the method "threads.list". This request holds the parameters needed by the gmail server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

userId - The user's email address. The special value `me` can be used to indicate the authenticated user. [default: me]

Returns:

the request

Throws:

IOException

modify

public Gmail.Users.Threads.Modify modify(String userId,
                                         String id,
                                         ModifyThreadRequest content)
                                  throws IOException

Modifies the labels applied to the thread. This applies to all messages in the thread. Create a request for the method "threads.modify". This request holds the parameters needed by the gmail server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

userId - The user's email address. The special value `me` can be used to indicate the authenticated user. [default: me]

id - The ID of the thread to modify.

content - the ModifyThreadRequest

Returns:

the request

Throws:

IOException

trash

public Gmail.Users.Threads.Trash trash(String userId,
                                       String id)
                                throws IOException

Moves the specified thread to the trash. Any messages that belong to the thread are also moved to the trash. Create a request for the method "threads.trash". This request holds the parameters needed by the gmail server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

userId - The user's email address. The special value `me` can be used to indicate the authenticated user. [default: me]

id - The ID of the thread to Trash.

Returns:

the request

Throws:

IOException

untrash

public Gmail.Users.Threads.Untrash untrash(String userId,
                                           String id)
                                    throws IOException

Removes the specified thread from the trash. Any messages that belong to the thread are also removed from the trash. Create a request for the method "threads.untrash". This request holds the parameters needed by the gmail server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

userId - The user's email address. The special value `me` can be used to indicate the authenticated user. [default: me]

id - The ID of the thread to remove from Trash.

Returns:

the request

Throws:

IOException