initial_setup_sync


Description:

[ Version ( since = "3.20" ) ]
public virtual bool initial_setup_sync (out HashTable<unowned string,unowned string> out_save_setup, Cancellable? cancellable = null) throws Error

Runs initial setup for the this.

It's meant to preset some values the first time the account connects to the server after it had been created. The function should return true even if it didn't populate anything. The default implementation does just that.

The save_setup result, if not null, should be freed using g_hash_table_destroy. It's not an error to have it null, it only means the this doesn't have anything to save. Both the key and the value in the hash are newly allocated UTF-8 strings, owned by the hash table.

The this advertises support of this function by including CAMEL_STORE_SUPPORTS_INITIAL_SETUP in CamelStore: CamelStore:flagss.

Parameters:

this

a Store

out_save_setup

setup values to save

cancellable

optional Cancellable object, or null

Returns:

true on success, false on error