com.google.api.services.gmail

Class Gmail.Users.Settings.Filters

java.lang.Object

com.google.api.services.gmail.Gmail.Users.Settings.Filters

Enclosing class:

Gmail.Users.Settings

public class Gmail.Users.Settings.Filters
extends Object

The "filters" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Gmail.Users.Settings.Filters.Create
class	Gmail.Users.Settings.Filters.Delete
class	Gmail.Users.Settings.Filters.Get
class	Gmail.Users.Settings.Filters.List

Constructor Summary

Constructors

Constructor and Description
Filters()

Method Summary

Modifier and Type	Method and Description
Gmail.Users.Settings.Filters.Create	create(String userId, Filter content) Creates a filter.
Gmail.Users.Settings.Filters.Delete	delete(String userId, String id) Immediately and permanently deletes the specified filter.
Gmail.Users.Settings.Filters.Get	get(String userId, String id) Gets a filter.
Gmail.Users.Settings.Filters.List	list(String userId) Lists the message filters of a Gmail user.

Methods inherited from class java.lang.Object

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

Constructor Detail

Filters

public Filters()

Method Detail

create

public Gmail.Users.Settings.Filters.Create create(String userId,
                                                  Filter content)
                                           throws IOException

Creates a filter. Note: you can only create a maximum of 1,000 filters. Create a request for the method "filters.create". 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 - User's email address. The special value "me" can be used to indicate the authenticated user. [default: me]

content - the Filter

Returns:

the request

Throws:

IOException

delete

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

Immediately and permanently deletes the specified filter. Create a request for the method "filters.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 - User's email address. The special value "me" can be used to indicate the authenticated user. [default: me]

id - The ID of the filter to be deleted.

Returns:

the request

Throws:

IOException

get

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

Gets a filter. Create a request for the method "filters.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 - User's email address. The special value "me" can be used to indicate the authenticated user. [default: me]

id - The ID of the filter to be fetched.

Returns:

the request

Throws:

IOException

list

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

Lists the message filters of a Gmail user. Create a request for the method "filters.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 - User's email address. The special value "me" can be used to indicate the authenticated user. [default: me]

Returns:

the request

Throws:

IOException