Aspose::Email::Clients::Imap::RestoreSettingsAsync Class Reference

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

Inherits Aspose::Email::Clients::Imap::RestoreSettings.

Public Member Functions

ASPOSE_EMAIL_SHARED_API System::AsyncCallback get_Callback () const
 References a method to be called when a corresponding asynchronous operation completes. More...
 
ASPOSE_EMAIL_SHARED_API void set_Callback (System::AsyncCallback value)
 References a method to be called when a corresponding asynchronous operation completes. More...
 
ASPOSE_EMAIL_SHARED_API System::SharedPtr< System::Object > get_State () const
 The state. More...
 
ASPOSE_EMAIL_SHARED_API void set_State (System::SharedPtr< System::Object > value)
 The state. More...
 
ASPOSE_EMAIL_SHARED_API RestoreSettingsAsync ()
 Initializes a new instance of the RestoreSettingsAsync class. More...
 
ASPOSE_EMAIL_SHARED_API RestoreSettingsAsync (System::SharedPtr< RestoreSettings > settings)
 Initialize RestoreSettingsAsync from RestoreSettings. More...
 
- Public Member Functions inherited from Aspose::Email::Clients::Imap::RestoreSettings
ASPOSE_EMAIL_SHARED_API System::SharedPtr< IConnectionget_Connection ()
 Connection to a server. More...
 
ASPOSE_EMAIL_SHARED_API void set_Connection (System::SharedPtr< IConnection > value)
 Connection to a server. More...
 
ASPOSE_EMAIL_SHARED_API Aspose::Email::Storage::Pst::RestoreOptions get_Options () const
 Restore options. More...
 
ASPOSE_EMAIL_SHARED_API void set_Options (Aspose::Email::Storage::Pst::RestoreOptions value)
 Restore options. More...
 
ASPOSE_EMAIL_SHARED_API System::SharedPtr< ImapFolderInfoCollection > get_Folders () const
 A folders to be restored. More...
 
ASPOSE_EMAIL_SHARED_API void set_Folders (System::SharedPtr< ImapFolderInfoCollection > value)
 A folders to be restored. More...
 
ASPOSE_EMAIL_SHARED_API Aspose::Email::Common::Delegate::BeforeItemCallback get_BeforeItemCallback () const
 The callback called when the next item (message or folder) is processed. More...
 
ASPOSE_EMAIL_SHARED_API void set_BeforeItemCallback (Aspose::Email::Common::Delegate::BeforeItemCallback value)
 The callback called when the next item (message or folder) is processed. More...
 
ASPOSE_EMAIL_SHARED_API 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...
 
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 () 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...
 
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 () 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...
 
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 bool get_RemoveNonexistentFolders () const
 Indicates that mail folders, which do not have the equal folders in the personal storage, should be removed More...
 
ASPOSE_EMAIL_SHARED_API void set_RemoveNonexistentFolders (bool value)
 Indicates that mail folders, which do not have the equal folders in the personal storage, should be removed More...
 
ASPOSE_EMAIL_SHARED_API bool get_RemoveNonexistentItems () const
 Indicates that mail items, which do not have the equal items in the personal storage, should be removed More...
 
ASPOSE_EMAIL_SHARED_API void set_RemoveNonexistentItems (bool value)
 Indicates that mail items, which do not have the equal items in the personal storage, should be removed More...
 
ASPOSE_EMAIL_SHARED_API bool get_Recursive () const
 Indicates that nested folders should be also restored More...
 
ASPOSE_EMAIL_SHARED_API void set_Recursive (bool value)
 Indicates that nested folders should be also restored More...
 
ASPOSE_EMAIL_SHARED_API void BeforeItemCallbackExecutor (System::SharedPtr< System::Object > item)
 
ASPOSE_EMAIL_SHARED_API RestoreSettings ()
 

Friends

class Aspose::Email::Clients::Imap::ImapClient
 

Additional Inherited Members

- Static Public Member Functions inherited from Aspose::Email::Clients::Imap::RestoreSettings
static ASPOSE_EMAIL_SHARED_API System::SharedPtr< RestoreSettingsto_RestoreSettings (Storage::Pst::RestoreOptions options)
 

Detailed Description

The settings for the ImapClient.Restore async method.

Constructor & Destructor Documentation

◆ RestoreSettingsAsync() [1/2]

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

Initializes a new instance of the RestoreSettingsAsync class.

◆ RestoreSettingsAsync() [2/2]

ASPOSE_EMAIL_SHARED_API Aspose::Email::Clients::Imap::RestoreSettingsAsync::RestoreSettingsAsync ( System::SharedPtr< RestoreSettings settings)

Initialize RestoreSettingsAsync from RestoreSettings.

Parameters
settings

Member Function Documentation

◆ get_Callback()

ASPOSE_EMAIL_SHARED_API System::AsyncCallback Aspose::Email::Clients::Imap::RestoreSettingsAsync::get_Callback ( ) const

References a method to be called when a corresponding asynchronous operation completes.

◆ get_State()

ASPOSE_EMAIL_SHARED_API System::SharedPtr<System::Object> Aspose::Email::Clients::Imap::RestoreSettingsAsync::get_State ( ) const

The state.

◆ set_Callback()

ASPOSE_EMAIL_SHARED_API void Aspose::Email::Clients::Imap::RestoreSettingsAsync::set_Callback ( System::AsyncCallback  value)

References a method to be called when a corresponding asynchronous operation completes.

◆ set_State()

ASPOSE_EMAIL_SHARED_API void Aspose::Email::Clients::Imap::RestoreSettingsAsync::set_State ( System::SharedPtr< System::Object >  value)

The state.

Friends And Related Function Documentation

◆ Aspose::Email::Clients::Imap::ImapClient

friend class Aspose::Email::Clients::Imap::ImapClient
friend