Advanced Usage

Asynchronous Notifications

If you are running inside an asyncio event loop, you can use async_notify() to send notifications without blocking.

import asyncio
import apprise

async def main():
    apobj = apprise.Apprise()
    apobj.add('mailto://user:pass@example.com')

    # Await the notification delivery
    await apobj.async_notify(
        title='Async Test',
        body='This was sent asynchronously',
    )

asyncio.run(main())

Serialization (Pickle)

Apprise objects can be serialized (pickled). This allows you to configure an Apprise object once, save it to disk (or a database), and reload it later with all services configured.

import apprise
import pickle

# 1. Setup
apobj = apprise.Apprise()
apobj.add("json://localhost")

# 2. Serialize
serialized_data = pickle.dumps(apobj)

# ... later in your code ...

# 3. Restore
restored_obj = pickle.loads(serialized_data)
restored_obj.notify("I am back!")

Low-Level: The Apprise Notification Object

When you call Apprise.notify(), it handles tagging, configuration, and logging for you. If you need to bypass this and interact directly with a specific notification object:

import apprise

# Instantiate a single notification object directly
# (Bypassing the Apprise() manager)
obj = apprise.Apprise.instantiate('glib://')

# Send raw content
obj.send(
    body="Raw message",
    title="Raw title"
)

Caution

Using send() directly bypasses many of the safeguards and features (like tagging and attachment processing) provided by the main notify() method.

Proxy Support

Apprise sends every notification over requests, which honours the standard HTTP_PROXY, HTTPS_PROXY, and NO_PROXY environment variables automatically. No Apprise-specific configuration is required — set the variable before your process starts (or export it in the environment Apprise runs under) and every outbound request routes through the proxy:

export HTTPS_PROXY="http://127.0.0.1:3128"
export HTTP_PROXY="http://127.0.0.1:3128"

python3 my_script.py

If you only want Apprise to proxy (and not the rest of your application), scope the variable to the subprocess or environment that runs Apprise rather than exporting it globally — for example, setting it inline for a single command, or in a systemd unit’s Environment= directive for a long-running service.

NO_PROXY is also honoured, letting you exempt specific hosts:

export HTTPS_PROXY="http://127.0.0.1:3128"
export NO_PROXY="localhost,127.0.0.1,internal.example.com"

Note

SOCKS proxies (socks5h://...) require the optional PySocks package (pip install pysocks) — requests needs it to understand SOCKS proxy URLs. Without it, a socks5h:// value in HTTP_PROXY/HTTPS_PROXY will fail.