com.google.api.services.gmail.model

Class ImapSettings

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.gmail.model.ImapSettings

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class ImapSettings
extends GenericJson

IMAP settings for an account.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Gmail API. For a detailed explanation see: http://code.google.com/p/google-http-java-client/wiki/JSON

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
ImapSettings()

Method Summary

Methods

Modifier and Type	Method and Description
ImapSettings	clone()
Boolean	getAutoExpunge() If this value is true, Gmail will immediately expunge a message when it is marked as deleted in IMAP.
Boolean	getEnabled() Whether IMAP is enabled for the account.
String	getExpungeBehavior() The action that will be executed on a message when it is marked as deleted and expunged from the last visible IMAP folder.
Integer	getMaxFolderSize() An optional limit on the number of messages that an IMAP folder may contain.
ImapSettings	set(String fieldName, Object value)
ImapSettings	setAutoExpunge(Boolean autoExpunge) If this value is true, Gmail will immediately expunge a message when it is marked as deleted in IMAP.
ImapSettings	setEnabled(Boolean enabled) Whether IMAP is enabled for the account.
ImapSettings	setExpungeBehavior(String expungeBehavior) The action that will be executed on a message when it is marked as deleted and expunged from the last visible IMAP folder.
ImapSettings	setMaxFolderSize(Integer maxFolderSize) An optional limit on the number of messages that an IMAP folder may contain.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ImapSettings

public ImapSettings()

Method Detail

getAutoExpunge

public Boolean getAutoExpunge()

If this value is true, Gmail will immediately expunge a message when it is marked as deleted in IMAP. Otherwise, Gmail will wait for an update from the client before expunging messages marked as deleted.

Returns:

value or null for none

setAutoExpunge

public ImapSettings setAutoExpunge(Boolean autoExpunge)

If this value is true, Gmail will immediately expunge a message when it is marked as deleted in IMAP. Otherwise, Gmail will wait for an update from the client before expunging messages marked as deleted.

Parameters:

autoExpunge - autoExpunge or null for none

getEnabled

public Boolean getEnabled()

Whether IMAP is enabled for the account.

Returns:

value or null for none

setEnabled

public ImapSettings setEnabled(Boolean enabled)

Whether IMAP is enabled for the account.

Parameters:

enabled - enabled or null for none

getExpungeBehavior

public String getExpungeBehavior()

The action that will be executed on a message when it is marked as deleted and expunged from the last visible IMAP folder.

Returns:

value or null for none

setExpungeBehavior

public ImapSettings setExpungeBehavior(String expungeBehavior)

The action that will be executed on a message when it is marked as deleted and expunged from the last visible IMAP folder.

Parameters:

expungeBehavior - expungeBehavior or null for none

getMaxFolderSize

public Integer getMaxFolderSize()

An optional limit on the number of messages that an IMAP folder may contain. Legal values are 0, 1000, 2000, 5000 or 10000. A value of zero is interpreted to mean that there is no limit.

Returns:

value or null for none

setMaxFolderSize

public ImapSettings setMaxFolderSize(Integer maxFolderSize)

An optional limit on the number of messages that an IMAP folder may contain. Legal values are 0, 1000, 2000, 5000 or 10000. A value of zero is interpreted to mean that there is no limit.

Parameters:

maxFolderSize - maxFolderSize or null for none

set

public ImapSettings set(String fieldName,
               Object value)

Overrides:

set in class GenericJson

clone

public ImapSettings clone()

Overrides:

clone in class GenericJson