Get Mail Folders
Name
get_mailfolders
Description
Get the list of mail folders for the specified user Id. [API reference]
Parameters
| Parameter | Label | Required | Options | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| UserId | User ID or Email | YES | The Microsoft Mail user ID GUID or email address for the account to read messages from. (Examples: '4ff54a77-9c09-4274-958f-83bdc0a53900' or 'first.last@domain.com') | |||||||||||
| OrderBy | Order By | NO |
|
Order the specified column by ascending or descending order [API reference] | ||||||||||
| SearchCriteria | Search Criteria | NO |
|
Data filter (e.g. somecolumn -eq 'somevalue') [API reference] | ||||||||||
| PageSize | Page Size | NO | The number of records to include in each page of results [API reference] | |||||||||||
| SelectedColumns | Selected Columns | NO | Select the individual columns to be included in the response, to reduce the response size and increase performance [API reference] |
Output Columns
| Label | Data Type (SSIS) | Data Type (SQL) | Length | Raw | Description |
|---|---|---|---|---|---|
| Id |
DT_WSTR
|
nvarchar(1200)
|
1200 | False |
|
| DisplayName |
DT_WSTR
|
nvarchar(500)
|
500 | False |
|
| ParentFolderId |
DT_WSTR
|
nvarchar(1200)
|
1200 | False |
|
| ChildFolderCount |
DT_I4
|
int
|
False |
||
| UnreadItemCount |
DT_I4
|
int
|
False |
||
| TotalItemCount |
DT_I4
|
int
|
False |
||
| SizeInBytes |
DT_I4
|
int
|
False |
||
| IsHidden |
DT_BOOL
|
bit
|
False |
If the column you are looking for is missing, consider customizing Outlook Mail (Office 365) Connector.
Input Columns
| Label | Data Type (SSIS) | Data Type (SQL) | Length | Raw | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Examples
SSIS
Use Outlook Mail (Office 365) Connector in API Source component to read data or in API Destination component to read/write data:
Get Mail Folders using API Source
Outlook Mail (Office 365)
Get Mail Folders
Get Mail Folders using API Destination
Outlook Mail (Office 365)
Get Mail Folders
ODBC application
Use these SQL queries in your ODBC application data source:
Get mail folders
SELECT * FROM get_mailfolders
WITH
(
"UserId" = 'abcd-1234-userid'
)SQL Server
Use these SQL queries in SQL Server after you create a data source in Data Gateway:
Get mail folders
DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM get_mailfolders
WITH
(
"UserId" = ''abcd-1234-userid''
)';
EXEC (@MyQuery) AT [LS_TO_OUTLOOK_MAIL_OFFICE_365_IN_GATEWAY];