1
<?xml version="1.0" encoding="UTF-8"?><!--
2
================================================================================
5
Copyright (c) 2005-2006 Novell, Inc. All Rights Reserved.
7
Use and redistribution of this work is subject to the developer license
8
agreement through which this work is made available. Pursuant to that license
9
agreement, Novell hereby grants You a royalty-free, non-exclusive license to
10
include Novell's sample code in Your product(s) that interoperate with the
11
applicable Novell product, and worldwide distribution rights to market,
12
distribute, or sell Novell's sample code as a component of Your product.
14
THE WORK IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
15
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
16
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL NOVELL OR THE AUTHORS
17
OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
18
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
19
OR IN CONNECTION WITH THE WORK OR THE USE OR OTHER DEALINGS IN THE WORK.
22
Alternatively, the contents of this file may be used under the terms of
23
GNU General Public License Version 2 (the "GPL") as explained below.
24
If you wish to allow use of your version of this file only under the terms
25
of the GPL, and not to allow others to use your version of this file under
26
the provisions appearing above, indicate your decision by deleting the
27
provisions above and replace them with the notice and other provisions required
28
by the GPL. If you do not delete the provisions above, a recipient may use
29
your version of this file under the above provisions of the GPL.
32
This file is free software; you can redistribute it and/or modify it under the
33
terms of version 2 of the GNU General Public License as published by the
34
Free Software Foundation. This program is distributed in the hope that it will
35
be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
36
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
37
for more details. You should have received a copy of the GNU General Public License
38
along with this program; if not, contact Novell, Inc.
40
To contact Novell about this file by physical or electronic mail, you may find
41
current contact information at www.novell.com.
42
================================================================================
43
--><xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" targetNamespace="http://schemas.novell.com/2005/01/GroupWise/methods" elementFormDefault="qualified" xmlns="http://schemas.novell.com/2005/01/GroupWise/methods" xmlns:types="http://schemas.novell.com/2005/01/GroupWise/types" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
45
<xs:import namespace="http://schemas.novell.com/2005/01/GroupWise/types" schemaLocation="types.xsd"/>
47
<xs:element name="acceptRequest">
50
<xs:element name="items" type="types:ItemRefList"/>
51
<xs:element name="comment" type="xs:string" nillable="1"/>
52
<xs:element name="acceptLevel" type="types:AcceptLevel" nillable="1"/>
53
<xs:element name="recurrenceAllInstances" type="xs:unsignedInt" default="0" minOccurs="0"/>
57
<xs:element name="acceptResponse">
60
<xs:element name="status" type="types:Status"/>
64
<xs:element name="acceptShareRequest">
67
If name is not present, the original name value from the
68
notification message will be used.
69
A container is requied for accepting a shared folder notification.
70
It is the container id of the parent folder under which the new
71
folder will be placed.
72
If container is not present, the shared folder will be put
73
under the Cabinet folder.
78
<xs:element name="id" type="types:uid"/>
79
<xs:element name="name" type="xs:string" minOccurs="0"/>
80
<xs:element name="container" type="types:uid" minOccurs="0"/>
81
<xs:element ref="types:description" minOccurs="0"/>
85
<xs:element name="acceptShareResponse">
88
<xs:element name="id" type="types:uid" minOccurs="0"/>
89
<xs:element name="status" type="types:Status"/>
93
<xs:element name="addItemRequest">
96
<xs:element name="container" type="types:uid"/>
97
<xs:element name="id" type="types:uid"/>
101
<xs:element name="addItemResponse">
104
<xs:element name="status" type="types:Status"/>
108
<xs:element name="addItemsRequest">
111
<xs:element name="container" type="types:uid"/>
112
<xs:element name="items" type="types:ItemRefList"/>
116
<xs:element name="addItemsResponse">
119
<xs:element name="status" type="types:Status"/>
123
<xs:element name="addMembersRequest">
126
<xs:element name="container" type="types:uid"/>
127
<xs:element name="members" type="types:GroupMemberList"/>
131
<xs:element name="addMembersResponse">
134
<xs:element name="status" type="types:Status"/>
138
<xs:element name="closeFreeBusySessionRequest">
141
<xs:element name="freeBusySessionId" type="xs:int"/>
145
<xs:element name="closeFreeBusySessionResponse">
148
<xs:element name="status" type="types:Status"/>
152
<xs:element name="completeRequest">
155
<xs:element name="items" type="types:ItemRefList"/>
159
<xs:element name="completeResponse">
162
<xs:element name="status" type="types:Status"/>
166
<xs:element name="createCursorRequest">
169
<xs:element name="container" type="types:uid"/>
170
<xs:element name="view" type="types:View" minOccurs="0"/>
171
<xs:element name="filter" type="types:Filter" minOccurs="0"/>
175
<xs:element name="createCursorResponse">
178
<xs:element name="cursor" type="xs:int" minOccurs="0"/>
179
<xs:element name="status" type="types:Status"/>
183
<xs:element name="createItemRequest">
186
<xs:element name="item" type="types:Item"/>
187
<xs:element name="notification" type="types:SharedFolderNotification" minOccurs="0"/>
191
<xs:element name="createItemResponse">
194
<xs:element name="id" type="types:uid" minOccurs="0" maxOccurs="unbounded"/>
195
<xs:element name="status" type="types:Status"/>
199
<xs:element name="createItemsRequest">
202
<xs:element name="item" type="types:Item" maxOccurs="unbounded"/>
206
<xs:element name="createItemsResponse">
209
<xs:element name="id" type="types:uid" minOccurs="0" maxOccurs="unbounded"/>
210
<xs:element name="status" type="types:Status"/>
214
<xs:element name="createJunkEntryRequest">
217
<xs:element name="entry" type="types:JunkEntry"/>
221
<xs:element name="createJunkEntryResponse">
224
<xs:element name="id" type="types:uid" minOccurs="0"/>
225
<xs:element name="status" type="types:Status"/>
229
<xs:element name="createProxyAccessRequest">
232
<xs:element name="entry" type="types:AccessRightEntry"/>
236
<xs:element name="createProxyAccessResponse">
239
<xs:element name="id" type="types:uid" minOccurs="0"/>
240
<xs:element name="status" type="types:Status"/>
244
<xs:element name="createSignatureRequest">
247
<xs:element name="signature" type="types:Signature"/>
251
<xs:element name="createSignatureResponse">
254
<xs:element name="status" type="types:Status"/>
258
<xs:element name="declineRequest">
261
<xs:element name="items" type="types:ItemRefList"/>
262
<xs:element name="comment" type="xs:string" nillable="1"/>
263
<xs:element name="recurrenceAllInstances" type="xs:unsignedInt" default="0" minOccurs="0"/>
267
<xs:element name="declineResponse">
270
<xs:element name="status" type="types:Status"/>
274
<xs:element name="delegateRequest">
277
<xs:element name="id" type="types:uid"/>
278
<xs:element name="commentToOrganizer" type="xs:string" nillable="1"/>
279
<xs:element name="commentToDelegatee" type="xs:string" nillable="1"/>
280
<xs:element name="distribution" type="types:Distribution"/>
281
<xs:element name="recurrenceAllInstances" type="xs:unsignedInt" default="0" minOccurs="0"/>
285
<xs:element name="delegateResponse">
288
<xs:element name="status" type="types:Status"/>
292
<xs:element name="destroyCursorRequest">
295
<xs:element name="container" type="types:uid"/>
296
<xs:element name="cursor" type="xs:int"/>
300
<xs:element name="destroyCursorResponse">
303
<xs:element name="status" type="types:Status"/>
307
<xs:element name="executeRuleRequest">
310
<xs:element name="id" type="types:uid"/>
314
<xs:element name="executeRuleResponse">
317
<xs:element name="status" type="types:Status"/>
321
<xs:element name="forwardRequest">
324
Forwarding a message is a two step process.
325
First you call the method with the id of the original item.
326
A new mail item is returned.
327
It has the orignal subject.
328
The caller is responsible to prepend "Fwd:" or what ever they
329
want to modify the original subject.
330
If the caller wants the original message body returned, they need
331
to supply message or message/RTF in the view.
332
It is up to the caller to modify the message body in any way.
333
When all of the changes to the returned mail item are complete,
334
the caller would then call sendRequest with the new mail item.
335
A linkInfo element is return in the mail item. That element needs
336
to be passed unchanged in the sendRequest.
337
If the caller wants to send the original item as an attachment to
338
the new mail item, the caller would pass the 'embed' element in the
344
<xs:element name="id" type="types:uid"/>
345
<xs:element name="view" type="types:View" nillable="1"/>
346
<xs:element name="embed" type="xs:boolean" default="0"/>
350
<xs:element name="forwardResponse">
353
<xs:element name="item" type="types:Item" minOccurs="0"/>
354
<xs:element name="status" type="types:Status"/>
358
<xs:element name="getAddressBookListRequest">
361
<xs:element name="getAddressBookListResponse">
364
<xs:element name="books" type="types:AddressBookList" minOccurs="0"/>
365
<xs:element name="status" type="types:Status"/>
369
<xs:element name="getAttachmentRequest">
372
This work only for file attachments.
373
If you try to specify an embedded item, you will get an error.
374
If you specify offset = 0 and length = -1,
375
you will receive the whole attachment.
376
You can supply other values for offset and length to receive
377
a part of the attachment.
382
<xs:element name="id" type="types:uid"/>
383
<xs:element name="offset" type="xs:int"/>
384
<xs:element name="length" type="xs:int"/>
388
<xs:element name="getAttachmentResponse">
391
<xs:element name="part" type="types:MessagePart" minOccurs="0"/>
392
<xs:element name="status" type="types:Status"/>
396
<xs:element name="getCategoryListRequest">
399
<xs:element name="getCategoryListResponse">
402
<xs:element name="categories" type="types:CategoryList" minOccurs="0"/>
403
<xs:element name="status" type="types:Status"/>
407
<xs:element name="getCustomListRequest">
410
<xs:element name="getCustomListResponse">
413
<xs:element name="customs" type="types:CustomList" minOccurs="0"/>
414
<xs:element name="status" type="types:Status"/>
418
<xs:element name="getDeltasRequest">
423
container: The only valid container at this time is the GroupWise System Address book uid.
424
view: This is the view for the items that are returned.
427
<xs:element name="container" type="types:uid"/>
428
<xs:element name="view" type="types:View" nillable="1"/>
429
<xs:element name="deltaInfo" type="types:DeltaInfo"/>
433
<xs:element name="getDeltasResponse">
436
<xs:element name="items" type="types:Items" minOccurs="0"/>
437
<xs:element name="deltaInfo" type="types:DeltaInfo"/>
438
<xs:element name="status" type="types:Status"/>
442
<xs:element name="getDeltaInfoRequest">
447
The only valid container at this time is the GroupWise System Address book uid.
450
<xs:element name="container" type="types:uid"/>
454
<xs:element name="getDeltaInfoResponse">
457
<xs:element name="deltaInfo" type="types:DeltaInfo"/>
458
<xs:element name="status" type="types:Status"/>
462
<xs:element name="getDocumentTypeListRequest">
465
<xs:element name="library" type="types:uid"/>
469
<xs:element name="getDocumentTypeListResponse">
472
<xs:element name="items" type="types:DocumentTypeList" minOccurs="0"/>
473
<xs:element name="status" type="types:Status"/>
477
<xs:element name="getFolderRequest">
480
<xs:element name="id" type="types:uid" minOccurs="0"/>
481
<xs:element name="folderType" type="types:FolderType" minOccurs="0"/>
482
<xs:element name="types" type="types:MessageTypeList" minOccurs="0"/>
483
<xs:element name="source" type="types:ItemSourceList" minOccurs="0"/>
484
<xs:element name="view" type="types:View" nillable="1"/>
488
<xs:element name="getFolderResponse">
491
<xs:element name="folder" type="types:Folder" minOccurs="0"/>
492
<xs:element name="status" type="types:Status"/>
496
<xs:element name="getFolderListRequest">
499
<xs:element name="parent" type="types:uid"/>
500
<xs:element name="view" type="types:View" nillable="1"/>
501
<xs:element name="recurse" type="xs:boolean"/>
502
<xs:element name="imap" type="xs:boolean" default="0"/>
503
<xs:element name="nntp" type="xs:boolean" default="0"/>
507
<xs:element name="getFolderListResponse">
510
<xs:element name="folders" type="types:FolderList" minOccurs="0"/>
511
<xs:element name="status" type="types:Status"/>
515
<xs:element name="getFreeBusyRequest">
518
<xs:element name="freeBusySessionId" type="xs:string"/>
522
<xs:element name="getFreeBusyResponse">
525
<xs:element name="freeBusyStats" type="types:FreeBusyStats" minOccurs="0"/>
526
<xs:element name="freeBusyInfo" type="types:FreeBusyInfoList" minOccurs="0"/>
527
<xs:element name="status" type="types:Status"/>
531
<xs:element name="getItemRequest">
534
<xs:element name="id" type="types:uid"/>
535
<xs:element name="view" type="types:View" nillable="1"/>
539
<xs:element name="getItemResponse">
542
<xs:element name="item" type="types:Item" minOccurs="0"/>
543
<xs:element name="status" type="types:Status"/>
547
<xs:element name="getItemsRequest">
550
<xs:element name="container" type="types:uid" minOccurs="0"/>
551
<xs:element name="view" type="types:View" nillable="1"/>
552
<xs:element name="filter" type="types:Filter" nillable="1"/>
553
<xs:element name="items" type="types:ItemRefList" minOccurs="0" maxOccurs="1"/>
554
<xs:element name="count" type="xs:int" default="-1"/>
558
<xs:element name="getItemsResponse">
561
<xs:element name="items" type="types:Items" minOccurs="0"/>
562
<xs:element name="status" type="types:Status"/>
566
<xs:element name="getJunkEntriesRequest">
569
<xs:element name="container" type="types:JunkHandlingListType" minOccurs="0"/>
573
<xs:element name="getJunkEntriesResponse">
576
<xs:element name="junk" type="types:JunkHandlingList" minOccurs="0"/>
577
<xs:element name="block" type="types:JunkHandlingList" minOccurs="0"/>
578
<xs:element name="trust" type="types:JunkHandlingList" minOccurs="0"/>
579
<xs:element name="status" type="types:Status"/>
583
<xs:element name="getJunkMailSettingsRequest">
586
<xs:element name="getJunkMailSettingsResponse">
589
<xs:element name="settings" type="types:SettingsList" minOccurs="0"/>
590
<xs:element name="status" type="types:Status"/>
594
<xs:element name="getLibraryItemRequest">
597
This method will get a library, document or version object
598
depending on the arguments passed in.
599
versionNumber is a string.
600
It can take "current", "official" or a specific version number.
601
To get a version object, you must also supply a document number.
606
<xs:element name="library" type="types:uid"/>
607
<xs:element name="documentNumber" type="xs:unsignedInt" minOccurs="0"/>
608
<xs:element name="versionNumber" type="xs:string" minOccurs="0"/>
612
<xs:element name="getLibraryItemResponse">
615
<xs:element name="item" type="types:Item" minOccurs="0"/>
616
<xs:element name="status" type="types:Status"/>
620
<xs:element name="getLibraryListRequest">
623
<xs:element name="getLibraryListResponse">
626
<xs:element name="libraries" type="types:LibraryList" minOccurs="0"/>
627
<xs:element name="status" type="types:Status"/>
631
<xs:element name="getQuickMessagesRequest">
634
This method provides a quicker access to mail items.
635
It does this by only access fields that are stored in the
636
database index. The fields in the index are: id, status, modified,
637
container, message type, categories, subject, orignalSubject, and
639
The New list is the fastest access.
640
The Modified list is slower.
641
The All list is the slowest.
642
If you pass a startDate, the test is for any item that is newer
643
or equal to that date.
644
If you don't pass a container string. The query will be across
646
If you don't pass a types list, the query will be for all message
647
types unless the container is the Calendar folder. In that case
648
the default will be "CalendarItem. "CalendarItem" is a special
649
case it represents Appointment, Note and Task.
650
You can select the source types you want to see. If you don't
651
specify a source, you will get received, draft and personal.
652
If you don't specify a view, the above fields will be returned.
653
If you specify other fields than the above fields, they will not
655
You can restrict the number of items return by specifying a count.
656
All items will be returned if no count is given.
657
In the case of searching for items, the new startDate will be
658
returned for use in the next call to getQuickMessagesRequest.
659
The startDate is the time value before this read was performed.
665
<xs:element name="list" type="types:MessageList"/>
666
<xs:element ref="types:startDate" minOccurs="0"/>
667
<xs:element name="container" type="types:uid" minOccurs="0"/>
668
<xs:element name="types" type="types:MessageTypeList" minOccurs="0"/>
669
<xs:element name="source" type="types:ItemSourceList" minOccurs="0"/>
670
<xs:element name="view" type="types:View" minOccurs="0"/>
671
<xs:element name="count" type="xs:int" default="-1"/>
675
<xs:element name="getQuickMessagesResponse">
678
<xs:element ref="types:startDate" minOccurs="0"/>
679
<xs:element name="items" type="types:Items" minOccurs="0"/>
680
<xs:element name="status" type="types:Status"/>
684
<xs:element name="getProxyAccessListRequest">
687
<xs:element name="getProxyAccessListResponse">
690
<xs:element name="accessRights" type="types:AccessRightList" minOccurs="0"/>
691
<xs:element name="status" type="types:Status"/>
695
<xs:element name="getProxyListRequest">
698
<xs:element name="getProxyListResponse">
701
<xs:element name="proxies" type="types:ProxyList" minOccurs="0"/>
702
<xs:element name="status" type="types:Status"/>
706
<xs:element name="getRuleListRequest">
709
<xs:element name="getRuleListResponse">
712
<xs:element name="rules" type="types:RuleList" minOccurs="0"/>
713
<xs:element name="status" type="types:Status"/>
717
<xs:element name="getSettingsRequest">
720
<xs:element name="id" type="xs:string" minOccurs="0" nillable="1"/>
724
<xs:element name="getSettingsResponse">
727
<xs:element name="settings" type="types:Settings" minOccurs="0"/>
728
<xs:element name="status" type="types:Status"/>
732
<xs:element name="getSignaturesRequest">
735
<xs:element name="global" type="xs:boolean" default="0" minOccurs="0"/>
739
<xs:element name="getSignaturesResponse">
742
<xs:element name="signatures" type="types:Signatures" minOccurs="0"/>
743
<xs:element name="status" type="types:Status"/>
747
<xs:element name="getTimestampRequest">
750
<xs:element name="backup" type="xs:boolean" minOccurs="0"/>
751
<xs:element name="retention" type="xs:boolean" minOccurs="0"/>
752
<xs:element name="noop" type="xs:boolean" minOccurs="0"/>
756
<xs:element name="getTimestampResponse">
759
<xs:element name="backup" type="xs:dateTime" minOccurs="0"/>
760
<xs:element name="retention" type="xs:dateTime" minOccurs="0"/>
761
<xs:element name="status" type="types:Status"/>
765
<xs:element name="getTimezoneListRequest">
768
<xs:element name="getTimezoneListResponse">
771
<xs:element name="timezones" type="types:TimezoneList" minOccurs="0"/>
772
<xs:element name="status" type="types:Status"/>
776
<xs:element name="getUserListRequest">
779
<xs:element name="name" type="xs:string" minOccurs="0"/>
780
<xs:element name="key" type="xs:string" minOccurs="0"/>
784
<xs:element name="getUserListResponse">
787
<xs:element name="users" type="types:UserList" minOccurs="0"/>
788
<xs:element name="status" type="types:Status"/>
792
<xs:element name="loginRequest">
795
<xs:element name="auth" type="types:Authentication"/>
796
<xs:element name="language" type="xs:language"/>
797
<xs:element name="version" type="xs:decimal"/>
798
<xs:element name="application" type="xs:string" minOccurs="0"/>
802
<xs:element name="loginResponse">
805
<xs:element name="session" type="xs:string" minOccurs="0"/>
806
<xs:element name="userinfo" type="types:UserInfo" minOccurs="0"/>
807
<xs:element name="entry" type="types:AccessRightEntry" minOccurs="0"/>
808
<xs:element name="gwVersion" type="xs:string" minOccurs="0"/>
809
<xs:element name="build" type="xs:string" minOccurs="0"/>
810
<xs:element name="redirectToHost" type="types:Host" minOccurs="0" maxOccurs="unbounded"/>
811
<xs:element name="serverUTCTime" type="xs:dateTime" minOccurs="0"/>
812
<xs:element name="status" type="types:Status"/>
816
<xs:element name="logoutRequest">
819
<xs:element name="logoutResponse">
822
<xs:element name="status" type="types:Status"/>
826
<xs:element name="markPrivateRequest">
829
<xs:element name="items" type="types:ItemRefList"/>
833
<xs:element name="markPrivateResponse">
836
<xs:element name="status" type="types:Status"/>
840
<xs:element name="markReadRequest">
843
<xs:element name="items" type="types:ItemRefList"/>
847
<xs:element name="markReadResponse">
850
<xs:element name="status" type="types:Status"/>
854
<xs:element name="markUnPrivateRequest">
857
<xs:element name="items" type="types:ItemRefList"/>
861
<xs:element name="markUnPrivateResponse">
864
<xs:element name="status" type="types:Status"/>
868
<xs:element name="markUnReadRequest">
871
<xs:element name="items" type="types:ItemRefList"/>
875
<xs:element name="markUnReadResponse">
878
<xs:element name="status" type="types:Status"/>
882
<xs:element name="modifyItemRequest">
885
<xs:element name="id" type="types:uid"/>
886
<xs:element name="notification" type="types:SharedFolderNotification" minOccurs="0"/>
887
<xs:element name="updates" type="types:ItemChanges"/>
888
<xs:element name="recurrenceAllInstances" type="xs:unsignedInt" default="0" minOccurs="0"/>
892
<xs:element name="modifyItemResponse">
895
<xs:element ref="types:modified" minOccurs="0"/>
896
<xs:element name="id" type="types:uid" minOccurs="0" maxOccurs="unbounded"/>
897
<xs:element name="status" type="types:Status"/>
901
<xs:element name="modifyItemsRequest">
904
<xs:element name="item" type="types:ModifyItem" maxOccurs="unbounded"/>
908
<xs:element name="modifyItemsResponse">
911
<xs:element ref="types:modified" minOccurs="0" maxOccurs="unbounded"/>
912
<xs:element name="id" type="types:uid" minOccurs="0" maxOccurs="unbounded"/>
913
<xs:element name="status" type="types:Status"/>
917
<xs:element name="modifyJunkEntryRequest">
920
<xs:element name="entry" type="types:JunkEntry"/>
924
<xs:element name="modifyJunkEntryResponse">
927
<xs:element name="status" type="types:Status"/>
931
<xs:element name="modifyJunkMailSettingsRequest">
934
<xs:element name="settings" type="types:SettingsList"/>
938
<xs:element name="modifyJunkMailSettingsResponse">
941
<xs:element name="status" type="types:Status"/>
945
<xs:element name="modifyPasswordRequest">
948
<xs:element name="old" type="xs:string" minOccurs="0"/>
949
<xs:element name="new" type="xs:string" minOccurs="0"/>
953
<xs:element name="modifyPasswordResponse">
956
<xs:element name="status" type="types:Status"/>
960
<xs:element name="modifyProxyAccessRequest">
963
<xs:element name="id" type="types:uid"/>
964
<xs:element name="updates" type="types:AccessRightChanges"/>
968
<xs:element name="modifyProxyAccessResponse">
971
<xs:element name="status" type="types:Status"/>
975
<xs:element name="modifySettingsRequest">
978
<xs:element name="settings" type="types:SettingsList"/>
982
<xs:element name="modifySettingsResponse">
985
<xs:element name="status" type="types:Status"/>
989
<xs:element name="modifySignaturesRequest">
992
<xs:element name="updates" type="types:Signatures"/>
996
<xs:element name="modifySignaturesResponse">
999
<xs:element name="status" type="types:Status"/>
1003
<xs:element name="moveItemRequest">
1006
This method will link (copy) or move items into the container.
1007
To do a link (copy) do not supply a from container.
1008
To move item(s) from one container to another supply the from
1014
<xs:element name="id" type="types:uid"/>
1015
<xs:element name="container" type="types:uid"/>
1016
<xs:element name="from" type="types:uid" minOccurs="0"/>
1020
<xs:element name="moveItemResponse">
1023
<xs:element name="status" type="types:Status"/>
1027
<xs:element name="positionCursorRequest">
1030
<xs:element name="container" type="types:uid"/>
1031
<xs:element name="cursor" type="xs:int"/>
1032
<xs:element name="seek" type="types:CursorSeek"/>
1033
<xs:element name="offset" type="xs:int"/>
1037
<xs:element name="positionCursorResponse">
1040
<xs:element name="status" type="types:Status"/>
1044
<xs:element name="purgeDeletedItemsRequest">
1047
This method permanently deletes all items that were previously
1048
marked for deletion (i.e. stored in the "Trash").
1055
<xs:element name="purgeDeletedItemsResponse">
1058
<xs:element name="status" type="types:Status"/>
1062
<xs:element name="purgeRequest">
1065
<xs:element name="items" type="types:ItemRefList"/>
1069
<xs:element name="purgeResponse">
1072
<xs:element name="status" type="types:Status"/>
1076
<xs:element name="readCursorRequest">
1079
If "start" or "end" is passed in "position", the value for "forward"
1081
"start" will read from the start of the database going forward.
1082
"end" will read from the end of the database going backward.
1083
If you are making multiple calls to readCursorRequest, "position"
1084
should either be "current" or not present after the first call.
1089
<xs:element name="container" type="types:uid"/>
1090
<xs:element name="cursor" type="xs:int"/>
1091
<xs:element name="forward" type="xs:boolean" default="1"/>
1092
<xs:element name="position" type="types:CursorSeek" nillable="1" default="current"/>
1093
<xs:element name="count" type="xs:int" nillable="1" default="0"/>
1097
<xs:element name="readCursorResponse">
1100
<xs:element name="items" type="types:ItemList" minOccurs="0"/>
1101
<xs:element name="status" type="types:Status"/>
1105
<xs:element name="removeCustomDefinitionRequest">
1108
This method remove the custom field defintion not the field and
1109
values within an item.
1110
To delete custom defintions from personal address book entries, set
1111
books = "1", else the definition will be deleted from mail items.
1112
This method can take a long time to execute.
1113
You can set doAsynchronous to have the custom field definition
1114
removed in the background.
1119
<xs:element name="customs" type="types:CustomList" minOccurs="0"/>
1120
<xs:element name="books" type="xs:boolean" default="0"/>
1121
<xs:element name="doAsynchronous" type="xs:boolean" default="0"/>
1125
<xs:element name="removeCustomDefinitionResponse">
1128
<xs:element name="status" type="types:Status"/>
1132
<xs:element name="removeItemRequest">
1135
If the container is not specified then the item is
1136
removed from all of the containers that it is linked
1137
to and is stored in the "Trash".
1138
If the container is specified then the item is only
1139
removed from that specific container and it's link
1140
is stored in the "Trash".
1145
<xs:element name="container" type="types:uid" nillable="1"/>
1146
<xs:element name="id" type="types:uid"/>
1150
<xs:element name="removeItemResponse">
1153
<xs:element name="status" type="types:Status"/>
1157
<xs:element name="removeItemsRequest">
1160
<xs:element name="container" type="types:uid"/>
1161
<xs:element name="items" type="types:ItemRefList"/>
1165
<xs:element name="removeItemsResponse">
1168
<xs:element name="status" type="types:Status"/>
1172
<xs:element name="removeJunkEntryRequest">
1175
<xs:element name="id" type="types:uid"/>
1179
<xs:element name="removeJunkEntryResponse">
1182
<xs:element name="status" type="types:Status"/>
1186
<xs:element name="removeMembersRequest">
1189
<xs:element name="container" type="types:uid"/>
1190
<xs:element name="members" type="types:GroupMemberList"/>
1194
<xs:element name="removeMembersResponse">
1197
<xs:element name="status" type="types:Status"/>
1201
<xs:element name="removeProxyAccessRequest">
1204
<xs:element name="id" type="types:uid"/>
1208
<xs:element name="removeProxyAccessResponse">
1211
<xs:element name="status" type="types:Status"/>
1216
<xs:element name="removeProxyUserRequest">
1219
<xs:element name="id" type="types:uid"/>
1223
<xs:element name="removeProxyUserResponse">
1226
<xs:element name="status" type="types:Status"/>
1231
<xs:element name="removeSignatureRequest">
1234
The signature will be purged when remove
1235
request completed. The missing id node
1236
when it is not delete all signatures
1237
indicates the removing of plain text signature
1238
which resides in user's settings record.
1243
<xs:element name="id" type="types:uid" minOccurs="0"/>
1244
<xs:element name="all" type="xs:boolean" minOccurs="0"/>
1245
<xs:element name="global" type="xs:boolean" default="0" minOccurs="0"/>
1249
<xs:element name="removeSignatureResponse">
1252
<xs:element name="status" type="types:Status"/>
1256
<xs:element name="replyRequest">
1259
Replying to a message is a two step process.
1260
First you call the method with the id of the original item.
1261
A new mail item is returned.
1262
It has the orignal subject.
1263
The caller is responsible to prepend "Re:" or what ever they
1264
want to modify the original subject.
1265
If the caller wants the original message body returned, they need
1266
to supply message or message/RTF in the view.
1267
It is up to the caller to modify the message body in any way.
1268
When all of the changes to the returned mail item are complete,
1269
the caller would then call sendRequest with the new mail item.
1270
If the caller wants to reply to all recipeints of the original
1271
item, the caller needs to pass recipients in the view.
1272
If recipients is not in the view, the response will be addressed
1273
to the original sender.
1274
A linkInfo element is return in the mail item. That element needs
1275
to be passed unchanged in the sendRequest.
1280
<xs:element name="id" type="types:uid"/>
1281
<xs:element name="view" type="types:View" nillable="1"/>
1285
<xs:element name="replyResponse">
1288
<xs:element name="item" type="types:Item" minOccurs="0"/>
1289
<xs:element name="status" type="types:Status"/>
1293
<xs:element name="retractRequest">
1296
If a recipient has opened or accepted a Calendar item, a notice
1297
will be placed in the recipient's in-box when the item is
1298
retracted. The notice can be affected by the following options:
1300
"comment": The comment will be included in the notice.
1301
"retractCausedByResend": When TRUE, the notice will be suppressed
1302
in lieu of the 'new' calendar item that will be delivered to
1304
"retractingAllInstances": When TRUE, a single notice will be
1305
placed in the recipient's in-box (instead of a notice for each auto-date
1308
If no retractType is specified, the default is recipientMailboxes.
1313
<xs:element name="items" type="types:ItemRefList"/>
1314
<xs:element name="comment" type="xs:string" minOccurs="0" nillable="1"/>
1315
<xs:element name="retractingAllInstances" type="xs:boolean" minOccurs="0" default="0"/>
1316
<xs:element name="retractCausedByResend" type="xs:boolean" minOccurs="0" default="0"/>
1317
<xs:element name="retractType" type="types:RetractType" minOccurs="0"/>
1321
<xs:element name="retractResponse">
1324
<xs:element name="status" type="types:Status"/>
1328
<xs:element name="sendItemRequest">
1331
<xs:element name="item" type="types:Item"/>
1335
<xs:element name="sendItemResponse">
1338
<xs:element name="id" type="types:uid" minOccurs="0" maxOccurs="unbounded"/>
1339
<xs:element name="status" type="types:Status"/>
1343
<xs:element name="setTimestampRequest">
1346
<xs:element name="backup" type="xs:dateTime" minOccurs="0"/>
1347
<xs:element name="retention" type="xs:dateTime" minOccurs="0"/>
1351
<xs:element name="setTimestampResponse">
1354
<xs:element name="status" type="types:Status"/>
1358
<xs:element name="startFreeBusySessionRequest">
1361
<xs:element name="users" type="types:FreeBusyUserList"/>
1362
<xs:element name="startDate" type="xs:dateTime"/>
1363
<xs:element name="endDate" type="xs:dateTime"/>
1367
<xs:element name="startFreeBusySessionResponse">
1370
<xs:element name="freeBusySessionId" type="xs:int" minOccurs="0"/>
1371
<xs:element name="status" type="types:Status"/>
1375
<xs:element name="unacceptRequest">
1378
<xs:element name="items" type="types:ItemRefList"/>
1382
<xs:element name="unacceptResponse">
1385
<xs:element name="status" type="types:Status"/>
1389
<xs:element name="uncompleteRequest">
1392
<xs:element name="items" type="types:ItemRefList"/>
1396
<xs:element name="uncompleteResponse">
1399
<xs:element name="status" type="types:Status"/>
1403
<xs:element name="updateVersionStatusRequest">
1406
The only version event types support are:
1415
<xs:element name="id" type="types:uid"/>
1416
<xs:element name="event" type="types:VersionEventType"/>
1417
<xs:element name="part" type="types:SignatureData" minOccurs="0"/>
1421
<xs:element name="updateVersionStatusResponse">
1424
<xs:element name="part" type="types:SignatureData" minOccurs="0"/>
1425
<xs:element name="status" type="types:Status"/>
b'\\ No newline at end of file'