Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Delta Chat

Schemesdeltachat://, deltachats://
Cargo featureservice-deltachat
Servicehttps://delta.chat/
Body formatstext (first is the default)
Attachmentsyes
Title lengthno title (merged into the body)
Body length32,768 characters
Body linesunlimited
Request throttlenone
Vendor URLs acceptedno

URL formats

{schema}://{host}
{schema}://{host}:{port}
{schema}://{host}:{port}/{targets}
{schema}://{host}/{targets}
{schema}://{user}@{host}
{schema}://{user}@{host}/{targets}
{schema}://{user}@{host}:{port}
{schema}://{user}@{host}/{targets}
{schema}://{user}@{host}:{port}/{targets}
{schema}://{user}:{password}@{host}
{schema}://{user}:{password}@{host}/{targets}
{schema}://{user}:{password}@{host}:{port}
{schema}://{user}:{password}@{host}:{port}/{targets}

{schema} is one of deltachat://, deltachats://.

URL tokens

TokenMeaningTypeRequiredDefaultNotes
{host}Domainstringyes
{password}Passwordstringnosecret
{port}Portint, 1 to 65535no
{target_email}Target Emailstringno
{targets}Targetslistnoany of target_email; separated by /
{user}User Namestringno

Query parameters

ParameterMeaningTypeDefaultNotes
bccBlind Carbon Copylistseparated by , or space
ccCarbon Copylistseparated by , or space
fromFrom Emailstring
inlineInline Attachmentsboolno
modeSecure Modechoicestarttls (usually; depends on the URL)one of starttls, ssl, insecure
nameFrom Namestring
pgpPGP Security Modechoicenoone of no, sign, encrypt; sign: Ed25519 or RSA (2048 to 8192 bits) private key; encrypt: cv25519 or RSA public key; without the service-deltachat-pgp feature a PGP mode fails with Unsupported
pgpprvPGP Private Key Pathstringsecret; path, file:// or http(s)://; default: the storage folder
pgppubPGP Public Key Pathstringsecret; path, file:// or http(s)://; default: the storage folder
replyReply Tolistseparated by , or space
smtpSMTP Serverstring
toTo Emailstring
wkdWeb Key Directoryboolno

Prefixed parameters:

  • +name=value: Email Header

The common URL parameters (format, overflow, verify, redirect, cto, rto, retry, wait, store, tag, tz, user, password, port, optional, emojis) apply as well.

Examples

Accepted URLs (tokens are fake):

deltachat://user:pass@smtp.example.com/friend@example.org
deltachats://user:pass@smtp.example.com/friend@example.org
deltachats://user:pass@smtp.example.com/friend@example.org?format=html
deltachats://user:pass@smtp.example.com/friend@example.org?cc=other@example.org&+X-Extra=1

Rejected URLs:

deltachat://
deltachat://user:pass@smtp.example.com/friend@example.org?pgp=invalid

Send one from the command line:

mercurio -t 'Backup' -b 'Finished in 42s' 'deltachat://user:pass@smtp.example.com/friend@example.org'

Notes

Delta Chat (deltachat://, deltachats://): messages to Delta Chat users as e-mail, delivered with a Chat-Version: 1.0 header, plain-text bodies and a Chat: <excerpt> subject built from the body (the title is merged into the body).

Differences with Apprise

  • PGP works as for email (feature service-deltachat-pgp), with the subject Chat: when signing and Chat: Encrypted message when encrypting, the Autocrypt header and key generation included.