Outlook component

Table of Contents

• General information
  • Description
  • Completeness Matrix
  • API version
  • Requirements
  • Environment variables
• Credentials
• Triggers
  • Contacts
  • Poll for New Mail
• Actions
  • Check Availability
  • Find Next Available Time
  • Create Event
  • Move Mail
  • Send Mail
• Known Limitations

General information

Description

Outlook is a personal information manager web app from Microsoft consisting of webmail, calendaring, contacts, and tasks services.

Completeness Matrix

Completeness Matrix

API version

The component uses Microsoft Graph REST API v1.0.

Requirements

This component uses OAuth 2.0 protocol, so you should register your app. For more details, learn how to register an app. A Redirect URI for your tenant is: https://your-tenant.elastic.io/callback/oauth2, for default EIO tenant just use https://app.elastic.io/callback/oauth2.

To create the credentials you would need:

• select existing Auth Client from drop-down list Choose Auth Client or create a new one. to create a new client you should specify the following fields:

Field name	Mandatory	Description
Name	true	your Auth Client's name
Client ID	true	your OAuth client key
Client Secret	true	your OAuth client secret
Authorization Endpoint	true	your OAuth authorization endpoint. Use https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Token Endpoint	true	your OAuth Token endpoint for refreshing access token. Use https://login.microsoftonline.com/common/oauth2/v2.0/token

• fill field Name Your Credential
• click on Authenticate button - if you have not logged in Salesforce before then log in by entering data in the login window that appears
• click on Verify button for verifying your credentials
• click on Save button for saving your credentials

This is the list of the scopes that the credentials for the entire component might require. If you want to limit the scope of the credentials, feel free to only select the required scopes (space separated list):

• openid
• offline_access
• User.Read
• Contacts.Read
• Profile
• Calendars.ReadWrite
• Mail.ReadWrite
• Mail.Send

offline_access is required for each credential. Example of the scopes for the Send Mail action: offline_access Mail.Send

Please Note! To be able to verify the credentials you need these scopes: offline_access User.Read

Environment variables

Name	Mandatory	Description	Values
MAIL_RETRIEVE_MAX_COUNT	false	Define max count mails could be retrieved per one Poll for New Mail trigger execution. Defaults to 1000	1000
TOP_LIST_MAIL_FOLDER	false	Define the maximum number of folders that can be found for dropdown fields containing a list of Mail Folder. Defaults to 100	100

Credentials

To create new credentials you need to authorize in Microsoft system using OAuth2 protocol - details are described in Requirements section.

Triggers

Contacts

Triggers to poll all new contacts from Outlook since last polling. Polling is provided by lastModifiedDateTime contact's property. Per one execution it is possible to poll 900 contacts.

Expected output metadata

/lib/schemas/contacts.out.json

Poll for New Mail

Triggers to poll all new mails from specified folder since last polling. Polling is provided by lastModifiedDateTime mail's property. Per one execution it is possible to poll 1000 mails by defaults, this can be changed by using environment variable MAIL_RETRIEVE_MAX_COUNT.

List of Expected Config fields

• Mail Folder - Dropdown list with available Outlook mail folders
• Start Time - Start datetime of polling. Defaults: 1970-01-01T00:00:00.000Z
• Poll Only Unread Mail - CheckBox, if set, only unread mails will be poll
• Get Attachment - CheckBox, if checked, email attachments will be downloaded to the platform and the link will be provided as a part of the output metadata with the key attachments
• Emit Behavior - Options are: default is Emit Individually emits each mail in separate message, Emit All emits all found mails in one message

Expected output metadata

/lib/schemas/readMail.out.json

Actions

Check Availability

The action retrieves events for the time specified in Time field or for the current time (in case if Time field is empty) and returns true if no events found, or false otherwise.

Expected input metadata

/lib/schemas/checkAvailability.in.json

Expected output metadata

/lib/schemas/checkAvailability.out.json

Find Next Available Time

The action retrieves events for the time specified in Time field or for the current time (in case if Time field is empty).

Returns specified time if no events found, otherwise calculates the new available time based on found event.

If no time specified, the result time will be emitted in UTC time zone (e.g. 2023-08-20T10:00:00Z)

Expected input metadata

/lib/schemas/findNextAvailableTime.in.json

Expected output metadata

/lib/schemas/findNextAvailableTime.out.json

Create Event

The action creates event in specified calendar with specified options.

List of Expected Config fields

• Calendar - Dropdown list with available Outlook calendars
• Time Zone - Dropdown list with available time zones
• Importance - Dropdown list, options are: Low, Normal, High
• Show As - Dropdown list, options are: Free, Tentative, Busy, Out of Office, Working Elsewhere, Unknown
• Sensitivity - Dropdown list, options are: Normal, Personal, Private, Confidential
• Body Content Type - Dropdown list, options are: Text, HTML
• All Day Event - CheckBox, if set, all day event will be created

Expected input metadata

/lib/schemas/createEvent.in.json

Expected output metadata

/lib/schemas/createEvent.out.json

Move Mail

The action moves message with specified id from the original mail folder to a specified destination mail folder or soft-deletes message if the destination folder isn't specified.

List of Expected Config fields

• Original Mail Folder - Dropdown list with available Outlook mail folders - from where mail should be moved, required field.
• Destination Mail Folder - Dropdown list with available Outlook mail folders - where mail should be moved, not required field. If not specified, the message will be soft-deleted (moved to the folder with property deleteditems).

Expected input metadata

/lib/schemas/moveMail.in.json

Expected output metadata

Input metadata contains field Message ID - what exactly message should be moved. /lib/schemas/moveMail.out.json

Send Mail

The action simply send a message to a recipient(s).

Expected input metadata

/lib/schemas/sendMail.in.json

Expected output metadata

In case of a success, output metadata simply repeats the incoming message. I.e. output message schema is exactly the same as for input message. /lib/schemas/sendMail.out.json

Message Example

{
  "subject": "Hello",
  "toRecipients": [
    {
      "emailAddress": {
        "address": "[email protected]",
        "name": "John"
      }
    }
  ],
  "body": {
    "content": "Hello, I am an email content text",
    "contentType": "text"
  }
}

Known limitations

• When utilizing the Send Mail action with attachments, the component operates smoothly with files up to 20MB by default. However, if you intend to work with larger files, it is advisable to create or increase the environment variable EIO_REQUIRED_RAM_MB, which serves as the memory usage limit for the component, initially set at 256MB