org.bluez.obex.Message(5)

๐Ÿ’Œ NAME ๐Ÿ’Œ

okay so this is the manual page for org.bluez.obex.Message, aka the BlueZ D-Bus OBEX Message API documentation ๐Ÿ˜ญ๐Ÿ’–. It's from the Linux System Administration manual, and we're gonna walk through the service/interface/object path situation, the Get method, and every single property โ€” no skipping, bestie, periodt โœจ.

๐Ÿฆ‹ INTERFACE ๐Ÿฆ‹

here's the identity card, no cap:

  • Service โ€” org.bluez.obex ๐Ÿ’…
  • Interface โ€” org.bluez.obex.Message1 ๐Ÿซถ
  • Object path โ€” [Session object path]/message{#} ๐ŸŽ€

โœจ METHODS โœจ

๐Ÿ“ฅ object, dict Get(string targetfile, boolean attachment)

okay so this method downloads the message and stores it in the target file. literally that's the whole vibe. ๐Ÿ’พโœจ

If an empty targetfile is given, a temporary file will be automatically generated โ€” the system's got you, bestie. ๐Ÿงš

The returned path represents the newly created transfer, and you should use it to find out if the content has been successfully transferred or if the operation fails. important!! ๐Ÿ˜ญ

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. iykyk ๐Ÿ‘‘

Possible errors:

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

๐Ÿ’… PROPERTIES ๐Ÿ’…

vibe check on every property, incoming:

  • string Folder [readonly] โ€” the folder which the message belongs to ๐Ÿ—‚๏ธ
  • string Subject [readonly] โ€” message subject ๐Ÿ’Œ
  • string Timestamp [readonly] โ€” message timestamp โฐ
  • string Sender [readonly] โ€” message sender name ๐Ÿซถ
  • string SenderAddress [readonly] โ€” message sender address ๐Ÿ“ฎ
  • string ReplyTo [readonly] โ€” message Reply-To address โ†ฉ๏ธ
  • string Recipient [readonly] โ€” message recipient name ๐ŸŽ€
  • string RecipientAddress [readonly] โ€” message recipient address ๐Ÿ“ฌ
  • string Type [readonly] โ€” message type ๐ŸŒˆ
    • possible values:
      • "email"
      • "sms-gsm"
      • "sms-cdma"
      • "mms"
  • uint64 Size [readonly] โ€” message size in bytes ๐Ÿ“
  • string Status [readonly] โ€” message reception status ๐Ÿ“ฅ
    • possible values:
      • "complete"
      • "fractioned"
      • "notification"
  • boolean Priority [readonly] โ€” message priority flag ๐Ÿ”ฅ
  • boolean Read [read/write] โ€” message read flag ๐Ÿ‘€
  • boolean Deleted [writeonly] โ€” message deleted flag ๐Ÿ—‘๏ธ
  • boolean Sent [readonly] โ€” message sent flag ๐Ÿš€
  • boolean Protected [readonly] โ€” message protected flag ๐Ÿ”’
  • string DeliveryStatus [readonly] [optional] โ€” message delivery status ๐Ÿšš
    • possible values:
      • "delivered"
      • "sent"
      • "unknown"
  • uint64 ConversationId [readonly] [required] โ€” message conversation id sent by Server which serves as unique identification of the conversation ๐Ÿงต
  • string ConversationName [readonly] [optional] โ€” human readable name of the conversation ๐Ÿ’ฌ
  • string Direction [readonly] [required] โ€” indicate the direction of the message ๐Ÿงญ
    • possible values:
      • "incoming"
      • "outgoing"
      • "outgoingdraft"
      • "outgoingpending"
  • string AttachmentMimeTypes [readonly] [optional] โ€” MIME type of the attachment ๐Ÿ“Ž

and that's the whole manual page, bestie โ€” slay ๐Ÿ’–. source/version is BlueZ, date is October 2023, and the page is org.bluez.obex.Message(5). periodt โœจ๐Ÿซถ

๐Ÿ“ฆ where this page comes from