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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
|
[
{
"namespace": "manifest",
"types": [
{
"$extend": "OptionalPermission",
"choices": [
{
"type": "string",
"enum": ["accountsIdentities"]
}
]
}
]
},
{
"namespace": "identities",
"permissions": ["accountsRead"],
"types": [
{
"id": "MailIdentity",
"type": "object",
"properties": {
"accountId": {
"type": "string",
"optional": true,
"description": "The id of the :ref:`accounts.MailAccount` this identity belongs to. The ``accountId`` property is read-only."
},
"composeHtml": {
"type": "boolean",
"optional": true,
"description": "If the identity uses HTML as the default compose format."
},
"email": {
"type": "string",
"optional": true,
"description": "The user's email address as used when messages are sent from this identity."
},
"id": {
"type": "string",
"optional": true,
"description": "A unique identifier for this identity. The ``id`` property is read-only."
},
"label": {
"type": "string",
"optional": true,
"description": "A user-defined label for this identity."
},
"name": {
"type": "string",
"optional": true,
"description": "The user's name as used when messages are sent from this identity."
},
"replyTo": {
"type": "string",
"optional": true,
"description": "The reply-to email address associated with this identity."
},
"organization": {
"type": "string",
"optional": true,
"description": "The organization associated with this identity."
},
"signature": {
"type": "string",
"optional": true,
"description": "The signature of the identity."
},
"signatureIsPlainText": {
"type": "boolean",
"optional": true,
"description": "If the signature should be interpreted as plain text or as HTML."
}
}
}
],
"functions": [
{
"name": "list",
"type": "function",
"description": "Returns the identities of the specified account, or all identities if no account is specified. Do not expect the returned identities to be in any specific order. Use :ref:`identities.getDefault` to get the default identity of an account.",
"async": "callback",
"parameters": [
{
"name": "accountId",
"type": "string",
"optional": true
},
{
"type": "function",
"name": "callback",
"optional": true,
"parameters": [
{
"type": "array",
"items": {
"$ref": "identities.MailIdentity"
}
}
]
}
]
},
{
"name": "get",
"type": "function",
"description": "Returns details of the requested identity, or <value>null</value> if it doesn't exist.",
"async": "callback",
"parameters": [
{
"name": "identityId",
"type": "string"
},
{
"type": "function",
"name": "callback",
"optional": true,
"parameters": [
{
"$ref": "identities.MailIdentity",
"optional": true
}
]
}
]
},
{
"name": "create",
"permissions": ["accountsIdentities"],
"type": "function",
"description": "Create a new identity in the specified account.",
"async": "callback",
"parameters": [
{
"name": "accountId",
"type": "string"
},
{
"name": "details",
"$ref": "identities.MailIdentity"
},
{
"type": "function",
"name": "callback",
"optional": true,
"parameters": [
{
"$ref": "identities.MailIdentity"
}
]
}
]
},
{
"name": "delete",
"permissions": ["accountsIdentities"],
"type": "function",
"description": "Attempts to delete the requested identity. Default identities cannot be deleted.",
"async": true,
"parameters": [
{
"name": "identityId",
"type": "string"
}
]
},
{
"name": "update",
"permissions": ["accountsIdentities"],
"type": "function",
"description": "Updates the details of an identity.",
"async": "callback",
"parameters": [
{
"name": "identityId",
"type": "string"
},
{
"name": "details",
"$ref": "identities.MailIdentity"
},
{
"type": "function",
"name": "callback",
"optional": true,
"parameters": [
{
"$ref": "identities.MailIdentity"
}
]
}
]
},
{
"name": "getDefault",
"type": "function",
"description": "Returns the default identity for the requested account, or <value>null</value> if it is not defined.",
"async": "callback",
"parameters": [
{
"name": "accountId",
"type": "string"
},
{
"type": "function",
"name": "callback",
"optional": true,
"parameters": [
{
"$ref": "identities.MailIdentity"
}
]
}
]
},
{
"name": "setDefault",
"type": "function",
"description": "Sets the default identity for the requested account.",
"async": true,
"parameters": [
{
"name": "accountId",
"type": "string"
},
{
"name": "identityId",
"type": "string"
}
]
}
],
"events": [
{
"name": "onCreated",
"type": "function",
"description": "Fired when a new identity has been created and added to an account. The event also fires for default identities that are created when a new account is added.",
"parameters": [
{
"name": "identityId",
"type": "string"
},
{
"name": "identity",
"$ref": "MailIdentity"
}
]
},
{
"name": "onDeleted",
"type": "function",
"description": "Fired when an identity has been removed from an account.",
"parameters": [
{
"name": "identityId",
"type": "string"
}
]
},
{
"name": "onUpdated",
"type": "function",
"description": "Fired when one or more properties of an identity have been modified. The returned :ref:`identities.MailIdentity` includes only the changed values.",
"parameters": [
{
"name": "identityId",
"type": "string"
},
{
"name": "changedValues",
"$ref": "MailIdentity"
}
]
}
]
}
]
|
