API Reference

Delta Chat JSON-RPC high-level API.

class deltachat_rpc_client.Account(manager: DeltaChat, id: int)

Delta Chat account.

bring_online()

Start I/O and wait until IMAP becomes IDLE.

check_qr(qr)

Parse QR code contents.

This function takes the raw text scanned and checks what can be done with it.

clear_all_events()

Remove all queued-up events for a given account.

Useful for tests.

clone() → Account

Clone given account.

This uses backup-transfer via iroh, i.e. the ‘Add second device’ feature.

create_broadcast(name: str) → Chat

Create a new broadcast channel (called “Channel” in the UI).

Broadcast channels are similar to groups on the sending device, however, recipients get the messages in a read-only chat and will not see who the other members are.

Called broadcast here rather than channel, because the word “channel” already appears a lot in the code, which would make it hard to grep for it.

After creation, the chat contains no recipients and is in _unpromoted_ state; see create_group() for more information on the unpromoted state.

Returns the created chat.

create_chat(account: Account) → Chat

Create a 1:1 chat with another account.

create_contact(obj: int | str | Contact | Account, name: str | None = None) → Contact

Create a new Contact or return an existing one.

Calling this method will always result in the same underlying contact id. If there already is a Contact with that e-mail address, it is unblocked and its display name is updated if specified.

Parameters:

• obj – email-address, contact id or account.

• name – (optional) display name for this contact.

create_group(name: str, protect: bool = False) → Chat

Create a new group chat.

After creation, the group has only self-contact as member one member (see SpecialContactId.SELF) and is in _unpromoted_ state. This means, you can add or remove members, change the name, the group image and so on without messages being sent to all group members.

This changes as soon as the first message is sent to the group members and the group becomes _promoted_. After that, all changes are synced with all group members by sending status message.

To check, if a chat is still unpromoted, you can look at the is_unpromoted property of a chat (see get_full_snapshot() / get_basic_snapshot()). This may be useful if you want to show some help for just created groups.

Parameters:

protect – If set to 1 the function creates group with protection initially enabled. Only verified members are allowed in these groups and end-to-end-encryption is always enabled.

delete_messages(messages: list[Message]) → None

Delete messages (local and remote).

property device_contact: Chat

Account’s device contact.

export_backup(path, passphrase: str = '') → None

Export backup.

export_self_keys(path) → None

Export keys.

get_avatar() → str | None

Get self avatar.

get_blocked_contacts() → list[AttrDict]

Return a list with snapshots of all blocked contacts.

get_chat_by_contact(contact: int | Contact) → Chat | None

Return 1:1 chat for a contact if it exists.

get_chat_by_id(chat_id: int) → Chat

Return the Chat instance with the given ID.

get_chatlist(query: str | None = None, contact: Contact | None = None, archived_only: bool = False, for_forwarding: bool = False, no_specials: bool = False, alldone_hint: bool = False, snapshot: bool = False) → list[Chat] | list[AttrDict]

Return list of chats.

Parameters:

• query – if a string is specified only chats matching this query are returned.

• contact – if a contact is specified only chats including this contact are returned.

• archived_only – if True only archived chats are returned.

• for_forwarding – if True the chat list is sorted with “Saved messages” at the top and without “Device chat” and contact requests.

• no_specials – if True archive link is not added to the list.

• alldone_hint – if True the “all done hint” special chat will be added to the list as needed.

• snapshot – If True return a list of chat snapshots instead of Chat instances.

get_config(key: str) → str | None

Get configuration value.

get_contact_by_addr(address: str) → Contact | None

Check if an e-mail address belongs to a known and unblocked contact.

get_contact_by_id(contact_id: int) → Contact

Return Contact instance for the given contact ID.

get_contacts(query: str | None = None, *, with_self: bool = False, snapshot: bool = False) → list[Contact] | list[AttrDict]

Get a filtered list of contacts.

Parameters:

