3.1 Folders

Folder management consists of creating, deleting, and modifying all folder types, including personal, shared, IMAP, NNTP, and query folders. The following sections contain examples of events that are returned for IMAP, NNTP, and Personal folders:

3.1.1 Creating a Folder

Creating a folder creates a FolderAdd event.

<gwe:event>
   <gwe:event>FolderAdd</gwe:event>
   <gwe:id>44E06767.domain1.po1.100.16E3837.1.EED.1</gwe:id>
   <gwe:timeStamp>2012-08-14T18:07:03Z</gwe:timeStamp>
   <gwe:container>C.domain1.po1.100.0.1.0.1@21</gwe:container>
   <gwe:key>GWEvents</gwe:key>
   <gwe:uid>10286</gwe:uid>
</gwe:event>

3.1.2 Deleting a Folder

Deleting a folder creates a FolderDelete event.

<gwe:event>
   <gwe:event>FolderDelete</gwe:event>
   <gwe:id>44E06767.domain1.po1.100.16E3837.1.EED.1</gwe:id>
   <gwe:timeStamp>2012-08-14T18:12:19Z</gwe:timeStamp>
   <gwe:key>GWEvents</gwe:key>
   <gwe:uid>10288</gwe:uid>
</gwe:event>

3.1.3 Modifying a Folder

Modifying a folder name creates a FolderModify event.

<gwe:event>
   <gwe:event>FolderModify</gwe:event>
   <gwe:id>44E06767.domain1.po1.100.16E3837.1.EED.1</gwe:id>
   <gwe:timeStamp>2012-08-14T18:10:48Z</gwe:timeStamp>
   <gwe:field>Name</gwe:field>
   <gwe:key>GWEvents</gwe:key>
   <gwe:uid>10287</gwe:uid>
</gwe:event>

3.1.4 Moving a Folder

When a folder is moved, a FolderModified event is triggered. On the event, the id is the folder that is moved. The field has the keyword “Parent”.

<gwe:events>
<gwe:event>
   <gwe:event>FolderModifiy</gwe:event>
   <gwe:id>48F5F3AC.domain1.po1.100.16A6163.1.138.1</gwe:id>
   <gwe:timeStamp>2012-10-15T19:44:40Z</gwe:timeStamp>
   <gwe:field>Parent</gwe:field>
   <gwe:key>Events 1</gwe:key>
   <gwe:uid>30</gwe:uid>
</gwe:event>
</gwe:events>

3.1.5 Shared Folders

Folders can be shared with other users. The following definitions (as defined in types.xsd for shared folders) are used in the examples in this section:

  • When a user shares a folder with other users, it is referred to as isSharedByMe.

  • When a user accepts a folder shared by another user, it is referred to as isSharedToMe.

The following sections contain examples of events that are returned for shared folders:

Creating Shared Folders

When a user shares a folder with other users, you can expect the following events:

  • FolderAdd: Created for the new folder.

  • FolderItemAdd: Created for the sent item shared folder notification.

<gwe:event>
   <gwe:event>FolderAdd</gwe:event>
   <gwe:id>44E05582.domain1.po1.100.16E3837.1.EE2.1</gwe:id>
   <gwe:timeStamp>2012-08-14T16:50:42Z</gwe:timeStamp>
   <gwe:containerC.domain1.po1.100.0.1.0.1@21/gwe:container>
   <gwe:key>GWEvents</gwe:key>
   <gwe:uid>10261</gwe:uid>
</gwe:event>
<gwe:event>
   <gwe:event>FolderItemAdd</gwe:event>
   <gwe:id>44E05584.domain1.po1.100.16E3837.1.EE3.1</gwe:id>
   <gwe:timeStamp>2012-08-14T16:50:44Z</gwe:timeStamp>
   <gwe:container>7.domain1.po1.100.0.1.0.1@16</gwe:container>
   <gwe:key>GWEvents</gwe:key>
   <gwe:uid>10262</gwe:uid>
   <gwe:type>Mail</gwe:type>
</gwe:event>

Deleting Shared Folders

When a folder that was shared to others (isSharedByMe) is deleted, you can expect the following event:

<gwe:event>
   <gwe:event>FolderDelete</gwe:event>
   <gwe:id>44E05582.domain1.po1.100.16E3837.1.EE2.1</gwe:id>
   <gwe:timeStamp>2012-08-14T17:22:18Z</gwe:timeStamp>
   <gwe:key>GWEvents</gwe:key>
   <gwe:uid>10263</gwe:uid>
</gwe:event>

Modifying Shared Folders

When a folder is renamed, you can expect a FolderModify event.

