ORG.BLUEZ.OBEX.MESSAGEACCESS(5) | Linux System Administration | ORG.BLUEZ.OBEX.MESSAGEACCESS(5) |
NAME
org.bluez.obex.MessageAccess - BlueZ D-Bus OBEX MessageAccess API documentation
INTERFACE
- Service
- org.bluez.obex
- Interface
- org.bluez.obex.MessageAccess1
- Object path
- [Session object path]
Methods
void SetFolder(string name)
Possible name:
Possible errors:
array{dict} ListFolders(dict filter)
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:
array{string} ListFilterFields()
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)
Possible Filters:
- uint16 Offset (default 0)
- Offset of the first item.
uint16 MaxCount (default 1024):
- 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:
- string PeriodEnd
- Filter messages by ending period.
Possible values:
- boolean Read
- Filter messages by read flag.
Possible values:
- string Recipient
- Filter messages by recipient address.
- string Sender
- Filter messages by sender address.
- boolean Priority
- Filter messages by priority flag.
Possible values:
Each message is represented by an object path, which implements org.bluez.obex.Message(5) interface, followed by a dictionary of its properties.
void UpdateInbox(void)
Possible errors:
object, dict PushMessage(string sourcefile, string folder, dict args)
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:
October 2023 | BlueZ |