• query – if a string is specified, only return contacts whose name or e-mail matches query.

• with_self – if True the self-contact is also included if it matches the query.

• snapshot – If True return a list of contact snapshots instead of Contact instances.

get_device_chat() → Chat

Return device chat.

get_fresh_messages() → list[Message]

Return the list of fresh messages, newest messages first.

This call is intended for displaying notifications. If you are writing a bot, use get_fresh_messages_in_arrival_order() instead, to process oldest messages first.

get_fresh_messages_in_arrival_order() → list[Message]

Return fresh messages list sorted in the order of their arrival, with ascending IDs.

get_info() → AttrDict

Return dictionary of this account configuration parameters.

get_message_by_id(msg_id: int) → Message

Return the Message instance with the given ID.

get_next_messages() → list[Message]

Return a list of next messages.

get_qr_code() → str

Get Setup-Contact QR Code text.

This data needs to be transferred to another Delta Chat account in a second channel, typically used by mobiles with QRcode-show + scan UX.

get_qr_code_svg() → tuple[str, str]

Get Setup-Contact QR code text and SVG.

get_size() → int

Get the combined filesize of an account in bytes.

import_backup(path, passphrase: str = '') → None

Import backup.

import_self_keys(path) → None

Import keys.

import_vcard(vcard: str) → list[Contact]

Import vCard.

Return created or modified contacts in the order they appear in vCard.

initiate_autocrypt_key_transfer() → None

Send Autocrypt Setup Message.

is_configured() → bool

Return True if this account is configured.

make_vcard(contacts: list[Contact]) → str

Create vCard with the given contacts.

mark_seen_messages(messages: list[Message]) → None

Mark the given set of messages as seen.

remove() → None

Remove the account.

secure_join(qrdata: str) → Chat

Continue a Setup-Contact or Verified-Group-Invite protocol started on another device.

The function returns immediately and the handshake runs in background, sending and receiving several messages. Subsequent calls of secure_join() will abort previous, unfinished handshakes. See https://securejoin.delta.chat/ for protocol details.

Parameters:

qrdata – The text of the scanned QR code.

property self_contact: Contact

Account’s identity as a Contact.

set_avatar(img_path: str | None = None) → None

Set self avatar.

Passing None will discard the currently set avatar.

set_config(key: str, value: str | None = None) → None

Set configuration value.

set_config_from_qr(qr: str)

Set configuration values from a QR code.

start_io() → None

Start the account I/O.

stop_io() → None

Stop the account I/O.

update_config(**kwargs) → None

Update config values.

wait_for_event(event_type=None) → AttrDict

Wait until the next event and return it.

wait_for_incoming_msg()

Wait for incoming message and return it.

Consumes all events before the next incoming message event.

wait_for_incoming_msg_event()

Wait for incoming message event and return it.

wait_for_msgs_changed_event()

Wait for messages changed event and return it.

wait_for_msgs_noticed_event()

Wait for messages noticed event and return it.

wait_for_reactions_changed()

Wait for reaction change event.

wait_for_securejoin_inviter_success()

Wait until SecureJoin process finishes successfully on the inviter side.

wait_for_securejoin_joiner_success()

Wait until SecureJoin process finishes successfully on the joiner side.

wait_next_messages() → list[Message]

Wait for new messages and return a list of them.

class deltachat_rpc_client.AttrDict(*args, **kwargs)

Dictionary that allows accessing values using the “dot notation” as attributes.

class deltachat_rpc_client.Bot(account: Account, hooks: Iterable[tuple[Callable, type | EventFilter]] | None = None, logger: logging.Logger | None = None)

Simple bot implementation that listens to events of a single account.

configure(email: str, password: str, **kwargs) → None

Configure the bot.

class deltachat_rpc_client.Chat(account: Account, id: int)

Chat object which manages members and through which you can send and retrieve messages.

accept() → None

Accept this contact request chat.

add_contact(*contact: int | str | Contact) → None

