1ORG.BLUEZ.OBEX.MESSAGEACCESLSi(n5u)x System AdministrOaRtGi.oBnLUEZ.OBEX.MESSAGEACCESS(5)
2
3
4

NAME

6       org.bluez.obex.MessageAccess - BlueZ D-Bus OBEX MessageAccess API docu‐
7       mentation
8

INTERFACE

10       Service
11              org.bluez.obex
12
13       Interface
14              org.bluez.obex.MessageAccess1
15
16       Object path
17              [Session object path]
18
19   Methods
20   void SetFolder(string name)
21          Set working directory for current session.
22
23          Possible name:
24              Directory name or '..[/dir]'.
25
26          Possible errors:
27
28          org.bluez.obex.Error.InvalidArguments
29
30          org.bluez.obex.Error.Failed
31
32   array{dict} ListFolders(dict filter)
33          Returns a dictionary containing information about the current folder
34          content.
35
36          Possible filter:
37
38          uint16 Offset (default 0)
39                 Offset of the first item.
40
41          uint16 MaxCount (default 1024)
42                 Maximum number of items.
43
44          Possible return:
45
46          string Name
47                 Folder name
48
49          Possible errors:
50
51          org.bluez.obex.Error.InvalidArguments
52
53          org.bluez.obex.Error.Failed
54
55   array{string} ListFilterFields()
56          Return all available fields that can be used in Fields filter.
57
58          Possible values:
59
60          "subject"
61
62          "timestamp"
63
64          "sender"
65
66          "sender-address"
67
68          "recipient"
69
70          "recipient-address"
71
72          "type"
73
74          "size"
75
76          "status"
77
78          "text"
79
80          "attachment"
81
82          "priority"
83
84          "read"
85
86          "sent"
87
88          "protected"
89
90          "replyto"
91
92          Possible errors: None
93
94   array{object, dict} ListMessages(string folder, dict filter)
95          Returns  an array containing the messages objects found in the given
96          subfolder of the current folder, or in the current folder if  folder
97          is empty.
98
99          Possible Filters:
100
101          uint16 Offset (default 0)
102                 Offset of the first item.
103
104          uint16 MaxCount (default 1024):
105              Maximum number of items.
106
107          byte SubjectLength (default 256)
108                 Maximum length of the Subject property in the message.
109
110          array{string} Fields
111                 Message fields, default is all values.
112
113                 See ListFilterFields() for possible values.
114
115          array{string} Types
116                 Filter messages by type.
117
118                 Possible values:
119
120                 "sms"
121
122                 "email"
123
124                 "mms"
125
126          string PeriodBegin
127                 Filter messages by starting period.
128
129                 Possible values:
130                     Date in "YYYYMMDDTHHMMSS" format.
131
132          string PeriodEnd
133                 Filter messages by ending period.
134
135                 Possible values:
136                     Date in "YYYYMMDDTHHMMSS" format.
137
138          boolean Read
139                 Filter messages by read flag.
140
141                 Possible values:
142                     True for read or False for unread
143
144          string Recipient
145                 Filter messages by recipient address.
146
147          string Sender
148                 Filter messages by sender address.
149
150          boolean Priority
151                 Filter messages by priority flag.
152
153                 Possible values:
154                     True for high priority or False for non-high priority.
155
156          Each  message  is  represented  by  an object path, which implements
157          org.bluez.obex.Message(5) interface, followed by a dictionary of its
158          properties.
159
160       void UpdateInbox(void)
161          Requests remote to update its inbox.
162
163          Possible errors:
164
165          org.bluez.obex.Error.Failed
166
167   object, dict PushMessage(string sourcefile, string folder, dict args)
168          Transfers a message (in bMessage format) to the remote device.
169
170          The message is transferred either to the given subfolder of the cur‐
171          rent folder, or to the current folder if folder is empty.
172
173          Possible args: Transparent, Retry, Charset
174
175          The returned path  represents  the  newly  created  transfer,  which
176          should  be  used  to  find  out if the content has been successfully
177          transferred or if the operation fails.
178
179          The properties of this transfer are also returned along with the ob‐
180          ject    path,    to    avoid    a   call   to   GetProperties,   see
181          org.bluez.obex.Transfer(5) for the possible list of properties.
182
183          Possible errors:
184
185          org.bluez.obex.Error.InvalidArguments
186
187          org.bluez.obex.Error.Failed
188
189
190
191
192BlueZ                            October 2023  ORG.BLUEZ.OBEX.MESSAGEACCESS(5)