com.aspose.email

Interfaces

Classes

Enums

Exceptions

com.aspose.email

Class ImapRestoreSettings

    • Method Summary

      Methods 
      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 getRecursive()
      Indicates that nested folders should be also restored
      boolean getRemoveNonexistentFolders()
      Indicates that mail folders, which do not have the equal folders in the personal storage, should be removed
      boolean getRemoveNonexistentItems()
      Indicates that mail items, which do not have the equal items in the personal storage, should be removed
      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 setRecursive(boolean value)
      Indicates that nested folders should be also restored
      void setRemoveNonexistentFolders(boolean value)
      Indicates that mail folders, which do not have the equal folders in the personal storage, should be removed
      void setRemoveNonexistentItems(boolean value)
      Indicates that mail items, which do not have the equal items in the personal storage, should be removed
      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
    • Constructor Detail

      • ImapRestoreSettings

        public ImapRestoreSettings()
    • Method Detail

      • to_RestoreSettings

        public static ImapRestoreSettings to_RestoreSettings(int options)

        Converts enumerable options to class

        Parameters:
        options - Options to convert
      • getConnection

        public final IConnection getConnection()

        Connection to a server.

      • setConnection

        public final void setConnection(IConnection value)

        Connection to a server.

      • getOptions

        public final int getOptions()

        Restore options.

      • setOptions

        public final void setOptions(int value)

        Restore options.

      • getBeforeItemCallback

        public final BeforeItemCallback getBeforeItemCallback()

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

      • setBeforeItemCallback

        public final void setBeforeItemCallback(BeforeItemCallback value)

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

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

      • getRemoveNonexistentFolders

        public final boolean getRemoveNonexistentFolders()

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

      • setRemoveNonexistentFolders

        public final void setRemoveNonexistentFolders(boolean value)

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

      • getRemoveNonexistentItems

        public final boolean getRemoveNonexistentItems()

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

      • setRemoveNonexistentItems

        public final void setRemoveNonexistentItems(boolean value)

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

      • getRecursive

        public final boolean getRecursive()

        Indicates that nested folders should be also restored

      • setRecursive

        public final void setRecursive(boolean value)

        Indicates that nested folders should be also restored