org.bluez...ageAccess(5)

🎀 NAME 🎀

Bestie, this is the org.bluez.obex.MessageAccess(5) page — a Linux System Administration manual page for the BlueZ D-Bus OBEX MessageAccess API. The official NAME situation is org.bluez.obex.MessageAccess — BlueZ D-Bus OBEX MessageAccess API documentation. So yes, we are getting into the MessageAccess API, and we are not skipping a single method, filter, default, or error. 💖✨

---

✨ INTERFACE ✨

Here’s the identity card, no cap:

• Service — org.bluez.obex
• Interface — org.bluez.obex.MessageAccess1
• Object path — [Session object path]

---

💅 METHODS 💅

🌸 void SetFolder(string name)

Sets the working directory for the current session. Literally moving the group chat to a different folder. 🗂️

Possible name:

• Directory name or '..[/dir]'.

Possible errors:

• org.bluez.obex.Error.InvalidArguments
• org.bluez.obex.Error.Failed

---

🗂️ array{dict} ListFolders(dict filter)

Returns a dictionary containing information about the current folder content. Folder tea, spilled. ☕

Possible filter:

• uint16 Offset (default 0) — offset of the first item.
• uint16 MaxCount (default 1024) — maximum number of items.

Possible return:

• string Name — folder name

Possible errors:

• org.bluez.obex.Error.InvalidArguments
• org.bluez.obex.Error.Failed

---

🏷️ array{string} ListFilterFields()

Returns all available fields that can be used in the Fields filter. This is the field menu, bestie — the whole roster. 🎀

Possible values:

• "subject"
• "timestamp"
• "sender"
• "sender-address"
• "recipient"
• "recipient-address"
• "type"
• "size"
• "status"
• "text"
• "attachment"
• "priority"
• "read"
• "sent"
• "protected"
• "replyto"

Possible errors: None

---

📨 array{object, dict} ListMessages(string folder, dict filter)

Returns an array containing the message objects found in the given subfolder of the current folder, or in the current folder if folder is empty. Empty folder means “stay right here,” periodt. 💌

Possible Filters:

• uint16 Offset (default 0) — offset of the first item.
• uint16 MaxCount (default 1024): — maximum number of items.
• byte SubjectLength (default 256) — maximum length of the Subject property in the message.
• array{string} Fields — message fields, default is all values. See ListFilterFields() for possible values.
• array{string} Types — filter messages by type.
  • Possible values:
    • "sms"
    • "email"
    • "mms"
• string PeriodBegin — filter messages by starting period.
  • Possible values:
    • Date in "YYYYMMDDTHHMMSS" format.
• string PeriodEnd — filter messages by ending period.
  • Possible values:
    • Date in "YYYYMMDDTHHMMSS" format.
• boolean Read — filter messages by read flag.
  • Possible values:
    • True for read or False for unread
• string Recipient — filter messages by recipient address.
• string Sender — filter messages by sender address.
• boolean Priority — filter messages by priority flag.
  • Possible values:
    • True for high priority or False for non-high priority.

Each message is represented by an object path, which implements the org.bluez.obex.Message(5) interface, followed by a dictionary of its properties. So you get the object path plus its little property bag. 🎒✨

---

🔄 void UpdateInbox(void)

Requests remote to update its inbox. Politely asking the other side to refresh, basically. 🔁

Possible errors:

• org.bluez.obex.Error.Failed

---

📤 object, dict PushMessage(string sourcefile, string folder, dict args)

Transfers a message (in bMessage format) to the remote device. Sending it, slay. 💅

The message is transferred either to the given subfolder of the current folder, or to the current folder if folder is empty.

Possible args: Transparent, Retry, Charset

The returned path represents the newly created transfer, which should be used to find out if the content has been successfully transferred or if the operation fails.

The properties of this transfer are also returned along with the object path, to avoid a call to GetProperties; see org.bluez.obex.Transfer(5) for the possible list of properties.

Possible errors:

• org.bluez.obex.Error.InvalidArguments
• org.bluez.obex.Error.Failed

---

👑 PROPERTIES 👑

⭐ array{string} SupportedTypes [readonly]

List of supported message types. The whole roster:

Possible values:

• "EMAIL" — Email messages.
• "SMS_GSM" — GSM short messages.
• "SMS_CDMA" — CDMA short messages.
• "MMS" — MMS messages.
• "IM" — Instant messaging.

---

Source/version and date, bestie: BlueZ, October 2023. That’s the whole page — now go be the main character of your OBEX session. 💅✨