com.aspose.email

Interfaces

Classes

Enums

Exceptions

com.aspose.email

Class BackupSettings


  • public class BackupSettings
extends Object

    Class contains options for backup operation

    • Method Summary

      Methods 
      Modifier and Type Method and Description
      static BackupSettings getDefault()
      Gets BackupSettings class with settings by default
      boolean getExecuteRecursively()
      Gets or sets value which defines if backup should be executed recursively
      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.
      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 setExecuteRecursively(boolean value)
      Gets or sets value which defines if backup should be executed recursively
      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 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 BackupSettings to_BackupSettings(int options)
      Converts enumerable options to class

    • Constructor Detail

      • BackupSettings

        public BackupSettings()

        Initializes a new instance of the BackupSettings class

      • BackupSettings

        public BackupSettings(int options)

        Initializes a new instance of the BackupSettings class

        Parameters:
        options - enumerates backup options

      • BackupSettings

        public BackupSettings(boolean executeRecursively,
              boolean restoreConnection,
              int numberOfAttempts,
              int timeoutBetweenAttempts)

        Initializes a new instance of the BackupSettings class

        Parameters:
        executeRecursively - defines if backup should be executed recursively
        restoreConnection - defines if connection has to be restored in case if server closes connection forcibly
        numberOfAttempts - defines number of attempts to repeat failed operation
        timeoutBetweenAttempts - defines timeout (in milliseconds) between attemptions to execute operation again

    • Method Detail

      • to_BackupSettings

        public static BackupSettings to_BackupSettings(int options)

        Converts enumerable options to class

        Parameters:
        options - Options to convert

      • getExecuteRecursively

        public final boolean getExecuteRecursively()

        Gets or sets value which defines if backup should be executed recursively

      • setExecuteRecursively

        public final void setExecuteRecursively(boolean value)

        Gets or sets value which defines if backup should be executed recursively

      • 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.

      • setRestoreConnection

        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.

      • 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.

      • setNumberOfAttemptsToRrepeat

        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.

      • 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.

      • setTimeoutBetweenAttempts

        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.