com.google.api.services.gmail

Class Gmail.Users.Settings

java.lang.Object

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

Enclosing class:

Gmail.Users

public class Gmail.Users.Settings
extends Object

The "settings" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Gmail.Users.Settings.Cse The "cse" collection of methods.
class	Gmail.Users.Settings.Delegates The "delegates" collection of methods.
class	Gmail.Users.Settings.Filters The "filters" collection of methods.
class	Gmail.Users.Settings.ForwardingAddresses The "forwardingAddresses" collection of methods.
class	Gmail.Users.Settings.GetAutoForwarding
class	Gmail.Users.Settings.GetImap
class	Gmail.Users.Settings.GetLanguage
class	Gmail.Users.Settings.GetPop
class	Gmail.Users.Settings.GetVacation
class	Gmail.Users.Settings.SendAs The "sendAs" collection of methods.
class	Gmail.Users.Settings.UpdateAutoForwarding
class	Gmail.Users.Settings.UpdateImap
class	Gmail.Users.Settings.UpdateLanguage
class	Gmail.Users.Settings.UpdatePop
class	Gmail.Users.Settings.UpdateVacation

Constructor Summary

Constructors

Constructor and Description
Settings()

Method Summary

Modifier and Type	Method and Description
Gmail.Users.Settings.Cse	cse() An accessor for creating requests from the Cse collection.
Gmail.Users.Settings.Delegates	delegates() An accessor for creating requests from the Delegates collection.
Gmail.Users.Settings.Filters	filters() An accessor for creating requests from the Filters collection.
Gmail.Users.Settings.ForwardingAddresses	forwardingAddresses() An accessor for creating requests from the ForwardingAddresses collection.
Gmail.Users.Settings.GetAutoForwarding	getAutoForwarding(String userId) Gets the auto-forwarding setting for the specified account.
Gmail.Users.Settings.GetImap	getImap(String userId) Gets IMAP settings.
Gmail.Users.Settings.GetLanguage	getLanguage(String userId) Gets language settings.
Gmail.Users.Settings.GetPop	getPop(String userId) Gets POP settings.
Gmail.Users.Settings.GetVacation	getVacation(String userId) Gets vacation responder settings.
Gmail.Users.Settings.SendAs	sendAs() An accessor for creating requests from the SendAs collection.
Gmail.Users.Settings.UpdateAutoForwarding	updateAutoForwarding(String userId, AutoForwarding content) Updates the auto-forwarding setting for the specified account.
Gmail.Users.Settings.UpdateImap	updateImap(String userId, ImapSettings content) Updates IMAP settings.
Gmail.Users.Settings.UpdateLanguage	updateLanguage(String userId, LanguageSettings content) Updates language settings.
Gmail.Users.Settings.UpdatePop	updatePop(String userId, PopSettings content) Updates POP settings.
Gmail.Users.Settings.UpdateVacation	updateVacation(String userId, VacationSettings content) Updates vacation responder settings.

Methods inherited from class java.lang.Object

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

Constructor Detail

Settings

public Settings()

Method Detail

getAutoForwarding

public Gmail.Users.Settings.GetAutoForwarding getAutoForwarding(String userId)
                                                         throws IOException

Gets the auto-forwarding setting for the specified account. Create a request for the method "settings.getAutoForwarding". 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

getImap

public Gmail.Users.Settings.GetImap getImap(String userId)
                                     throws IOException

Gets IMAP settings. Create a request for the method "settings.getImap". 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

getLanguage

public Gmail.Users.Settings.GetLanguage getLanguage(String userId)
                                             throws IOException

Gets language settings. Create a request for the method "settings.getLanguage". 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

getPop

public Gmail.Users.Settings.GetPop getPop(String userId)
                                   throws IOException

Gets POP settings. Create a request for the method "settings.getPop". 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

getVacation

public Gmail.Users.Settings.GetVacation getVacation(String userId)
                                             throws IOException

Gets vacation responder settings. Create a request for the method "settings.getVacation". 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

updateAutoForwarding

public Gmail.Users.Settings.UpdateAutoForwarding updateAutoForwarding(String userId,
                                                                      AutoForwarding content)
                                                               throws IOException

Updates the auto-forwarding setting for the specified account. A verified forwarding address must be specified when auto-forwarding is enabled. This method is only available to service account clients that have been delegated domain-wide authority. Create a request for the method "settings.updateAutoForwarding". 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 AutoForwarding

Returns:

the request

Throws:

IOException

updateImap

public Gmail.Users.Settings.UpdateImap updateImap(String userId,
                                                  ImapSettings content)
                                           throws IOException

Updates IMAP settings. Create a request for the method "settings.updateImap". 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 ImapSettings

Returns:

the request

Throws:

IOException

updateLanguage

public Gmail.Users.Settings.UpdateLanguage updateLanguage(String userId,
                                                          LanguageSettings content)
                                                   throws IOException

Updates language settings. If successful, the return object contains the `displayLanguage` that was saved for the user, which may differ from the value passed into the request. This is because the requested `displayLanguage` may not be directly supported by Gmail but have a close variant that is, and so the variant may be chosen and saved instead. Create a request for the method "settings.updateLanguage". 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 LanguageSettings

Returns:

the request

Throws:

IOException

updatePop

public Gmail.Users.Settings.UpdatePop updatePop(String userId,
                                                PopSettings content)
                                         throws IOException

Updates POP settings. Create a request for the method "settings.updatePop". 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 PopSettings

Returns:

the request

Throws:

IOException

updateVacation

public Gmail.Users.Settings.UpdateVacation updateVacation(String userId,
                                                          VacationSettings content)
                                                   throws IOException

Updates vacation responder settings. Create a request for the method "settings.updateVacation". 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 VacationSettings

Returns:

the request

Throws:

IOException

cse

public Gmail.Users.Settings.Cse cse()

An accessor for creating requests from the Cse collection.

The typical use is:

    Gmail gmail = new Gmail(...);
    Gmail.Cse.List request = gmail.cse().list(parameters ...)
 

Returns:

the resource collection

delegates

public Gmail.Users.Settings.Delegates delegates()

An accessor for creating requests from the Delegates collection.

The typical use is:

    Gmail gmail = new Gmail(...);
    Gmail.Delegates.List request = gmail.delegates().list(parameters ...)
 

Returns:

the resource collection

filters

public Gmail.Users.Settings.Filters filters()

An accessor for creating requests from the Filters collection.

The typical use is:

    Gmail gmail = new Gmail(...);
    Gmail.Filters.List request = gmail.filters().list(parameters ...)
 

Returns:

the resource collection

forwardingAddresses

public Gmail.Users.Settings.ForwardingAddresses forwardingAddresses()

An accessor for creating requests from the ForwardingAddresses collection.

The typical use is:

    Gmail gmail = new Gmail(...);
    Gmail.ForwardingAddresses.List request = gmail.forwardingAddresses().list(parameters ...)
 

Returns:

the resource collection

sendAs

public Gmail.Users.Settings.SendAs sendAs()

An accessor for creating requests from the SendAs collection.

The typical use is:

    Gmail gmail = new Gmail(...);
    Gmail.SendAs.List request = gmail.sendAs().list(parameters ...)
 

Returns:

the resource collection