public class ImapRestoreSettings extends Object
The settings for the ImapClient.Restore method
Constructor and Description |
---|
ImapRestoreSettings() |
Modifier and Type | Method and Description |
---|---|
BeforeItemCallback |
getBeforeItemCallback()
The callback called when the next item (message or folder) is processed.
|
IConnection |
getConnection()
Connection to a server.
|
ImapFolderInfoCollection |
getFolders()
A folders to be restored.
|
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.
|
int |
getOptions()
Restore options.
|
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.
|
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.
|
void |
setBeforeItemCallback(BeforeItemCallback value)
The callback called when the next item (message or folder) is processed.
|
void |
setConnection(IConnection value)
Connection to a server.
|
void |
setFolders(ImapFolderInfoCollection value)
A folders to be restored.
|
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.
|
void |
setOptions(int value)
Restore options.
|
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.
|
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.
|
static ImapRestoreSettings |
to_RestoreSettings(int options)
Converts enumerable options to class
|
public static ImapRestoreSettings to_RestoreSettings(int options)
Converts enumerable options to class
options
- Options to convertpublic final IConnection getConnection()
Connection to a server.
public final void setConnection(IConnection value)
Connection to a server.
public final int getOptions()
Restore options.
public final void setOptions(int value)
Restore options.
public final ImapFolderInfoCollection getFolders()
A folders to be restored.
public final void setFolders(ImapFolderInfoCollection value)
A folders to be restored.
public final BeforeItemCallback getBeforeItemCallback()
The callback called when the next item (message or folder) is processed.
public final void setBeforeItemCallback(BeforeItemCallback value)
The callback called when the next item (message or folder) is processed.
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.
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.
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.
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.
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.
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.
Copyright (c) 2008-2019 Aspose Pty Ltd. All Rights Reserved.