Gjsify LogoGjsify Logo

Index

Enumerations

Classes

Interfaces

Variables

Functions

Variables

CLIENT_BACKEND_PROPERTY_CACHE_DIR: string

The "cache-dir" property indicates the backend's local directory for cached data.

CLIENT_BACKEND_PROPERTY_CAPABILITIES: string

The "capabilities" property is a comma-separated list of capabilities supported by the backend. The preferred method of retrieving and working with capabilities is e_client_get_capabilities() and e_client_check_capability().

CLIENT_BACKEND_PROPERTY_ONLINE: string

The "online" property is "TRUE" when the client is fully opened and online, "FALSE" at all other times. See also e_client_is_online().

CLIENT_BACKEND_PROPERTY_OPENED: string

The "opened" property is "TRUE" when the client is fully opened, "FALSE" at all other times.

CLIENT_BACKEND_PROPERTY_OPENING: string

The "opening" property is "TRUE" when the client is in the process of opening, "FALSE" at all other times.

CLIENT_BACKEND_PROPERTY_READONLY: string

The "online" property is "TRUE" if the backend has only read access to its data, "FALSE" if the backend can modify its data. See also e_client_is_readonly().

CLIENT_BACKEND_PROPERTY_REVISION: string

The current overall revision string, this can be used as a quick check to see if data has changed at all since the last time the revision was observed.

DEBUG_LOG_DOMAIN_CAL_QUERIES: string
DEBUG_LOG_DOMAIN_GLOG: string
DEBUG_LOG_DOMAIN_USER: string
EDS_MAJOR_VERSION: number

The major version number of the Evolution-Data-Server library. Like eds_major_version(), but from the headers used at application compile time, rather than from the library linked against at application run time.

EDS_MICRO_VERSION: number

The micro version number of the Evolution-Data-Server library. Like eds_micro_version(), but from the headers used at application compile time, rather than from the library linked against at application run time.

EDS_MINOR_VERSION: number

The minor version number of the Evolution-Data-Server library. Like eds_minor_version(), but from the headers used at application compile time, rather than from the library linked against at application run time.

NETWORK_MONITOR_ALWAYS_ONLINE_NAME: string

A special name, which can be used as a GIO name in the call to e_network_monitor_set_gio_name(), which is used to report the network as always reachable.

OAUTH2_SECRET_ACCESS_TOKEN: string
OAUTH2_SECRET_EXPIRES_AFTER: string
OAUTH2_SECRET_REFRESH_TOKEN: string
SOURCE_CREDENTIAL_PASSWORD: string

A name of the named parameter used for passwords in credentials, used to authenticate users with e_source_invoke_authenticate_sync() and e_source_invoke_authenticate(). The named parameter is optional, different authentication methods can use different names.

SOURCE_CREDENTIAL_SSL_TRUST: string

A name of the named parameter used for SSL/TLS trust in credentials, used to authenticate users with e_source_invoke_authenticate_sync() and e_source_invoke_authenticate(). The named parameter is optional. Its value corresponds to current ESourceWebdav::ssl-trust property, in case the ESource has that extension available. This is required to have up-to-date data on the server side, when the client side just saved the SSL trust change, which might not be propagated into the server (factory) side quickly enough. The key is added into the credentials in e_source_invoke_authenticate() automatically, if the corresponding ESource contain a WebDAV extension and the key is not part of the credentials already.

SOURCE_CREDENTIAL_USERNAME: string

A name of the named parameter used for usernames in credentials, used to authenticate users with e_source_invoke_authenticate_sync() and e_source_invoke_authenticate(). The named parameter is optional, different authentication methods can use different names.

SOURCE_EXTENSION_ADDRESS_BOOK: string

Pass this extension name to e_source_get_extension() to access #ESourceAddressBook. This is also used as a group name in key files.

SOURCE_EXTENSION_ALARMS: string

Pass this extension name to e_source_get_extension() to access #ESourceAlarms. This is also used as a group name in key files.

SOURCE_EXTENSION_AUTHENTICATION: string

Pass this extension name to e_source_get_extension() to access #ESourceAuthentication. This is also used as a group name in key files.

SOURCE_EXTENSION_AUTOCOMPLETE: string

Pass this extension name to e_source_get_extension() to access #ESourceAutocomplete. This is also used as a group name in key files.

SOURCE_EXTENSION_AUTOCONFIG: string

Pass this extension name to e_source_get_extension() to access #ESourceAutoconfig. This is also used as a group name in key files.

SOURCE_EXTENSION_CALENDAR: string

Pass this extension name to e_source_get_extension() to access #ESourceCalendar. This is also used as a group name in key files.

SOURCE_EXTENSION_COLLECTION: string

Pass this extension name to e_source_get_extension() to access #ESourceCollection. This is also used as a group name in key files.

SOURCE_EXTENSION_CONTACTS_BACKEND: string

Pass this extension name to e_source_get_extension() to access #ESourceContacts. This is also used as a group name in key files.

SOURCE_EXTENSION_GOA: string

Pass this extension name to e_source_get_extension() to access #ESourceGoa. This is also used as a group name in key files.

SOURCE_EXTENSION_LDAP_BACKEND: string

Pass this extension name to e_source_get_extension() to access #ESourceLDAP. This is also used as a group name in key files.

SOURCE_EXTENSION_LOCAL_BACKEND: string

Pass this extension name to e_source_get_extension() to access #ESourceLocal. This is also used as a group name in key files.

SOURCE_EXTENSION_MAIL_ACCOUNT: string

Pass this extension name to e_source_get_extension() to access #ESourceMailAccount. This is also used as a group name in key files.

SOURCE_EXTENSION_MAIL_COMPOSITION: string

Pass this extension name to e_source_get_extension() to access #ESourceMailComposition. This is also used as a group name in key files.

SOURCE_EXTENSION_MAIL_IDENTITY: string

Pass this extension name to e_source_get_extension() to access #ESourceMailIdentity. This is also used as a group name in key files.

SOURCE_EXTENSION_MAIL_SIGNATURE: string

Pass this extension name to e_source_get_extension() to access #ESourceMailSignature. This is also used as a group name in key files.

