Blob: org.bluez.obex.Message.rst

Blob id: d16ed061db746aee1ca2448414a1d25eb82e001c

Size: 3.3 KB

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
======================
org.bluez.obex.Message
======================

------------------------------------------
BlueZ D-Bus OBEX Message API documentation
------------------------------------------

:Version: BlueZ
:Date: October 2023
:Manual section: 5
:Manual group: Linux System Administration

Interface
=========

:Service:	org.bluez.obex
:Interface:	org.bluez.obex.Message1
:Object path:	[Session object path]/message{#}

Methods
-------

object, dict Get(string targetfile, boolean attachment)
```````````````````````````````````````````````````````

Download message and store it in the target file.

If an empty target file is given, a temporary file will be automatically
generated.

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
----------

string Folder [readonly]
````````````````````````

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 servers 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