Aspose::Email::Clients::Imap::BackupSettings Class Reference

Class contains options for backup operation More...

Inherits Object.

Public Member Functions

ASPOSE_EMAIL_SHARED_API bool get_ExecuteRecursively ()
 Gets value which defines if backup should be executed recursively More...
 
ASPOSE_EMAIL_SHARED_API void set_ExecuteRecursively (bool value)
 Sets value which defines if backup should be executed recursively More...
 
ASPOSE_EMAIL_SHARED_API bool get_RestoreConnection ()
 Gets 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. More...
 
ASPOSE_EMAIL_SHARED_API void set_RestoreConnection (bool value)
 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. More...
 
ASPOSE_EMAIL_SHARED_API int32_t get_NumberOfAttemptsToRrepeat ()
 Gets 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. More...
 
ASPOSE_EMAIL_SHARED_API void set_NumberOfAttemptsToRrepeat (int32_t value)
 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. More...
 
ASPOSE_EMAIL_SHARED_API int32_t get_TimeoutBetweenAttempts ()
 Gets value which defines timeout (in milliseconds) between attemptions to execute operation again This option has to be used together with NumberOfAttemptsToRrepeat option. More...
 
ASPOSE_EMAIL_SHARED_API void set_TimeoutBetweenAttempts (int32_t value)
 Sets value which defines timeout (in milliseconds) between attemptions to execute operation again This option has to be used together with NumberOfAttemptsToRrepeat option. More...
 
ASPOSE_EMAIL_SHARED_API BackupSettings ()
 Initializes a new instance of the BackupSettings class More...
 
ASPOSE_EMAIL_SHARED_API BackupSettings (Storage::Pst::BackupOptions options)
 Initializes a new instance of the BackupSettings class More...
 
ASPOSE_EMAIL_SHARED_API BackupSettings (bool executeRecursively, bool restoreConnection, int32_t numberOfAttempts, int32_t timeoutBetweenAttempts)
 Initializes a new instance of the BackupSettings class More...
 

Static Public Member Functions

static ASPOSE_EMAIL_SHARED_API System::SharedPtr< BackupSettingsget_Default ()
 Gets BackupSettings class with settings by default More...
 
static ASPOSE_EMAIL_SHARED_API System::SharedPtr< BackupSettingsto_BackupSettings (Storage::Pst::BackupOptions options)
 

Detailed Description

Class contains options for backup operation

Constructor & Destructor Documentation

◆ BackupSettings() [1/3]

ASPOSE_EMAIL_SHARED_API Aspose::Email::Clients::Imap::BackupSettings::BackupSettings ( )

Initializes a new instance of the BackupSettings class

◆ BackupSettings() [2/3]

ASPOSE_EMAIL_SHARED_API Aspose::Email::Clients::Imap::BackupSettings::BackupSettings ( Storage::Pst::BackupOptions  options)

Initializes a new instance of the BackupSettings class

Parameters
optionsenumerates backup options

◆ BackupSettings() [3/3]

ASPOSE_EMAIL_SHARED_API Aspose::Email::Clients::Imap::BackupSettings::BackupSettings ( bool  executeRecursively,
bool  restoreConnection,
int32_t  numberOfAttempts,
int32_t  timeoutBetweenAttempts 
)

Initializes a new instance of the BackupSettings class

Parameters
executeRecursivelydefines if backup should be executed recursively
restoreConnectiondefines if connection has to be restored in case if server closes connection forcibly
numberOfAttemptsdefines number of attempts to repeat failed operation
timeoutBetweenAttemptsdefines timeout (in milliseconds) between attemptions to execute operation again

Member Function Documentation

◆ get_Default()

static ASPOSE_EMAIL_SHARED_API System::SharedPtr<BackupSettings> Aspose::Email::Clients::Imap::BackupSettings::get_Default ( )
static

Gets BackupSettings class with settings by default

◆ get_ExecuteRecursively()

ASPOSE_EMAIL_SHARED_API bool Aspose::Email::Clients::Imap::BackupSettings::get_ExecuteRecursively ( )

Gets value which defines if backup should be executed recursively

◆ get_NumberOfAttemptsToRrepeat()

ASPOSE_EMAIL_SHARED_API int32_t Aspose::Email::Clients::Imap::BackupSettings::get_NumberOfAttemptsToRrepeat ( )

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

◆ get_RestoreConnection()

ASPOSE_EMAIL_SHARED_API bool Aspose::Email::Clients::Imap::BackupSettings::get_RestoreConnection ( )

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

◆ get_TimeoutBetweenAttempts()

ASPOSE_EMAIL_SHARED_API int32_t Aspose::Email::Clients::Imap::BackupSettings::get_TimeoutBetweenAttempts ( )

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

◆ set_ExecuteRecursively()

ASPOSE_EMAIL_SHARED_API void Aspose::Email::Clients::Imap::BackupSettings::set_ExecuteRecursively ( bool  value)

Sets value which defines if backup should be executed recursively

◆ set_NumberOfAttemptsToRrepeat()

ASPOSE_EMAIL_SHARED_API void Aspose::Email::Clients::Imap::BackupSettings::set_NumberOfAttemptsToRrepeat ( int32_t  value)

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.

◆ set_RestoreConnection()

ASPOSE_EMAIL_SHARED_API void Aspose::Email::Clients::Imap::BackupSettings::set_RestoreConnection ( bool  value)

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.

◆ set_TimeoutBetweenAttempts()

ASPOSE_EMAIL_SHARED_API void Aspose::Email::Clients::Imap::BackupSettings::set_TimeoutBetweenAttempts ( int32_t  value)

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

◆ to_BackupSettings()

static ASPOSE_EMAIL_SHARED_API System::SharedPtr<BackupSettings> Aspose::Email::Clients::Imap::BackupSettings::to_BackupSettings ( Storage::Pst::BackupOptions  options)
static