Add contacts to this group.

archive() → None

Archive this chat.

block() → None

Block this chat.

can_send() → bool

Return true if messages can be sent to the chat.

delete() → None

Delete this chat and all its messages.

Note:

• does not delete messages on server

• the chat or contact is not blocked, new message will arrive

forward_messages(messages: list[Message]) → None

Forward a list of messages to this chat.

get_basic_snapshot() → AttrDict

Get a chat snapshot with basic info about this chat.

get_contacts() → list[Contact]

Get the contacts belonging to this chat.

For single/direct chats self-address is not included.

get_draft() → AttrDict | None

Get draft message.

get_encryption_info() → str

Return encryption info for this chat.

get_fresh_message_count() → int

Get number of fresh messages in this chat.

get_full_snapshot() → AttrDict

Get a full snapshot of this chat.

get_locations(contact: Contact | None = None, timestamp_from: 'datetime' | None = None, timestamp_to: 'datetime' | None = None) → list[AttrDict]

Get list of location snapshots for the given contact in the given timespan.

get_messages(info_only: bool = False, add_daymarker: bool = False) → list[Message]

Get the list of messages in this chat.

get_past_contacts() → list[Contact]

Get past contacts for this chat.

get_qr_code() → str

Get Join-Group QR code text.

get_qr_code_svg() → tuple[str, str]

Get Join-Group QR code text and SVG data.

leave() → None

Leave this chat.

mark_noticed() → None

Mark all messages in this chat as noticed.

mute(duration: int | None = None) → None

Mute this chat, if a duration is not provided the chat is muted forever.

Parameters:

duration – mute duration from now in seconds. Must be greater than zero.

pin() → None

Pin this chat.

remove_contact(*contact: int | str | Contact) → None

Remove members from this group.

remove_draft() → None

Remove draft message.

remove_image() → None

Remove profile image of this chat.

send_contact(contact: Contact)

Send contact to the chat.

send_file(path)

Send a file and return the resulting Message instance.

send_message(text: str | None = None, html: str | None = None, viewtype: ViewType | None = None, file: str | None = None, filename: str | None = None, location: tuple[float, float] | None = None, override_sender_name: str | None = None, quoted_msg: int | Message | None = None) → Message

Send a message and return the resulting Message instance.

send_sticker(path: str) → Message

Send an sticker and return the resulting Message instance.

send_text(text: str) → Message

Send a text message and return the resulting Message instance.

send_videochat_invitation() → Message

Send a videochat invitation and return the resulting Message instance.

set_draft(text: str | None = None, file: str | None = None, filename: str | None = None, quoted_msg: int | None = None, viewtype: str | None = None) → None

Set draft message.

set_ephemeral_timer(timer: int) → None

Set ephemeral timer of this chat in seconds.

0 means the timer is disabled, use 1 for immediate deletion.

set_image(path: str) → None

Set profile image of this chat.

Parameters:

path – Full path of the image to use as the group image.

set_name(name: str) → None

Set name of this chat.

unarchive() → None

Unarchive this chat.

unmute() → None

Unmute this chat.

unpin() → None

Unpin this chat.

class deltachat_rpc_client.Client(account: Account, hooks: Iterable[tuple[Callable, type | EventFilter]] | None = None, logger: logging.Logger | None = None)

Simple Delta Chat client that listen to events of a single account.

add_hook(hook: ~typing.Callable, event: type | ~deltachat_rpc_client.events.EventFilter = <class 'deltachat_rpc_client.events.RawEvent'>) → None

Register hook for the given event filter.

add_hooks(hooks: Iterable[tuple[Callable, type | EventFilter]]) → None

Register multiple hooks.

configure(email: str, password: str, **kwargs) → None

Configure the client.

is_configured() → bool

Return True if the client is configured.

remove_hook(hook: Callable, event: type | EventFilter) → None

Unregister hook from the given event filter.

run_forever() → None

Process events forever.

run_until(func: Callable[[AttrDict], bool]) → AttrDict

Process events until the given callable evaluates to True.

The callable should accept an AttrDict object representing the last processed event. The event is returned when the callable evaluates to True.

class deltachat_rpc_client.Contact(account: Account, id: int)

Contact API.

Essentially a wrapper for RPC, account ID and a contact ID.

block() → None

Block contact.

create_chat() → Chat

Create or get an existing 1:1 chat for this contact.

delete() → None

Delete contact.

get_encryption_info() → str

Get a multi-line encryption info.

Encryption info contains your fingerprint and the fingerprint of the contact.

get_snapshot() → AttrDict

Return a dictionary with a snapshot of all contact properties.

make_vcard() → str

Make a vCard for the contact.

set_name(name: str) → None

Change the name of this contact.

unblock() → None

Unblock contact.

class deltachat_rpc_client.DeltaChat(rpc: Rpc)

Delta Chat accounts manager.

This is the root of the object oriented API.

add_account() → Account

Create a new account database.

get_all_accounts() → list[Account]

Return a list of all available accounts.

get_system_info() → AttrDict

Get information about the Delta Chat core in this system.

maybe_network() → None

Indicate that the network conditions might have changed.

set_translations(translations: dict[str, str]) → None

Set stock translation strings.

start_io() → None

Start the I/O of all accounts.

stop_io() → None

Stop the I/O of all accounts.

class deltachat_rpc_client.EventType(*values)

Core event types.

class deltachat_rpc_client.Message(account: Account, id: int)

Delta Chat Message object.

continue_autocrypt_key_transfer(setup_code: str) → None

Continue the Autocrypt Setup Message key transfer.

This function can be called on received Autocrypt Setup Message to import the key encrypted with the provided setup code.

get_info() → str

Return message info.

get_reactions() → AttrDict | None

Get message reactions.

get_read_receipts() → List[AttrDict]

Get message read receipts.

get_sender_contact() → Contact

Return sender contact.

get_snapshot() → AttrDict

Get a snapshot with the properties of this message.

get_webxdc_info() → dict

Get info from a Webxdc message in JSON format.

get_webxdc_status_updates(last_known_serial: int = 0) → list

Return a list of Webxdc status updates for Webxdc instance message.

mark_seen() → None

Mark the message as seen.

send_reaction(*reaction: str) → Message

Send a reaction to this message.

send_webxdc_status_update(update: dict | str, description: str) → None

Send a webxdc status update. This message must be a webxdc.

wait_until_delivered() → None

Consume events until the message is delivered.

class deltachat_rpc_client.SpecialContactId(*values)

Special contact IDs.

class deltachat_rpc_client.Rpc(accounts_dir: str | None = None, **kwargs)

RPC client.

clear_all_events(account_id: int)

Remove all queued-up events for a given account. Useful for tests.

close() → None

Terminate RPC server process and wait until the reader loop finishes.

events_loop() → None

Request new events and distributes them between queues.

get_queue(account_id: int) → Queue

Get event queue corresponding to the given account ID.

reader_loop() → None

Process JSON-RPC responses from the RPC server process output.

start() → None

Start RPC server subprocess.

wait_for_event(account_id: int) → dict | None

Wait for the next event from the given account and returns it.

writer_loop() → None

Writer loop ensuring only a single thread writes requests.

deltachat_rpc_client.run_bot_cli(hooks: Iterable[Tuple[Callable, type | EventFilter]] | None = None, argv: list | None = None, **kwargs) → None

Run a simple bot command line using the given hooks.

Extra keyword arguments are passed to the internal Rpc object.

deltachat_rpc_client.run_client_cli(hooks: Iterable[Tuple[Callable, type | EventFilter]] | None = None, argv: list | None = None, **kwargs) → None

Run a simple command line app, using the given hooks.

Extra keyword arguments are passed to the internal Rpc object.