FOLDERS: Outlook Folders |
Catalog: Outlook
Schema: General
Primary Keys: EntryID
Label: Folders
Documentation:
Outlook folders.
This is a read-only table function. The Outlook API may not support changing the data or the Invantive UniversalSQL driver for Outlook does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Outlook API.
Parameters of Table Function
The following parameters can be used to control the behaviour of the table function FOLDERS. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values.
Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.
Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.
Name |
Data Type |
Required |
Default Value |
Documentation |
---|---|---|---|---|
ignoreComException |
boolean |
☐ |
False |
Whether to ignore COM exception during retrieval of data. |
includeDefaultFolders |
boolean |
☐ |
True |
Whether to include default folders of the current user. |
includeExternalStores |
boolean |
☐ |
False |
Whether to include external stores available to the session besides the current user. |
includeSharedFolders |
boolean |
☐ |
False |
Whether to include shared folders available to the session besides the current user. |
Columns of Table Function
The columns of the table function FOLDERS are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
---|---|---|---|---|
AddressBookName |
string(240) |
|
☐ |
|
Class |
string |
|
☑ |
|
DefaultMessageClass |
string |
|
☑ |
|
Description |
string |
|
☐ |
|
DisplayName |
string(240) |
|
☐ |
|
EntryID |
string(1024) |
|
☑ |
|
FolderPath |
string(240) |
|
☑ |
|
GroupName |
string(240) |
|
☐ |
|
GroupPosition |
int32 |
|
☐ |
|
IsSharepointFolder |
boolean |
|
☑ |
|
Label |
string(240) |
|
☑ |
|
Name |
string |
|
☑ |
|
Position |
int32 |
|
☐ |
|
SourceName |
string |
|
☑ |
|
SourceType |
string(30) |
|
☑ |
|
StoreID |
string(1024) |
|
☑ |
|
UnReadItemCount |
int32 |
|
☑ |
|
WebViewURL |
string(240) |
|
☐ |
|
30-05-2024 10:38 Version 24.1.3-BETA+4689