Microsoft Outlook 365
Microsoft Outlook 365 is a comprehensive email and productivity platform that integrates email, calendar, contacts, and tasks to streamline communication and organization.
Categories: Communication, Calendars and Scheduling
Type: microsoftOutlook365/v1
Connections
Version: 1
OAuth2 Authorization Code
Properties
| Name | Label | Type | Description | Required |
|---|---|---|---|---|
| clientId | Client Id | STRING | true | |
| clientSecret | Client Secret | STRING | true | |
| tenantId | Tenant Id | STRING | true |
Connection Setup
Create OAuth 2.0 Application
Creation of OAuth 2.0 application is documented here.
Grant Necessary Permissions
- Open the Azure Portal: https://portal.azure.com/
- Click on App registrations.
- Click on All applications.
- Click on application you want to connect to Microsoft Outlook.
- Click on API permissions.
- Click on Microsoft Graph (1).
- Select following scopes:
- Mail.ReadWrite
- Mail.Send
- MailboxSettings.Read
- Calendars.ReadWrite
- offline_access
- After selecting all the scopes click on Update permissions
Actions
Create Event
Name: createEvent
Creates a new event in the specified calendar.
Properties
| Name | Label | Type | Description | Required |
|---|---|---|---|---|
| calendar | Calendar ID | STRING | The ID of the calendar to create the event in. | true |
| subject | Subject | STRING | The subject of the event. | false |
| allDay | All Day Event? | BOOLEAN Optionstrue, false | Is the event all day? | true |
| start | Start Date | DATE | The start date of the event. | true |
| end | End Date | DATE | The end date of the event. | true |
| start | Start Date Time | DATE_TIME | The start time of the event. | true |
| end | End Date Time | DATE_TIME | The end time of the event. | true |
| attendees | Attendees | ARRAY Items[STRING] | The attendees of the event. | false |
| isOnlineMeeting | Is Online Meeting? | BOOLEAN Optionstrue, false | Is the event an online meeting? | false |
| reminderMinutesBeforeStart | Reminder Minutes Before Start | INTEGER | The number of minutes before the event start time that the reminder alert occurs. | false |
Example JSON Structure
{
"label" : "Create Event",
"name" : "createEvent",
"parameters" : {
"calendar" : "",
"subject" : "",
"allDay" : false,
"start" : "2021-01-01T00:00:00",
"end" : "2021-01-01T00:00:00",
"attendees" : [ "" ],
"isOnlineMeeting" : false,
"reminderMinutesBeforeStart" : 1
},
"type" : "microsoftOutlook365/v1/createEvent"
}Output
Type: OBJECT
Properties
| Name | Type | Description |
|---|---|---|
| iCalUId | STRING | ID for an event across calendars, |
| id | STRING | ID of the event. |
| subject | STRING | The text of the event's subject line. |
| startTime | DATE_TIME | Start time of the event. |
| endTime | DATE_TIME | End time of the event. |
| attendees | ARRAY Items[STRING] | The attendees for the event. |
| isOnlineMeeting | BOOLEAN Optionstrue, false | Indicates whether the event is an online meeting. |
| onlineMeetingUrl | STRING | URL for an online meeting. |
| reminderMinutesBeforeStart | BOOLEAN Optionstrue, false | The number of minutes before the event start time that the reminder alert occurs. |
Output Example
{
"iCalUId" : "",
"id" : "",
"subject" : "",
"startTime" : "2021-01-01T00:00:00",
"endTime" : "2021-01-01T00:00:00",
"attendees" : [ "" ],
"isOnlineMeeting" : false,
"onlineMeetingUrl" : "",
"reminderMinutesBeforeStart" : false
}Delete Event
Name: deleteEvent
Deletes an event from the specified calendar.
Properties
| Name | Label | Type | Description | Required |
|---|---|---|---|---|
| calendar | Calendar ID | STRING | The ID of the calendar to delete the event from. | true |
| event | Event ID | STRING Depends Oncalendar | ID of the event to delete. | true |
Example JSON Structure
{
"label" : "Delete Event",
"name" : "deleteEvent",
"parameters" : {
"calendar" : "",
"event" : ""
},
"type" : "microsoftOutlook365/v1/deleteEvent"
}Output
This action does not produce any output.
Get Email
Name: getEmail
Gets the specified email message.
Properties
| Name | Label | Type | Description | Required |
|---|---|---|---|---|
| id | Message ID | STRING | The ID of the message to retrieve. | true |
| format | Format | STRING OptionsSIMPLE, FULL | The format to return the message in. | true |
Example JSON Structure
{
"label" : "Get Email",
"name" : "getEmail",
"parameters" : {
"id" : "",
"format" : ""
},
"type" : "microsoftOutlook365/v1/getEmail"
}Output
The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.
Get Events
Name: getEvents
Gets a list of events in specified calendar.
Properties
| Name | Label | Type | Description | Required |
|---|---|---|---|---|
| calendar | Calendar ID | STRING | The ID of the calendar to retrieve events from. | true |
| dateRange | Date Range | OBJECT Properties{DATE_TIME(from), DATE_TIME(to)} | Date range to find events that exist in this range. | false |
Example JSON Structure
{
"label" : "Get Events",
"name" : "getEvents",
"parameters" : {
"calendar" : "",
"dateRange" : {
"from" : "2021-01-01T00:00:00",
"to" : "2021-01-01T00:00:00"
}
},
"type" : "microsoftOutlook365/v1/getEvents"
}Output
Type: ARRAY
Items Type: OBJECT
Properties
| Name | Type | Description |
|---|---|---|
| iCalUId | STRING | ID for an event across calendars, |
| id | STRING | ID of the event. |
| subject | STRING | The text of the event's subject line. |
| startTime | DATE_TIME | Start time of the event. |
| endTime | DATE_TIME | End time of the event. |
| attendees | ARRAY Items[STRING] | The attendees for the event. |
| isOnlineMeeting | BOOLEAN Optionstrue, false | Indicates whether the event is an online meeting. |
| onlineMeetingUrl | STRING | URL for an online meeting. |
| reminderMinutesBeforeStart | BOOLEAN Optionstrue, false | The number of minutes before the event start time that the reminder alert occurs. |
Output Example
[ {
"iCalUId" : "",
"id" : "",
"subject" : "",
"startTime" : "2021-01-01T00:00:00",
"endTime" : "2021-01-01T00:00:00",
"attendees" : [ "" ],
"isOnlineMeeting" : false,
"onlineMeetingUrl" : "",
"reminderMinutesBeforeStart" : false
} ]Get Free Time Slots
Name: getFreeTimeSlots
Gets the free time slots from the specified calendar.
Properties
| Name | Label | Type | Description | Required |
|---|---|---|---|---|
| calendar | Calendar ID | STRING | The ID of the calendar to retrieve free time slots from. | true |
| dateRange | Date Range | OBJECT Properties{DATE_TIME(from), DATE_TIME(to)} | Date range to find free time. | true |
Example JSON Structure
{
"label" : "Get Free Time Slots",
"name" : "getFreeTimeSlots",
"parameters" : {
"calendar" : "",
"dateRange" : {
"from" : "2021-01-01T00:00:00",
"to" : "2021-01-01T00:00:00"
}
},
"type" : "microsoftOutlook365/v1/getFreeTimeSlots"
}Output
Type: ARRAY
Items Type: OBJECT
Properties
| Name | Type | Description |
|---|---|---|
| startTime | DATE_TIME | Start time of the free time slot. |
| endTime | DATE_TIME | End time of the free time slot. |
Output Example
[ {
"startTime" : "2021-01-01T00:00:00",
"endTime" : "2021-01-01T00:00:00"
} ]Move Email
Name: moveEmail
Moves a email to another folder within the user's mailbox.
Properties
| Name | Label | Type | Description | Required |
|---|---|---|---|---|
| id | Message ID | STRING | The ID of the message to move. | true |
| destinationId | Folder ID | STRING | The destination folder ID. | true |
Example JSON Structure
{
"label" : "Move Email",
"name" : "moveEmail",
"parameters" : {
"id" : "",
"destinationId" : ""
},
"type" : "microsoftOutlook365/v1/moveEmail"
}Output
The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.
Reply to Email
Name: replyToEmail
Sends a reply to an email message.
Properties
| Name | Label | Type | Description | Required |
|---|---|---|---|---|
| id | Message ID | STRING | The ID of the message to reply to. | true |
| bccRecipients | Bcc Recipients | ARRAY Items[STRING] | The Bcc recipients for the message. | false |
| ccRecipients | Cc Recipients | ARRAY Items[STRING] | The Cc recipients for the message. | false |
| contentType | Content Type | STRING OptionsTEXT, HTML | The type of the content. | false |
| content | HTML Content | STRING | Body text of the email in HTML format. | false |
| content | Text Content | STRING | Body text of the email. | false |
| attachments | Attachments | ARRAY Items[FILE_ENTRY] | A list of attachments to send with the email. | false |
Example JSON Structure
{
"label" : "Reply to Email",
"name" : "replyToEmail",
"parameters" : {
"id" : "",
"bccRecipients" : [ "" ],
"ccRecipients" : [ "" ],
"contentType" : "",
"content" : "",
"attachments" : [ {
"extension" : "",
"mimeType" : "",
"name" : "",
"url" : ""
} ]
},
"type" : "microsoftOutlook365/v1/replyToEmail"
}Output
This action does not produce any output.
Search Email
Name: searchEmail
Lists the email messages in the signed-in user's mailbox.
Properties
| Name | Label | Type | Description | Required |
|---|---|---|---|---|
| format | Format | STRING OptionsSIMPLE, FULL | The format to return the message in. | true |
| from | From | STRING | The email address sending the mail. | false |
| to | To | STRING | The email address receiving the new mail. | false |
| subject | Subject | STRING | Words in the subject line. | false |
| category | Category | STRING | Messages in a certain category. | false |
Example JSON Structure
{
"label" : "Search Email",
"name" : "searchEmail",
"parameters" : {
"format" : "",
"from" : "",
"to" : "",
"subject" : "",
"category" : ""
},
"type" : "microsoftOutlook365/v1/searchEmail"
}Output
The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.
Send Email
Name: sendEmail
Sends a new email message from the signed-in user's mailbox.
Properties
| Name | Label | Type | Description | Required |
|---|---|---|---|---|
| toRecipients | To Recipients | ARRAY Items[STRING] | The To: recipients for the message. | true |
| subject | Subject | STRING | The subject of the message. | true |
| bccRecipients | Bcc Recipients | ARRAY Items[STRING] | The Bcc recipients for the message. | false |
| ccRecipients | Cc Recipients | ARRAY Items[STRING] | The Cc recipients for the message. | false |
| replyTo | Reply To | ARRAY Items[STRING] | The email addresses to use when replying. | false |
| body | Body | OBJECT Properties{STRING(contentType), STRING(content), STRING(content)} | The body of the message. It can be in HTML or text format. | true |
| attachments | Attachments | ARRAY Items[FILE_ENTRY] | A list of attachments to send with the email. | false |
Example JSON Structure
{
"label" : "Send Email",
"name" : "sendEmail",
"parameters" : {
"toRecipients" : [ "" ],
"subject" : "",
"bccRecipients" : [ "" ],
"ccRecipients" : [ "" ],
"replyTo" : [ "" ],
"body" : {
"contentType" : "",
"content" : ""
},
"attachments" : [ {
"extension" : "",
"mimeType" : "",
"name" : "",
"url" : ""
} ]
},
"type" : "microsoftOutlook365/v1/sendEmail"
}Output
This action does not produce any output.
Triggers
New Email
Name: newEmail
Triggers when new email is received.
Type: POLLING
Properties
| Name | Label | Type | Description | Required |
|---|---|---|---|---|
| format | Format | STRING OptionsSIMPLE, FULL | The format to return the message in. | true |
Output
The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.
JSON Example
{
"label" : "New Email",
"name" : "newEmail",
"parameters" : {
"format" : ""
},
"type" : "microsoftOutlook365/v1/newEmail"
}What to do if your action is not listed here?
If this component doesn't have the action you need, you can use Custom Action to create your own. Custom Actions empower you to define HTTP requests tailored to your specific requirements, allowing for greater flexibility in integrating with external services or APIs.
To create a Custom Action, simply specify the desired HTTP method, path, and any necessary parameters. This way, you can extend the functionality of your component beyond the predefined actions, ensuring that you can meet all your integration needs effectively.
How is this guide?
Last updated on
Microsoft OneDrive
Microsoft OneDrive is a cloud storage service provided by Microsoft for storing, accessing, and sharing files online.
Microsoft SharePoint
Microsoft SharePoint is a web-based collaborative platform that integrates with Microsoft Office, providing document management, intranet, and content management features for organizations.