ImapRestoreSettings

Inheritance: java.lang.Object

public class ImapRestoreSettings

The settings for the ImapClient.Restore method

Constructors

Constructor Description
ImapRestoreSettings()

Methods

Method Description
to_RestoreSettings(int options) Converts enumerable options to class
getConnection() Connection to a server.
setConnection(IConnection value) Connection to a server.
getOptions() Restore options.
setOptions(int value) Restore options.
getFolders() A folders to be restored.
setFolders(ImapFolderInfoCollection value) A folders to be restored.
getBeforeItemCallback() The callback called when the next item (message or folder) is processed.
setBeforeItemCallback(BeforeItemCallback value) The callback called when the next item (message or folder) is processed.
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.
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.
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.
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.
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.
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.
getRemoveNonexistentFolders() Indicates that mail folders, which do not have the equal folders in the personal storage, should be removed
setRemoveNonexistentFolders(boolean value) 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
setRemoveNonexistentItems(boolean value) Indicates that mail items, which do not have the equal items in the personal storage, should be removed
getRecursive() Indicates that nested folders should be also restored
setRecursive(boolean value) Indicates that nested folders should be also restored

ImapRestoreSettings()

public ImapRestoreSettings()

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

getConnection()

public final IConnection getConnection()

Connection to a server.

Returns: IConnection

setConnection(IConnection value)

public final void setConnection(IConnection value)

Connection to a server.

Parameters:

Parameter Type Description
value IConnection

getOptions()

public final int getOptions()

Restore options.

Returns: int

setOptions(int value)

public final void setOptions(int value)

Restore options.

Parameters:

Parameter Type Description
value int

getFolders()

public final ImapFolderInfoCollection getFolders()

A folders to be restored.

Returns: ImapFolderInfoCollection

setFolders(ImapFolderInfoCollection value)

public final void setFolders(ImapFolderInfoCollection value)

A folders to be restored.

Parameters:

Parameter Type Description
value ImapFolderInfoCollection

getBeforeItemCallback()

public final BeforeItemCallback getBeforeItemCallback()

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

Returns: BeforeItemCallback

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

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

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

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

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

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

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

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

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

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

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

getRecursive()

public final boolean getRecursive()

Indicates that nested folders should be also restored

Returns: boolean

setRecursive(boolean value)

public final void setRecursive(boolean value)

Indicates that nested folders should be also restored

Parameters:

Parameter Type Description
value boolean