Office 365 1.0.0
App Vendor: Microsoft
App Category: Messaging
Connector Version: 1.0.0
API Version: 1.0.0
About App
Microsoft Office 365 includes productivity applications that are part of the Microsoft stack. Microsoft Office 365 is designed to help people and businesses achieve more with innovative Office apps, intelligent cloud services, and world-class security.
The Office 365 app is configured with Orchestrate to perform the following actions:
Action Name | Description |
|---|---|
Get Email | This action retrieves emails from a mailbox. |
Delete Email | This action deletes an email from a mailbox. |
Get Delta Link for Folder | This action returns a delta link for a folder. |
Get Delta Results | This action retrieves delta results from a deltaLink URL or nextLink URL. Delta results are those that have been added, deleted, or updated in a specified folder. |
Get Folders | The action retrieves the folders in a mailbox. |
Get Folder ID from Name | This action retrieves the folder ID for a folder. |
Get Email in Time Range | This action retrieves emails from a mailbox in a specified time range. |
Copy Email | This action copies an email to a destination mailbox. |
Move Email | This action moves an email to a destination mailbox. |
Get Attachments from Email | This action sends attachments from an email to a local file system for analysis. |
Configuration Parameters
The following configuration parameters are required for the Office 365 application to communicate with the Office 365 enterprise application. The parameters can be configured by creating instances in the Office 365 app.
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Client ID | Enter the client ID of the application that is used to connect to Office 365. Example: “09cxx5c9-29b3-99ff-b49z-4123xxx5b427” | Text | Required | |
Client Secret | Enter the client secret ID of the application that is used to connect to Office 365. Example: “2345~123245xxx3245abc~abc12xx512345abc” | Password | Required | The client secret ID must be URL-encoded before it is sent. |
Tenant ID | Enter the tenant ID of the Azure instance to connect to. Example: “09cdxxc9-29b3-99ff-b49z-412xx65b427” | Text | Required |
Action: Get Email
This action retrieves emails from a mailbox.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Mailbox ID | Enter the mailbox ID to retrieve emails. Example: “test@contesco.onmicrosoft.com” | Text | Required | |
Folder ID | Enter the folder ID to retrieve the emails. Example: “amkagq3ngu3zwq2lwm0” | Text | Optional | If the folder ID is not provided, all the emails in the account are returned. |
Limit | Enter the number of results to be displayed. Example: 200 | Integer | Optional | Default value: 1000 |
Example Request
[
{
"mailbox_id": "test@contesco.onmicrosoft.com",
"folder_id": "amkagq3ngu3zwq2lwm0",
“limit”: 200
}
]Action: Delete Email
This action deletes an email from the Office 365 Outlook application.
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Mailbox ID | Enter the mailbox ID to retrieve an email. Example: “test@contesco.onmicrosoft.com” | Text | Required | |
Email ID | Enter the ID of an email you need to delete. Example: “aamkagq3ngu3zwq2lwm0mtitngq4ny04m2i xltgwnwflmjzjnxxxxgaaaaaabzhv0qo5xpsop 6gzzf6k5gbwdxxxxx6_qtp45dpzfd_kkaaaaaa emaadawrtrk6_qtp45dpzfd_kkaab76_59aaa=” | Text | Required |
[
{
“mailbox_id": "test@contesco.onmicrosoft.com",
“email_id”: “cramkagq3ngu3zwq2lwm0mtitngq4ny
04m2ixltgxxxxxlmjzjndzlmgbgaxxxxbzhv
0qo5xpsop6gzzf6k5gbwdawrtrk6_qtp45d
pzfd_kxxxxxaaemaadawrtrk6_qtp45dpzf
d_kkaab76_59aaa=“
}
]Action: Get Delta Link for Folder
This action returns a deltaLink for a folder. You can use the retrieved deltaLink URL in Action: Get Delta Results to retrieve new emails.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Mailbox ID | Enter the mailbox ID. Example: “test@contesco.onmicrosoft.com” | Text | Required | |
Folder ID | Enter the folder ID. Example: “amkagq3ngu3zwq2lwm0” | Text | Required |
Example Request
[
{
"mailbox_id": "test@contesco.onmicrosoft.com",
"folder_id": "amkagq3ngu3zwq2lwm0"
}
]Action: Get Delta Results
This action retrieves delta results from a deltaLink URL or nextLink URL. Delta results are those that have been added, deleted, or updated in a specified folder.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
URL | Enter a deltaLink URL or nextLink URL to retrieve delta results. Example: “https://graph.microsoft.com/beta/users/test@conteso.on microsoft.com/mailfolders('aqmbagz3ngu3awq2lxm0mxxx xgq4ny04m2ixltgwnwflmjzjndzlmgauaaadc4vdeduv6uqke hs83_ixxxxx2sk7ayuvke6eoq6cxxfipaaaagemaaaa')/messages /delta$deltatoken=lztfwwjo5iivxxxxxxaefppquq0uwa2bclcih2v mkaczs14hfsgsvdaxwwjzi3ywzx81aj2blczqnzdny4defceijlhiig9q gftyc4ei.j8xvglai6ys6bcrbn2999_zwsytvocafdf5qlj4ofsdx” | Text | Required |
Example Request
[
{
"url”: “https://graph.microsoft.com/beta/users/test@conteso.on
microsoft.com/mailfolders('aqmbagz3ngu3awq2lxm0mxxx
xgq4ny04m2ixltgwnwflmjzjndzlmgauaaadc4vdeduv6uqke
hs83_ixxxxx2sk7ayuvke6eoq6cxxfipaaaagemaaaa')/messages
/delta$deltatoken=lztfwwjo5iivxxxxxxaefppquq0uwa2bclcih2v
mkaczs14hfsgsvdaxwwjzi3ywzx81aj2blczqnzdny4defceijlhiig9q
gftyc4ei.j8xvglai6ys6bcrbn2999_zwsytvocafdf5qlj4ofsdx”
}
]Action: Get Folders
The action retrieves the folders in a mailbox.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Mailbox ID | Enter the mailbox ID to retrieve folders. Example: “test@contesco.onmicrosoft.com” | Text | Required |
Example Request
[
{
"mailbox_id": "test@contesco.onmicrosoft.com"
}
]Action: Get Folder ID from Name
This action retrieves the folder ID for a folder. By default, this action retrieves the inbox ID.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Mailbox ID | Enter the mailbox ID to retrieve the folder ID. Example: “test@contesco.onmicrosoft.com” | Text | Required | |
Folder Name | Enter the folder name to retrieve the folder ID. Example: “deleted items” | Text | Optional |
Example Request
[
{
"mailbox_id": "test@contesco.onmicrosoft.com",
"folder_name”: "deleted items"
}
]Action: Get Email in Time Range
This action retrieves emails from a mailbox in a specified time range. This action retrieves a maximum of 1000 emails.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Mailbox ID | Enter the mailbox ID to retrieve emails. Example: “test@contesco.onmicrosoft.com” | Text | Required | |
From Time | Enter the start time for the time range to retrieve emails. Example:
| Text | Required | |
To Time | Enter the end time for time range to retrieve emails. The entered time does is not inclusive (less than this time) to retrieve emails. Example:
| Text | Required | |
Folder ID | Enter the folder ID to retrieve emails. Example: “amkagq3ngu3zwq2lwm0” | Text | Optional | If you do not provide a folder ID, then all emails are returned. |
Example Request
[
{
"mailbox_id": "test@contesco.onmicrosoft.com",
"from_time”: “1-10-2021” ,
“to_time”: “1-10-2022” ,
"folder_id": "amkagq3ngu3zwq2lw"
}
]Action: Copy Email
This action copies an email to a destination mailbox.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Mailbox ID | Enter the mailbox ID where the email is located. Example: “test@contesco.onmicrosoft.com” | Text | Required | |
Email ID | Enter the ID of an email that you need to copy. Example: “aamkagq3ngu3zwq2lwm0mtitngq4ny04m2i xltgwnwflmjzjnxxxxgaaaaaabzhv0qo5xpsop 6gzzf6k5gbwdxxxxx6_qtp45dpzfd_kkaaaaaa emaadawrtrk6_qtp45dpzfd_kkaab76_59aaa=” | Text | Required | |
Destination ID | Enter the destination ID of the folder where you need to copy an email. Example: “aamkagq3ngu3zwq2lwm0mtitngq4ny04m2ixltgwnwflmjzj ndzlmgxxxxxaaaabzhv0qo5xpsop6gzzf6k5gbwdawrtrk6_q tp45dpzfd_kkaaaaaaxxxxxawrtrk6_qtp45dpzfd_kkaab76_59aaa=“ | Text | Required | |
Original folder ID | Enter the ID of folder containing an email that needs to be copied. Example: “aamkagq3ngu3zwq2lwm0mtitngq4ny04m2ixltgxxxxxlmjzjndz lmgbgaxxxxbzhv0qo5xpsop6gzzf6k5gbwdawrtrk6_qtp45d pzfd_kxxxxxaaemaadawrtrk6_qtp45dpzfd_kkaab76_59aaa=“ | Text | Optional | If the email resides in a sub folder, then the folder ID parameter is mandatory. |
Example Request
[
{
“mailbox_id": "test@contesco.onmicrosoft.com",
“email_id”: “cramkagq3ngu3zwq2lwm0mtitngq4ny
04m2ixltgxxxxxlmjzjndzlmgbgaxxxxbzhv
0qo5xpsop6gzzf6k5gbwdawrtrk6_qtp45d
pzfd_kxxxxxaaemaadawrtrk6_qtp45dpzf
d_kkaab76_59aaa=“ ,
“destination_id": “gframkagq3ngu3zwq2lwm0mtitngq4ny
04m2ixltgxxxxxlmjzjndzlmgbgaxxxxbzhv
0qo5xpsop6gzzf6k5gbwdawrtrk6_qtp45d
pzfd_kxxxxxaaemaadawrtrk6_qtp45dpzf
d_kkaab76_59aaa=“ ,
“original_folder_id": “kytramkagq3ngu3zwq2lwm0mtitngq4ny
04m2ixltgxxxxxlmjzjndzlmgbgaxxxxbzhv
0qo5xpsop6gzzf6k5gbwdawrtrk6_qtp45d
pzfd_kxxxxxaaemaadawrtrk6_qtp45dpzf
d_kkaab76_59aaa=“
}
]
Action: Move Email
This action moves an email to a destination mailbox.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Mailbox ID | Enter the mailbox ID where the email is located. Example: “test@contesco.onmicrosoft.com” | Text | Required | |
Email ID | Enter the ID of an email that you need to move. Example: “aamkagq3ngu3zwq2lwm0mtitngq4ny04m2i xltgwnwflmjzjnxxxxgaaaaaabzhv0qo5xpsop 6gzzf6k5gbwdxxxxx6_qtp45dpzfd_kkaaaaaa emaadawrtrk6_qtp45dpzfd_kkaab76_59aaa=” | Text | Required | |
Destination ID | Enter the destination ID of the folder where you need to move an email. Example: “aamkagq3ngu3zwq2lwm0mtitngq4ny04m2ixltgwnwflmjzj ndzlmgxxxxxaaaabzhv0qo5xpsop6gzzf6k5gbwdawrtrk6_q tp45dpzfd_kkaaaaaaxxxxxawrtrk6_qtp45dpzfd_kkaab76_59aaa=“ | Text | Required | |
Original folder ID | Enter the ID of folder containing an email that needs to be moved. Example: “aamkagq3ngu3zwq2lwm0mtitngq4ny04m2ixltgxxxxxlmjzjndz lmgbgaxxxxbzhv0qo5xpsop6gzzf6k5gbwdawrtrk6_qtp45d pzfd_kxxxxxaaemaadawrtrk6_qtp45dpzfd_kkaab76_59aaa=“ | Text | Optional | If the email resides in a sub folder, then the folder ID parameter is mandatory. |
Example Request
[
{
“mailbox_id": "test@contesco.onmicrosoft.com",
“email_id”: “cramkagq3ngu3zwq2lwm0mtitngq4ny
04m2ixltgxxxxxlmjzjndzlmgbgaxxxxbzhv
0qo5xpsop6gzzf6k5gbwdawrtrk6_qtp45d
pzfd_kxxxxxaaemaadawrtrk6_qtp45dpzf
d_kkaab76_59aaa=“ ,
“destination_id": “gframkagq3ngu3zwq2lwm0mtitngq4ny
04m2ixltgxxxxxlmjzjndzlmgbgaxxxxbzhv
0qo5xpsop6gzzf6k5gbwdawrtrk6_qtp45d
pzfd_kxxxxxaaemaadawrtrk6_qtp45dpzf
d_kkaab76_59aaa=“ ,
“original_folder_id": “kytramkagq3ngu3zwq2lwm0mtitngq4ny
04m2ixltgxxxxxlmjzjndzlmgbgaxxxxbzhv
0qo5xpsop6gzzf6k5gbwdawrtrk6_qtp45d
pzfd_kxxxxxaaemaadawrtrk6_qtp45dpzf
d_kkaab76_59aaa=“
}
]Action: Get Attachments from Email
This action sends attachments from an email to a local file system for analysis.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Mailbox ID | Enter the mailbox ID where the email is present. Example: “test@contesco.onmicrosoft.com” | Text | Required | |
Email ID | Enter the ID of an email whose attachments you need to send to a local file system. Example: “aamkagq3ngu3zwq2lwm0mtitngq4ny04m2i xltgwnwflmjzjnxxxxgaaaaaabzhv0qo5xpsop 6gzzf6k5gbwdxxxxx6_qtp45dpzfd_kkaaaaaa emaadawrtrk6_qtp45dpzfd_kkaab76_59aaa=” | Text | Required | |
Folder ID | Enter the ID of folder containing the email. Example: “aamkagq3ngu3zwq2lwm0mtitngq4ny04m2ixltgxxxxxlmjzjndz lmgbgaxxxxbzhv0qo5xpsop6gzzf6k5gbwdawrtrk6_qtp45d pzfd_kxxxxxaaemaadawrtrk6_qtp45dpzfd_kkaab76_59aaa=“ | Text | Optional | If the folder ID is not provided, then all emails are considered. |
Example Request
[
{
“mailbox_id": "test@contesco.onmicrosoft.com",
“email_id”: “cramkagq3ngu3zwq2lwm0mtitngq4ny
04m2ixltgxxxxxlmjzjndzlmgbgaxxxxbzhv
0qo5xpsop6gzzf6k5gbwdawrtrk6_qtp45d
pzfd_kxxxxxaaemaadawrtrk6_qtp45dpzf
d_kkaab76_59aaa=“,
“folder_id": “kytramkagq3ngu3zwq2lwm0mtitngq4ny
04m2ixltgxxxxxlmjzjndzlmgbgaxxxxbzhv
0qo5xpsop6gzzf6k5gbwdawrtrk6_qtp45d
pzfd_kxxxxxaaemaadawrtrk6_qtp45dpzf
d_kkaab76_59aaa=“
}
]