accounts.calendar.accountsList of calendars.
Type: attribute set of (submodule)
Default: { }
Declared by:
accounts.calendar.accounts.<name>.khal.enableWhether to enable khal access.
Type: boolean
Default: false
Example: true
Declared by:
accounts.calendar.accounts.<name>.khal.colorColor in which events in this calendar are displayed.
Type: null or one of "black", "white", "brown", "yellow", "dark gray", "dark green", "dark blue", "light gray", "light green", "light blue", "dark magenta", "dark cyan", "dark red", "light magenta", "light cyan", "light red"
Default: null
Example: "light green"
Declared by:
accounts.calendar.accounts.<name>.khal.globThe glob expansion to be searched for events or birthdays when
+type is set to discover.
Type: string
Default: "*"
Declared by:
accounts.calendar.accounts.<name>.khal.priorityPriority of a calendar used for coloring.
Type: signed integer
Default: 10
Declared by:
accounts.calendar.accounts.<name>.khal.readOnlyKeep khal from making any changes to this account.
Type: boolean
Default: false
Declared by:
accounts.calendar.accounts.<name>.khal.typeThere is no description of this option.
Type: null or one of "calendar", "discover"
Default: null
Declared by:
accounts.calendar.accounts.<name>.localLocal configuration for the calendar.
Type: null or (submodule)
Default: null
Declared by:
accounts.calendar.accounts.<name>.local.encodingFile encoding for items, both content and file name.
+Defaults to UTF-8.
Type: null or string
Default: null
Declared by:
accounts.calendar.accounts.<name>.local.fileExtThe file extension to use.
Type: null or string
Default: null
Declared by:
accounts.calendar.accounts.<name>.local.pathThe path of the storage.
Type: string
Default: "‹accounts.contact.basePath›/‹name›"
Declared by:
accounts.calendar.accounts.<name>.local.typeThe type of the storage.
Type: one of "filesystem", "singlefile"
Declared by:
accounts.calendar.accounts.<name>.nameUnique identifier of the calendar. This is set to the
+attribute name of the calendar configuration.
Type: string (read only)
Declared by:
accounts.calendar.accounts.<name>.primaryWhether this is the primary account. Only one account may be
+set as primary.
Type: boolean
Default: false
Declared by:
accounts.calendar.accounts.<name>.primaryCollectionThe primary collection of the account. Required when an
+account has multiple collections.
Type: string
Declared by:
accounts.calendar.accounts.<name>.remoteRemote configuration for the calendar.
Type: null or (submodule)
Default: null
Declared by:
accounts.calendar.accounts.<name>.remote.passwordCommandA command that prints the password to standard output.
Type: null or (list of string)
Default: null
Example:
[
+ "pass"
+ "caldav"
+]
Declared by:
accounts.calendar.accounts.<name>.remote.typeThe type of the storage.
Type: one of "caldav", "http", "google_calendar"
Declared by:
accounts.calendar.accounts.<name>.remote.urlThe URL of the storage.
Type: null or string
Default: null
Declared by:
accounts.calendar.accounts.<name>.remote.userNameUser name for authentication.
Type: null or string
Default: null
Declared by:
accounts.calendar.accounts.<name>.vdirsyncer.enableWhether to enable synchronization using vdirsyncer.
Type: boolean
Default: false
Example: true
Declared by:
accounts.calendar.accounts.<name>.vdirsyncer.authAuthentication settings. The default is basic.
Type: null or one of "basic", "digest", "guess"
Default: null
Declared by:
accounts.calendar.accounts.<name>.vdirsyncer.authCertEither a path to a certificate with a client certificate and
+the key or a list of paths to the files with them.
Type: null or string or list of string
Default: null
Declared by:
accounts.calendar.accounts.<name>.vdirsyncer.clientIdCommandA command that prints the OAuth credentials to standard
+output.
+
+See
+https://vdirsyncer.pimutils.org/en/stable/config.html#google
+for more information.
Type: null or (list of string)
Default: null
Example:
[
+ "pass"
+ "client_id"
+]
Declared by:
accounts.calendar.accounts.<name>.vdirsyncer.clientSecretCommandA command that prints the OAuth credentials to standard
+output.
+
+See
+https://vdirsyncer.pimutils.org/en/stable/config.html#google
+for more information.
Type: null or (list of string)
Default: null
Example:
[
+ "pass"
+ "client_secret"
+]
Declared by:
accounts.calendar.accounts.<name>.vdirsyncer.collectionsThe collections to synchronize between the storages.
Type: null or (list of (string or list of string))
Default: null
Declared by:
accounts.calendar.accounts.<name>.vdirsyncer.conflictResolutionWhat to do in case of a conflict between the storages. Either
+remote wins or
+local wins or
+a list that contains a command to run. By default, an error
+message is printed.
Type: null or one of "remote wins", "local wins" or list of string
Default: null
Declared by:
accounts.calendar.accounts.<name>.vdirsyncer.itemTypesKinds of items to show. The default is to show everything.
+This depends on particular features of the server, the results
+are not validated.
Type: null or (list of string)
Default: null
Declared by:
accounts.calendar.accounts.<name>.vdirsyncer.metadataMetadata keys that should be synchronized when vdirsyncer
+metasync is executed.
Type: list of string
Default: [ ]
Example:
[
+ "color"
+ "displayname"
+]
Declared by:
accounts.calendar.accounts.<name>.vdirsyncer.partialSyncWhat should happen if synchronization in one direction
+is impossible due to one storage being read-only.
+Defaults to revert.
+
+See
+https://vdirsyncer.pimutils.org/en/stable/config.html#pair-section
+for more information.
Type: null or one of "revert", "error", "ignore"
Default: null
Declared by:
accounts.calendar.accounts.<name>.vdirsyncer.postHookCommand to call for each item creation and modification.
+The command will be called with the path of the new/updated
+file.
Type: strings concatenated with "\n"
Default: ""
Declared by:
accounts.calendar.accounts.<name>.vdirsyncer.timeRangeA time range to synchronize. start and end can be any Python
+expression that returns a datetime.datetime
+object.
Type: null or (submodule)
Default: null
Example:
{
+ end = "datetime.now() + timedelta(days=365)";
+ start = "datetime.now() - timedelta(days=365)";
+}Declared by:
accounts.calendar.accounts.<name>.vdirsyncer.timeRange.endEnd of time range to show.
Type: string
Declared by:
accounts.calendar.accounts.<name>.vdirsyncer.timeRange.startStart of time range to show.
Type: string
Declared by:
accounts.calendar.accounts.<name>.vdirsyncer.tokenFileA file path where access tokens are stored.
Type: null or string
Default: null
Declared by:
accounts.calendar.accounts.<name>.vdirsyncer.userAgentThe user agent to report to the server. Defaults to
+vdirsyncer.
Type: null or string
Default: null
Declared by:
accounts.calendar.accounts.<name>.vdirsyncer.verifyVerify SSL certificate.
Type: null or boolean
Default: null
Declared by:
accounts.calendar.accounts.<name>.vdirsyncer.verifyFingerprintOptional. SHA1 or MD5 fingerprint of the expected server certificate.
+
+See
+https://vdirsyncer.pimutils.org/en/stable/ssl-tutorial.html#ssl-tutorial
+for more information.
Type: null or string
Default: null
Declared by:
accounts.calendar.basePathThe base directory in which to save calendars. May be a
+relative path, in which case it is relative the home
+directory.
Type: string
Declared by:
accounts.contact.accountsList of contacts.
Type: attribute set of (submodule)
Default: { }
Declared by:
accounts.contact.accounts.<name>.khal.enableWhether to enable khal access.
Type: boolean
Default: false
Example: true
Declared by:
accounts.contact.accounts.<name>.khal.readOnlyKeep khal from making any changes to this account.
Type: boolean
Default: false
Declared by:
accounts.contact.accounts.<name>.localLocal configuration for the contacts.
Type: null or (submodule)
Default: null
Declared by:
accounts.contact.accounts.<name>.local.encodingFile encoding for items, both content and file name.
+Defaults to UTF-8.
Type: null or string
Default: null
Declared by:
accounts.contact.accounts.<name>.local.fileExtThe file extension to use.
Type: null or string
Default: null
Declared by:
accounts.contact.accounts.<name>.local.pathThe path of the storage.
Type: string
Default: "‹accounts.contact.basePath›/‹name›"
Declared by:
accounts.contact.accounts.<name>.local.typeThe type of the storage.
Type: one of "filesystem", "singlefile"
Declared by:
accounts.contact.accounts.<name>.nameUnique identifier of the contact account. This is set to the
+attribute name of the contact configuration.
Type: string (read only)
Declared by:
accounts.contact.accounts.<name>.remoteRemote configuration for the contacts.
Type: null or (submodule)
Default: null
Declared by:
accounts.contact.accounts.<name>.remote.passwordCommandA command that prints the password to standard output.
Type: null or (list of string)
Default: null
Example:
[
+ "pass"
+ "caldav"
+]
Declared by:
accounts.contact.accounts.<name>.remote.typeThe type of the storage.
Type: one of "carddav", "http", "google_contacts"
Declared by:
accounts.contact.accounts.<name>.remote.urlThe URL of the storage.
Type: null or string
Default: null
Declared by:
accounts.contact.accounts.<name>.remote.userNameUser name for authentication.
Type: null or string
Default: null
Declared by:
accounts.contact.accounts.<name>.vdirsyncer.enableWhether to enable synchronization using vdirsyncer.
Type: boolean
Default: false
Example: true
Declared by:
accounts.contact.accounts.<name>.vdirsyncer.authAuthentication settings. The default is basic.
Type: null or one of "basic", "digest", "guess"
Default: null
Declared by:
accounts.contact.accounts.<name>.vdirsyncer.authCertEither a path to a certificate with a client certificate and
+the key or a list of paths to the files with them.
Type: null or string or list of string
Default: null
Declared by:
accounts.contact.accounts.<name>.vdirsyncer.clientIdCommandA command that prints the OAuth credentials to standard
+output.
+
+See
+https://vdirsyncer.pimutils.org/en/stable/config.html#google
+for more information.
Type: null or (list of string)
Default: null
Example:
[
+ "pass"
+ "client_id"
+]
Declared by:
accounts.contact.accounts.<name>.vdirsyncer.clientSecretCommandA command that prints the OAuth credentials to standard
+output.
+
+See
+https://vdirsyncer.pimutils.org/en/stable/config.html#google
+for more information.
Type: null or (list of string)
Default: null
Example:
[
+ "pass"
+ "client_secret"
+]
Declared by:
accounts.contact.accounts.<name>.vdirsyncer.collectionsThe collections to synchronize between the storages.
Type: null or (list of (string or list of string))
Default: null
Declared by:
accounts.contact.accounts.<name>.vdirsyncer.conflictResolutionWhat to do in case of a conflict between the storages. Either
+remote wins or
+local wins or
+a list that contains a command to run. By default, an error
+message is printed.
Type: null or one of "remote wins", "local wins" or list of string
Default: null
Declared by:
accounts.contact.accounts.<name>.vdirsyncer.itemTypesKinds of items to show. The default is to show everything.
+This depends on particular features of the server, the results
+are not validated.
Type: null or (list of string)
Default: null
Declared by:
accounts.contact.accounts.<name>.vdirsyncer.metadataMetadata keys that should be synchronized when vdirsyncer
+metasync is executed.
Type: list of string
Default: [ ]
Example:
[
+ "color"
+ "displayname"
+]
Declared by:
accounts.contact.accounts.<name>.vdirsyncer.partialSyncWhat should happen if synchronization in one direction
+is impossible due to one storage being read-only.
+Defaults to revert.
+
+See
+https://vdirsyncer.pimutils.org/en/stable/config.html#pair-section
+for more information.
Type: null or one of "revert", "error", "ignore"
Default: null
Declared by:
accounts.contact.accounts.<name>.vdirsyncer.postHookCommand to call for each item creation and modification.
+The command will be called with the path of the new/updated
+file.
Type: strings concatenated with "\n"
Default: ""
Declared by:
accounts.contact.accounts.<name>.vdirsyncer.timeRangeA time range to synchronize. start and end can be any Python
+expression that returns a datetime.datetime
+object.
Type: null or (submodule)
Default: null
Example:
{
+ end = "datetime.now() + timedelta(days=365)";
+ start = "datetime.now() - timedelta(days=365)";
+}Declared by:
accounts.contact.accounts.<name>.vdirsyncer.timeRange.endEnd of time range to show.
Type: string
Declared by:
accounts.contact.accounts.<name>.vdirsyncer.timeRange.startStart of time range to show.
Type: string
Declared by:
accounts.contact.accounts.<name>.vdirsyncer.tokenFileA file path where access tokens are stored.
Type: null or string
Default: null
Declared by:
accounts.contact.accounts.<name>.vdirsyncer.userAgentThe user agent to report to the server. Defaults to
+vdirsyncer.
Type: null or string
Default: null
Declared by:
accounts.contact.accounts.<name>.vdirsyncer.verifyVerify SSL certificate.
Type: null or boolean
Default: null
Declared by:
accounts.contact.accounts.<name>.vdirsyncer.verifyFingerprintOptional. SHA1 or MD5 fingerprint of the expected server certificate.
+
+See
+https://vdirsyncer.pimutils.org/en/stable/ssl-tutorial.html#ssl-tutorial
+for more information.
Type: null or string
Default: null
Declared by:
accounts.contact.basePathThe base directory in which to save contacts. May be a
+relative path, in which case it is relative the home
+directory.
Type: string
Declared by:
accounts.email.accountsList of email accounts.
Type: attribute set of (submodule)
Default: { }
Declared by: