Aspose::Email::Clients::Imap::RestoreSettings Class Reference

The settings for the ImapClient.Restore method More...

Inherits Object.

Inherited by Aspose::Email::Clients::Imap::RestoreSettingsAsync.

Public Member Functions

System::SharedPtr< IConnectionget_Connection ()
 Connection to a server. More...
 
void set_Connection (System::SharedPtr< IConnection > value)
 Connection to a server. More...
 
Aspose::Email::Storage::Pst::RestoreOptions get_Options () const
 Restore options. More...
 
void set_Options (Aspose::Email::Storage::Pst::RestoreOptions value)
 Restore options. More...
 
System::SharedPtr< ImapFolderInfoCollectionget_Folders () const
 A folders to be restored. More...
 
void set_Folders (System::SharedPtr< ImapFolderInfoCollection > value)
 A folders to be restored. More...
 
Aspose::Email::Common::Delegate::BeforeItemCallback get_BeforeItemCallback () const
 The callback called when the next item (message or folder) is processed. More...
 
void set_BeforeItemCallback (Aspose::Email::Common::Delegate::BeforeItemCallback value)
 The callback called when the next item (message or folder) is processed. More...
 
bool get_RestoreConnection () const
 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...
 
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...
 
int32_t get_NumberOfAttemptsToRrepeat () const
 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...
 
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...
 
int32_t get_TimeoutBetweenAttempts () const
 Gets value which defines timeout (in milliseconds) between attemptions to execute operation again This option has to be used together with NumberOfAttemptsToRrepeat option. More...
 
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...
 
bool get_RemoveNonexistentFolders () const
 Indicates that mail folders, which do not have the equal folders in the personal storage, should be removed More...
 
void set_RemoveNonexistentFolders (bool value)
 Indicates that mail folders, which do not have the equal folders in the personal storage, should be removed More...
 
bool get_RemoveNonexistentItems () const
 Indicates that mail items, which do not have the equal items in the personal storage, should be removed More...
 
void set_RemoveNonexistentItems (bool value)
 Indicates that mail items, which do not have the equal items in the personal storage, should be removed More...
 
bool get_Recursive () const
 Indicates that nested folders should be also restored More...
 
void set_Recursive (bool value)
 Indicates that nested folders should be also restored More...
 
void BeforeItemCallbackExecutor (System::SharedPtr< System::Object > item)
 
 RestoreSettings ()
 

Static Public Member Functions

static System::SharedPtr< RestoreSettingsto_RestoreSettings (Storage::Pst::RestoreOptions options)
 

Friends

class Aspose::Email::Clients::Imap::Commands::RestoreGrCommand
 

Detailed Description

The settings for the ImapClient.Restore method

Constructor & Destructor Documentation

◆ RestoreSettings()

Aspose::Email::Clients::Imap::RestoreSettings::RestoreSettings ( )

Member Function Documentation

◆ BeforeItemCallbackExecutor()

void Aspose::Email::Clients::Imap::RestoreSettings::BeforeItemCallbackExecutor ( System::SharedPtr< System::Object >  item)

◆ get_BeforeItemCallback()

Aspose::Email::Common::Delegate::BeforeItemCallback Aspose::Email::Clients::Imap::RestoreSettings::get_BeforeItemCallback ( ) const

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

◆ get_Connection()

System::SharedPtr<IConnection> Aspose::Email::Clients::Imap::RestoreSettings::get_Connection ( )

Connection to a server.

◆ get_Folders()

System::SharedPtr<ImapFolderInfoCollection> Aspose::Email::Clients::Imap::RestoreSettings::get_Folders ( ) const

A folders to be restored.

◆ get_NumberOfAttemptsToRrepeat()

int32_t Aspose::Email::Clients::Imap::RestoreSettings::get_NumberOfAttemptsToRrepeat ( ) const

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_Options()

Aspose::Email::Storage::Pst::RestoreOptions Aspose::Email::Clients::Imap::RestoreSettings::get_Options ( ) const

Restore options.

◆ get_Recursive()

bool Aspose::Email::Clients::Imap::RestoreSettings::get_Recursive ( ) const

Indicates that nested folders should be also restored

◆ get_RemoveNonexistentFolders()

bool Aspose::Email::Clients::Imap::RestoreSettings::get_RemoveNonexistentFolders ( ) const

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

◆ get_RemoveNonexistentItems()

bool Aspose::Email::Clients::Imap::RestoreSettings::get_RemoveNonexistentItems ( ) const

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

◆ get_RestoreConnection()

bool Aspose::Email::Clients::Imap::RestoreSettings::get_RestoreConnection ( ) const

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()

int32_t Aspose::Email::Clients::Imap::RestoreSettings::get_TimeoutBetweenAttempts ( ) const

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

◆ set_BeforeItemCallback()

void Aspose::Email::Clients::Imap::RestoreSettings::set_BeforeItemCallback ( Aspose::Email::Common::Delegate::BeforeItemCallback  value)

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

◆ set_Connection()

void Aspose::Email::Clients::Imap::RestoreSettings::set_Connection ( System::SharedPtr< IConnection value)

Connection to a server.

◆ set_Folders()

void Aspose::Email::Clients::Imap::RestoreSettings::set_Folders ( System::SharedPtr< ImapFolderInfoCollection value)

A folders to be restored.

◆ set_NumberOfAttemptsToRrepeat()

void Aspose::Email::Clients::Imap::RestoreSettings::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_Options()

void Aspose::Email::Clients::Imap::RestoreSettings::set_Options ( Aspose::Email::Storage::Pst::RestoreOptions  value)

Restore options.

◆ set_Recursive()

void Aspose::Email::Clients::Imap::RestoreSettings::set_Recursive ( bool  value)

Indicates that nested folders should be also restored

◆ set_RemoveNonexistentFolders()

void Aspose::Email::Clients::Imap::RestoreSettings::set_RemoveNonexistentFolders ( bool  value)

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

◆ set_RemoveNonexistentItems()

void Aspose::Email::Clients::Imap::RestoreSettings::set_RemoveNonexistentItems ( bool  value)

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

◆ set_RestoreConnection()

void Aspose::Email::Clients::Imap::RestoreSettings::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()

void Aspose::Email::Clients::Imap::RestoreSettings::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_RestoreSettings()

static System::SharedPtr<RestoreSettings> Aspose::Email::Clients::Imap::RestoreSettings::to_RestoreSettings ( Storage::Pst::RestoreOptions  options)
static

Friends And Related Function Documentation

◆ Aspose::Email::Clients::Imap::Commands::RestoreGrCommand

friend class Aspose::Email::Clients::Imap::Commands::RestoreGrCommand
friend