Skip to content

bluebubbles

bluebubbles

BlueBubblesChannel — BlueBubbles (iMessage bridge) adapter.

Classes

BlueBubblesChannel 

BlueBubblesChannel(url: str = '', *, password: str = '', bus: Optional[EventBus] = None)

Bases: BaseChannel

BlueBubbles (iMessage bridge) channel adapter.

PARAMETER DESCRIPTION
url

BlueBubbles server URL. Falls back to BLUEBUBBLES_URL env var.

TYPE: str DEFAULT: ''

password

BlueBubbles server password. Falls back to BLUEBUBBLES_PASSWORD env var.

TYPE: str DEFAULT: ''

bus

Optional event bus for publishing channel events.

TYPE: Optional[EventBus] DEFAULT: None

Source code in src/openjarvis/channels/bluebubbles.py 
37
38
39
40
41
42
43
44
45
46
47
48
def __init__(
    self,
    url: str = "",
    *,
    password: str = "",
    bus: Optional[EventBus] = None,
) -> None:
    self._url = url or os.environ.get("BLUEBUBBLES_URL", "")
    self._password = password or os.environ.get("BLUEBUBBLES_PASSWORD", "")
    self._bus = bus
    self._handlers: List[ChannelHandler] = []
    self._status = ChannelStatus.DISCONNECTED
Functions
connect 
connect() -> None

Mark as connected (send-only — no persistent connection).

Source code in src/openjarvis/channels/bluebubbles.py 
52
53
54
55
56
57
58
def connect(self) -> None:
    """Mark as connected (send-only — no persistent connection)."""
    if not self._url or not self._password:
        logger.warning("No BlueBubbles URL or password configured")
        self._status = ChannelStatus.ERROR
        return
    self._status = ChannelStatus.CONNECTED
disconnect 
disconnect() -> None

Mark as disconnected.

Source code in src/openjarvis/channels/bluebubbles.py 
60
61
62
def disconnect(self) -> None:
    """Mark as disconnected."""
    self._status = ChannelStatus.DISCONNECTED
send 
send(channel: str, content: str, *, conversation_id: str = '', metadata: Dict[str, Any] | None = None) -> bool

Send an iMessage via the BlueBubbles API.

Source code in src/openjarvis/channels/bluebubbles.py 
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
def send(
    self,
    channel: str,
    content: str,
    *,
    conversation_id: str = "",
    metadata: Dict[str, Any] | None = None,
) -> bool:
    """Send an iMessage via the BlueBubbles API."""
    if not self._url or not self._password:
        logger.warning("Cannot send: no BlueBubbles credentials configured")
        return False

    try:
        import httpx

        url = f"{self._url}/api/v1/message/text"
        payload: Dict[str, Any] = {
            "chatGuid": channel,
            "message": content,
            "method": "private-api",
        }

        resp = httpx.post(
            url,
            params={"password": self._password},
            json=payload,
            timeout=10.0,
        )
        if resp.status_code < 300:
            self._publish_sent(channel, content, conversation_id)
            return True
        logger.warning(
            "BlueBubbles API returned status %d", resp.status_code,
        )
        return False
    except Exception:
        logger.debug("BlueBubbles send failed", exc_info=True)
        return False
status 
status() -> ChannelStatus

Return the current connection status.

Source code in src/openjarvis/channels/bluebubbles.py 
106
107
108
def status(self) -> ChannelStatus:
    """Return the current connection status."""
    return self._status
list_channels 
list_channels() -> List[str]

Return available channel identifiers.

Source code in src/openjarvis/channels/bluebubbles.py 
110
111
112
def list_channels(self) -> List[str]:
    """Return available channel identifiers."""
    return ["bluebubbles"]
on_message 
on_message(handler: ChannelHandler) -> None

Register a callback for incoming messages.

Source code in src/openjarvis/channels/bluebubbles.py 
114
115
116
def on_message(self, handler: ChannelHandler) -> None:
    """Register a callback for incoming messages."""
    self._handlers.append(handler)