ImapRestoreSettings

Inheritance: java.lang.Object

public class ImapRestoreSettings

The settings for the ImapClient.Restore method

Constructors

Constructor	Description
ImapRestoreSettings()

Methods

Method	Description
equals(Object arg0)
getBeforeItemCallback()	The callback called when the next item (message or folder) is processed.
getClass()
getConnection()	Connection to a server.
getFolders()	A folders to be restored.
getNumberOfAttemptsToRrepeat()	Gets or sets value which defines number of attempts to repeat failed operation In case of some IMAP command inside backup operation returns failed result, IMAP client tries to repeat this operation again according to defined quantity of times.
getOptions()	Restore options.
getRecursive()	Indicates that nested folders should be also restored
getRemoveNonexistentFolders()	Indicates that mail folders, which do not have the equal folders in the personal storage, should be removed
getRemoveNonexistentItems()	Indicates that mail items, which do not have the equal items in the personal storage, should be removed
getRestoreConnection()	Gets or sets value which defines if connection has to be restored in case if server closes connection forcibly This option has to be used together with NumberOfAttemptsToRrepeat option.
getTimeoutBetweenAttempts()	Gets or sets value which defines timeout (in milliseconds) between attemptions to execute operation again This option has to be used together with NumberOfAttemptsToRrepeat option.
hashCode()
notify()
notifyAll()
setBeforeItemCallback(BeforeItemCallback value)	The callback called when the next item (message or folder) is processed.
setConnection(IConnection value)	Connection to a server.
setFolders(ImapFolderInfoCollection value)	A folders to be restored.
setNumberOfAttemptsToRrepeat(int value)	Gets or sets value which defines number of attempts to repeat failed operation In case of some IMAP command inside backup operation returns failed result, IMAP client tries to repeat this operation again according to defined quantity of times.
setOptions(int value)	Restore options.
setRecursive(boolean value)	Indicates that nested folders should be also restored
setRemoveNonexistentFolders(boolean value)	Indicates that mail folders, which do not have the equal folders in the personal storage, should be removed
setRemoveNonexistentItems(boolean value)	Indicates that mail items, which do not have the equal items in the personal storage, should be removed
setRestoreConnection(boolean value)	Gets or sets value which defines if connection has to be restored in case if server closes connection forcibly This option has to be used together with NumberOfAttemptsToRrepeat option.
setTimeoutBetweenAttempts(int value)	Gets or sets value which defines timeout (in milliseconds) between attemptions to execute operation again This option has to be used together with NumberOfAttemptsToRrepeat option.
toString()
to_RestoreSettings(int options)	Converts enumerable options to class
wait()
wait(long arg0)
wait(long arg0, int arg1)

ImapRestoreSettings()

public ImapRestoreSettings()

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

Parameter	Type	Description
arg0	java.lang.Object

Returns: boolean

getBeforeItemCallback()

public final BeforeItemCallback getBeforeItemCallback()

The callback called when the next item (message or folder) is processed.

Returns: BeforeItemCallback

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getConnection()

public final IConnection getConnection()

Connection to a server.

Returns: IConnection

getFolders()

public final ImapFolderInfoCollection getFolders()

A folders to be restored.

Returns: ImapFolderInfoCollection

getNumberOfAttemptsToRrepeat()

public final int getNumberOfAttemptsToRrepeat()

Gets or sets value which defines number of attempts to repeat failed operation In case of some IMAP command inside backup operation returns failed result, IMAP client tries to repeat this operation again according to defined quantity of times. For instance if FETCH operation returns error AE_1_1_0243 FETCH 219 (BODY) AE_1_1_0243 NO[UNAVAILABLE] FETCH Service is temporarily not available Client tries to execute it again.

Returns: int

getOptions()

public final int getOptions()

Restore options.

Returns: int

getRecursive()

public final boolean getRecursive()

Indicates that nested folders should be also restored

Returns: boolean

getRemoveNonexistentFolders()

public final boolean getRemoveNonexistentFolders()

Indicates that mail folders, which do not have the equal folders in the personal storage, should be removed

Returns: boolean

getRemoveNonexistentItems()

public final boolean getRemoveNonexistentItems()

Indicates that mail items, which do not have the equal items in the personal storage, should be removed

Returns: boolean

getRestoreConnection()

public final boolean getRestoreConnection()

Gets or sets value which defines if connection has to be restored in case if server closes connection forcibly This option has to be used together with NumberOfAttemptsToRrepeat option.

Returns: boolean

getTimeoutBetweenAttempts()

public final int getTimeoutBetweenAttempts()

Gets or sets value which defines timeout (in milliseconds) between attemptions to execute operation again This option has to be used together with NumberOfAttemptsToRrepeat option.

Returns: int

hashCode()

public native int hashCode()

Returns: int

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

setBeforeItemCallback(BeforeItemCallback value)

public final void setBeforeItemCallback(BeforeItemCallback value)

The callback called when the next item (message or folder) is processed.

Parameters:

Parameter	Type	Description
value	BeforeItemCallback

setConnection(IConnection value)

public final void setConnection(IConnection value)

Connection to a server.

Parameters:

Parameter	Type	Description
value	IConnection

setFolders(ImapFolderInfoCollection value)

public final void setFolders(ImapFolderInfoCollection value)

A folders to be restored.

Parameters:

Parameter	Type	Description
value	ImapFolderInfoCollection

setNumberOfAttemptsToRrepeat(int value)

public final void setNumberOfAttemptsToRrepeat(int value)

Gets or sets value which defines number of attempts to repeat failed operation In case of some IMAP command inside backup operation returns failed result, IMAP client tries to repeat this operation again according to defined quantity of times. For instance if FETCH operation returns error AE_1_1_0243 FETCH 219 (BODY) AE_1_1_0243 NO[UNAVAILABLE] FETCH Service is temporarily not available Client tries to execute it again.

Parameters:

Parameter	Type	Description
value	int

setOptions(int value)

public final void setOptions(int value)

Restore options.

Parameters:

Parameter	Type	Description
value	int

setRecursive(boolean value)

public final void setRecursive(boolean value)

Indicates that nested folders should be also restored

Parameters:

Parameter	Type	Description
value	boolean

setRemoveNonexistentFolders(boolean value)

public final void setRemoveNonexistentFolders(boolean value)

Indicates that mail folders, which do not have the equal folders in the personal storage, should be removed

Parameters:

Parameter	Type	Description
value	boolean

setRemoveNonexistentItems(boolean value)

public final void setRemoveNonexistentItems(boolean value)

Indicates that mail items, which do not have the equal items in the personal storage, should be removed

Parameters:

Parameter	Type	Description
value	boolean

setRestoreConnection(boolean value)

public final void setRestoreConnection(boolean value)

Gets or sets value which defines if connection has to be restored in case if server closes connection forcibly This option has to be used together with NumberOfAttemptsToRrepeat option.

Parameters:

Parameter	Type	Description
value	boolean

setTimeoutBetweenAttempts(int value)

public final void setTimeoutBetweenAttempts(int value)

Gets or sets value which defines timeout (in milliseconds) between attemptions to execute operation again This option has to be used together with NumberOfAttemptsToRrepeat option.

Parameters:

Parameter	Type	Description
value	int

toString()

public String toString()

Returns: java.lang.String

to_RestoreSettings(int options)

public static ImapRestoreSettings to_RestoreSettings(int options)

Converts enumerable options to class

Parameters:

Parameter	Type	Description
options	int	Options to convert

Returns: ImapRestoreSettings

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Parameters:

Parameter	Type	Description
arg0	long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

Parameter	Type	Description
arg0	long
arg1	int