<gwe:event>
   <gwe:event>FolderModify</gwe:event>
   <gwe:id>44E05D7B.domain1.po1.100.16E3837.1.EE4.1</gwe:id>
   <gwe:timeStamp>2012-08-14T17:24:59Z</gwe:timeStamp>
   <gwe:field>Name</gwe:field>
   <gwe:key>GWEvents</gwe:key>
   <gwe:uid>10266</gwe:uid>
</gwe:event>

When users are added or removed from folder sharing, a folderItemAdd event is returned for the notifications.

Sharing Folders With Others (isSharedToMe)

When a folder is shared with other users (isSharedByMe), a shared folder notification is sent to all the users that the folder was shared with (isSharedToMe). This notification appears in the mailbox folder. If your application is listening for the FolderItemAdd event types on the mailbox folder, you can expect the following event:

<gwe:event>
   <gwe:event>FolderItemAdd</gwe:event>
   <gwe:id>44E040CA.domain1.po1.100.16E3837.1.EE0.1</gwe:id>
   <gwe:timeStamp>2012-08-14T15:22:18Z</gwe:timeStamp>
   <gwe:container>7.domain1.po1.100.0.1.0.1@16</gwe:container>
   <gwe:key>GWEvents</gwe:key>
   <gwe:uid>10253</gwe:uid>
   <gwe:type>Mail</gwe:type>
</gwe:event>

Accepting a Shared Folder (isSharedToMe)

When a user accepts a shared folder notification, you can expect the following events:

  • FolderAccept: Created when the user accepts the shared folder notification.

  • FolderAdd: Created when the folder is added to the folder tree.

  • FolderItemMove: Created when the original shared folder notification is marked hidden and moved to the newly created folder.

<gwe:event>
   <gwe:event>FolderAccept</gwe:event>
   <gwe:id>44E040CA.domain1.po1.100.16E3837.1.EE0.1</gwe:id>
   <gwe:timeStamp>2012-08-14T15:41:40Z</gwe:timeStamp>
   <gwe:key>GWEvents</gwe:key>
   <gwe:uid>10255</gwe:uid>
   <gwe:type>Mail</gwe:type>
</gwe:event>
<gwe:event>
   <gwe:event>FolderAdd</gwe:event>
   <gwe:id>44E04554.domain1.po1.100.16E3837.1.EE1.1</gwe:id>
   <gwe:timeStamp>2012-08-14T15:41:40Z</gwe:timeStamp>
   <gwe:containerC.domain1.po1.100.0.1.0.1@21/gwe:container>
   <gwe:key>GWEvents</gwe:key>
   <gwe:uid>10256</gwe:uid>
</gwe:event>
<gwe:event>
   <gwe:event>FolderItemMove</gwe:event>
   <gwe:id>44E040CA.domain1.po1.100.16E3837.1.EE0.1</gwe:id>
   <gwe:timeStamp>2012-08-14T15:41:41Z</gwe:timeStamp>
   <gwe:field>Hidden</gwe:field>
   <gwe:container>44E04554.domain1.po1.100.16E3837.1.EE1.1@13<
   gwe:container>
   <gwe:from>7.domain1.po1.100.0.1.0.1@16</gwe:from>
   <gwe:key>GWEvents</gwe:key>
   <gwe:uid>10257</gwe:uid>
   <gwe:type>Mail</gwe:type>
</gwe:event>

Deleting Shared Folders

When a user deletes an isSharedToMe folder, you can expect the following events:

  • ItemPurge: The original shared folder notification that was moved to the shared folder and marked hidden.

  • FolderDelete: The folder being deleted.

<gwe:event>
   <gwe:event>ItemPurge</gwe:event>
   <gwe:id>44E040CA.domain1.po1.100.16E3837.1.EE0.1</gwe:id>
   <gwe:timeStamp>2012-08-14T16:31:06Z</gwe:timeStamp>
   <gwe:key>GWEvents</gwe:key>
   <gwe:uid>10259</gwe:uid>
   <gwe:type>Mail</gwe:type>
</gwe:event>
<gwe:event>
   <gwe:event>FolderDelete</gwe:event>
   <gwe:id>44E04554.domain1.po1.100.16E3837.1.EE1.1</gwe:id>
   <gwe:timeStamp>2012-08-14T16:31:06Z</gwe:timeStamp>
   <gwe:key>GWEvents</gwe:key>
   <gwe:uid>10260</gwe:uid>
</gwe:event>

Modifying Shared Folders

When a folder is renamed, you can expect a FolderModify event.

<gwe:event>
   <gwe:event>FolderModify</gwe:event>
   <gwe:id>44E05D7B.domain1.po1.100.16E3837.1.EE4.1</gwe:id>
   <gwe:timeStamp>2012-08-14T17:24:59Z</gwe:timeStamp>
   <gwe:field>Name</gwe:field>
   <gwe:key>GWEvents</gwe:key>
   <gwe:uid>10266</gwe:uid>
</gwe:event>