SOURCE_EXTENSION_MAIL_SUBMISSION: string

Pass this extension name to e_source_get_extension() to access #ESourceMailSubmission. This is also used as a group name in key files.

SOURCE_EXTENSION_MAIL_TRANSPORT: string

Pass this extension name to e_source_get_extension() to access #ESourceMailTransport. This is also used as a group name in key files.

SOURCE_EXTENSION_MDN: string

Pass this extension name to e_source_get_extension() to access #ESourceMDN. This is also used as a group name in key files.

SOURCE_EXTENSION_MEMO_LIST: string

Pass this extension name to e_source_get_extension() to access #ESourceMemoList. This is also used as a group name in key files.

SOURCE_EXTENSION_OFFLINE: string

Pass this extension name to e_source_get_extension() to access #ESourceOffline. This is also used as a group name in key files.

SOURCE_EXTENSION_OPENPGP: string

Pass this extension name to e_source_get_extension() to access #ESourceOpenPGP. This is also used as a group name in key files.

SOURCE_EXTENSION_PROXY: string

Pass this extension name to e_source_get_extension() to access #ESourceProxy. This is also used as a group name in key files.

SOURCE_EXTENSION_REFRESH: string

Pass this extension name to e_source_get_extension() to access #ESourceRefresh. This is also used as a group name in key files.

SOURCE_EXTENSION_RESOURCE: string

Pass this extension name to e_source_get_extension() to access #ESourceResource. This is also used as a group name in key files.

SOURCE_EXTENSION_REVISION_GUARDS: string

Pass this extension name to e_source_get_extension() to access #ESourceRevisionGuards. This is also used as a group name in key files.

SOURCE_EXTENSION_SECURITY: string

Pass this extension name to e_source_get_extension() to access #ESourceSecurity. This is also used as a group name in key files.

SOURCE_EXTENSION_SMIME: string

Pass this extension name to e_source_get_extension() to access #ESourceSMIME. This is also used as a group name in key files.

SOURCE_EXTENSION_TASK_LIST: string

Pass this extension name to e_source_get_extension() to access #ESourceTaskList. This is also used as a group name in key files.

SOURCE_EXTENSION_UOA: string

Pass this extension name to e_source_get_extension() to access #ESourceUoa. This is also used as a group name in key files.

SOURCE_EXTENSION_WEATHER_BACKEND: string

Pass this extension name to e_source_get_extension() to access #ESourceWeather. This is also used as a group name in key files.

SOURCE_EXTENSION_WEBDAV_BACKEND: string

Pass this extension name to e_source_get_extension() to access #ESourceWebdav. This is also used as a group name in key files.

SOURCE_EXTENSION_WEBDAV_NOTES: string

Pass this extension name to e_source_get_extension() to access #ESourceWebDAVNotes. This is also used as a group name in key files.

SOURCE_PARAM_SETTING: number

Extends #GParamFlags to indicate the #GObject property is associated with a key file value. Use this flag when installing #GObject properties in #ESourceExtension subclasses.

WEBDAV_CAPABILITY_ACCESS_CONTROL: string
WEBDAV_CAPABILITY_ADDRESSBOOK: string
WEBDAV_CAPABILITY_BIND: string
WEBDAV_CAPABILITY_CALENDAR_ACCESS: string
WEBDAV_CAPABILITY_CALENDAR_AUTO_SCHEDULE: string
WEBDAV_CAPABILITY_CALENDAR_PROXY: string
WEBDAV_CAPABILITY_CALENDAR_SCHEDULE: string
WEBDAV_CAPABILITY_CLASS_1: string
WEBDAV_CAPABILITY_CLASS_2: string
WEBDAV_CAPABILITY_CLASS_3: string
WEBDAV_CAPABILITY_EXTENDED_MKCOL: string
WEBDAV_COLLATION_ASCII_CASEMAP: string
WEBDAV_COLLATION_ASCII_CASEMAP_SUFFIX: string
WEBDAV_COLLATION_ASCII_NUMERIC: string
WEBDAV_COLLATION_ASCII_NUMERIC_SUFFIX: string
WEBDAV_COLLATION_OCTET: string
WEBDAV_COLLATION_OCTET_SUFFIX: string
WEBDAV_COLLATION_UNICODE_CASEMAP: string
WEBDAV_COLLATION_UNICODE_CASEMAP_SUFFIX: string
WEBDAV_CONTENT_TYPE_CALENDAR: string
WEBDAV_CONTENT_TYPE_VCARD: string
WEBDAV_CONTENT_TYPE_XML: string
WEBDAV_DEPTH_INFINITY: string
WEBDAV_DEPTH_THIS: string
WEBDAV_DEPTH_THIS_AND_CHILDREN: string
WEBDAV_NS_CALDAV: string
WEBDAV_NS_CALENDARSERVER: string
WEBDAV_NS_CARDDAV: string
WEBDAV_NS_DAV: string
WEBDAV_NS_ICAL: string

