vdirsyncer.enable
Whether to enable synchronization using vdirsyncer.
Type: boolean
Default:
false
Example:
true
Declared by:
vdirsyncer.auth
Authentication settings. The default is basic.
Type: null or one of “basic”, “digest”, “guess”
Default:
null
Declared by:
vdirsyncer.authCert
Either 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:
vdirsyncer.clientIdCommand
A 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:
vdirsyncer.clientSecretCommand
A 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:
vdirsyncer.collections
The collections to synchronize between the storages.
Type: null or (list of (string or list of string))
Default:
null
Declared by:
vdirsyncer.conflictResolution
What 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:
vdirsyncer.itemTypes
Kinds 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:
vdirsyncer.metadata
Metadata keys that should be synchronized when vdirsyncer metasync is executed.
Type: list of string
Default:
[ ]
Example:
[
"color"
"displayname"
]
Declared by:
vdirsyncer.partialSync
What 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:
vdirsyncer.postHook
Command to call for each item creation and modification. The command will be called with the path of the new/updated file.
Type: null or strings concatenated with “\n”
Default:
null
Declared by:
vdirsyncer.timeRange
A 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:
vdirsyncer.timeRange.end
End of time range to show.
Type: string
Declared by:
vdirsyncer.timeRange.start
Start of time range to show.
Type: string
Declared by:
vdirsyncer.tokenFile
A file path where access tokens are stored.
Type: null or string
Default:
null
Declared by:
vdirsyncer.urlCommand
A command that prints the URL of the storage.
Type: null or (list of string)
Default:
null
Example:
[
"~/get-url.sh"
]
Declared by:
vdirsyncer.useVcard4
Specifies whether vdirsyncer should request vCards in version 4.0.
If set to false then vdirsyncer will default to version 3.0.
Type: boolean
Default:
false
Declared by:
vdirsyncer.userAgent
The user agent to report to the server. Defaults to
vdirsyncer.
Type: null or string
Default:
null
Declared by:
vdirsyncer.userNameCommand
A command that prints the user name to standard output.
Type: null or (list of string)
Default:
null
Example:
[
"~/get-username.sh"
]
Declared by:
vdirsyncer.verify
Null or path to certificate to verify SSL against
Type: null or absolute path
Default:
null
Example:
"/path/to/cert.pem"
Declared by:
vdirsyncer.verifyFingerprint
Optional. 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: