forked from Zimbra/zm-api-js-client
-
Notifications
You must be signed in to change notification settings - Fork 0
/
schema.graphql
3149 lines (2807 loc) · 61.7 KB
/
schema.graphql
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
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
enum SortBy {
none
dateAsc
dateDesc
subjAsc
subjDesc
nameAsc
nameDesc
rcptAsc
rcptDesc
attachAsc
attachDesc
flagAsc
flagDesc
priorityAsc
priorityDesc
readAsc
readDesc
sizeAsc
sizeDesc
}
enum ShareInputAction {
edit
revoke
expire
}
enum FreeBusyStatus {
F # Free
B # Busy
T # Tentative
O # Out of Office
}
enum AccountType {
imap
pop3
}
enum ConnectionType {
cleartext
ssl
tls
tls_is_available
}
enum PrefCalendarInitialView {
day
list
month
week
workWeek
year
}
enum PrefMailSendReadReceipts {
prompt
always
never
}
enum PrefDelegatedSendSaveTarget {
owner
sender
both
none
}
enum AlarmAction {
DISPLAY
AUDIO
EMAIL
PROCEDURE
X_YAHOO_CALENDAR_ACTION_IM
X_YAHOO_CALENDAR_ACTION_MOBILE
NONE
}
enum AlarmRelatedTo {
START
END
}
enum Weekday {
SU
MO
TU
WE
TH
FR
SA
}
enum CalendarItemRecurrenceFrequency {
SEC
MIN
HOU
DAI
WEE
MON
YEA
}
enum InviteReplyVerb {
ACCEPT
DECLINE
TENTATIVE
}
enum InviteReplyType {
r #reply
w #forward
}
enum AutoCompleteMatchType {
gal
contact
rankingTable
}
enum ParticipationStatus {
NE # needs-action
AC # accept
TE # tentative
DE # declined
DG # delegated
CO # completed
IN # in-process
WA # waiting (only tasks)
DF # deferred (only tasks)
}
enum InviteCompletionStatus {
NEED # Not Started / Need Response
TENT # Tentative
CONF # Confirmed
CANC # Cancelled
COMP # Completed
INPR # In Progress
WAITING # Waiting on someone else
DEFERRED # Deferred
}
enum ParticipationRole {
REQ # required
OPT # optional
NON # informational purposes only
}
enum CalendarItemClass {
PRI # Private
PUB # Public
CON # Confidential
}
enum AddressType {
f # from
t # to
c # cc
b # bcc
r # reply-to
s # sender
n # read-receipt notification
rf # resent-from
}
# https://github.com/Zimbra/zm-mailbox/blob/develop/store/docs/acl.md
enum GranteeType {
usr # Zimbra User
grp # Zimbra Group (distribution list)
egp # an external AD group
dom # Zimbra Domain
all # All authenticated users
pub # public access
guest # Non-zimbra email address and password
key # Non-Zimbra email address and access key
cos # Grantee ID must match zimbraCOSId (Class of Service)
}
enum SearchType {
conversation
message
contact
appointment
task
wiki
document
}
enum ContactType {
C # Reference to another contact
G # Reference to a GAL entry
I # Inlined member (member name and email address is embeded in the contact group)
}
enum FolderView {
search
folder
tag
conversation
message
contact
document
appointment
virtual
remote
wiki
task
chat
note
comment
}
enum GalSearchType {
all
account
resource
group
}
enum NeedIsMemberType {
all
directOnly
none
}
enum ReadingPaneLocation {
off
right
bottom
}
enum PrefMailSelectAfterDelete {
next
previous
adaptive
}
enum ActionTypeName {
ContactAction
ConvAction
DistributionList
FolderAction
ItemAction
MsgAction
TagAction
}
enum LicenseStatus {
OK
NOT_INSTALLED
NOT_ACTIVATED
IN_FUTURE
EXPIRED
INVALID
LICENSE_GRACE_PERIOD
ACTIVATION_GRACE_PERIOD
}
enum SetRecoveryAccountOp {
sendCode
validateCode
resendCode
reset
}
enum SetRecoveryAccountChannel {
email
}
enum RecoverAccountOp {
getRecoveryAccount
sendRecoveryCode
}
enum PasswordRecoveryAddressStatus {
verified
pending
}
enum ZimletPresence {
mandatory
enabled
disabled
}
enum ResetPasswordStatus {
enabled
disabled
suspended
}
enum PrefClientType {
advanced
modern
zimbrax
standard
}
type CsrfToken {
_content: String
}
type AuthResponse {
authToken: [AuthToken]
twoFactorAuthRequired: TwoFactorAuthRequired
trustedDevicesEnabled: TrustedDevicesEnabled
lifetime: Float
session: Session
skin: [Skin]
csrfToken: CsrfToken
}
type ScratchCodeType {
_content: String
}
type ScratchCodes {
scratchCodes: ScratchCode
}
type ScratchCode {
scratchCode: [ScratchCodeType]
}
type EnableTwoFactorAuthResponse {
secret: [Secret]
scratchCodes: [ScratchCode]
authToken: [AuthToken]
csrfToken: [CsrfToken]
}
type ProfileImageChangeResponse {
itemId: ID
}
type Secret {
_content: String
}
type AuthToken {
_content: String
}
type TwoFactorAuthRequired {
_content: Boolean
}
type TrustedDevicesEnabled {
_content: Boolean
}
type Session {
id: ID
_content: String
}
type Skin {
_content: String
}
type CalOrganizer {
address: String
name: String
url: String
sentBy: String
}
type Instance {
start: Float
dueDate: Float
tzoDue: Int
utcRecurrenceId: String
isException: Boolean # ex
alarm: Boolean
allDay: Boolean
changeDate: Float # md
class: CalendarItemClass
componentNum: Int # compNum
date: Float # d
duration: Float # dur
excerpt: String # fr
flags: String # f
freeBusy: FreeBusyStatus # fb
freeBusyActual: FreeBusyStatus # fba
inviteId: ID #invId
location: String # loc
modifiedSequence: Int # ms
name: String
organizer: CalOrganizer # or
otherAttendees: Boolean
participationStatus: ParticipationStatus
revision: Float # rev
status: InviteCompletionStatus
isOrganizer: Boolean # isOrg
exceptId: [DtTimeInfo]
}
type Alarm {
alarmInstStart: Float
componentNum: Int # compNum
inviteId: ID #invId
location: String # loc
name: String
nextAlarm: Float
}
type InviteReplyResponse {
inviteId: ID #invId
calendarItemId: ID #calItemId
}
type ModifyAppointmentResponse {
appointmentId: ID #appointmentId
calendarItemId: ID #calItemId
inviteId: ID #invId
modifiedSequence: Int # ms
revision: Float # rev
}
type ZimletPref {
name: String
presence: String
}
type ModifyZimletPrefsResponse {
zimlet: [ZimletPref]
}
type EmailAddress {
address: String
name: String
type: String
displayName: String
}
type ShareNotification {
truncated: Boolean
content: String
}
type MessageAttributes {
isEncrypted: Boolean
isSigned: Boolean
}
interface MailItem {
id: ID
size: Float # s
date: Float # d
folderId: ID # l
subject: String # su
emailAddresses: [EmailAddress]
excerpt: String # fr
conversationId: ID # cid
flags: String # f
tags: String # t
tagNames: String # tn
revision: Float # rev
changeDate: Float # md
modifiedSequence: Int # ms
invitations: [InviteInfo] # inv
sortField: String # sf, Sort field used for cursor-based pagination
share: [ShareNotification] # shr
replyType: String #rt
}
type ClientInfoAttributes {
zimbraWebClientLoginURL: String
zimbraWebClientLogoutURL: String
}
type ClientInfoType {
attributes: ClientInfoAttributes
}
type MessageInfo implements MailItem {
id: ID
size: Float # s
date: Float # d
folderId: ID # l
origId: ID #origid
subject: String # su
emailAddresses: [EmailAddress]
excerpt: String # fr
conversationId: ID # cid
flags: String # f
tags: String # t
tagNames: String # tn
revision: Float # rev
changeDate: Float # md
modifiedSequence: Int # ms
invitations: [InviteInfo] # inv
sortField: String # sf, Sort field used for cursor-based pagination
mimeParts: [MimePart]
to: [EmailAddress]
from: [EmailAddress]
cc: [EmailAddress]
bcc: [EmailAddress]
sender: [EmailAddress]
html: String
text: String
attachments: [MimePart]
inlineAttachments: [MimePart]
share: [ShareNotification] # shr
replyType: String #rt
attributes: MessageAttributes
autoSendTime: Float
local: Boolean
}
type Conversation implements MailItem {
id: ID
size: Float # s
date: Float # d
folderId: ID # l
subject: String # su
excerpt: String # fr
emailAddresses: [EmailAddress]
conversationId: ID # cid
flags: String # f
tags: String # t
tagNames: String # tn
revision: Float # rev
changeDate: Float # md
modifiedSequence: Int # ms
invitations: [InviteInfo] # inv
sortField: String # sf, Sort field used for cursor-based pagination
messages: [MessageInfo]
messagesMetaData: [MessageInfo]
numMessages: Int # n, Number of messages in this conversation
unread: Int # u
share: [ShareNotification] # shr
replyType: String #rt
}
type MsgWithGroupInfo implements MailItem {
id: ID
i4uid: Int
cif: String
origid: String
entityId: ID # idnt
forAcct: String
autoSendTime: Float
size: Float # s
date: Float # d
folderId: ID # l
subject: String # su
emailAddresses: [EmailAddress]
excerpt: String # fr
conversationId: ID # cid
flags: String # f
tags: String # t
tagNames: String # tn
revision: Float # rev
changeDate: Float # md
modifiedSequence: Int # ms
invitations: [InviteInfo] # inv
sortField: String # sf, Sort field used for cursor-based pagination
share: [ShareNotification] # shr
replyType: String #rt
}
enum InviteType {
appt # Appointment
task
}
type InviteInfo {
type: InviteType #though type is a required value on the response, outdated invites come back as empty InviteInfo objects
components: [InviteComponent] #comp
replies: [InviteReplies] #replies
}
type AddRecurrenceInfo { # <add>
add: [AddRecurrenceInfo]
exclude: [ExcludeRecurrenceInfo]
except: [ExceptionRuleInfo]
cancel: [CancelRuleInfo]
# dates: SingleDates # TODO
rule: [SimpleRepeatingRule]
}
type ExcludeRecurrenceInfo { # <exclude>
exclude: [ExcludeRecurrenceInfo]
except: [ExceptionRuleInfo]
}
type ExceptionRuleInfo { # <except>
rangeType: Int
recurId: String
tz: String
ridZ: String
add: [AddRecurrenceInfo]
exclude: [ExcludeRecurrenceInfo]
}
type CancelRuleInfo { # <cancel>
rangeType: Int
recurId: String
tz: String
ridZ: String
}
# type SingleDates { # <dates>
# }
type WkDay { # <wkday>
day: Weekday
ordwk: Int
}
type ByDayRule { # <byday>
wkday: [WkDay]
}
type IntervalRule { # <interval>
intervalCount: Int # ival
}
type CalendarItemRecurrenceEndDate {
date: String
}
type CalendarItemRecurrenceEndCount {
number: Int
}
type ByMonthDayRule {
dayList: String
}
type ByMonthRule {
monthList: Int
}
type BySetPosRule {
poslist: Int
}
type SimpleRepeatingRule { # <rule>
frequency: CalendarItemRecurrenceFrequency # freq
interval: [IntervalRule]
byday: [ByDayRule]
until: [CalendarItemRecurrenceEndDate]
count: [CalendarItemRecurrenceEndCount]
bymonthday: [ByMonthDayRule]
bymonth: [ByMonthRule]
bysetpos: [BySetPosRule]
}
type RecurrenceInfo { # <recur>
add: [AddRecurrenceInfo]
exclude: [ExcludeRecurrenceInfo]
except: [ExceptionRuleInfo]
cancel: [CancelRuleInfo]
# dates: [SingleDates] # TODO
rule: [SimpleRepeatingRule]
}
type InviteReplies {
reply: [CalendarItemReply]
}
type InviteComponent {
# duration: DurationInfo # dur - TODO
alarms: [CalendarItemAlarm]
recurrence: [RecurrenceInfo] # recur
allDay: Boolean
attendees: [CalendarItemAttendee]
calendarItemId: ID
ciFolder: ID
class: CalendarItemClass
completedDateTime: String # completed , yyyyMMddThhmmssZ
componentNum: Int # compNum
date: Float # d
description: [StringContent] # desc
draft: Boolean
neverSent: Boolean
end: [DtTimeInfo] # e
excerpt: String # fr
freeBusy: FreeBusyStatus # fb
freeBusyActual: FreeBusyStatus # fba
htmlDescription: [StringContent] # descHtml
isException: Boolean # ex
isOrganizer: Boolean # isOrg
location: String # loc
name: String
noBlob: Boolean
organizer: CalOrganizer # or
percentComplete: String
priority: String
utcRecurrenceId: String #ridZ
rsvp: Boolean
sequence: Int # seq
start: [DtTimeInfo] # s
status: InviteCompletionStatus
uid: String
x_uid: String
aid: String
method: String
exceptId: [DtTimeInfo]
}
type DtTimeInfo {
date: String # d , of format YYYYMMDD['T'HHMMSS[Z]]
timezone: String # tz
utc: Float # u
}
type Invitation { # <inv>
type: String!
sequenceNumber: Int! # seq
id: Int!
componentNum: Int! # compNum
recurrenceId: String # recurId
tz: CalTZInfo
components: [InviteComponent]! # comp
replies: [InviteReplies] # replies
mimeParts: MimePart
}
type CalTZInfo { # <tz>
id: String
timezoneStdOffset: Int # stdoff
timezoneDaylightOffset: Int # dayoff
stdname: String
dayname: String
standard: TzOnsetInfo
daylight: TzOnsetInfo
}
type TzOnsetInfo { # <standard>, <daylight>
week: Int
wkday: Int
mon: Int
mday: Int
hour: Int
min: Int
sec: Int
}
type AppointmentInfo { # <appt>; aka AppointmentHitInfo
id: ID!
invitations: [Invitation] # inv
}
type CalendarItemHitInfo { # <appt>; aka AppointmentHitInfo
alarm: Boolean
allDay: Boolean
changeDate: Float # md
class: CalendarItemClass!
componentNum: Int # compNum
date: Float # d
timezoneOffset: Int
duration: Float # dur
excerpt: String # fr
flags: String # f
folderId: ID! # l
freeBusy: FreeBusyStatus # fb
freeBusyActual: FreeBusyStatus # fba
id: ID!
alarmData: [Alarm]
instances: [Instance] # inst
invitations: [Invitation] # inv
inviteId: ID! #invId
isOrganizer: Boolean # isOrg
isRecurring: Boolean # recur
location: String # loc
modifiedSequence: Int # ms
name: String
organizer: CalOrganizer # or
otherAttendees: Boolean
participationStatus: ParticipationStatus
percentComplete: String
priority: String
revision: Float # rev
utcRecurrenceId: String # ridZ
size: Float # s
sortField: String # sf
status: InviteCompletionStatus
tagNames: String # tn
tags: String # t
uid: String
x_uid: String
aid: String
draft: Boolean
neverSent: Boolean
}
type ReminderItemHitInfo { # <appt>; aka AppointmentHitInfo
alarm: Boolean
allDay: Boolean
changeDate: Float # md
class: CalendarItemClass!
componentNum: Int # compNum
date: Float # d
timezoneOffset: Int
duration: Float # dur
excerpt: String # fr
flags: String # f
folderId: ID! # l
freeBusy: FreeBusyStatus # fb
freeBusyActual: FreeBusyStatus # fba
id: ID!
alarmData: [Alarm]
instances: [Instance] # inst
invitations: [Invitation] # inv
inviteId: ID! #invId
isOrganizer: Boolean # isOrg
isRecurring: Boolean # recur
location: String # loc
modifiedSequence: Int # ms
name: String
organizer: CalOrganizer # or
otherAttendees: Boolean
participationStatus: ParticipationStatus
percentComplete: String
priority: String
revision: Float # rev
utcRecurrenceId: String # ridZ
size: Float # s
sortField: String # sf
status: InviteCompletionStatus
tagNames: String # tn
tags: String # t
uid: String
x_uid: String
aid: String
draft: Boolean
neverSent: Boolean
}
type ExternalAccountTestResponse {
success: Boolean!
error: String
}
input ExternalAccount {
id: ID!
name: String!
accountType: AccountType
isEnabled: Int
host: String!
port: String!
connectionType: ConnectionType
username: String!
password: String!
}
type FreeBusyInstance {
start: Float
end: Float
}
type FreeBusy {
id: String!
tentative: [FreeBusyInstance]
busy: [FreeBusyInstance]
unavailable: [FreeBusyInstance]
nodata: [FreeBusyInstance]
free: [FreeBusyInstance]
}
type WorkingHoursInstance {
start: Float
end: Float
}
type WorkingHours {
id: ID!
tentative: [WorkingHoursInstance]
busy: [WorkingHoursInstance]
unavailable: [WorkingHoursInstance]
nodata: [WorkingHoursInstance]
free: [WorkingHoursInstance]
}
##### Filters ######
enum Importance {
high
normal
low
}
enum FilterMatchCondition {
allof
anyof
}
type AddressCondition {
header: String!
part: String!
stringComparison: String!
caseSensitive: Boolean
value: String!
valueComparison: String
countComparison: String
index: Int
negative: Boolean
}
type BasicCondition {
index: Int
negative: Boolean
}
type BodyCondition {
caseSensitive: Boolean
value: String
index: Int
negative: Boolean
}
type ConversationCondition {
where: String
index: Int
negative: Boolean
}
type DateCondition {
dateComparison: String
date: Float # d
index: Int
negative: Boolean
}
type FlagCondition {
flagName: String!
index: Int
negative: Boolean
}
type HeaderCheckCondition {
header: String!
index: Int
negative: Boolean
}
type HeaderCondition {
header: String
stringComparison: String
valueComparison: String
countComparison: String
value: String
caseSensitive: Boolean
index: Int
negative: Boolean
}
type ImportanceCondition {
importance: Importance! # imp
index: Int
negative: Boolean
}
type InviteCondition {
methods: [String]
index: Int
negative: Boolean
}
type MimeHeaderCondition {
header: String
stringComparison: String
value: String
caseSensitive: Boolean
index: Int
negative: Boolean
}
type SizeCondition {
numberComparison: String
size: String # s
index: Int
negative: Boolean
}
type FilterCondition {
allOrAny: FilterMatchCondition! # condition
addressBook: [HeaderCheckCondition] # addressBookTest
address: [AddressCondition] # addressTest
attachment: [BasicCondition] # attachmentTest
body: [BodyCondition] # bodyTest
bulk: [BasicCondition] # bulkTest
contactRanking: [HeaderCheckCondition] # contactRankingTest
conversation: [ConversationCondition] # conversationTest
date: [DateCondition] # dateTest
facebook: [BasicCondition] # facebookTest
flag: [FlagCondition] # flaggedTest
headerExists: [HeaderCheckCondition] # headerExistsTest
header: [HeaderCondition] # headerTest
importance: [ImportanceCondition] # importanceTest
invite: [InviteCondition] # inviteTest
linkedin: [BasicCondition] # linkedinTest
list: [BasicCondition] # listTest
me: [HeaderCheckCondition] # meTest
mimeHeader: [MimeHeaderCondition] # mimeHeaderTest
size: [SizeCondition] # sizeTest
twitter: [BasicCondition] # twitterTest
communityRequests: [BasicCondition] # communityRequestsTest