Functions

  • Thread safe variant of g_object_bind_property(). See its documentation for more information on arguments and return value.

    Parameters

    • source: GObject.Object

      the source #GObject

    • sourceProperty: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • targetProperty: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    Returns Binding

  • Thread safe variant of g_object_bind_property_with_closures(). See its documentation for more information on arguments and return value.

    Parameters

    • source: GObject.Object

      the source #GObject

    • sourceProperty: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • targetProperty: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    • transformTo: TClosure<any, any>

      a #GClosure wrapping the transformation function from the source to the target, or %NULL to use the default

    • transformFrom: TClosure<any, any>

      a #GClosure wrapping the transformation function from the target to the source, or %NULL to use the default

    Returns Binding

  • bindingTransformEnumNickToValue(binding: Binding, sourceValue: any, targetValue: any, notUsed: object): boolean
  • Transforms an enumeration nickname to its corresponding value.

    Parameters

    • binding: Binding

      a #GBinding

    • sourceValue: any

      a #GValue of type #G_TYPE_STRING

    • targetValue: any

      a #GValue whose type is derived from #G_TYPE_ENUM

    • notUsed: object

      not used

    Returns boolean

  • bindingTransformEnumValueToNick(binding: Binding, sourceValue: any, targetValue: any, notUsed: object): boolean
  • Transforms an enumeration value to its corresponding nickname.

    Parameters

    • binding: Binding

      a #GBinding

    • sourceValue: any

      a #GValue whose type is derived from #G_TYPE_ENUM

    • targetValue: any

      a #GValue of type #G_TYPE_STRING

    • notUsed: object

      not used

    Returns boolean

  • categoriesAdd(category: string, unused: string, iconFile: string, searchable: boolean): void
  • Adds a new category, with its corresponding icon, to the configuration database.

    This function is thread safe.

    Parameters

    • category: string

      name of category to add.

    • unused: string

      DEPRECATED! associated color. DEPRECATED!

    • iconFile: string

      full path of the icon associated to the category.

    • searchable: boolean

      whether the category can be used for searching in the GUI.

    Returns void

  • categoriesDupIconFileFor(category: string): string
  • Gets the icon file associated with the given category and returns a copy of it.

    This function is thread safe.

    Parameters

    • category: string

      category to retrieve the icon file for.

    Returns string

  • categoriesDupList(): string[]
  • Returns a sorted list of all the category names currently configured.

    This function is thread safe.

    Returns string[]

  • categoriesExist(category: string): boolean
  • Checks whether the given category is available in the configuration.

    This function is thread safe.

    Parameters

    • category: string

      category to be searched.

    Returns boolean

  • categoriesGetIconFileFor(category: string): string
  • Gets the icon file associated with the given category.

    This function is mostly thread safe, but as the icon file name is not copied, it may be freed by another thread after being returned by this function. Use e_categories_dup_icon_file_for() instead.

    Parameters

    • category: string

      category to retrieve the icon file for.

    Returns string

  • categoriesGetList(): string[]
  • Returns a sorted list of all the category names currently configured.

    This function is mostly thread safe, but as the category names are not copied, they may be freed by another thread after being returned by this function. Use e_categories_dup_list() instead.

    Returns string[]

  • categoriesIsSearchable(category: string): boolean
  • Gets whether the given calendar is to be used for searches in the GUI.

    This function is thread safe.

    Return value; %TRUE% if the category is searchable, %FALSE% if not.

    Parameters

    • category: string

      category name.

    Returns boolean

  • Registers callback to be called on change of any category. Pair listener and user_data is used to distinguish between listeners. Listeners can be unregistered with e_categories_unregister_change_listener.

    This function is thread safe.

    Parameters

    • listener: GObject.Callback

      the callback to be called on any category change.

    Returns void

  • categoriesRemove(category: string): void
  • Removes the given category from the configuration.

    This function is thread safe.

    Parameters

    • category: string

      category to be removed.

    Returns void

  • categoriesSetIconFileFor(category: string, iconFile: string): void
  • Sets the icon file associated with the given category.

    This function is thread safe.

    Parameters

    • category: string

      category to set the icon file for.

    • iconFile: string

      icon file.

    Returns void

  • Removes previously registered callback from the list of listeners on changes. If it was not registered, then does nothing.

    This function is thread safe.

    Parameters

    Returns void

  • collatorErrorQuark(): Quark
  • dataServerUtilGetDbusCallTimeout(): number
  • dataServerUtilSetDbusCallTimeout(timeoutMsec: number): void
  • Sets default timeout, in milliseconds, for calls of g_dbus_proxy_call() family functions.

    -1 means the default value as set by D-Bus itself. G_MAXINT means no timeout at all.

    Default value is set also by configure option --with-dbus-call-timeout=ms and -1 is used when not set.

    Parameters

    • timeoutMsec: number

      default timeout for D-Bus calls in miliseconds

    Returns void

  • debugLogClear(): void
  • debugLogDisableDomains(domains: string[]): void
  • Disables all domains from the domains array.

    Parameters

    • domains: string[]

      an array of domains to disable

    Returns void

  • debugLogDump(filename: string): boolean
  • Saves current log information to the given filename.

    Parameters

    • filename: string

      a filename to save logged information to

    Returns boolean

  • debugLogDumpToDatedFile(): boolean
  • Saves current log information to a file "e-debug-log-YYYY-MM-DD-HH-mm-ss.txt" in the user's HOME directory.

    Returns boolean

  • debugLogEnableDomains(domains: string[]): void
  • Enables all domains from the domains array.

    Parameters

    • domains: string[]

      an array of domains to enable

    Returns void

  • debugLogGetMaxLines(): number
  • debugLogIsDomainEnabled(domain: string): boolean
  • debugLogLoadConfiguration(filename: string): boolean
  • Loads configuration for the logging from the given filename.

    Parameters

    • filename: string

      a configuration file name

    Returns boolean

  • debugLogSetMaxLines(numLines: number): void
  • Limits how many lines the log can have.

    Parameters

    • numLines: number

      number of lines

    Returns void

  • edsCheckVersion(requiredMajor: number, requiredMinor: number, requiredMicro: number): string | null
  • Checks that the Evolution-Data-Server library in use is compatible with the given version. Generally you would pass in the constants #EDS_MAJOR_VERSION, #EDS_MINOR_VERSION, #EDS_MICRO_VERSION as the three arguments to this function. That produces a check that the library in use is compatible with the version of Evolution-Data-Server the application or module was compiled against.

    Parameters

    • requiredMajor: number

      the required major version

    • requiredMinor: number

      the required minor version

    • requiredMicro: number

      the required micro version

    Returns string | null

  • enumFromString(enumType: GType<unknown>, string: string, enumValue: number): boolean
  • Fetches the appropriate enumeration value for string in the given enum type type and stores the result in enum_value

    Parameters

    • enumType: GType<unknown>

      The enum type

    • string: string

      The string containing the enum value or nick

    • enumValue: number

      A return location to store the result

    Returns boolean

  • enumToString(enumType: GType<unknown>, enumValue: number): string
  • Converts an enum value to a string using strings from the GType system.

    Parameters

    • enumType: GType<unknown>

      An enum type

    • enumValue: number

      The enum value to convert

    Returns string

  • Asynchronously deletes file. If file is a directory, its contents are deleted recursively before file itself is deleted. The recursive delete operation will stop on the first error.

    If cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object before the operation finishes.

    When the operation is finished, callback will be called. You can then call e_file_recursive_delete_finish() to get the result of the operation.

    Parameters

    • file: Gio.File

      a #GFile to delete

    • ioPriority: number

      the I/O priority of the request

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied

    Returns void

  • Finishes the operation started with e_file_recursive_delete().

    If the operation was cancelled, the error #G_IO_ERROR_CANCELLED will be returned.

    Parameters

    Returns boolean

  • Deletes file. If file is a directory, its contents are deleted recursively before file itself is deleted. The recursive delete operation will stop on the first error.

    If cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error #G_IO_ERROR_CANCELLED will be returned.

    Parameters

    Returns boolean

  • filenameMakeSafe(string: string): void
  • filenameMkdirEncoded(basepath: string, fileprefix: string, filename: string, fileindex: number): string | null
  • Creates a local path constructed from basepath / fileprefix + "-" + filename, and makes sure the path basepath exists. If creation of the path fails, then NULL is returned.

    Parameters

    • basepath: string

      base path of a file name; this is left unchanged

    • fileprefix: string

      prefix for the filename; this is encoded

    • filename: string

      file name to use; this is encoded; can be %NULL

    • fileindex: number

      used when filename is NULL, then the filename is generated as "file" + fileindex

    Returns string | null

  • Converts the free_form_exp to an S-Expression using the S-Expression builders defined in the symbols. The symbols should have one symbol with an empty string as its name, which is used for words which do not have a symbol name prefix.

    The symbols is a NULL-terminated array of known symbols. The NULL should be set for the symbol's name.

    Parameters

    • freeFormExp: string

      a Free Form Expression

    • symbols: FreeFormExpSymbol

      known symbols, which can be used in the Free From Expression

    Returns string | null

  • getUserCacheDir(): string
  • Returns a base directory in which to store user-specific, non-essential cached data for Evolution or Evolution-Data-Server.

    The returned string is owned by libedataserver and must not be modified or freed.

    Returns string

  • getUserConfigDir(): string
  • Returns a base directory in which to store user-specific configuration information for Evolution or Evolution-Data-Server.

    The returned string is owned by libedataserver and must not be modified or freed.

    Returns string

  • getUserDataDir(): string
  • Returns a base directory in which to store user-specific data for Evolution or Evolution-Data-Server.

    The returned string is owned by libedataserver and must not be modified or freed.

    Returns string

  • localtimeWithOffset(tt: number, tm: object, offset: number): void
  • Converts the calendar time time representation tt to a broken-down time representation, store in tm, and provides the offset in seconds from UTC time, stored in offset.

    Parameters

    • tt: number

      The #time_t to convert.

    • tm: object

      The #tm to store the result in.

    • offset: number

      The #int to store the offset in.

    Returns void

  • mktimeUtc(tm: object): number
  • Like mktime(3), but assumes UTC instead of local timezone.

    Parameters

    • tm: object

      The #tm to convert to a calendar time representation.

    Returns number

  • oauth2ServiceUtilSetToForm(form: HashTable<string | number | symbol, string | number | boolean>, name: string, value: string): void
  • Sets value for name to form. The form should be the one used in e_oauth2_service_prepare_authentication_uri_query(), e_oauth2_service_prepare_get_token_form() or e_oauth2_service_prepare_refresh_token_form().

    If the value is %NULL, then the property named name is removed from the form instead.

    Parameters

    • form: HashTable<string | number | symbol, string | number | boolean>

      a #GHashTable

    • name: string

      a property name

    • value: string

      a property value

    Returns void

  • oauth2ServiceUtilTakeToForm(form: HashTable<string | number | symbol, string | number | boolean>, name: string, value: string): void
  • Takes ownership of value and sets it for name to form. The value will be freed with g_free(), when no longer needed. The form should be the one used in e_oauth2_service_prepare_authentication_uri_query(), e_oauth2_service_prepare_get_token_form() or e_oauth2_service_prepare_refresh_token_form().

    If the value is %NULL, then the property named name is removed from the form instead.

    Parameters

    • form: HashTable<string | number | symbol, string | number | boolean>

      a #GHashTable

    • name: string

      a property name

    • value: string

      a property value

    Returns void

  • Transfers the contents of src_queue to the tail of dst_queue. When the operation is complete, src_queue will be empty.

    Parameters

    Returns void

  • secretStoreDeleteSync(uid: string, cancellable: Gio.Cancellable): boolean
  • Deletes the secret for uid from either the default keyring or session keyring.

    Note the boolean return value indicates whether the delete operation itself completed successfully, not whether the secret was found and deleted. If no such secret was found, the function will still return %TRUE. If an error occurs, the function sets error and returns %FALSE.

    Parameters

    • uid: string

      a unique identifier of the secret

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns boolean

  • secretStoreLookupSync(uid: string, cancellable: Gio.Cancellable): [boolean, string]
  • Looks up a secret for the uid. Both the default and session keyrings are queried.

    Note the boolean return value indicates whether the lookup operation itself completed successfully, not whether the secret was found. If no secret was found, the function will set out_secret to %NULL, but still return %TRUE. If an error occurs, the function sets error and returns %FALSE.

    Parameters

    • uid: string

      a unique identifier of the secret

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns [boolean, string]

  • secretStoreStoreSync(uid: string, secret: string, label: string, permanently: boolean, cancellable: Gio.Cancellable): boolean
  • Stores the secret for the uid.

    If permanently is %TRUE, the secret is stored in the default keyring. Otherwise the secret is stored in the memory-only session keyring. If an error occurs, the function sets error and returns %FALSE.

    Parameters

    • uid: string

      a unique identifier of the secret

    • secret: string

      the secret to store

    • label: string

      human readable description of the secret

    • permanently: boolean

      store permanently or just for the session

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns boolean

  • Remembers what had been read from the input_stream and prints it to stdout when the message is finished. The function assumes ownership of the input_stream.

    Parameters

    Returns Gio.InputStream

  • Sets up automatic SSL certificate trust handling for soup_message using the trust data stored in source's WebDAV extension. If soup_message is about to be sent on an SSL connection with an invalid certificate, the code checks if the WebDAV extension already has a trust response for that certificate and verifies it with e_source_webdav_verify_ssl_trust(). If the verification fails, then the soup_message send also fails.

    This works by connecting to the "network-event" signal on soup_message and connecting to the "accept-certificate" signal on each #GTlsConnection for which soup_message reports a #G_SOCKET_CLIENT_TLS_HANDSHAKING event. These handlers are torn down automatically when soup_message is disposed. This process is not thread-safe; it is sufficient for safety if all use of soup_message's session and the disposal of soup_message occur in the same thread.

    Parameters

    Returns void

  • strftime(string: string, max: number, fmt: string, tm: object): number
  • This function is a wrapper around the strftime (3) function, which converts the %l and %k (12h and 24h) format variables if necessary.

    Parameters

    • string: string

      The string array to store the result in.

    • max: number

      The size of array s.

    • fmt: string

      The formatting to use on tm.

    • tm: object

      The time value to format.

    Returns number

  • timeFormatDateAndTime(dateTm: object, use24HourFormat: boolean, showMidnight: boolean, showZeroSeconds: boolean, buffer: string, bufferSize: number): void
  • Creates a string representation of the time value date_tm and stores it in buffer. buffer_size should be at least 64 to be safe. If show_midnight is %FALSE, and the time is midnight, then only the date is stored in buffer. If show_zero_seconds is %FALSE, then if the time has zero seconds only the hour and minute of the time are stored in buffer.

    Parameters

    • dateTm: object

      The #tm to convert to a string.

    • use24HourFormat: boolean

      A #gboolean.

    • showMidnight: boolean

      A #gboolean.

    • showZeroSeconds: boolean

      A #gboolean.

    • buffer: string

      A #char buffer to store the time string in.

    • bufferSize: number

      The length of buffer.

    Returns void

  • timeFormatTime(dateTm: object, use24HourFormat: boolean, showZeroSeconds: boolean, buffer: string, bufferSize: number): void
  • Creates a string representation of a time value in date_tm and stores it in buffer. buffer_size should be at least 64.

    Parameters

    • dateTm: object

      The #tm to convert to a string.

    • use24HourFormat: boolean

      A #gboolean.

    • showZeroSeconds: boolean

      A #gboolean.

    • buffer: string

      The #char buffer to store the result in.

    • bufferSize: number

      The length of buffer.

    Returns void

  • timeGetDFmtWith4digitYear(): string
  • Retrieves a date format string with a 4-digit year (D_FMT on systems with nl_langinfo() available). In case the current locale doesn't support 4-digit year, the function returns format as specified by the locale.

    Free the returned string with g_free().

    Returns string

  • Takes in a date string entered by the user and tries to convert it to a struct #tm.

    Parameters

    • value: string

      A date string.

    • result: object

      Return value for the parsed date.

    Returns TimeParseStatus

  • Parses a string value containing a date and a time and stores the result in result. The date in value is expected to be in a format like "Wed 3/13/00 14:20:00", though gettext() is used to support the appropriate local formats. There is also some leniency on the format of the string, e.g. the weekday can be skipped or 12-hour formats with am/pm can be used.

    Parameters

    • value: string

      the string to parse a date and time from

    • result: object

      a #tm to store the result in

    Returns TimeParseStatus

  • timeParseDateAndTimeEx(value: string, result: object, twoDigitYear: boolean): TimeParseStatus
  • Parses a string value containing a date and a time and stores the result in result. The date in value is expected to be in a format like "Wed 3/13/00 14:20:00", though gettext() is used to support the appropriate local formats. There is also some leniency on the format of the string, e.g. the weekday can be skipped or 12-hour formats with am/pm can be used.

    Parameters

    • value: string

      The string to parse a date and time from.

    • result: object

      A #tm to store the result in.

    • twoDigitYear: boolean

      set to TRUE, is parsing with two-digit year, else FALSE, but only when not NULL.

    Returns TimeParseStatus

  • timeParseDateEx(value: string, result: object, twoDigitYear: boolean): TimeParseStatus
  • Takes in a date string entered by the user and tries to convert it to a struct #tm.

    Parameters

    • value: string

      A date string.

    • result: object

      Return value for the parsed date.

    • twoDigitYear: boolean

      set to TRUE, is parsing with two-digit year, else FALSE, but only when not NULL.

    Returns TimeParseStatus

  • Parses value, a string containing a time. value is expected to be in a format like "14:20:00". gettext() is used to support the appropriate local formats and slightly different formats, such as 12-hour formats with am/pm, are accepted as well.

    Parameters

    • value: string

      The string to parse a time from.

    • result: object

      A #tm to store the result in.

    Returns TimeParseStatus

  • timeoutAddSecondsWithName(priority: number, interval: number, name: string, function_: SourceFunc): number
  • Similar to g_timeout_add_seconds_full(), but also names the #GSource as name.

    You might find e_named_timeout_add_seconds() or e_named_timeout_add_seconds_full() more convenient. Those macros name the #GSource implicitly.

    Parameters

    • priority: number

      the priority of the timeout source, typically in the range between #G_PRIORITY_DEFAULT and #G_PRIORITY_HIGH

    • interval: number

      the time between calls to the function, in seconds

    • name: string

      debug name for the source

    • function_: SourceFunc

      function to call

    Returns number

  • timeoutAddWithName(priority: number, interval: number, name: string, function_: SourceFunc): number
  • Similar to g_timeout_add_full(), but also names the #GSource as name.

    You might find e_named_timeout_add() or e_named_timeout_add_full() more convenient. Those macros name the #GSource implicitly.

    Parameters

    • priority: number

      the priority of the timeout source, typically in the range between #G_PRIORITY_DEFAULT and #G_PRIORITY_HIGH

    • interval: number

      the time between calls to the function, in milliseconds (1/1000ths of a second)

    • name: string

      debug name for the source

    • function_: SourceFunc

      function to call

    Returns number

  • Calls func for all instantiable subtypes of parent_type.

    This is often useful for extending functionality by way of #EModule. A module may register a subtype of parent_type in its e_module_load() function. Then later on the application will call e_type_traverse() to instantiate all registered subtypes of parent_type.

    Parameters

    • parentType: GType<unknown>

      the root #GType to traverse from

    • func: TypeFunc

      the function to call for each visited #GType

    Returns void

  • uidNew(): string
  • utf8Strftime(string: string, max: number, fmt: string, tm: object): number
  • The UTF-8 equivalent of e_strftime ().

    Parameters

    • string: string

      The string array to store the result in.

    • max: number

      The size of array s.

    • fmt: string

      The formatting to use on tm.

    • tm: object

      The time value to format.

    Returns number

  • utilCanUseCollectionAsCredentialSource(collectionSource: object, childSource: object): boolean
  • Checks whether the collection_source can be used as a credential source for the child_source. The relationship is not tested in the function. When the collection_source is %NULL, then it simply returns %FALSE.

    Parameters

    • collectionSource: object

      a collection #ESource, or %NULL

    • childSource: object

      a children of collection_source

    Returns boolean

  • utilCopyStringSlist(copyTo: string[], strings: string[]): string[]
  • Copies #GSList of strings at the end of copy_to.

    Parameters

    • copyTo: string[]

      Where to copy; can be %NULL

    • strings: string[]

      #GSList of strings to be copied

    Returns string[]

  • utilEnsureGdbusString(str: string, gdbusStr: string): string
  • If str is a valid UTF-8 string, the function returns str and does not set gdbus_str.

    If str is an invalid UTF-8 string, the function calls e_util_utf8_make_valid() and points gdbus_str to the newly-allocated, valid UTF-8 string, and also returns it. The caller should free the string pointed to by gdbus_str with g_free().

    If str is %NULL, the function returns an empty string and does not set gdbus_str.

    Admittedly, the function semantics are a little awkward. The example below illustrates the easiest way to cope with the gdbus_str argument:

    |[ const gchar *trusted_utf8; gchar *allocated = NULL;

    trusted_utf8 = e_util_ensure_gdbus_string (untrusted_utf8, &allocated);

    Do stuff with trusted_utf8, then clear it.

    trusted_utf8 = NULL;

    g_free (allocated);
    allocated = NULL;

    @param str a possibly invalid UTF-8 string, or %NULL
    @param gdbusStr return location for the corrected string

    Parameters

    • str: string
    • gdbusStr: string

    Returns string

  • Calls g_object_unref() on each member of objects if non-%NULL and then frees also objects itself.

    Parameters

    Returns void

  • Calls g_object_unref() on each member of objects and then frees also objects itself.

    Parameters

    Returns void

  • utilFreeStringSlist(strings: string[]): void
  • Frees memory previously allocated by e_util_strv_to_slist().

    Parameters

    • strings: string[]

      a #GSList of strings (gchar *)

    Returns void

  • utilGenerateUid(): string
  • Generates a unique identificator, which can be used as part of the Message-ID header, or iCalendar component UID, or vCard UID. The resulting string doesn't contain any host name, it's a hexa-decimal string with no particular meaning.

    Free the returned string with g_free(), when no longer needed.

    Returns string

  • utilGetDirectoryVariants(mainPath: string, replacePrefix: string, withModulesDir: boolean): string[]
  • The main_path is a directory, which will be always used. It should have as its prefix the replace_prefix, otherwise the function returns only the main_path in the paths array.

    When there's exported an environment variable EDS_EXTRA_PREFIXES, it is used as a list of alternative prefixes where to look for the main_path (rest after the replace_prefix).

    When the with_modules_dir is %TRUE, there's also added g_get_user_data_dir() + "evolution/modules/", aka ~/.local/share/evolution/modules/, into the resulting array.

    Parameters

    • mainPath: string

      the main path to work with

    • replacePrefix: string

      path prefix to replace

    • withModulesDir: boolean

      whether to add also the modules directory

    Returns string[]

  • utilGetSourceFullName(registry: object, source: object): string
  • Constructs a full name of the source with all of its parents of the form: "<account-name> : <parent>/<source>" where the "<parent>/" part can be repeated zero or more times, depending on the deep level of the source.

    Parameters

    • registry: object

      an #ESourceRegistry

    • source: object

      an #ESource

    Returns string

  • utilGthreadId(thread: Thread): number
  • Returns a 64-bit integer hopefully uniquely identifying the thread. To be used in debugging output and logging only. The returned value is just a cast of a pointer to the 64-bit integer.

    There is no guarantee that calling e_util_gthread_id () on one thread first and later after that thread has dies on another won't return the same integer.

    On Linux and Win32, known to really return a unique id for each thread existing at a certain time. No guarantee that ids won't be reused after a thread has terminated, though.

    Parameters

    • thread: Thread

      A #GThread pointer

    Returns number

  • utilIdentityCanSend(registry: object, identitySource: object): boolean
  • Checks whether the identity_source can be used for sending, which means whether it has configures send mail source.

    Parameters

    • registry: object

      an #ESourceRegistry

    • identitySource: object

      an #ESource with mail identity extension

    Returns boolean

  • utilSafeFreeString(str: string): void
  • Calls g_free() on string, but before it rewrites its content with zeros. This is suitable to free strings with passwords.

    Parameters

    • str: string

      a string to free

    Returns void

  • utilSlistToStrv(strings: string[]): string[]
  • Convert list of strings into NULL-terminates array of strings.

    Parameters

    • strings: string[]

      a #GSList of strings (const gchar *)

    Returns string[]

  • utilSourceCompareForSort(sourceA: object, sourceB: object): number
  • Compares two #ESource-s in a way suitable for user interface. It can be used as a #GCompareFunc.

    This is also used by e_source_registry_build_display_tree().

    Parameters

    • sourceA: object

      the first #ESource

    • sourceB: object

      the second #ESource

    Returns number

  • utilStrcmp0(str1: string, str2: string): number
  • Compares str1 and str2 like g_strcmp0(), except it handles %NULL and empty strings as equal.

    Parameters

    • str1: string

      a C string on %NULL

    • str2: string

      another C string or %NULL

    Returns number

  • utilStrdupStrip(string: string): string | null
  • Duplicates string and strips off any leading or trailing whitespace. The resulting string is returned unless it is empty or %NULL, in which case the function returns %NULL.

    Free the returned string with g_free().

    Parameters

    • string: string

      a string value, or %NULL

    Returns string | null

  • utilStrstrcase(haystack: string, needle: string): string | null
  • Find the first instance of needle in haystack, ignoring case for bytes that are ASCII characters.

    Parameters

    • haystack: string

      The string to search in.

    • needle: string

      The string to search for.

    Returns string | null

  • utilStrvEqual(v1: string[], v2: string[]): boolean
  • Compares v1 and v2 for equality, handling %NULL gracefully.

    The arguments types are generic for compatibility with #GEqualFunc.

    Parameters

    • v1: string[]

      a %NULL-terminated string array, or %NULL

    • v2: string[]

      another %NULL-terminated string array, or %NULL

    Returns boolean

  • utilStrvToSlist(strv: string): string[]
  • Convert NULL-terminated array of strings to a list of strings.

    Parameters

    • strv: string

      a NULL-terminated array of strings (const gchar *)

    Returns string[]

  • utilUnicodeGetUtf8(text: string, out: string): string | null
  • Get a UTF-8 character from the beginning of text.

    Parameters

    • text: string

      The string to take the UTF-8 character from.

    • out: string

      The location to store the UTF-8 character in.

    Returns string | null

  • utilUnrefInThread(object: object): void
  • Unrefs the given object in a dedicated thread. This is useful when unreffing object deep in call stack when the caller might still use the object and this being the last reference to it.

    Parameters

    • object: object

      a #GObject

    Returns void

  • utilUtf8DataMakeValid(data: string, dataBytes: number): string
  • Returns a newly-allocated NULL-terminated string with invalid characters replaced by Unicode replacement characters (U+FFFD). For %NULL data returns newly allocated empty string ("").

    Parameters

    • data: string

      UTF-8 binary data

    • dataBytes: number

      length of the binary data

    Returns string

  • utilUtf8Decompose(text: string): string
  • Converts the text into a decomposed variant and strips it, which allows also cheap case insensitive comparision afterwards. This produces an output as being used in e_util_utf8_strstrcasedecomp().

    Parameters

    • text: string

      a UTF-8 string

    Returns string

  • utilUtf8MakeValid(str: string): string
  • Returns a newly-allocated copy of str, with invalid characters replaced by Unicode replacement characters (U+FFFD). For %NULL str returns newly allocated empty string ("").

    Parameters

    • str: string

      a UTF-8 string

    Returns string

  • utilUtf8Normalize(str: string): string | null
  • Normalizes str by making it all lower case and removing any accents from it.

    Parameters

    • str: string

      a UTF-8 string

    Returns string | null

  • utilUtf8RemoveAccents(str: string): string | null
  • Returns a newly-allocated copy of str with accents removed.

    Parameters

    • str: string

      a UTF-8 string, or %NULL

    Returns string | null

  • utilUtf8Strcasecmp(s1: string, s2: string): number
  • Compares two UTF-8 strings using approximate case-insensitive ordering.

    Parameters

    • s1: string

      a UTF-8 string

    • s2: string

      another UTF-8 string

    Returns number

  • utilUtf8Strstrcase(haystack: string, needle: string): string | null
  • Find the first instance of needle in haystack, ignoring case. (No proper case folding or decomposing is done.) Both needle and haystack are UTF-8 strings.

    Parameters

    • haystack: string

      The string to search in.

    • needle: string

      The string to search for.

    Returns string | null

  • utilUtf8Strstrcasedecomp(haystack: string, needle: string): string | null
  • Find the first instance of needle in haystack, where both needle and haystack are UTF-8 strings. Both strings are stripped and decomposed for comparison, and case is ignored.

    Parameters

    • haystack: string

      The string to search in.

    • needle: string

      The string to search for.

    Returns string | null

  • webdavAccessControlEntryFree(ptr: object): void
  • Frees an #EWebDAVAccessControlEntry previously created with e_webdav_access_control_entry_new() or e_webdav_access_control_entry_copy(). The function does nothing, if ptr is %NULL.

    Parameters

    • ptr: object

      an #EWebDAVAccessControlEntry

    Returns void

  • Frees a GSList of discovered sources returned from e_webdav_discover_sources_finish() or e_webdav_discover_sources_sync().

    Parameters

    Returns void

  • Asynchronously runs discovery of the WebDAV sources (CalDAV and CardDAV), eventually limited by the only_supports filter, which can be %E_WEBDAV_DISCOVER_SUPPORTS_NONE to search all types. Note that the list of returned calendars can be more general, thus check for its actual support type for further filtering of the results. The url_use_path can be used to override actual server path, or even complete URL, for the given source.

    When the operation is finished, callback will be called. You can then call e_webdav_discover_sources_finish() to get the result of the operation.

    Parameters

    • source: EDataServer.Source

      an #ESource from which to take connection details

    • urlUsePath: string

      optional URL override, or %NULL

    • onlySupports: number

      bit-or of EWebDAVDiscoverSupports, to limit what type of sources to search

    • credentials: NamedParameters

      credentials to use for authentication to the server

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied

    Returns void

  • Finishes the operation started with e_webdav_discover_sources(). If an error occurred, the function will set error and return %FALSE. The function can return success and no discovered sources, the same as it can return failure, but still set some output arguments, like the certificate related output arguments with SOUP_STATUS_SSL_FAILED error.

    The return value of out_certificate_pem should be freed with g_free() when no longer needed.

    The return value of out_discovered_sources should be freed with e_webdav_discover_free_discovered_sources() when no longer needed.

    The return value of out_calendar_user_addresses should be freed with g_slist_free_full (calendar_user_addresses, g_free); when no longer needed.

    Parameters

    Returns [boolean, string, TlsCertificateFlags, WebDAVDiscoveredSource[], string[]]

  • This is the same as e_webdav_discover_sources(), it only allows to provide a callback function (with its user_data), to reference an additional #ESource. It's good to avoid creating its own #ESourceRegistry instance to get it.

    When the operation is finished, callback will be called. You can then call e_webdav_discover_sources_finish() to get the result of the operation.

    Parameters

    • source: EDataServer.Source

      an #ESource from which to take connection details

    • urlUsePath: string

      optional URL override, or %NULL

    • onlySupports: number

      bit-or of EWebDAVDiscoverSupports, to limit what type of sources to search

    • credentials: NamedParameters

      credentials to use for authentication to the server

    • refSourceFunc: WebDAVDiscoverRefSourceFunc

      optional callback to use to get an ESource

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied

    Returns void

  • This is the same as e_webdav_discover_sources_sync(), it only allows to provide a callback function (with its user_data), to reference an additional #ESource. It's good to avoid creating its own #ESourceRegistry instance to get it.

    Parameters

    • source: EDataServer.Source

      an #ESource from which to take connection details

    • urlUsePath: string

      optional URL override, or %NULL

    • onlySupports: number

      bit-or of EWebDAVDiscoverSupports, to limit what type of sources to search

    • credentials: NamedParameters

      credentials to use for authentication to the server

    • refSourceFunc: WebDAVDiscoverRefSourceFunc

      optional callback to use to get an ESource

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns [boolean, string, TlsCertificateFlags, WebDAVDiscoveredSource[], string[]]

  • Synchronously runs discovery of the WebDAV sources (CalDAV and CardDAV), eventually limited by the only_supports filter, which can be %E_WEBDAV_DISCOVER_SUPPORTS_NONE to search all types. Note that the list of returned calendars can be more general, thus check for its actual support type for further filtering of the results. The url_use_path can be used to override actual server path, or even complete URL, for the given source.

    If an error occurred, the function will set error and return %FALSE. The function can return success and no discovered sources, the same as it can return failure, but still set some output arguments, like the certificate related output arguments with SOUP_STATUS_SSL_FAILED error.

    The return value of out_certificate_pem should be freed with g_free() when no longer needed.

    The return value of out_discovered_sources should be freed with e_webdav_discover_free_discovered_sources() when no longer needed.

    The return value of out_calendar_user_addresses should be freed with g_slist_free_full (calendar_user_addresses, g_free); when no longer needed.

    Parameters

    • source: EDataServer.Source

      an #ESource from which to take connection details

    • urlUsePath: string

      optional URL override, or %NULL

    • onlySupports: number

      bit-or of EWebDAVDiscoverSupports, to limit what type of sources to search

    • credentials: NamedParameters

      credentials to use for authentication to the server

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns [boolean, string, TlsCertificateFlags, WebDAVDiscoveredSource[], string[]]

  • webdavPrivilegeFree(ptr: object): void
  • Frees an #EWebDAVPrivilege previously created with e_webdav_privilege_new() or e_webdav_privilege_copy(). The function does nothing, if ptr is %NULL.

    Parameters

    • ptr: object

      an #EWebDAVPrivilege

    Returns void

  • webdavPropertyChangeFree(ptr: object): void
  • Frees an #EWebDAVPropertyChange previously created with e_webdav_property_change_new_set(), e_webdav_property_change_new_remove() or or e_webdav_property_change_copy(). The function does nothing, if ptr is %NULL.

    Parameters

    • ptr: object

      an #EWebDAVPropertyChange

    Returns void

  • webdavResourceFree(ptr: object): void
  • Frees an #EWebDAVResource previously created with e_webdav_resource_new() or e_webdav_resource_copy(). The function does nothing, if ptr is %NULL.

    Parameters

    • ptr: object

      an #EWebDAVResource

    Returns void

  • xmlDestroyHash(hash: HashTable<string | number | symbol, string | number | boolean>): void
  • Frees the memory used by hash and its contents.

    Parameters

    • hash: HashTable<string | number | symbol, string | number | boolean>

      the #GHashTable to destroy

    Returns void

  • xmlSaveFile(filename: string, doc: libxml2.Doc): number
  • Writes the given XML document structure to the file given by filename. If an error occurs while saving, the function returns -1 and sets errno.

    Parameters

    • filename: string

      path to a file to save to

    • doc: libxml2.Doc

      an XML document structure

    Returns number

  • Creates a #GHashTable representation of the #xmlDoc doc. If type is * E_XML_HASH_TYPE_PROPERTY, all XML nodes will be indexed in the #GHashTable by name. If type is %E_XML_HASH_TYPE_OBJECT_UID, then XML objects will be indexed in the hash by their UID (other nodes will still be indexed by name).

    Parameters

    • doc: libxml2.Doc

      The #xmlDoc to store in a hash table.

    • type: XmlHashType

      The value type to use as a key in the hash table.

    Returns HashTable

  • xmlhashAdd(hash: XmlHash, key: string, data: string): void
  • Adds a new key/value pair to the #EXmlHash hash.

    Parameters

    • hash: XmlHash

      the #EXmlHash to add an entry to

    • key: string

      the key to use for the entry

    • data: string

      the value of the new entry

    Returns void

  • Compares the value with key equal to key in hash against compare_data.

    Parameters

    • hash: XmlHash

      the #EXmlHash to compare against

    • key: string

      the key of the hash entry to compare with

    • compareData: string

      the data to compare against the hash entry

    Returns XmlHashStatus

  • xmlhashDestroy(hash: XmlHash): void
  • Calls g_hash_table_foreach_remove() on hash<!-- -->'s internal hash table. See g_hash_table_foreach_remove() for details.

    Parameters

    Returns void

  • xmlhashRemove(hash: XmlHash, key: string): void
  • Remove the entry in hash with key equal to key, if it exists.

    Parameters

    • hash: XmlHash

      the #EXmlHash to remove an entry from

    • key: string

      the key of the entry to remove

    Returns void

  • Writes the XML represented by hash to the file originally passed to e_xmlhash_new().

    Parameters

    • hash: XmlHash

      The #EXmlHash to write.

    Returns void

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method