1. Overview
Microsoft Outlook is Microsoft's flagship email client and personal information manager, part of the Microsoft 365 suite. It provides comprehensive email management, calendar scheduling, contact organization, task tracking, and collaboration features for personal and business use.
Through GoInsight's Microsoft Outlook node, you can seamlessly integrate email operations, calendar management, and contact handling into your automated workflows. You can achieve full lifecycle management of emails, events, contacts, and organizational data, including:
- Create and manage calendars, contacts, events, and email drafts
- Send and process email messages with advanced features like reply handling and response tracking
- Organize and manipulate mail folders and message attachments
- Update and maintain existing records across all Outlook resources
2. Prerequisites
Before using this node, you need to have a valid Microsoft Outlook account. You may need administrator or specific permissions to create and manage API credentials for Microsoft Graph API access.
3. Credentials
For detailed guidance on how to obtain and configure credentials, please refer to our official documentation: Credentials Configuration Guide.
4. Supported Operations
This node primarily operates around eight core resources: Calendar, Contact, Draft, Event, Folder, Folder Message, Message, and Message Attachment. Each resource supports various operations including creation, retrieval, updating, and deletion as applicable.
Summary
| Resource | Operation | Description |
|---|---|---|
| Calendar | Create a Calendar | Create a new calendar in Microsoft Outlook using Microsoft Graph API |
| Calendar | Delete a Calendar | Delete a calendar from Microsoft Outlook using Microsoft Graph API |
| Calendar | Get Calendars | Retrieve all calendars from Microsoft Outlook using Microsoft Graph API |
| Calendar | Get a Calendar | Retrieve calendar information from Microsoft Outlook using Microsoft Graph API |
| Calendar | Update a Calendar | Update an existing calendar in Microsoft Outlook using Microsoft Graph API |
| Contact | Create a Contact | Create a new contact in Microsoft Outlook using Microsoft Graph API |
| Contact | Delete a Contact | Delete a contact from Microsoft Outlook using Microsoft Graph API |
| Contact | Get Many Contacts | Retrieve all contacts from Microsoft Outlook using Microsoft Graph API |
| Contact | Get a Contact | Retrieve contact information from Microsoft Outlook using Microsoft Graph API |
| Contact | Update a Contact | Update an existing contact in Microsoft Outlook using Microsoft Graph API |
| Draft | Create a Draft | Create a new email draft in Microsoft Outlook using Microsoft Graph API |
| Draft | Delete a Draft | Delete an email draft from Microsoft Outlook using Microsoft Graph API |
| Draft | Get a Draft | Retrieve email draft information from Microsoft Outlook using Microsoft Graph API |
| Draft | Send a Draft | Send an email draft from Microsoft Outlook using Microsoft Graph API |
| Draft | Update a Draft | Update an existing email draft in Microsoft Outlook using Microsoft Graph API |
| Event | Create an Event | Create a new calendar event in Microsoft Outlook using Microsoft Graph API |
| Event | Delete an Event | Delete a calendar event from Microsoft Outlook using Microsoft Graph API |
| Event | Get Many Events | Retrieve calendar events from Microsoft Outlook using Microsoft Graph API |
| Event | Get an Event | Retrieve calendar event information from Microsoft Outlook using Microsoft Graph API |
| Event | Update an Event | Update an existing calendar event in Microsoft Outlook using Microsoft Graph API |
| Folder | Create a Folder | Create a new mail folder in Microsoft Outlook using Microsoft Graph API |
| Folder | Delete a Folder | Delete a mail folder in Microsoft Outlook using Microsoft Graph API |
| Folder | Get Many Folders | Get multiple mail folders in Microsoft Outlook using Microsoft Graph API |
| Folder | Get a Folder | Get a mail folder in Microsoft Outlook using Microsoft Graph API |
| Folder | Update a Folder | Update a mail folder in Microsoft Outlook using Microsoft Graph API |
| Folder Message | Get Many Folder Messages | Get messages from a specific folder in Microsoft Outlook using Microsoft Graph API |
| Message | Delete a Message | Delete an email message in Microsoft Outlook using Microsoft Graph API |
| Message | Get Many Messages | Get multiple email messages in Microsoft Outlook using Microsoft Graph API |
| Message | Get a Message | Get an email message in Microsoft Outlook using Microsoft Graph API |
| Message | Move a Message | Move an email message to another folder in Microsoft Outlook using Microsoft Graph API |
| Message | Reply to Message | Reply to an email message in Microsoft Outlook using Microsoft Graph API |
| Message | Send a Message | Send an email message in Microsoft Outlook using Microsoft Graph API |
| Message | Send and Wait for Response | Send an email message and wait for response in Microsoft Outlook using Microsoft Graph API |
| Message | Update a Message | Update an email message in Microsoft Outlook using Microsoft Graph API |
| Message Attachment | Add Message Attachment | Add a file attachment to an email message in Microsoft Outlook using Microsoft Graph API |
| Message Attachment | Download Message Attachment | Download an attachment from an email message in Microsoft Outlook using Microsoft Graph API |
| Message Attachment | Get Many Message Attachments | Get all attachments from an email message in Microsoft Outlook using Microsoft Graph API |
| Message Attachment | Get Message Attachment | Get attachment information from an email message in Microsoft Outlook using Microsoft Graph API |
Operation Details
Create a Calendar
Create a new calendar in Microsoft Outlook using Microsoft Graph API. Requires calendar name and optionally color. Returns new calendar object with properties, status code, and error message.
Input Parameters:
- CalendarName: The name of the new calendar to create
Options:
- Color: The color theme for the calendar (option)Specifies the color theme to distinguish the calendar from other calendars in a UI. The property values are: LightBlue=0, LightGreen=1, LightOrange=2, LightGray=3, LightYellow=4, LightTeal=5, LightPink=6, LightBrown=7, LightRed=8, MaxColor=9, Auto=-1
Output:
- NewCalendar (object): Newly created calendar object containing properties like id, name, color, permissions and owner information
- StatusCode (number): An HTTP status code indicating the success or failure of the API request.
- ErrorMessage (string): A descriptive error message explaining why the request failed.
Delete a Calendar
Delete a calendar from Microsoft Outlook using Microsoft Graph API. Requires calendar ID. Returns deletion status, status code, and error message.
Input Parameters:
- CalendarId: The ID of the calendar to delete
Output:
- IsDeleted (bool): Boolean indicating whether the calendar was successfully deleted
- StatusCode (number): An HTTP status code indicating the success or failure of the API request.
- ErrorMessage (string): A descriptive error message explaining why the request failed.
Get Calendars
Retrieve all calendars from Microsoft Outlook using Microsoft Graph API. Supports filtering by calendar group. Returns array of calendar objects with properties, status code, and error message.
Options:
- CalendarGroupId: The ID of the specific calendar group to retrieve calendars from (optional, if not provided gets all calendars)
Output:
- Calendars (object-array): List of user's calendars with detailed information for each calendar
- StatusCode (number): An HTTP status code indicating the success or failure of the API request.
- ErrorMessage (string): A descriptive error message explaining why the request failed.
Get a Calendar
Retrieve calendar information from Microsoft Outlook using Microsoft Graph API. Can get default calendar or a specific calendar by ID. Returns calendar object with properties, status code, and error message.
Options:
- CalendarId: The ID of the specific calendar to retrieve (optional, if not provided gets default calendar)
Output:
- Calendar (object): Calendar object containing properties like id, name, color, permissions and owner information
- StatusCode (number): An HTTP status code indicating the success or failure of the API request.
- ErrorMessage (string): A descriptive error message explaining why the request failed.
Update a Calendar
Update an existing calendar in Microsoft Outlook using Microsoft Graph API. Requires calendar ID and at least one field to update (name or color). Returns updated calendar object with properties, status code, and error message.
Input Parameters:
- CalendarId: The ID of the calendar to update
Options:
- CalendarName: New name for the calendar (optional)
- Color: New color theme for the calendar (optional). The property values are: LightBlue=0, LightGreen=1, LightOrange=2, LightGray=3, LightYellow=4, LightTeal=5, LightPink=6, LightBrown=7, LightRed=8, MaxColor=9, Auto=-1
Output:
- UpdatedCalendar (object): Updated calendar object containing properties like id, name, color, permissions and owner information
- StatusCode (number): An HTTP status code indicating the success or failure of the API request.
- ErrorMessage (string): A descriptive error message explaining why the request failed.
Create a Contact
Create a new contact in Microsoft Outlook using Microsoft Graph API. Requires display name and optionally email address, phone number, first name, last name, and company name. Returns new contact object with properties, status code, and error message.
Input Parameters:
- DisplayName: The display name of the new contact to create
Options:
- EmailAddress: The email address of the contact (optional)
- PhoneNumber: The business phone number of the contact (optional)
- FirstName: The first name (given name) of the contact (optional)
- LastName: The last name (surname) of the contact (optional)
- CompanyName: The company name of the contact (optional)
Output:
- NewContact (object): Newly created contact object containing properties like id, display name, email addresses, phone numbers, and other contact information
- StatusCode (number): An HTTP status code indicating the success or failure of the API request.
- ErrorMessage (string): A descriptive error message explaining why the request failed.
Delete a Contact
Delete a contact from Microsoft Outlook using Microsoft Graph API. Requires contact ID. Returns deletion status, status code, and error message.
Input Parameters:
- ContactId: The ID of the contact to delete
Output:
- IsDeleted (bool): Boolean indicating whether the contact was successfully deleted
- StatusCode (number): An HTTP status code indicating the success or failure of the API request.
- ErrorMessage (string): A descriptive error message explaining why the request failed.
Get Many Contacts
Retrieve all contacts from Microsoft Outlook using Microsoft Graph API. Supports filtering by contact folder and limiting the number of results. Returns array of contact objects with properties, status code, and error message.
Options:
- FolderId: The ID of the specific contact folder to retrieve contacts from (optional, if not provided gets all contacts)
- Top: The number of contacts to return (optional, default is 10, max is 999)
Output:
- Contacts (object-array): List of user's contacts with detailed information for each contact
- StatusCode (number): An HTTP status code indicating the success or failure of the API request.
- ErrorMessage (string): A descriptive error message explaining why the request failed.
Get a Contact
Retrieve contact information from Microsoft Outlook using Microsoft Graph API. Can get a specific contact by ID or the first contact if no ID is provided. Returns contact object with properties, status code, and error message.
Options:
- ContactId: The ID of the specific contact to retrieve (optional, if not provided gets the first contact)
Output:
- Contact (object): Contact object containing properties like id, display name, email addresses, phone numbers, and other contact information
- StatusCode (number): An HTTP status code indicating the success or failure of the API request.
- ErrorMessage (string): A descriptive error message explaining why the request failed.
Update a Contact
Update an existing contact in Microsoft Outlook using Microsoft Graph API. Requires contact ID and at least one field to update (display name, email, phone, first name, last name, company name, or job title). Returns updated contact object with properties, status code, and error message.
Input Parameters:
- ContactId: The ID of the contact to update
Options:
- DisplayName: New display name for the contact (optional)
- EmailAddress: New email address for the contact (optional)
- PhoneNumber: New business phone number for the contact (optional)
- FirstName: New first name (given name) for the contact (optional)
- LastName: New last name (surname) for the contact (optional)
- CompanyName: New company name for the contact (optional)
- JobTitle: New job title for the contact (optional)
Output:
- UpdatedContact (object): Updated contact object containing properties like id, display name, email addresses, phone numbers, and other contact information
- StatusCode (number): An HTTP status code indicating the success or failure of the API request.
- ErrorMessage (string): A descriptive error message explaining why the request failed.
Create a Draft
Create a new email draft in Microsoft Outlook using Microsoft Graph API. Requires subject and optionally body content, recipients, content type, and importance. Returns new draft object with properties, status code, and error message.
Input Parameters:
- Subject: The subject of the email draft
Options:
- BodyContent: The body content of the email draft (optional)
- ToRecipients: To recipients email addresses, separated by semicolon (optional)
- CcRecipients: CC recipients email addresses, separated by semicolon (optional)
- BodyType: The body content type: Text or HTML (optional, default is Text)
- Importance: The importance of the email: Low, Normal, or High (optional, default is Normal)
Output:
- NewDraft (object): Newly created email draft object containing properties like id, subject, body, recipients, and other email properties
- StatusCode (number): An HTTP status code indicating the success or failure of the API request.
- ErrorMessage (string): A descriptive error message explaining why the request failed.
Delete a Draft
Delete an email draft from Microsoft Outlook using Microsoft Graph API. Requires draft ID. Returns deletion status, status code, and error message.
Input Parameters:
- DraftId: The ID of the email draft to delete
Output:
- IsDeleted (bool): Boolean indicating whether the email draft was successfully deleted
- StatusCode (number): An HTTP status code indicating the success or failure of the API request.
- ErrorMessage (string): A descriptive error message explaining why the request failed.
Get a Draft
Retrieve email draft information from Microsoft Outlook using Microsoft Graph API. Can get a specific draft by ID or the first draft if no ID is provided. Returns draft object with properties, status code, and error message.
Options:
- DraftId: The ID of the specific email draft to retrieve (optional, if not provided gets the first draft)
Output:
- Draft (object): Email draft object containing properties like id, subject, body, recipients, and other email properties
- StatusCode (number): An HTTP status code indicating the success or failure of the API request.
- ErrorMessage (string): A descriptive error message explaining why the request failed.
Send a Draft
Send an email draft from Microsoft Outlook using Microsoft Graph API. Requires draft ID. Returns send status, status code, and error message. The draft must have at least one recipient to be sent successfully.
Input Parameters:
- DraftId: The ID of the email draft to send
Output:
- IsSent (bool): Boolean indicating whether the email draft was successfully sent
- StatusCode (number): An HTTP status code indicating the success or failure of the API request.
- ErrorMessage (string): A descriptive error message explaining why the request failed.
Update a Draft
Update an existing email draft in Microsoft Outlook using Microsoft Graph API. Requires draft ID and at least one field to update (subject, body content, recipients, body type, or importance). Returns updated draft object with properties, status code, and error message.
Input Parameters:
- DraftId: The ID of the email draft to update
Options:
- Subject: New subject for the email draft (optional)
- BodyContent: New body content for the email draft (optional)
- ToRecipients: New to recipients email addresses, separated by semicolon (optional)
- CcRecipients: New CC recipients email addresses, separated by semicolon (optional)
- BodyType: New body content type: Text or HTML (optional)
- Importance: New importance of the email: Low, Normal, or High (optional)
Output:
- UpdatedDraft (object): Updated email draft object containing properties like id, subject, body, recipients, and other email properties
- StatusCode (number): An HTTP status code indicating the success or failure of the API request.
- ErrorMessage (string): A descriptive error message explaining why the request failed.
Create an Event
Create a new calendar event in Microsoft Outlook using Microsoft Graph API. Requires subject, start/end date times and optionally location, description, attendees, calendar ID, and all-day flag. Returns new event object with properties, status code, and error message.
Input Parameters:
- Subject: The subject/title of the event
- StartDateTime: Start date and time in ISO 8601 format (e.g., 2024-01-15T09:00:00)
- EndDateTime: End date and time in ISO 8601 format (e.g., 2024-01-15T10:00:00)
Options:
- Location: Event location (optional)
- BodyContent: Event description content (optional)
- Attendees: Attendee email addresses separated by semicolon (optional)
- CalendarId: Specific calendar ID to create event in (optional, uses default calendar if not provided)
- IsAllDay: Whether this is an all-day event (optional, default false)
Output:
- NewEvent (object): Newly created calendar event object containing properties like id, subject, start/end times, location, attendees, and other event information
- StatusCode (number): An HTTP status code indicating the success or failure of the API request.
- ErrorMessage (string): A descriptive error message explaining why the request failed.
Delete an Event
Delete a calendar event from Microsoft Outlook using Microsoft Graph API. Requires event ID. Returns deletion status, status code, and error message.
Input Parameters:
- EventId: The ID of the calendar event to delete
Output:
- IsDeleted (bool): Boolean indicating whether the calendar event was successfully deleted
- StatusCode (number): An HTTP status code indicating the success or failure of the API request.
- ErrorMessage (string): A descriptive error message explaining why the request failed.
Get Many Events
Retrieve calendar events from Microsoft Outlook using Microsoft Graph API. Supports filtering by calendar, date range, and limiting the number of results. Events are ordered by start time. Returns array of event objects with properties, status code, and error message.
Options:
- CalendarId: The ID of the specific calendar to retrieve events from (optional, if not provided gets events from default calendar)
- Top: The number of events to return (optional, default is 10, max is 999)
- StartDateTime: Filter events starting from this date time in ISO 8601 format (optional)
- EndDateTime: Filter events ending before this date time in ISO 8601 format (optional)
Output:
- Events (object-array): List of user's calendar events with detailed information for each event, ordered by start time
- StatusCode (number): An HTTP status code indicating the success or failure of the API request.
- ErrorMessage (string): A descriptive error message explaining why the request failed.
Get an Event
Retrieve calendar event information from Microsoft Outlook using Microsoft Graph API. Can get a specific event by ID or the first event if no ID is provided. Returns event object with properties, status code, and error message.
Options:
- EventId: The ID of the specific calendar event to retrieve (optional, if not provided gets the first event)
Output:
- Event (object): Calendar event object containing properties like id, subject, start/end times, location, attendees, and other event information
- StatusCode (number): An HTTP status code indicating the success or failure of the API request.
- ErrorMessage (string): A descriptive error message explaining why the request failed.
Update an Event
Update an existing calendar event in Microsoft Outlook using Microsoft Graph API. Requires event ID and at least one field to update (subject, start/end times, location, description, attendees, categories, importance, sensitivity, show-as status, online meeting settings, reminder settings, etc.). Supports both regular and all-day events with comprehensive configuration options including privacy settings, meeting providers, and attendee visibility. Returns updated event object with properties, status code, and error message.
Input Parameters:
- EventId: The ID of the calendar event to update
Options:
- Subject: New subject/title for the event (optional)
- StartDateTime: New start date and time in ISO 8601 format (optional)
- EndDateTime: New end date and time in ISO 8601 format (optional)
- Location: New event location (optional)
- BodyContent: New event description content (optional)
- Attendees: New attendee email addresses separated by semicolon (optional)
- IsAllDay: Whether this is an all-day event (optional)
- Categories: Event categories separated by semicolon (optional)
- HideAttendees: Whether to hide attendees (optional)
- Importance: Event importance level (optional)
- IsOnlineMeeting: Whether this is an online meeting (optional)
- IsReminderOn: Whether reminder is enabled (optional)
- OnlineMeetingProvider: Online meeting provider (optional)
- ReminderMinutesBeforeStart: Minutes before start to send reminder (optional)
- ResponseRequested: Whether response is requested (optional)
- Sensitivity: Event sensitivity level (optional)
- ShowAs: How to show time as in calendar (optional)
Output:
- UpdatedEvent (object): Updated calendar event object containing properties like id, subject, start/end times, location, attendees, and other event information
- StatusCode (number): An HTTP status code indicating the success or failure of the API request.
- ErrorMessage (string): A descriptive error message explaining why the request failed.
Create a Folder
Create a new mail folder in Microsoft Outlook using Microsoft Graph API. Requires folder name and optionally parent folder ID. Returns new folder object with properties, status code, and error message.
Input Parameters:
- DisplayName: The display name of the new folder to create
Options:
- ParentFolderId: The ID of the parent folder (optional, if not provided creates in root)
Output:
- NewFolder (object): Newly created mail folder object containing properties like id, display name, parent folder, and folder statistics
- StatusCode (number): An HTTP status code indicating the success or failure of the API request.
- ErrorMessage (string): A descriptive error message explaining why the request failed.
Delete a Folder
Delete a mail folder in Microsoft Outlook using Microsoft Graph API. Requires folder ID for deletion. Returns deletion status, status code, and error message.
Input Parameters:
- FolderId: The ID of the folder to delete
Output:
- IsDeleted (bool): Boolean value indicating whether the folder was successfully deleted
- StatusCode (number): An HTTP status code indicating the success or failure of the API request.
- ErrorMessage (string): A descriptive error message explaining why the request failed.
Get Many Folders
Get multiple mail folders in Microsoft Outlook using Microsoft Graph API. Supports parent folder filtering, hidden folder inclusion, and result count limits. Returns array of folder objects with properties, status code, and error message.
Options:
- ParentFolderId: The ID of the parent folder (optional, defaults to root folders)
- Top: Maximum number of folders to return
- IncludeHidden: Whether to include hidden folders
Output:
- Folders (object-array): Array of mail folder objects, each containing properties like id, display name, item counts, and folder statistics
- StatusCode (number): An HTTP status code indicating the success or failure of the API request.
- ErrorMessage (string): A descriptive error message explaining why the request failed.
Get a Folder
Get a mail folder in Microsoft Outlook using Microsoft Graph API. Optional folder ID parameter, defaults to inbox folder. Returns folder object with properties, status code, and error message.
Options:
- FolderId: The ID of the folder to get (optional, defaults to inbox)
Output:
- Folder (object): Mail folder object containing properties like id, display name, item counts, and folder statistics
- StatusCode (number): An HTTP status code indicating the success or failure of the API request.
- ErrorMessage (string): A descriptive error message explaining why the request failed.
Update a Folder
Update a mail folder in Microsoft Outlook using Microsoft Graph API. Requires folder ID and at least one update field (display name or hidden status). Returns updated folder object with properties, status code, and error message.
Input Parameters:
- FolderId: The ID of the folder to update
Options:
- DisplayName: New display name for the folder (optional)
Output:
- UpdatedFolder (object): Updated mail folder object containing properties like id, display name, parent folder, and folder statistics
- StatusCode (number): An HTTP status code indicating the success or failure of the API request.
- ErrorMessage (string): A descriptive error message explaining why the request failed.
Get Many Folder Messages
Get messages from a specific folder in Microsoft Outlook using Microsoft Graph API. Supports filtering, sorting, and result count limits. Returns array of message objects with properties, status code, and error message.
Input Parameters:
- FolderId: The ID of the folder to get messages from
Options:
- Top: Maximum number of messages to return
- FilterCondition: Filter condition (e.g., 'isRead eq false')
- OrderBy: Sort order (default: 'receivedDateTime desc')
Output:
- Messages (object-array): Array of email message objects from the specified folder, containing properties like id, subject, body, recipients, and metadata
- StatusCode (number): An HTTP status code indicating the success or failure of the API request.
- ErrorMessage (string): A descriptive error message explaining why the request failed.
Delete a Message
Delete an email message in Microsoft Outlook using Microsoft Graph API. Requires message ID for deletion. Returns deletion status, status code, and error message.
Input Parameters:
- MessageId: The ID of the message to delete
Output:
- IsDeleted (bool): Boolean value indicating whether the message was successfully deleted
- StatusCode (number): An HTTP status code indicating the success or failure of the API request.
- ErrorMessage (string): A descriptive error message explaining why the request failed.
Get Many Messages
Get multiple email messages in Microsoft Outlook using Microsoft Graph API. Supports filtering, sorting, and result count limits. Returns array of message objects with properties, status code, and error message.
Options:
- Top: Maximum number of messages to return
- FilterCondition: Filter condition (e.g., 'isRead eq false')
- OrderBy: Sort order (default: 'receivedDateTime desc')
Output:
- Messages (object-array): Array of email message objects, each containing properties like id, subject, body preview, recipients, and metadata
- StatusCode (number): An HTTP status code indicating the success or failure of the API request.
- ErrorMessage (string): A descriptive error message explaining why the request failed.
Get a Message
Get an email message in Microsoft Outlook using Microsoft Graph API. Requires message ID for retrieval. Returns complete message object with properties, status code, and error message.
Input Parameters:
- MessageId: The ID of the message to retrieve
Output:
- Message (object): Email message object containing properties like id, subject, body, recipients, attachments, and metadata
- StatusCode (number): An HTTP status code indicating the success or failure of the API request.
- ErrorMessage (string): A descriptive error message explaining why the request failed.
Move a Message
Move an email message to another folder in Microsoft Outlook using Microsoft Graph API. Requires message ID and destination folder ID. Returns moved message object with properties, status code, and error message.
Input Parameters:
- MessageId: The ID of the message to move
- DestinationFolderId: The ID of the destination folder
Output:
- MovedMessage (object): Moved message object containing updated properties after the move operation
- StatusCode (number): An HTTP status code indicating the success or failure of the API request.
- ErrorMessage (string): A descriptive error message explaining why the request failed.
Reply to Message
Reply to an email message in Microsoft Outlook using Microsoft Graph API. Supports both reply and reply-all options. Requires message ID and reply content. Returns reply status, status code, and error message.
Input Parameters:
- MessageId: The ID of the message to reply to
- Comment: Reply content
Options:
- ReplyAll: Whether to reply to all recipients
Output:
- IsReplied (bool): Boolean value indicating whether the message reply was successfully sent
- StatusCode (number): An HTTP status code indicating the success or failure of the API request.
- ErrorMessage (string): A descriptive error message explaining why the request failed.
Send a Message
Send an email message in Microsoft Outlook using Microsoft Graph API. Requires subject, body content, and recipients. Supports HTML/Text body types, CC recipients, and importance levels. Returns sent status, status code, and error message.
Input Parameters:
- Subject: The subject of the email message
- BodyContent: The body content of the email message
- ToRecipients: Recipient email addresses separated by semicolons
Options:
- CcRecipients: CC recipient email addresses separated by semicolons
- BodyType: Body content type (Text or HTML)
- Importance: Message importance (Low/Normal/High)
Output:
- IsSent (bool): Boolean value indicating whether the message was successfully sent
- StatusCode (number): An HTTP status code indicating the success or failure of the API request.
- ErrorMessage (string): A descriptive error message explaining why the request failed.
Send and Wait for Response
Send an email message and wait for response in Microsoft Outlook using Microsoft Graph API. Supports sending to multiple recipients and polling for responses within a specified timeout period. Returns send status, response status, response messages, status code, and error message.
Input Parameters:
- Subject: Email subject
- BodyContent: Email body content
- ToRecipients: Recipient email addresses separated by semicolon
Options:
- TimeoutSeconds: Timeout for waiting response in seconds
Output:
- IsSent (bool): Boolean value indicating whether the message was successfully sent
- HasResponse (bool): Boolean value indicating whether any response was received within timeout
- Responses (object-array): Array of response messages received within the timeout period
- StatusCode (number): An HTTP status code indicating the success or failure of the API request.
- ErrorMessage (string): A descriptive error message explaining why the request failed.
Update a Message
Update an email message in Microsoft Outlook using Microsoft Graph API. Supports updating read status, categories, and flag status. Requires message ID and at least one field to update. Returns updated message object, status code, and error message.
Input Parameters:
- MessageId: The ID of the message to update
Options:
- IsRead: Whether the message is read
- Categories: Message categories separated by semicolon
- FlagStatus: Flag status (notFlagged/complete/flagged)
Output:
- UpdatedMessage (object): Updated message object containing properties like id, subject, read status, categories, and other message information
- StatusCode (number): An HTTP status code indicating the success or failure of the API request.
- ErrorMessage (string): A descriptive error message explaining why the request failed.
Add Message Attachment
Add a file attachment to an email message in Microsoft Outlook using Microsoft Graph API. Requires message ID and file path. Optional custom attachment name. Returns new attachment object with properties, status code, and error message.
Input Parameters:
- MessageId: The ID of the message to add attachment to
- ContentBase64: attachment Base64 Data
- AttachmentName: Custom name for the attachment (optional)
Options:
- ContentType: The content type of the attachment.
Output:
- NewAttachment (object): Newly added attachment object containing properties like id, name, size, and content type
- StatusCode (number): An HTTP status code indicating the success or failure of the API request.
- ErrorMessage (string): A descriptive error message explaining why the request failed.
Download Message Attachment
Download an attachment from an email message in Microsoft Outlook using Microsoft Graph API. Requires message ID, attachment ID, and download path. Returns download status, file path, file size, status code, and error message.
Input Parameters:
- MessageId: The ID of the message containing the attachment
- AttachmentId: The ID of the attachment to download
Output:
- Attachment (object): attachment object
- StatusCode (number): An HTTP status code indicating the success or failure of the API request.
- ErrorMessage (string): A descriptive error message explaining why the request failed.
Get Many Message Attachments
Get all attachments from an email message in Microsoft Outlook using Microsoft Graph API. Requires message ID to retrieve attachments. Returns array of attachment objects with details like id, name, content type, size, and attachment type, along with status code and error message.
Input Parameters:
- MessageId: The ID of the message to get attachments from
Output:
- Attachments (object-array): Array of attachment objects containing id, name, content type, size, and other attachment properties
- StatusCode (number): An HTTP status code indicating the success or failure of the API request.
- ErrorMessage (string): A descriptive error message explaining why the request failed.
Get Message Attachment
Get attachment information from an email message in Microsoft Outlook using Microsoft Graph API. Requires message ID and attachment ID. Returns attachment object with properties, status code, and error message.
Input Parameters:
- MessageId: The ID of the message containing the attachment
- AttachmentId: The ID of the attachment to get
Output:
- Attachment (object): Attachment object containing properties like id, name, content type, size, and attachment type
- StatusCode (number): An HTTP status code indicating the success or failure of the API request.
- ErrorMessage (string): A descriptive error message explaining why the request failed.
5. Example Usage
This section will guide you to create a simple workflow for creating a new calendar event in your Microsoft Outlook account. This workflow demonstrates how to use the calendar management capabilities to schedule meetings and events programmatically.
The workflow consists of three main components: Start -> Microsoft Outlook -> Answer, where the Microsoft Outlook node will create a new calendar event with specified details.
Step-by-step Guide:
- Add Tool Node:
- In the workflow canvas, click the "+" button to add a new node.
- In the popup panel, select the "Tools" tab.
- Find and select Microsoft Outlook from the tools list.
- In the list of Microsoft Outlook supported operations, click to select Create an Event, which will add the corresponding node to the canvas.
- Configure Node:
- Click the newly added Create an Event node, and the configuration panel will expand on the right side.
- Credentials Configuration: At the top of the panel, find the credentials field. Click the dropdown menu and select your pre-configured Microsoft Outlook credentials.
- Parameter Configuration: Fill in the input parameters with detailed information:
- For Subject parameter: Enter a title for your new event, such as "Team Meeting" or "Project Review".
- For StartDateTime parameter: Enter the start date and time in ISO 8601 format, for example "2024-03-15T09:00:00" for March 15, 2024, at 9:00 AM.
- For EndDateTime parameter: Enter the end date and time in ISO 8601 format, for example "2024-03-15T10:00:00" for March 15, 2024, at 10:00 AM.
- For Location parameter (optional): Enter the meeting location, such as "Conference Room A" or "Online".
- For BodyContent parameter (optional): Add event description or agenda details.
- For Attendees parameter (optional): Enter attendee email addresses separated by semicolons, like "user1@company.com;user2@company.com".
- Run and Validate:
- Once all required parameters are correctly filled, the error indicators in the top-right corner of the workflow canvas will disappear.
- Click the "Test Run" button in the top-right corner of the canvas to execute the workflow.
- After successful execution, you can click the log icon in the top-right corner to view the detailed input and output of the node, verifying that the operation was successful.
After completing these steps, your entire workflow will be configured and ready. Click "Test Run" to create a new calendar event in your Microsoft Outlook calendar with the specified details and attendees.
6. FAQs
Q: Why am I getting a 401 or 403 error when trying to access Outlook resources?
A: These errors typically indicate authentication or permission issues. Please check the following:
- Ensure your Microsoft Graph API credentials are properly configured and not expired
- Verify that your application has the necessary permissions (scopes) for the operations you're trying to perform
- Check if your access token needs to be refreshed
Q: I'm getting an error about required fields when creating events or messages. What should I check?
A: Please verify that you've provided all required parameters:
- For events: Subject, StartDateTime, and EndDateTime are mandatory
- For messages: Subject, BodyContent, and ToRecipients are required
- Ensure date/time formats follow ISO 8601 standard (e.g., 2024-03-15T09:00:00)
Q: My email attachments are not being added properly. What could be wrong?
A: Common attachment issues include:
- Ensure the ContentBase64 parameter contains properly encoded base64 data
- Verify the AttachmentName parameter doesn't contain invalid characters
- Check that the message ID you're attaching to exists and is valid
- Confirm the attachment size doesn't exceed Microsoft's limits
Q: How do I handle time zones in calendar events?
A: Microsoft Graph API uses UTC time by default. When specifying StartDateTime and EndDateTime:
- Use ISO 8601 format with timezone information (e.g., 2024-03-15T09:00:00-05:00 for EST)
- Or convert your local time to UTC before sending the request
- Consider using the IsAllDay parameter for events that don't require specific times
Leave a Reply.