Connectors Reference

Office 365 Outlook

Microsoft Office 365 is a cloud-based service that is designed to help meet your organization's needs for robust security, reliability, and user productivity.

 

Status: Production

Tier: Standard

Version: 1.0

 

Actions:

Name

Summary

CalendarGetTable (string table)

Get calendar metadata

ContactGetTable (string table)

Get folder metadata

GetEventsCalendarView (string calendarId, string startDateTimeOffset, string endDateTimeOffset)

Get calendar view of events

CreateOnChangedEventPokeSubscription (ClientSubscription subscription, string table, [advanced][Optional]integer incomingDays, [advanced][Optional]integer pastDays)

When an event is added, updated or deleted in a calendar - Outlook subscription

CreateGraphOnChangedEventPokeSubscription (ClientSubscription subscription, string table, [advanced][Optional]integer incomingDays, [advanced][Optional]integer pastDays)

When an event is added, updated or deleted in a calendar - Graph subscription

DeleteEventSubscription (string id, string options)

Delete event subscription

RenewEventSubscription (string id, string options, ClientSubscription subscription)

Update web hook

OnFilePickerOpen (string operation, [Optional]integer top, [Optional]integer skip, [Optional]string mailboxAddress)

When the file picker is opened for the first time

OnFilePickerBrowse (string operation, string id, [Optional]integer top, [Optional]integer skip, [Optional]string mailboxAddress)

When the file picker is open and being browsed

GetEmails ([Optional]string folderPath, [Optional]boolean fetchOnlyUnread, [Optional]boolean includeAttachments, [Optional]string searchQuery, [Optional]integer top, [internal][Optional]integer skip)

Get emails

SendEmail (ClientSendMessage emailMessage)

Send an email

GetEmailsV2 ([Optional]string folderPath, [Optional]string to, [advanced][Optional]string cc, [advanced][Optional]string toOrCc, [Optional]string from, [advanced][Optional]string importance, [advanced][Optional]boolean fetchOnlyWithAttachment, [advanced][Optional]string subjectFilter, [Optional]boolean fetchOnlyUnread, [internal][Optional]boolean fetchOnlyFlagged, [internal][Optional]string mailboxAddress, [Optional]boolean includeAttachments, [Optional]string searchQuery, [Optional]integer top)

Get emails (V2)

SendEmailV2 (ClientSendHtmlMessage emailMessage)

Send an email (V2)

GetEmail (string messageId, [Optional]string mailboxAddress, [Optional]boolean includeAttachments)

Get email

DeleteEmail (string messageId)

Delete email

GetEmailV2 (string messageId, [Optional]string mailboxAddress, [Optional]boolean includeAttachments)

Get email (V2)

GetEmailsV3 ([Optional]string folderPath, [Optional]string to, [advanced][Optional]string cc, [advanced][Optional]string toOrCc, [Optional]string from, [advanced][Optional]string importance, [advanced][Optional]boolean fetchOnlyWithAttachment, [advanced][Optional]string subjectFilter, [Optional]boolean fetchOnlyUnread, [internal][Optional]boolean fetchOnlyFlagged, [Optional]string mailboxAddress, [Optional]boolean includeAttachments, [Optional]string searchQuery, [Optional]integer top)

Get emails (V3)

Move (string messageId, string folderPath)

Move email

MoveV2 (string messageId, string folderPath, [Optional]string mailboxAddress)

Move email (V2)

Flag (string messageId)

Flag email

MarkAsRead (string messageId)

Mark as read

ReplyTo (string messageId, string comment, [Optional]boolean replyAll)

Reply to email

ReplyToV2 (string messageId, ReplyMessage replyParameters, [Optional]string mailboxAddress)

Reply to email (V2)

ReplyToV3 (string messageId, ReplyHtmlMessage replyParameters, [Optional]string mailboxAddress)

Reply to email (V3)

GetAttachment (string messageId, string attachmentId)

Get attachment

SetAutomaticRepliesSetting (AutomaticRepliesSettingClient clientSetting)

Set up automatic replies

GetMailTips (string mailboxAddress)

Get mail tips for a mailbox

CreateOnNewEmailPokeSubscription (ClientSubscription subscription, [Optional]string folderPath, [advanced][Optional]string importance, [advanced][Optional]boolean fetchOnlyWithAttachment)

Create a webhook subscription for the trigger when a new email arrives

CreateGraphOnNewEmailPokeSubscription (ClientSubscription subscription, [Optional]string folderPath, [advanced][Optional]string importance, [advanced][Optional]boolean fetchOnlyWithAttachment)

Create a Graph webhook subscription for the trigger when a new email arrives

CreateOnNewMentionMeEmailPokeSubscription (ClientSubscription subscription, [Optional]string folderPath, [advanced][Optional]string importance, [advanced][Optional]boolean fetchOnlyWithAttachment)

When a new mentioning me email arrives - Outlook subscription

CreateGraphOnNewMentionMeEmailPokeSubscription (ClientSubscription subscription, [Optional]string folderPath, [advanced][Optional]string importance, [advanced][Optional]boolean fetchOnlyWithAttachment)

When a new mentioning me email arrives - Graph subscription

CreateOnFlaggedEmailPokeSubscription (ClientSubscription subscription, [Optional]string folderPath, [advanced][Optional]string importance, [advanced][Optional]boolean fetchOnlyWithAttachment)

Create an Outlook webhook subscription for the trigger when an email is flagged

CreateGraphOnFlaggedEmailPokeSubscription (ClientSubscription subscription, [Optional]string folderPath, [advanced][Optional]string importance, [advanced][Optional]boolean fetchOnlyWithAttachment)

Create a Graph webhook subscription for the trigger when an email is flagged

DeleteOnNewEmailSubscription (string id, string options)

Delete mail subscription

RenewOnNewEmailSubscription (string id, string options, ClientSubscription subscription)

Update web hook

GetDataSetsMetadata ()

 

SendMailWithOptions (OptionsEmailSubscription optionsEmailSubscription)

Send email with options

SendApprovalMail (ApprovalEmailSubscription approvalEmailSubscription)

Send approval email

DeleteApprovalMailSubscription (string id)

Delete approval email subscription

DeleteOptionsMailSubscription (string id)

Delete options email subscription

SharedMailboxSendEmail (SharedMailboxClientSendMessage emailMessage)

Send an email from a shared mailbox

SharedMailboxSendEmailV2 (SharedMailboxClientSendHtmlMessage emailMessage)

Send an email from a shared mailbox (V2)

TestConnection ()

Tests the connection

CalendarGetTables ()

Get calendars

CalendarGetItems (string table, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip)

Get events (V1)

CalendarPostItem (string table, CalendarEventBackend item)

Create event (V1)

CalendarGetItem (string table, string id)

Get event (V1)

CalendarDeleteItem (string table, string id)

Delete event

CalendarPatchItem (string table, string id, CalendarEventBackend item)

Update event (V1)

V3CalendarGetItems (string table, [advanced][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip)

Get events (V3)

V3CalendarPostItem (string table, CalendarEventHtmlClient item)

Create event (V3)

V4CalendarGetItems (string table, [advanced][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip)

Get events (V4)

V4CalendarPostItem (string table, GraphCalendarEventClient item)

Create event (V4)

V2CalendarGetItems (string table, [advanced][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip)

Get events (V2)

V2CalendarPostItem (string table, CalendarEventClient item)

Create event (V2)

GetEventsCalendarViewV2 (string calendarId, string startDateTimeOffset, string endDateTimeOffset, [advanced][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip, [advanced][Optional]string search)

Get calendar view of events (V2)

GetEventsCalendarViewV3 (string calendarId, string startDateTimeUtc, string endDateTimeUtc, [advanced][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip, [advanced][Optional]string search)

Get calendar view of events (V3)

V2CalendarGetItem (string table, string id)

Get event (V2)

V2CalendarPatchItem (string table, string id, CalendarEventClient item)

Update event (V2)

V3CalendarGetItem (string table, string id)

Get event (V3)

V3CalendarPatchItem (string table, string id, CalendarEventHtmlClient item)

Update event (V3)

V4CalendarPatchItem (string table, string id, GraphCalendarEventClient item)

Update event (V4)

ContactGetTables ()

Get contact folders

ContactGetTablesV2 ()

Get contact folders (V2)

ContactGetItems (string table, [advanced][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip)

Get contacts

ContactPostItem (string table, Contact item)

Create contact

ContactGetItem (string table, string id)

Get contact

ContactDeleteItem (string table, string id)

Delete contact

ContactPatchItem (string table, string id, Contact item)

Update contact

GetDataSets ()

Get datasets

ExportEmail (string messageId)

Export email

ExportEmail_V2 (string messageId, [Optional]string mailboxAddress)

Export email (V2)

Flag_V2 (string messageId, [Optional]string mailboxAddress, [Optional]UpdateEmailFlag body)

Flag email (V2)

MarkAsRead_V2 (string messageId, [Optional]string mailboxAddress, [Optional]MarkAsRead_V2ParameterBody body)

Mark as read or unread (V2)

MarkAsRead_V3 (string messageId, [Optional]string mailboxAddress, [Optional]MarkAsRead_V3ParameterBody body)

Mark as read or unread (V3)

DeleteEmail_V2 (string messageId, [Optional]string mailboxAddress)

Delete email (V2)

GetAttachment_V2 (string messageId, string attachmentId, [Optional]string mailboxAddress)

Get Attachment (V2)

RespondToEvent (string event_id, string response, [Optional]ResponseToEventInvite body)

Respond to an event invite

RespondToEvent_V2 (string event_id, string response, [Optional]ResponseToEventInvite body)

Respond to an event invite (V2)

ForwardEmail (string message_id, DirectForwardMessage body)

Forward an email

ForwardEmail_V2 (string message_id, [Optional]string mailboxAddress, DirectForwardMessage body)

Forward an email (V2)

GetRoomLists ()

Get room lists

GetRoomLists_V2 ()

Get room lists (V2)

GetRooms ()

Get rooms

GetRooms_V2 ()

Get rooms (V2)

GetRoomsInRoomList (string room_list)

Get rooms in room list

GetRoomsInRoomList_V2 (string room_list)

Get rooms in room list (V2)

FindMeetingTimes (FindMeetingTimesParameterBody body)

Find meeting times

FindMeetingTimes_V2 (FindMeetingTimes_V2ParameterBody body)

Find meeting times (V2)

SetAutomaticRepliesSetting_V2 (SetAutomaticRepliesSetting_V2ParameterBody body)

Set up automatic replies (V2)

GetMailTips_V2 (GetMailTips_V2ParameterBody body)

Get mail tips for a mailbox (V2)

CalendarGetTables_V2 ([internal][Optional]integer skip, [internal][Optional]integer top, [internal][Optional]string orderBy)

Get calendars (V2)

CalendarDeleteItem_V2 (string calendar, string event)

Delete event (V2)

ContactGetItem_V2 (string folder, string id)

Get contact (V2)

ContactDeleteItem_V2 (string folder, string id)

Delete contact (V2)

ContactPatchItem_V2 (string folder, string id, Contact_V2 item)

Update contact (V2)

ContactGetItems_V2 (string folder, [advanced][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip)

Get contacts (V2)

ContactPostItem_V2 (string folder, Contact_V2 item)

Create contact (V2)

UpdateMyContactPhoto (string folder, string id, string body, [internal][Optional]string Content-Type)

Update my contact's photo

ReceiveResponseGet (string state, [Optional]string sig, [Optional]boolean showConfirm)

Receives response from user

ReceiveResponsePost (string state, [Optional]string sig, [Optional]boolean fromConfirm)

Receives response from user

ReceiveMailFromSubscription (string state, SubscriptionPayload[OutlookReceiveMessage] subscriptionPayload, [Optional]string validationtoken)

Receive mail

ReceiveMailFromSubscriptionV2 (string state, SubscriptionPayload[OutlookReceiveMessage] subscriptionPayload, [Optional]string validationtoken, string subscribedConnectionId)

Receive mail (V2)

ReceiveEventFromSubscription (string state, SubscriptionPayload[SubscriptionEvent] subscriptionPayload, [Optional]string validationtoken)

Receive event

ReceiveEventFromSubscriptionV2 (string state, SubscriptionPayload[SubscriptionEvent] subscriptionPayload, [Optional]string validationtoken, string subscribedConnectionId)

Receive event (V2)

 

Triggers:

Name

Summary

OnUpcomingEvents (string table, [advanced][Optional]integer lookAheadTimeInMinutes)

When an upcoming event is starting soon

OnUpcomingEventsV2 (string table, [advanced][Optional]integer lookAheadTimeInMinutes)

When an upcoming event is starting soon (V2)

OnUpcomingEventsV3 (string table, [advanced][Optional]integer lookAheadTimeInMinutes)

When an upcoming event is starting soon (V3)

OnNewEmail ([Optional]string folderPath, [advanced][Optional]string to, [advanced][Optional]string cc, [advanced][Optional]string toOrCc, [advanced][Optional]string from, [advanced][Optional]string importance, [advanced][Optional]boolean fetchOnlyWithAttachment, [advanced][Optional]boolean includeAttachments, [advanced][Optional]string subjectFilter, [internal][Optional]string x-ms-operation-context)

When a new email arrives

OnNewEmailV2 ([Optional]string folderPath, [advanced][Optional]string to, [advanced][Optional]string cc, [advanced][Optional]string toOrCc, [advanced][Optional]string from, [advanced][Optional]string importance, [advanced][Optional]boolean fetchOnlyWithAttachment, [advanced][Optional]boolean includeAttachments, [advanced][Optional]string subjectFilter, [internal][Optional]string x-ms-operation-context)

When a new email arrives (V2)

OnNewEmailV3 ([Optional]string folderPath, [advanced][Optional]string to, [advanced][Optional]string cc, [advanced][Optional]string toOrCc, [advanced][Optional]string from, [advanced][Optional]string importance, [advanced][Optional]boolean fetchOnlyWithAttachment, [advanced][Optional]boolean includeAttachments, [advanced][Optional]string subjectFilter, [internal][Optional]string x-ms-operation-context)

When a new email arrives (V3)

OnFlaggedEmail ([Optional]string folderPath, [advanced][Optional]string to, [advanced][Optional]string cc, [advanced][Optional]string toOrCc, [advanced][Optional]string from, [advanced][Optional]string importance, [advanced][Optional]boolean fetchOnlyWithAttachment, [advanced][Optional]boolean includeAttachments, [advanced][Optional]string subjectFilter, [internal][Optional]string x-ms-operation-context)

When an email is flagged

OnFlaggedEmailV2 ([Optional]string folderPath, [advanced][Optional]string to, [advanced][Optional]string cc, [advanced][Optional]string toOrCc, [advanced][Optional]string from, [advanced][Optional]string importance, [advanced][Optional]boolean fetchOnlyWithAttachment, [advanced][Optional]boolean includeAttachments, [advanced][Optional]string subjectFilter)

When an email is flagged (V2)

OnFlaggedEmailV3 ([Optional]string folderPath, [advanced][Optional]string to, [advanced][Optional]string cc, [advanced][Optional]string toOrCc, [advanced][Optional]string from, [advanced][Optional]string importance, [advanced][Optional]boolean fetchOnlyWithAttachment, [advanced][Optional]boolean includeAttachments, [advanced][Optional]string subjectFilter)

When an email is flagged (V3)

OnNewMentionMeEmail ([internal][Optional]string messageIdToFireOnFirstTriggerRun, [Optional]string folderPath, [advanced][Optional]string to, [advanced][Optional]string cc, [advanced][Optional]string toOrCc, [advanced][Optional]string from, [advanced][Optional]string importance, [advanced][Optional]boolean fetchOnlyWithAttachment, [advanced][Optional]boolean includeAttachments, [advanced][Optional]string subjectFilter)

When a new email mentioning me arrives

OnNewMentionMeEmailV2 ([internal][Optional]string messageIdToFireOnFirstTriggerRun, [Optional]string folderPath, [advanced][Optional]string to, [advanced][Optional]string cc, [advanced][Optional]string toOrCc, [advanced][Optional]string from, [advanced][Optional]string importance, [advanced][Optional]boolean fetchOnlyWithAttachment, [advanced][Optional]boolean includeAttachments, [advanced][Optional]string subjectFilter)

When a new email mentioning me arrives (V2)

OnNewMentionMeEmailV3 ([internal][Optional]string messageIdToFireOnFirstTriggerRun, [Optional]string folderPath, [advanced][Optional]string to, [advanced][Optional]string cc, [advanced][Optional]string toOrCc, [advanced][Optional]string from, [advanced][Optional]string importance, [advanced][Optional]boolean fetchOnlyWithAttachment, [advanced][Optional]boolean includeAttachments, [advanced][Optional]string subjectFilter)

When a new email mentioning me arrives (V3)

CreateOnNewEmailSubscription (ClientSubscription subscription, [Optional]string folderPath, [advanced][Optional]string importance, [advanced][Optional]string hasAttachment)

When a new email arrives (webhook)

SharedMailboxOnNewEmail (string mailboxAddress, [Optional]string folderId, [advanced][Optional]string to, [advanced][Optional]string cc, [advanced][Optional]string toOrCc, [advanced][Optional]string from, [advanced][Optional]string importance, [advanced][Optional]boolean hasAttachments, [advanced][Optional]boolean includeAttachments, [advanced][Optional]string subjectFilter, [internal][Optional]string x-ms-operation-context)

When a new email arrives in a shared mailbox

SharedMailboxOnNewEmailV2 (string mailboxAddress, [Optional]string folderId, [advanced][Optional]string to, [advanced][Optional]string cc, [advanced][Optional]string toOrCc, [advanced][Optional]string from, [advanced][Optional]string importance, [advanced][Optional]boolean hasAttachments, [advanced][Optional]boolean includeAttachments, [advanced][Optional]string subjectFilter, [internal][Optional]string x-ms-operation-context)

When a new email arrives in a shared mailbox (V2)

CalendarGetOnNewItems (string table, [internal][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip, [internal][Optional]string x-ms-operation-context)

When a new event is created (V1)

CalendarGetOnUpdatedItems (string table, [internal][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip)

When an event is modified (V1)

ODataStyleGetOnNewItems (string dataset, string table, [internal][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip)

When a new item is created in a table

ODataStyleCalendarGetOnUpdatedItems (string dataset, string table, [internal][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip)

When an item is modified

CalendarGetOnNewItemsV2 (string table, [internal][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip, [internal][Optional]string x-ms-operation-context)

When a new event is created (V2)

CalendarGetOnNewItemsV3 (string table, [internal][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip, [internal][Optional]string x-ms-operation-context)

When a new event is created (V3)

CalendarGetOnUpdatedItemsV2 (string table, [internal][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip)

When an event is modified (V2)

CalendarGetOnUpdatedItemsV3 (string table, [internal][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip)

When an event is modified (V3)

CalendarGetOnChangedItems (string table, [advanced][Optional]integer incomingDays, [advanced][Optional]integer pastDays)

When an event is added, updated or deleted

CalendarGetOnChangedItemsV2 (string table, [advanced][Optional]integer incomingDays, [advanced][Optional]integer pastDays)

When an event is added, updated or deleted (V2)

CalendarGetOnChangedItemsV3 (string table, [advanced][Optional]integer incomingDays, [advanced][Optional]integer pastDays)

When an event is added, updated or deleted (V3)

 

Objects:

Name

Summary

ApprovalEmailSubscription

 

ApprovalMessage

 

Attendee

 

AutomaticRepliesSettingClient

 

AutomaticRepliesSettingClient_V2

 

BatchResponse[ClientReceiveMessage]

 

BatchResponse[GraphClientReceiveMessage]

 

BlobDataSetsMetadata

 

CalendarEventBackend

 

CalendarEventClient

 

CalendarEventClientReceive

 

CalendarEventClientReceiveStringEnums

 

CalendarEventClientWithActionType

 

CalendarEventHtmlClient

 

CalendarEventList

 

CalendarEventListClientReceive

 

CalendarEventListWithActionType

 

CalendarGetTables_V2Response

 

ClientReceiveFileAttachment

 

ClientReceiveMessage

 

ClientReceiveMessageStringEnums

 

ClientSendAttachment

 

ClientSendHtmlMessage

 

ClientSendMessage

 

ClientSubscription

 

Contact

 

ContactResponse

 

ContactResponse_V2

 

Contact_V2

 

DataSet

 

DataSetsList

 

DataSetsMetadata

 

DateTimeTimeZone

DateTimeTimeZone

DateTimeTimeZone_V2

DateTimeTimeZone

DirectForwardMessage

 

EmailAddress

 

EmailAddress_V2

 

EntityListResponse[CalendarEventBackend]

 

EntityListResponse[CalendarEventClientReceiveStringEnums]

 

EntityListResponse[ContactResponse]

 

EntityListResponse[ContactResponse]_V2

 

EntityListResponse[FilePickerFile]

 

EntityListResponse[GraphCalendarEventClientReceive]

 

EntityListResponse[GraphContactFolder]

 

EntityListResponse[Table]

 

FilePickerFile

 

FindMeetingTimesParameterBody

 

FindMeetingTimesResponse

 

FindMeetingTimes_V2ParameterBody

 

FindMeetingTimes_V2Response

 

GeoCoordinates

 

GetAttachment_V2Response

 

GetMailTips_V2ParameterBody

 

GetMailTips_V2Response

 

GetRoomListsResponse

 

GetRoomLists_V2Response

 

GetRoomsInRoomListResponse

 

GetRoomsInRoomList_V2Response

 

GetRoomsResponse

 

GetRooms_V2Response

 

GraphCalendarEventClient

 

GraphCalendarEventClientReceive

 

GraphCalendarEventClientWithActionType

 

GraphCalendarEventListClientReceive

 

GraphCalendarEventListWithActionType

 

GraphClientReceiveFileAttachment

 

GraphClientReceiveMessage

 

GraphContactFolder

 

InternetMessageHeader

 

ItemBody

 

Location

 

MailTipsAutomaticReplies

 

MailTipsAutomaticReplies_V2

 

MailTipsClientReceive

 

MailTipsClientReceive_V2

 

MarkAsRead_V2ParameterBody

 

MarkAsRead_V3ParameterBody

 

MessageWithOptions

 

Object

 

OptionsEmailSubscription

 

OutlookReceiveAttachment

 

OutlookReceiveMessage

 

PaginatedListResponse[CalendarEventClientReceiveStringEnums]

 

PassThroughNativeQuery

 

PatternedRecurrence

 

PhysicalAddress

 

PhysicalAddress_V2

 

Recipient

 

RecurrencePattern

 

RecurrenceRange

 

ReplyHtmlMessage

 

ReplyMessage

 

ResponseStatus

 

ResponseToEventInvite

 

SetAutomaticRepliesSetting_V2ParameterBody

 

SetAutomaticRepliesSetting_V2Response

 

SharedMailboxClientSendHtmlMessage

 

SharedMailboxClientSendMessage

 

SubscriptionEvent

 

SubscriptionPayloadEntity[OutlookReceiveMessage]

 

SubscriptionPayloadEntity[SubscriptionEvent]

 

SubscriptionPayload[OutlookReceiveMessage]

 

SubscriptionPayload[SubscriptionEvent]

 

SubscriptionResponse

 

Table

 

TableCapabilitiesMetadata

 

TableFilterRestrictionsMetadata

 

TableMetadata

 

TableSelectRestrictionsMetadata

 

TableSortRestrictionsMetadata

 

TabularDataSetsMetadata

 

TriggerBatchResponse[ClientReceiveMessage]

 

TriggerBatchResponse[GraphClientReceiveMessage]

 

UpdateEmailFlag

 

 

Actions:

CalendarGetTable

Summary: Get calendar metadata

Description: This operation gets metadata for a calendar.

 

Syntax:

Office365Outlook.CalendarGetTable (string table)

 

Parameters:

Name

Type

Summary

Required

Related Action

table

string

(Folder id)

Select a calendar.

True

CalendarGetTables

 

Returns:

          Type:TableMetadata

          Description: Table metadata

 

ContactGetTable

Summary: Get folder metadata

Description: This operation gets metadata for a contacts folder.

 

Syntax:

Office365Outlook.ContactGetTable (string table)

 

Parameters:

Name

Type

Summary

Required

Related Action

table

string

(Folder id)

Select a contacts folder.

True

ContactGetTables

 

Returns:

          Type:TableMetadata

          Description: Table metadata

 

GetEventsCalendarView

Summary: Get calendar view of events

Description: Get calendar view of events.

 

Syntax:

Office365Outlook.GetEventsCalendarView (string calendarId, string startDateTimeOffset, string endDateTimeOffset)

 

Parameters:

Name

Type

Summary

Required

Related Action

calendarId

string

(Calendar Id)

Select a calendar.

True

CalendarGetTables

startDateTimeOffset

string

(Start Time)

Start time (example: '2017-01-01T08:00:00-07:00').

True

endDateTimeOffset

string

(End Time)

End time (example: '2017-02-01T08:00:00-07:00').

True

 

Returns:

          Type:PaginatedListResponse[CalendarEventClientReceiveStringEnums]

          Description: Response containing a list and next link

 

CreateOnChangedEventPokeSubscription

Summary: When an event is added, updated or deleted in a calendar - Outlook subscription

Description: Create an Outlook webhook subscription for the trigger when an event is added, updated or deleted in a calendar.

 

Syntax:

Office365Outlook.CreateOnChangedEventPokeSubscription (ClientSubscription subscription, string table, [advanced][Optional]integer incomingDays, [advanced][Optional]integer pastDays)

 

Parameters:

Name

Type

Summary

Required

Related Action

subscription

ClientSubscription

 

Describes the subscription information.

True

table

string

(Calendar id)

Select a calendar.

True

CalendarGetTables

incomingDays

integer(int32)

(Incoming Days Tracked)

Number of incoming days in calendar to be tracked.

False

pastDays

integer(int32)

(Past Days Tracked)

Number of past days in calendar to be tracked.

False

 

Returns:

          Type:SubscriptionResponse

          Description: Base response model that connector returns to LA engine

 

CreateGraphOnChangedEventPokeSubscription

Summary: When an event is added, updated or deleted in a calendar - Graph subscription

Description: Create a Graph webhook subscription for the trigger when an event is added, updated or deleted in a calendar.

 

Syntax:

Office365Outlook.CreateGraphOnChangedEventPokeSubscription (ClientSubscription subscription, string table, [advanced][Optional]integer incomingDays, [advanced][Optional]integer pastDays)

 

Parameters:

Name

Type

Summary

Required

Related Action

subscription

ClientSubscription

 

Describes the subscription information.

True

table

string

(Calendar id)

Select a calendar.

True

CalendarGetTables_V2

incomingDays

integer(int32)

(Incoming Days Tracked)

Number of incoming days in calendar to be tracked.

False

pastDays

integer(int32)

(Past Days Tracked)

Number of past days in calendar to be tracked.

False

 

Returns:

          Type:SubscriptionResponse

          Description: Base response model that connector returns to LA engine

 

DeleteEventSubscription

Summary: Delete event subscription

Description: This operation deletes an event subscription.

 

Syntax:

Office365Outlook.DeleteEventSubscription (string id, string options)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Id of subscription to be deleted)

Id of subscription to be deleted.

True

options

string

(Subscription options)

Subscription options.

True

 

Returns:

 

RenewEventSubscription

Summary: Update web hook

Description: Update web hook with renew interval.

 

Syntax:

Office365Outlook.RenewEventSubscription (string id, string options, ClientSubscription subscription)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Id of subscription to be renewed)

Id of subscription to be renewed.

True

options

string

(Subscription options)

Subscription options.

True

subscription

ClientSubscription

 

Describes the subscription information.

True

 

Returns:

 

OnFilePickerOpen

Summary: When the file picker is opened for the first time

Description: When the file picker is opened for the first time.

 

Syntax:

Office365Outlook.OnFilePickerOpen (string operation, [Optional]integer top, [Optional]integer skip, [Optional]string mailboxAddress)

 

Parameters:

Name

Type

Summary

Required

Related Action

operation

string

(Name of the operation)

Name of the operation.

True

top

integer(int32)

(Limit on the number of results to return)

Limit on the number of results to return.

False

skip

integer(int32)

(Number of results to skip)

Number of results to skip.

False

mailboxAddress

string

(Mailbox to perform operations for)

Mailbox to perform operations for.

False

 

Returns:

          Type:EntityListResponse[FilePickerFile]

          Description: Entity list response

 

OnFilePickerBrowse

Summary: When the file picker is open and being browsed

Description: When the file picker is open and being browsed.

 

Syntax:

Office365Outlook.OnFilePickerBrowse (string operation, string id, [Optional]integer top, [Optional]integer skip, [Optional]string mailboxAddress)

 

Parameters:

Name

Type

Summary

Required

Related Action

operation

string

(Name of the operation)

Name of the operation.

True

id

string

(Id of the previously selected item)

Id of the previously selected item.

True

top

integer(int32)

(Limit on the number of results to return)

Limit on the number of results to return.

False

skip

integer(int32)

(Number of results to skip)

Number of results to skip.

False

mailboxAddress

string

(Mailbox to perform operations for)

Mailbox to perform operations for.

False

 

Returns:

          Type:EntityListResponse[FilePickerFile]

          Description: Entity list response

 

GetEmails

Summary: Get emails

Description: This operation gets emails from a folder.

 

Syntax:

Office365Outlook.GetEmails ([Optional]string folderPath, [Optional]boolean fetchOnlyUnread, [Optional]boolean includeAttachments, [Optional]string searchQuery, [Optional]integer top, [internal][Optional]integer skip)

 

Parameters:

Name

Type

Summary

Required

Related Action

folderPath

string

(Folder)

Mail folder to retrieve emails from (default: 'Inbox').

False

fetchOnlyUnread

boolean

(Fetch Only Unread Messages)

Retrieve only unread emails?.

False

includeAttachments

boolean

(Include Attachments)

If set to true, attachments will also be retrieved along with the email.

False

searchQuery

string

(Search Query)

Search query (like in the Outlook client) to filter emails.

False

top

integer(int32)

(Top)

Number of emails to retrieve (default: 10).

False

skip

integer(int32)

(Skip)

Number of emails to skip (default: 0).

False

 

Returns:

          Type:array of (ClientReceiveMessageStringEnums)

 

SendEmail

Summary: Send an email

Description: This operation sends an email message.

 

Syntax:

Office365Outlook.SendEmail (ClientSendMessage emailMessage)

 

Parameters:

Name

Type

Summary

Required

Related Action

emailMessage

ClientSendMessage

 

Send Email Message

True

 

Returns:

 

GetEmailsV2

Summary: Get emails (V2)

Description: This operation gets emails from a folder.

 

Syntax:

Office365Outlook.GetEmailsV2 ([Optional]string folderPath, [Optional]string to, [advanced][Optional]string cc, [advanced][Optional]string toOrCc, [Optional]string from, [advanced][Optional]string importance, [advanced][Optional]boolean fetchOnlyWithAttachment, [advanced][Optional]string subjectFilter, [Optional]boolean fetchOnlyUnread, [internal][Optional]boolean fetchOnlyFlagged, [internal][Optional]string mailboxAddress, [Optional]boolean includeAttachments, [Optional]string searchQuery, [Optional]integer top)

 

Parameters:

Name

Type

Summary

Required

Related Action

folderPath

string

(Folder)

Mail folder to retrieve emails from (default: 'Inbox').

False

to

string(email)

(To)

Recipient email addresses separated by semicolons (If any match, the trigger will run).

False

cc

string(email)

(CC)

CC recipient email addresses separated by semicolons (If any match, the trigger will run).

False

toOrCc

string(email)

(To or CC)

To or CC recipient email addresses separated by semicolons (If any match, the trigger will run).

False

from

string(email)

(From)

Sender email addresses separated by semicolons (If any match, the trigger will run).

False

importance

string

(Importance)Values: [Any, Low, Normal, High]

Importance of the email (Any, High, Normal, Low).

False

fetchOnlyWithAttachment

boolean

(Only with Attachments)

If set to true, only emails with an attachment will be retrieved. Emails without any attachments will be skipped. If set to false, all emails will be retrieved.

False

subjectFilter

string

(Subject Filter)

String to look for in the subject line.

False

fetchOnlyUnread

boolean

(Fetch Only Unread Messages)

Retrieve only unread emails?.

False

fetchOnlyFlagged

boolean

(Fetch Only Flagged Messages)

Retrieve only flagged emails?.

False

mailboxAddress

string

(Original Mailbox Address)

Address of the shared mailbox to retrieve mails from.

False

includeAttachments

boolean

(Include Attachments)

If set to true, attachments will also be retrieved along with the email.

False

searchQuery

string

(Search Query)

Search query (like in the Outlook client) to filter emails.

False

top

integer(int32)

(Top)

Number of emails to retrieve (default: 10).

False

 

Returns:

          Type:BatchResponse[ClientReceiveMessage]

          Description: Represents a wrapper object for batch response

 

SendEmailV2

Summary: Send an email (V2)

Description: This operation sends an email message.

 

Syntax:

Office365Outlook.SendEmailV2 (ClientSendHtmlMessage emailMessage)

 

Parameters:

Name

Type

Summary

Required

Related Action

emailMessage

ClientSendHtmlMessage

 

Send HTML Email Message

True

 

Returns:

 

GetEmail

Summary: Get email

Description: This operation gets an email by id.

 

Syntax:

Office365Outlook.GetEmail (string messageId, [Optional]string mailboxAddress, [Optional]boolean includeAttachments)

 

Parameters:

Name

Type

Summary

Required

Related Action

messageId

string

(Message Id)

Id of the email.

True

mailboxAddress

string

(Original Mailbox Address)

Address of the shared mailbox to retrieve mail from.

False

includeAttachments

boolean

(Include Attachments)

If set to true, attachments will also be retrieved along with the email.

False

 

Returns:

          Type:ClientReceiveMessage

          Description: Receive Email Message

 

DeleteEmail

Summary: Delete email

Description: This operation deletes an email by id.

 

Syntax:

Office365Outlook.DeleteEmail (string messageId)

 

Parameters:

Name

Type

Summary

Required

Related Action

messageId

string

(Message Id)

Id of the email to delete.

True

 

Returns:

 

GetEmailV2

Summary: Get email (V2)

Description: This operation gets an email by id.

 

Syntax:

Office365Outlook.GetEmailV2 (string messageId, [Optional]string mailboxAddress, [Optional]boolean includeAttachments)

 

Parameters:

Name

Type

Summary

Required

Related Action

messageId

string

(Message Id)

Id of the email.

True

mailboxAddress

string

(Original Mailbox Address)

Address of the shared mailbox to retrieve mail from.

False

includeAttachments

boolean

(Include Attachments)

If set to true, attachments will also be retrieved along with the email.

False

 

Returns:

          Type:GraphClientReceiveMessage

          Description: Graph Client Receive Email Message

 

GetEmailsV3

Summary: Get emails (V3)

Description: This operation gets emails from a folder via graph apis. Please note that filtering related to these fields: To, Cc, To Or Cc, From, Importance, Fetch Only With Attachments, Subject Filter, is performed using first 250 items in a given mail folder. To avoid that limitation you can use 'Search Query' field.

 

Syntax:

Office365Outlook.GetEmailsV3 ([Optional]string folderPath, [Optional]string to, [advanced][Optional]string cc, [advanced][Optional]string toOrCc, [Optional]string from, [advanced][Optional]string importance, [advanced][Optional]boolean fetchOnlyWithAttachment, [advanced][Optional]string subjectFilter, [Optional]boolean fetchOnlyUnread, [internal][Optional]boolean fetchOnlyFlagged, [Optional]string mailboxAddress, [Optional]boolean includeAttachments, [Optional]string searchQuery, [Optional]integer top)

 

Parameters:

Name

Type

Summary

Required

Related Action

folderPath

string

(Folder)

Mail folder to retrieve emails from (default: 'Inbox').

False

to

string(email)

(To)

Recipient email addresses separated by semicolons (If any match, the trigger will run).

False

cc

string(email)

(CC)

CC recipient email addresses separated by semicolons (If any match, the trigger will run).

False

toOrCc

string(email)

(To or CC)

To or CC recipient email addresses separated by semicolons (If any match, the trigger will run).

False

from

string(email)

(From)

Sender email addresses separated by semicolons (If any match, the trigger will run).

False

importance

string

(Importance)Values: [Any, Low, Normal, High]

Importance of the email (Any, High, Normal, Low).

False

fetchOnlyWithAttachment

boolean

(Only with Attachments)

If set to true, only emails with an attachment will be retrieved. Emails without any attachments will be skipped. If set to false, all emails will be retrieved.

False

subjectFilter

string

(Subject Filter)

String to look for in the subject line.

False

fetchOnlyUnread

boolean

(Fetch Only Unread Messages)

Retrieve only unread emails?.

False

fetchOnlyFlagged

boolean

(Fetch Only Flagged Messages)

Retrieve only flagged emails?.

False

mailboxAddress

string

(Original Mailbox Address)

Address of the shared mailbox to retrieve mails from.

False

includeAttachments

boolean

(Include Attachments)

If set to true, attachments will also be retrieved along with the email.

False

searchQuery

string

(Search Query)

Search query to filter emails. How to use '$search' parameter please refer to: https://docs.microsoft.com/graph/query-parameters#search-parameter.

False

top

integer(int32)

(Top)

Number of emails to retrieve (default: 10).

False

 

Returns:

          Type:BatchResponse[GraphClientReceiveMessage]

          Description: Represents a wrapper object for batch response

 

Move

Summary: Move email

Description: This operation moves an email to the specified folder within the same mailbox.

 

Syntax:

Office365Outlook.Move (string messageId, string folderPath)

 

Parameters:

Name

Type

Summary

Required

Related Action

messageId

string

(Message Id)

Id of the email to be moved.

True

folderPath

string

(Folder)

Mail folder to move the email to.

True

 

Returns:

          Type:ClientReceiveMessageStringEnums

          Description: Receive Email Message

 

MoveV2

Summary: Move email (V2)

Description: This operation moves an email to the specified folder within the same mailbox.

 

Syntax:

Office365Outlook.MoveV2 (string messageId, string folderPath, [Optional]string mailboxAddress)

 

Parameters:

Name

Type

Summary

Required

Related Action

messageId

string

(Message Id)

Id of the email to be moved.

True

folderPath

string

(Folder)

Mail folder to move the email to.

True

mailboxAddress

string

(Original Mailbox Address)

Address of the shared mailbox to move mail from.

False

 

Returns:

          Type:GraphClientReceiveMessage

          Description: Graph Client Receive Email Message

 

Flag

Summary: Flag email

Description: This operation flags an email.

 

Syntax:

Office365Outlook.Flag (string messageId)

 

Parameters:

Name

Type

Summary

Required

Related Action

messageId

string

(Message Id)

Id of the email to be flagged.

True

 

Returns:

 

MarkAsRead

Summary: Mark as read

Description: This operation marks an email as having been read.

 

Syntax:

Office365Outlook.MarkAsRead (string messageId)

 

Parameters:

Name

Type

Summary

Required

Related Action

messageId

string

(Message Id)

Id of the email to be marked as read.

True

 

Returns:

 

ReplyTo

Summary: Reply to email

Description: This operation replies to an email.

 

Syntax:

Office365Outlook.ReplyTo (string messageId, string comment, [Optional]boolean replyAll)

 

Parameters:

Name

Type

Summary

Required

Related Action

messageId

string

(Message Id)

Id of the email to reply to.

True

comment

string

(Comment)

Reply comment.

True

replyAll

boolean

(Reply All)

Reply to all recipients.

False

 

Returns:

 

ReplyToV2

Summary: Reply to email (V2)

Description: This operation replies to an email.

 

Syntax:

Office365Outlook.ReplyToV2 (string messageId, ReplyMessage replyParameters, [Optional]string mailboxAddress)

 

Parameters:

Name

Type

Summary

Required

Related Action

messageId

string

(Message Id)

Id of the email to reply to.

True

replyParameters

ReplyMessage

 

Properties of an email reply message.

True

mailboxAddress

string

(Original Mailbox Address)

Address of the shared mailbox to reply from.

False

 

Returns:

 

ReplyToV3

Summary: Reply to email (V3)

Description: This operation replies to an email.

 

Syntax:

Office365Outlook.ReplyToV3 (string messageId, ReplyHtmlMessage replyParameters, [Optional]string mailboxAddress)

 

Parameters:

Name

Type

Summary

Required

Related Action

messageId

string

(Message Id)

Id of the email to reply to.

True

replyParameters

ReplyHtmlMessage

 

Properties of an HTML email reply message.

True

mailboxAddress

string

(Original Mailbox Address)

Address of the shared mailbox to reply from.

False

 

Returns:

 

GetAttachment

Summary: Get attachment

Description: This operation gets an email attachment by id.

 

Syntax:

Office365Outlook.GetAttachment (string messageId, string attachmentId)

 

Parameters:

Name

Type

Summary

Required

Related Action

messageId

string

(Message Id)

Id of the email.

True

attachmentId

string

(Attachment Id)

Id of the attachment to download.

True

 

Returns:

          Type:string(binary)

 

SetAutomaticRepliesSetting

Summary: Set up automatic replies

Description: Set the automatic replies setting for your mailbox.

 

Syntax:

Office365Outlook.SetAutomaticRepliesSetting (AutomaticRepliesSettingClient clientSetting)

 

Parameters:

Name

Type

Summary

Required

Related Action

clientSetting

AutomaticRepliesSettingClient

 

Automatic replies setting model for the connector

True

 

Returns:

 

GetMailTips

Summary: Get mail tips for a mailbox

Description: Get mail tips for a mailbox such as automatic replies / OOF message or if the mailbox is full.

 

Syntax:

Office365Outlook.GetMailTips (string mailboxAddress)

 

Parameters:

Name

Type

Summary

Required

Related Action

mailboxAddress

string

(Original Mailbox Address)

Address of the mailbox to get mail tips for.

True

 

Returns:

          Type:MailTipsClientReceive

          Description: Mail tips client model returned to the caller

 

CreateOnNewEmailPokeSubscription

Summary: Create a webhook subscription for the trigger when a new email arrives

Description: Create a webhook subscription for the trigger when a new email arrives.

 

Syntax:

Office365Outlook.CreateOnNewEmailPokeSubscription (ClientSubscription subscription, [Optional]string folderPath, [advanced][Optional]string importance, [advanced][Optional]boolean fetchOnlyWithAttachment)

 

Parameters:

Name

Type

Summary

Required

Related Action

subscription

ClientSubscription

 

Describes the subscription information.

True

folderPath

string

(Folder)

Mail folder to check for new emails.

False

importance

string

(Importance)Values: [Any, Low, Normal, High]

Importance of the email (Any, High, Normal, Low).

False

fetchOnlyWithAttachment

boolean

(Only with Attachments)

If set to true, only emails with an attachment will be retrieved. Emails without any attachments will be skipped. If set to false, all emails will be retrieved.

False

 

Returns:

          Type:SubscriptionResponse

          Description: Base response model that connector returns to LA engine

 

CreateGraphOnNewEmailPokeSubscription

Summary: Create a Graph webhook subscription for the trigger when a new email arrives

Description: Create a Graph webhook subscription for the trigger when a new email arrives.

 

Syntax:

Office365Outlook.CreateGraphOnNewEmailPokeSubscription (ClientSubscription subscription, [Optional]string folderPath, [advanced][Optional]string importance, [advanced][Optional]boolean fetchOnlyWithAttachment)

 

Parameters:

Name

Type

Summary

Required

Related Action

subscription

ClientSubscription

 

Describes the subscription information.

True

folderPath

string

(Folder)

Mail folder to check for new emails.

False

importance

string

(Importance)Values: [Any, Low, Normal, High]

Importance of the email (Any, High, Normal, Low).

False

fetchOnlyWithAttachment

boolean

(Only with Attachments)

If set to true, only emails with an attachment will be retrieved. Emails without any attachments will be skipped. If set to false, all emails will be retrieved.

False

 

Returns:

          Type:SubscriptionResponse

          Description: Base response model that connector returns to LA engine

 

CreateOnNewMentionMeEmailPokeSubscription

Summary: When a new mentioning me email arrives - Outlook subscription

Description: Create an Outlook webhook subscription for the trigger when a new mentioning me email arrives.

 

Syntax:

Office365Outlook.CreateOnNewMentionMeEmailPokeSubscription (ClientSubscription subscription, [Optional]string folderPath, [advanced][Optional]string importance, [advanced][Optional]boolean fetchOnlyWithAttachment)

 

Parameters:

Name

Type

Summary

Required

Related Action

subscription

ClientSubscription

 

Describes the subscription information.

True

folderPath

string

(Folder)

Mail folder to check for new emails.

False

importance

string

(Importance)Values: [Any, Low, Normal, High]

Importance of the email (Any, High, Normal, Low).

False

fetchOnlyWithAttachment

boolean

(Only with Attachments)

If set to true, only emails with an attachment will be retrieved. Emails without any attachments will be skipped. If set to false, all emails will be retrieved.

False

 

Returns:

          Type:SubscriptionResponse

          Description: Base response model that connector returns to LA engine

 

CreateGraphOnNewMentionMeEmailPokeSubscription

Summary: When a new mentioning me email arrives - Graph subscription

Description: Create a Graph webhook subscription for the trigger when a new mentioning me email arrives.

 

Syntax:

Office365Outlook.CreateGraphOnNewMentionMeEmailPokeSubscription (ClientSubscription subscription, [Optional]string folderPath, [advanced][Optional]string importance, [advanced][Optional]boolean fetchOnlyWithAttachment)

 

Parameters:

Name

Type

Summary

Required

Related Action

subscription

ClientSubscription

 

Describes the subscription information.

True

folderPath

string

(Folder)

Mail folder to check for new emails.

False

importance

string

(Importance)Values: [Any, Low, Normal, High]

Importance of the email (Any, High, Normal, Low).

False

fetchOnlyWithAttachment

boolean

(Only with Attachments)

If set to true, only emails with an attachment will be retrieved. Emails without any attachments will be skipped. If set to false, all emails will be retrieved.

False

 

Returns:

          Type:SubscriptionResponse

          Description: Base response model that connector returns to LA engine

 

CreateOnFlaggedEmailPokeSubscription

Summary: Create an Outlook webhook subscription for the trigger when an email is flagged

Description: Create an Outlook webhook subscription for the trigger when an email is flagged.

 

Syntax:

Office365Outlook.CreateOnFlaggedEmailPokeSubscription (ClientSubscription subscription, [Optional]string folderPath, [advanced][Optional]string importance, [advanced][Optional]boolean fetchOnlyWithAttachment)

 

Parameters:

Name

Type

Summary

Required

Related Action

subscription

ClientSubscription

 

Describes the subscription information.

True

folderPath

string

(Folder)

Mail folder to check for new emails.

False

importance

string

(Importance)Values: [Any, Low, Normal, High]

Importance of the email (Any, High, Normal, Low).

False

fetchOnlyWithAttachment

boolean

(Only with Attachments)

If set to true, only emails with an attachment will be retrieved. Emails without any attachments will be skipped. If set to false, all emails will be retrieved.

False

 

Returns:

          Type:SubscriptionResponse

          Description: Base response model that connector returns to LA engine

 

CreateGraphOnFlaggedEmailPokeSubscription

Summary: Create a Graph webhook subscription for the trigger when an email is flagged

Description: Create a Graph webhook subscription for the trigger when an email is flagged.

 

Syntax:

Office365Outlook.CreateGraphOnFlaggedEmailPokeSubscription (ClientSubscription subscription, [Optional]string folderPath, [advanced][Optional]string importance, [advanced][Optional]boolean fetchOnlyWithAttachment)

 

Parameters:

Name

Type

Summary

Required

Related Action

subscription

ClientSubscription

 

Describes the subscription information.

True

folderPath

string

(Folder)

Mail folder to check for new emails.

False

importance

string

(Importance)Values: [Any, Low, Normal, High]

Importance of the email (Any, High, Normal, Low).

False

fetchOnlyWithAttachment

boolean

(Only with Attachments)

If set to true, only emails with an attachment will be retrieved. Emails without any attachments will be skipped. If set to false, all emails will be retrieved.

False

 

Returns:

          Type:SubscriptionResponse

          Description: Base response model that connector returns to LA engine

 

DeleteOnNewEmailSubscription

Summary: Delete mail subscription

Description: This operation deletes a mail subscription.

 

Syntax:

Office365Outlook.DeleteOnNewEmailSubscription (string id, string options)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Id of subscription to be deleted)

Id of subscription to be deleted.

True

options

string

(Subscription options)

Subscription options.

True

 

Returns:

 

RenewOnNewEmailSubscription

Summary: Update web hook

Description: Update web hook with renew interval.

 

Syntax:

Office365Outlook.RenewOnNewEmailSubscription (string id, string options, ClientSubscription subscription)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Id of subscription to be renewed)

Id of subscription to be renewed.

True

options

string

(Subscription options)

Subscription options.

True

subscription

ClientSubscription

 

Describes the subscription information.

True

 

Returns:

 

GetDataSetsMetadata

Summary:

Description:

 

Syntax:

Office365Outlook.GetDataSetsMetadata ()

 

Returns:

          Type:DataSetsMetadata

          Description: Dataset metadata

 

SendMailWithOptions

Summary: Send email with options

Description: This operation sends an email with multiple options and waits for the recipient to respond back with one of the options. Please refer to the following link regarding the support of actionable messages in different mail clients: https://docs.microsoft.com/outlook/actionable-messages/#outlook-version-requirements-for-actionable-messages.

 

Syntax:

Office365Outlook.SendMailWithOptions (OptionsEmailSubscription optionsEmailSubscription)

 

Parameters:

Name

Type

Summary

Required

Related Action

optionsEmailSubscription

OptionsEmailSubscription

 

Model for Options Email Subscription

True

 

Returns:

          Type:SubscriptionResponse

          Description: Base response model that connector returns to LA engine

 

SendApprovalMail

Summary: Send approval email

Description: This operation sends an approval email and waits for a response from the recipient. Please refer to the following link regarding the support of actionable messages in different mail clients: https://docs.microsoft.com/outlook/actionable-messages/#outlook-version-requirements-for-actionable-messages.

 

Syntax:

Office365Outlook.SendApprovalMail (ApprovalEmailSubscription approvalEmailSubscription)

 

Parameters:

Name

Type

Summary

Required

Related Action

approvalEmailSubscription

ApprovalEmailSubscription

 

Model for Approval Email Subscription

True

 

Returns:

          Type:SubscriptionResponse

          Description: Base response model that connector returns to LA engine

 

DeleteApprovalMailSubscription

Summary: Delete approval email subscription

Description: This operation deletes a subscription of approval email.

 

Syntax:

Office365Outlook.DeleteApprovalMailSubscription (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Id of subscription to be deleted)

Id of subscription to be deleted.

True

 

Returns:

 

DeleteOptionsMailSubscription

Summary: Delete options email subscription

Description: This operation deletes a subscription of options email.

 

Syntax:

Office365Outlook.DeleteOptionsMailSubscription (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Id of subscription to be deleted)

Id of subscription to be deleted.

True

 

Returns:

 

SharedMailboxSendEmail

Summary: Send an email from a shared mailbox

Description: This operation sends an email from a shared mailbox. Your account should have permission to access the mailbox for this operation to succeed.

 

Syntax:

Office365Outlook.SharedMailboxSendEmail (SharedMailboxClientSendMessage emailMessage)

 

Parameters:

Name

Type

Summary

Required

Related Action

emailMessage

SharedMailboxClientSendMessage

 

Shared Mailbox Send Email Message

True

 

Returns:

 

SharedMailboxSendEmailV2

Summary: Send an email from a shared mailbox (V2)

Description: This operation sends an email from a shared mailbox. Your account should have permission to access the mailbox for this operation to succeed.

 

Syntax:

Office365Outlook.SharedMailboxSendEmailV2 (SharedMailboxClientSendHtmlMessage emailMessage)

 

Parameters:

Name

Type

Summary

Required

Related Action

emailMessage

SharedMailboxClientSendHtmlMessage

 

Shared Mailbox Send HTML Email Message

True

 

Returns:

 

TestConnection

Summary: Tests the connection

Description: Tests the connection.

 

Syntax:

Office365Outlook.TestConnection ()

 

Returns:

 

CalendarGetTables

Summary: Get calendars

Description: This operation lists available calendars.

 

Syntax:

Office365Outlook.CalendarGetTables ()

 

Returns:

          Type:EntityListResponse[Table]

          Description: Entity list response

 

CalendarGetItems

Summary: Get events (V1)

Description: This operation gets events from a calendar. (V1)

 

Syntax:

Office365Outlook.CalendarGetItems (string table, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip)

 

Parameters:

Name

Type

Summary

Required

Related Action

table

string

(Calendar id)

Select a calendar

True

CalendarGetTables

$orderby

string

(Order By)

An ODATA orderBy query for specifying the order of entries.

False

$top

integer(int32)

(Top Count)

Total number of entries to retrieve (default = all).

False

$skip

integer(int32)

(Skip Count)

The number of entries to skip (default = 0).

False

 

Returns:

          Type:EntityListResponse[CalendarEventBackend]

          Description: Entity list response

 

CalendarPostItem

Summary: Create event (V1)

Description: This operation creates a new event in a calendar. (V1)

 

Syntax:

Office365Outlook.CalendarPostItem (string table, CalendarEventBackend item)

 

Parameters:

Name

Type

Summary

Required

Related Action

table

string

(Calendar id)

Select a calendar

True

CalendarGetTables

item

CalendarEventBackend

 

Connector specific calendar event model class for the backend

True

 

Returns:

          Type:CalendarEventBackend

          Description: Connector specific calendar event model class for the backend

 

CalendarGetItem

Summary: Get event (V1)

Description: This operation gets a specific event from a calendar. (V1)

 

Syntax:

Office365Outlook.CalendarGetItem (string table, string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

table

string

(Calendar id)

Select a calendar

True

CalendarGetTables

id

string

(Item id)

Select an event

True

 

Returns:

          Type:CalendarEventBackend

          Description: Connector specific calendar event model class for the backend

 

CalendarDeleteItem

Summary: Delete event

Description: This operation deletes an event in a calendar.

 

Syntax:

Office365Outlook.CalendarDeleteItem (string table, string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

table

string

(Calendar id)

Select a calendar

True

CalendarGetTables

id

string

(Id)

Select an event

True

 

Returns:

 

CalendarPatchItem

Summary: Update event (V1)

Description: This operation updates an event in a calendar. (V1)

 

Syntax:

Office365Outlook.CalendarPatchItem (string table, string id, CalendarEventBackend item)

 

Parameters:

Name

Type

Summary

Required

Related Action

table

string

(Calendar id)

Select a calendar

True

CalendarGetTables

id

string

(Id)

Select an event

True

item

CalendarEventBackend

 

Connector specific calendar event model class for the backend

True

 

Returns:

          Type:CalendarEventBackend

          Description: Connector specific calendar event model class for the backend

 

V3CalendarGetItems

Summary: Get events (V3)

Description: This operation gets events from a calendar. (V3)

 

Syntax:

Office365Outlook.V3CalendarGetItems (string table, [advanced][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip)

 

Parameters:

Name

Type

Summary

Required

Related Action

table

string

(Calendar id)

Select a calendar

True

CalendarGetTables

$filter

string

(Filter Query)

An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123).

False

$orderby

string

(Order By)

An ODATA orderBy query for specifying the order of entries.

False

$top

integer(int32)

(Top Count)

Total number of entries to retrieve (default = all).

False

$skip

integer(int32)

(Skip Count)

The number of entries to skip (default = 0).

False

 

Returns:

          Type:CalendarEventListClientReceive

          Description: The list of calendar items

 

V3CalendarPostItem

Summary: Create event (V3)

Description: This operation creates a new event in a calendar.

 

Syntax:

Office365Outlook.V3CalendarPostItem (string table, CalendarEventHtmlClient item)

 

Parameters:

Name

Type

Summary

Required

Related Action

table

string

(Calendar id)

Select a calendar

True

CalendarGetTables

item

CalendarEventHtmlClient

 

Connector specific calendar event model class for the html client

True

 

Returns:

          Type:CalendarEventClientReceiveStringEnums

          Description: Connector specific calendar event model class for the client

 

V4CalendarGetItems

Summary: Get events (V4)

Description: This operation gets events from a calendar using Graph API. (V4)

 

Syntax:

Office365Outlook.V4CalendarGetItems (string table, [advanced][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip)

 

Parameters:

Name

Type

Summary

Required

Related Action

table

string

(Calendar id)

Select a calendar

True

CalendarGetTables_V2

$filter

string

(Filter Query)

An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123).

False

$orderby

string

(Order By)

An ODATA orderBy query for specifying the order of entries.

False

$top

integer(int32)

(Top Count)

Total number of entries to retrieve (default = all).

False

$skip

integer(int32)

(Skip Count)

The number of entries to skip (default = 0).

False

 

Returns:

          Type:GraphCalendarEventListClientReceive

          Description: The list of calendar items returned by Graph API

 

V4CalendarPostItem

Summary: Create event (V4)

Description: This operation creates a new event in a calendar.

 

Syntax:

Office365Outlook.V4CalendarPostItem (string table, GraphCalendarEventClient item)

 

Parameters:

Name

Type

Summary

Required

Related Action

table

string

(Calendar id)

Select a calendar

True

CalendarGetTables_V2

item

GraphCalendarEventClient

 

Connector specific calendar event model class for the client for graph API

True

 

Returns:

          Type:GraphCalendarEventClientReceive

          Description: Connector specific calendar event model class for the client with Graph API

 

V2CalendarGetItems

Summary: Get events (V2)

Description: This operation gets events from a calendar. (V2)

 

Syntax:

Office365Outlook.V2CalendarGetItems (string table, [advanced][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip)

 

Parameters:

Name

Type

Summary

Required

Related Action

table

string

(Calendar id)

Select a calendar

True

CalendarGetTables

$filter

string

(Filter Query)

An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123).

False

$orderby

string

(Order By)

An ODATA orderBy query for specifying the order of entries.

False

$top

integer(int32)

(Top Count)

Total number of entries to retrieve (default = all).

False

$skip

integer(int32)

(Skip Count)

The number of entries to skip (default = 0).

False

 

Returns:

          Type:EntityListResponse[CalendarEventClientReceiveStringEnums]

          Description: Entity list response

 

V2CalendarPostItem

Summary: Create event (V2)

Description: This operation creates a new event in a calendar. (V2)

 

Syntax:

Office365Outlook.V2CalendarPostItem (string table, CalendarEventClient item)

 

Parameters:

Name

Type

Summary

Required

Related Action

table

string

(Calendar id)

Select a calendar

True

CalendarGetTables

item

CalendarEventClient

 

Connector specific calendar event model class for the client

True

 

Returns:

          Type:CalendarEventClientReceiveStringEnums

          Description: Connector specific calendar event model class for the client

 

GetEventsCalendarViewV2

Summary: Get calendar view of events (V2)

Description: This operation gets all events (including instances of recurrences) in a calendar. Recurrence property is null in this case.

 

Syntax:

Office365Outlook.GetEventsCalendarViewV2 (string calendarId, string startDateTimeOffset, string endDateTimeOffset, [advanced][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip, [advanced][Optional]string search)

 

Parameters:

Name

Type

Summary

Required

Related Action

calendarId

string

(Calendar Id)

Select a calendar

True

CalendarGetTables

startDateTimeOffset

string

(Start Time)

Start time (example: '2017-01-01T08:00:00-07:00')

True

endDateTimeOffset

string

(End Time)

End time (example: '2017-02-01T08:00:00-07:00')

True

$filter

string

(Filter Query)

An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123).

False

$orderby

string

(Order By)

An ODATA orderBy query for specifying the order of entries.

False

$top

integer(int32)

(Top Count)

Total number of entries to retrieve (default = all).

False

$skip

integer(int32)

(Skip Count)

The number of entries to skip (default = 0).

False

search

string

(Search)

Search text for matching event body and subject

False

 

Returns:

          Type:EntityListResponse[CalendarEventClientReceiveStringEnums]

          Description: Entity list response

 

GetEventsCalendarViewV3

Summary: Get calendar view of events (V3)

Description: This operation gets all events (including instances of recurrences) in a calendar using Graph API. Recurrence property is null in this case.

 

Syntax:

Office365Outlook.GetEventsCalendarViewV3 (string calendarId, string startDateTimeUtc, string endDateTimeUtc, [advanced][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip, [advanced][Optional]string search)

 

Parameters:

Name

Type

Summary

Required

Related Action

calendarId

string

(Calendar Id)

Select a calendar

True

CalendarGetTables_V2

startDateTimeUtc

string

(Start Time)

Start time in UTC (example: '2017-01-01T08:00:00')

True

endDateTimeUtc

string

(End Time)

End time in UTC (example: '2017-02-01T08:00:00')

True

$filter

string

(Filter Query)

An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123).

False

$orderby

string

(Order By)

An ODATA orderBy query for specifying the order of entries.

False

$top

integer(int32)

(Top Count)

Total number of entries to retrieve (default = all).

False

$skip

integer(int32)

(Skip Count)

The number of entries to skip (default = 0).

False

search

string

(Search)

Search text for matching event body and subject

False

 

Returns:

          Type:EntityListResponse[GraphCalendarEventClientReceive]

          Description: Entity list response

 

V2CalendarGetItem

Summary: Get event (V2)

Description: This operation gets a specific event from a calendar. (V2)

 

Syntax:

Office365Outlook.V2CalendarGetItem (string table, string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

table

string

(Calendar id)

Select a calendar

True

CalendarGetTables

id

string

(Item id)

Select an event

True

 

Returns:

          Type:CalendarEventClientReceiveStringEnums

          Description: Connector specific calendar event model class for the client

 

V2CalendarPatchItem

Summary: Update event (V2)

Description: This operation updates an event in a calendar. (V2)

 

Syntax:

Office365Outlook.V2CalendarPatchItem (string table, string id, CalendarEventClient item)

 

Parameters:

Name

Type

Summary

Required

Related Action

table

string

(Calendar id)

Select a calendar

True

CalendarGetTables

id

string

(Id)

Select an event

True

item

CalendarEventClient

 

Connector specific calendar event model class for the client

True

 

Returns:

          Type:CalendarEventClientReceiveStringEnums

          Description: Connector specific calendar event model class for the client

 

V3CalendarGetItem

Summary: Get event (V3)

Description: This operation gets a specific event from a calendar using Graph API. (V3)

 

Syntax:

Office365Outlook.V3CalendarGetItem (string table, string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

table

string

(Calendar id)

Select a calendar

True

CalendarGetTables_V2

id

string

(Item id)

Select an event

True

 

Returns:

          Type:GraphCalendarEventClientReceive

          Description: Connector specific calendar event model class for the client with Graph API

 

V3CalendarPatchItem

Summary: Update event (V3)

Description: This operation updates an event in a calendar.

 

Syntax:

Office365Outlook.V3CalendarPatchItem (string table, string id, CalendarEventHtmlClient item)

 

Parameters:

Name

Type

Summary

Required

Related Action

table

string

(Calendar id)

Select a calendar

True

CalendarGetTables

id

string

(Id)

Select an event

True

item

CalendarEventHtmlClient

 

Connector specific calendar event model class for the html client

True

 

Returns:

          Type:CalendarEventClientReceiveStringEnums

          Description: Connector specific calendar event model class for the client

 

V4CalendarPatchItem

Summary: Update event (V4)

Description: This operation updates an event in a calendar using Graph API.

 

Syntax:

Office365Outlook.V4CalendarPatchItem (string table, string id, GraphCalendarEventClient item)

 

Parameters:

Name

Type

Summary

Required

Related Action

table

string

(Calendar id)

Select a calendar

True

CalendarGetTables_V2

id

string

(Id)

Select an event

True

item

GraphCalendarEventClient

 

Connector specific calendar event model class for the client for graph API

True

 

Returns:

          Type:GraphCalendarEventClientReceive

          Description: Connector specific calendar event model class for the client with Graph API

 

ContactGetTables

Summary: Get contact folders

Description: This operation lists available contacts folders.

 

Syntax:

Office365Outlook.ContactGetTables ()

 

Returns:

          Type:EntityListResponse[Table]

          Description: Entity list response

 

ContactGetTablesV2

Summary: Get contact folders (V2)

Description: This operation lists available contacts folders using Graph API

 

Syntax:

Office365Outlook.ContactGetTablesV2 ()

 

Returns:

          Type:EntityListResponse[GraphContactFolder]

          Description: Entity list response

 

ContactGetItems

Summary: Get contacts

Description: This operation gets contacts from a contacts folder.

 

Syntax:

Office365Outlook.ContactGetItems (string table, [advanced][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip)

 

Parameters:

Name

Type

Summary

Required

Related Action

table

string

(Folder id)

Unique identifier of the contacts folder to retrieve

True

ContactGetTables

$filter

string

(Filter Query)

An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123).

False

$orderby

string

(Order By)

An ODATA orderBy query for specifying the order of entries.

False

$top

integer(int32)

(Top Count)

Total number of entries to retrieve (default = all).

False

$skip

integer(int32)

(Skip Count)

The number of entries to skip (default = 0).

False

 

Returns:

          Type:EntityListResponse[ContactResponse]

          Description: Entity list response

 

ContactPostItem

Summary: Create contact

Description: This operation creates a new contact in a contacts folder.

 

Syntax:

Office365Outlook.ContactPostItem (string table, Contact item)

 

Parameters:

Name

Type

Summary

Required

Related Action

table

string

(Folder id)

Select a contacts folder

True

ContactGetTables

item

Contact

 

Contact

True

 

Returns:

          Type:ContactResponse

          Description: Contact response

 

ContactGetItem

Summary: Get contact

Description: This operation gets a specific contact from a contacts folder.

 

Syntax:

Office365Outlook.ContactGetItem (string table, string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

table

string

(Folder id)

Select a contacts folder

True

ContactGetTables

id

string

(Item id)

Unique identifier of a contact to retrieve

True

 

Returns:

          Type:ContactResponse

          Description: Contact response

 

ContactDeleteItem

Summary: Delete contact

Description: This operation deletes a contact from a contacts folder.

 

Syntax:

Office365Outlook.ContactDeleteItem (string table, string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

table

string

(Folder id)

Select a contacts folder

True

ContactGetTables

id

string

(Id)

Unique identifier of contact to delete

True

 

Returns:

 

ContactPatchItem

Summary: Update contact

Description: This operation updates a contact in a contacts folder.

 

Syntax:

Office365Outlook.ContactPatchItem (string table, string id, Contact item)

 

Parameters:

Name

Type

Summary

Required

Related Action

table

string

(Folder id)

Select a contacts folder

True

ContactGetTables

id

string

(Id)

Unique identifier of contact to update

True

item

Contact

 

Contact

True

 

Returns:

          Type:ContactResponse

          Description: Contact response

 

GetDataSets

Summary: Get datasets

Description: This operation gets Contacts or Calendars

 

Syntax:

Office365Outlook.GetDataSets ()

 

Returns:

          Type:DataSetsList

          Description: List of datasets

 

ExportEmail

Summary: Export email

Description: Export the content of the email.

 

Syntax:

Office365Outlook.ExportEmail (string messageId)

 

Parameters:

Name

Type

Summary

Required

Related Action

messageId

string

(Message Id)

Id of the email to export.

True

 

Returns:

          Type:string(binary)

 

ExportEmail_V2

Summary: Export email (V2)

Description: Export the content of the email.

 

Syntax:

Office365Outlook.ExportEmail_V2 (string messageId, [Optional]string mailboxAddress)

 

Parameters:

Name

Type

Summary

Required

Related Action

messageId

string

(Message Id)

Id of the email to export.

True

mailboxAddress

string

(Original Mailbox Address)

Address of the shared mailbox to export from.

False

 

Returns:

          Type:string(binary)

 

Flag_V2

Summary: Flag email (V2)

Description: This operation updates an email flag.

 

Syntax:

Office365Outlook.Flag_V2 (string messageId, [Optional]string mailboxAddress, [Optional]UpdateEmailFlag body)

 

Parameters:

Name

Type

Summary

Required

Related Action

messageId

string

(Message Id)

Id of the email to be flagged.

True

mailboxAddress

string

(Original Mailbox Address)

Address of the shared mailbox to update mail.

False

body

UpdateEmailFlag

 

Update email flag body

False

 

Returns:

 

MarkAsRead_V2

Summary: Mark as read or unread (V2)

Description: This operation marks an email as read/unread.

 

Syntax:

Office365Outlook.MarkAsRead_V2 (string messageId, [Optional]string mailboxAddress, [Optional]MarkAsRead_V2ParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

messageId

string

(Message Id)

Id of the email to be marked.

True

mailboxAddress

string

(Original Mailbox Address)

Address of the shared mailbox to update mail.

False

body

MarkAsRead_V2ParameterBody

 

 

False

 

Returns:

 

MarkAsRead_V3

Summary: Mark as read or unread (V3)

Description: This operation marks an email as read/unread.

 

Syntax:

Office365Outlook.MarkAsRead_V3 (string messageId, [Optional]string mailboxAddress, [Optional]MarkAsRead_V3ParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

messageId

string

(Message Id)

Id of the email to be marked.

True

mailboxAddress

string

(Original Mailbox Address)

Address of the shared mailbox to update mail.

False

body

MarkAsRead_V3ParameterBody

 

 

False

 

Returns:

 

DeleteEmail_V2

Summary: Delete email (V2)

Description: This operation deletes an email by id.

 

Syntax:

Office365Outlook.DeleteEmail_V2 (string messageId, [Optional]string mailboxAddress)

 

Parameters:

Name

Type

Summary

Required

Related Action

messageId

string

(Message Id)

Id of the email to delete.

True

mailboxAddress

string

(Original Mailbox Address)

Address of the shared mailbox to delete mail from.

False

 

Returns:

 

GetAttachment_V2

Summary: Get Attachment (V2)

Description: This operation gets an email attachment by id.

 

Syntax:

Office365Outlook.GetAttachment_V2 (string messageId, string attachmentId, [Optional]string mailboxAddress)

 

Parameters:

Name

Type

Summary

Required

Related Action

messageId

string

(Message Id)

Id of the email.

True

attachmentId

string

(Attachement Id)

Id of the attachment to download.

True

mailboxAddress

string

(Original Mailbox Address)

Address of the shared mailbox to retrieve attachment from.

False

 

Returns:

          Type:GetAttachment_V2Response

 

RespondToEvent

Summary: Respond to an event invite

Description: Respond to an event invite.

 

Syntax:

Office365Outlook.RespondToEvent (string event_id, string response, [Optional]ResponseToEventInvite body)

 

Parameters:

Name

Type

Summary

Required

Related Action

event_id

string

(Event Id)

Id of the event to respond to.

True

response

string

(Response)Values: [Accept, Tentatively Accept, Decline]

Response for the event invite

True

body

ResponseToEventInvite

 

Response to an event invite

False

 

Returns:

 

RespondToEvent_V2

Summary: Respond to an event invite (V2)

Description: Respond to an event invite.

 

Syntax:

Office365Outlook.RespondToEvent_V2 (string event_id, string response, [Optional]ResponseToEventInvite body)

 

Parameters:

Name

Type

Summary

Required

Related Action

event_id

string

(Event Id)

Id of the event to respond to.

True

response

string

(Response)Values: [accept, tentativelyAccept, decline]

Response for the event invite

True

body

ResponseToEventInvite

 

Response to an event invite

False

 

Returns:

 

ForwardEmail

Summary: Forward an email

Description: Forward an email.

 

Syntax:

Office365Outlook.ForwardEmail (string message_id, DirectForwardMessage body)

 

Parameters:

Name

Type

Summary

Required

Related Action

message_id

string

(Message Id)

Id of the message to forward.

True

body

DirectForwardMessage

 

Directly forward message

True

 

Returns:

 

ForwardEmail_V2

Summary: Forward an email (V2)

Description: Forward an email.

 

Syntax:

Office365Outlook.ForwardEmail_V2 (string message_id, [Optional]string mailboxAddress, DirectForwardMessage body)

 

Parameters:

Name

Type

Summary

Required

Related Action

message_id

string

(Message Id)

Id of the message to forward.

True

mailboxAddress

string

(Original Mailbox Address)

Address of the shared mailbox to forward mail from.

False

body

DirectForwardMessage

 

Directly forward message

True

 

Returns:

 

GetRoomLists

Summary: Get room lists

Description: Get all the room lists defined in the user's tenant

 

Syntax:

Office365Outlook.GetRoomLists ()

 

Returns:

          Type:GetRoomListsResponse

 

GetRoomLists_V2

Summary: Get room lists (V2)

Description: Get all the room lists defined in the user's tenant

 

Syntax:

Office365Outlook.GetRoomLists_V2 ()

 

Returns:

          Type:GetRoomLists_V2Response

 

GetRooms

Summary: Get rooms

Description: Get all the meeting rooms defined in the user's tenant

 

Syntax:

Office365Outlook.GetRooms ()

 

Returns:

          Type:GetRoomsResponse

 

GetRooms_V2

Summary: Get rooms (V2)

Description: Get all the meeting rooms defined in the user's tenant

 

Syntax:

Office365Outlook.GetRooms_V2 ()

 

Returns:

          Type:GetRooms_V2Response

 

GetRoomsInRoomList

Summary: Get rooms in room list

Description: Get the meeting rooms in a specific room list

 

Syntax:

Office365Outlook.GetRoomsInRoomList (string room_list)

 

Parameters:

Name

Type

Summary

Required

Related Action

room_list

string

(Room list)

Room list to find rooms in

True

GetRoomLists_V2

 

Returns:

          Type:GetRoomsInRoomListResponse

 

GetRoomsInRoomList_V2

Summary: Get rooms in room list (V2)

Description: Get the meeting rooms in a specific room list

 

Syntax:

Office365Outlook.GetRoomsInRoomList_V2 (string room_list)

 

Parameters:

Name

Type

Summary

Required

Related Action

room_list

string

(Room list)

Room list to find rooms in

True

GetRoomLists_V2

 

Returns:

          Type:GetRoomsInRoomList_V2Response

 

FindMeetingTimes

Summary: Find meeting times

Description: Find meeting time suggestions based on organizer, attendee availability, and time or location constraints

 

Syntax:

Office365Outlook.FindMeetingTimes (FindMeetingTimesParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

FindMeetingTimesParameterBody

 

 

True

 

Returns:

          Type:FindMeetingTimesResponse

 

FindMeetingTimes_V2

Summary: Find meeting times (V2)

Description: Find meeting time suggestions based on organizer, attendee availability, and time or location constraints

 

Syntax:

Office365Outlook.FindMeetingTimes_V2 (FindMeetingTimes_V2ParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

FindMeetingTimes_V2ParameterBody

 

 

True

 

Returns:

          Type:FindMeetingTimes_V2Response

 

SetAutomaticRepliesSetting_V2

Summary: Set up automatic replies (V2)

Description: Set the automatic replies setting for your mailbox.

 

Syntax:

Office365Outlook.SetAutomaticRepliesSetting_V2 (SetAutomaticRepliesSetting_V2ParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

SetAutomaticRepliesSetting_V2ParameterBody

 

 

True

 

Returns:

          Type:SetAutomaticRepliesSetting_V2Response

 

GetMailTips_V2

Summary: Get mail tips for a mailbox (V2)

Description: Get mail tips for a mailbox such as automatic replies / OOF message or if the mailbox is full. This is not available in GccHigh.

 

Syntax:

Office365Outlook.GetMailTips_V2 (GetMailTips_V2ParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

GetMailTips_V2ParameterBody

 

 

True

 

Returns:

          Type:GetMailTips_V2Response

 

CalendarGetTables_V2

Summary: Get calendars (V2)

Description: This operation lists available calendars.

 

Syntax:

Office365Outlook.CalendarGetTables_V2 ([internal][Optional]integer skip, [internal][Optional]integer top, [internal][Optional]string orderBy)

 

Parameters:

Name

Type

Summary

Required

Related Action

skip

integer(int32)

(Skip)

Number of calendars to skip.

False

top

integer(int32)

(Top)

Calendar page size.

False

orderBy

string

(Order By)

Orders calendars.

False

 

Returns:

          Type:CalendarGetTables_V2Response

 

CalendarDeleteItem_V2

Summary: Delete event (V2)

Description: This operation deletes an event in a calendar.

 

Syntax:

Office365Outlook.CalendarDeleteItem_V2 (string calendar, string event)

 

Parameters:

Name

Type

Summary

Required

Related Action

calendar

string

(Calendar id)

Select a calendar

True

CalendarGetTables_V2

event

string

(Id)

Select an event

True

 

Returns:

 

ContactGetItem_V2

Summary: Get contact (V2)

Description: This operation gets a specific contact from a contacts folder.

 

Syntax:

Office365Outlook.ContactGetItem_V2 (string folder, string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

folder

string

(Folder id)

Select a contacts folder

True

ContactGetTablesV2

id

string

(Item id)

Unique identifier of a contact to retrieve

True

 

Returns:

          Type:ContactResponse_V2

          Description: Contact

 

ContactDeleteItem_V2

Summary: Delete contact (V2)

Description: This operation deletes a contact from a contacts folder.

 

Syntax:

Office365Outlook.ContactDeleteItem_V2 (string folder, string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

folder

string

(Folder id)

Select a contacts folder

True

ContactGetTablesV2

id

string

(Id)

Unique identifier of contact to delete

True

 

Returns:

 

ContactPatchItem_V2

Summary: Update contact (V2)

Description: This operation updates a contact in a contacts folder.

 

Syntax:

Office365Outlook.ContactPatchItem_V2 (string folder, string id, Contact_V2 item)

 

Parameters:

Name

Type

Summary

Required

Related Action

folder

string

(Folder id)

Select a contacts folder

True

ContactGetTablesV2

id

string

(Id)

Unique identifier of contact to update

True

item

Contact_V2

 

Contact

True

 

Returns:

          Type:ContactResponse_V2

          Description: Contact

 

ContactGetItems_V2

Summary: Get contacts (V2)

Description: This operation gets contacts from a contacts folder.

 

Syntax:

Office365Outlook.ContactGetItems_V2 (string folder, [advanced][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip)

 

Parameters:

Name

Type

Summary

Required

Related Action

folder

string

(Folder id)

Unique identifier of the contacts folder to retrieve

True

ContactGetTablesV2

$filter

string

(Filter Query)

An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123).

False

$orderby

string

(Order By)

An ODATA orderBy query for specifying the order of entries.

False

$top

integer(int32)

(Top Count)

Total number of entries to retrieve (default = all).

False

$skip

integer(int32)

(Skip Count)

The number of entries to skip (default = 0).

False

 

Returns:

          Type:EntityListResponse[ContactResponse]_V2

          Description: Entity list response

 

ContactPostItem_V2

Summary: Create contact (V2)

Description: This operation creates a new contact in a contacts folder.

 

Syntax:

Office365Outlook.ContactPostItem_V2 (string folder, Contact_V2 item)

 

Parameters:

Name

Type

Summary

Required

Related Action

folder

string

(Folder id)

Select a contacts folder

True

ContactGetTablesV2

item

Contact_V2

 

Contact

True

 

Returns:

          Type:ContactResponse_V2

          Description: Contact

 

UpdateMyContactPhoto

Summary: Update my contact's photo

Description: Updates the photo of the specified contact of the current user. The size of the photo must be less than 4 MB.

 

Syntax:

Office365Outlook.UpdateMyContactPhoto (string folder, string id, string body, [internal][Optional]string Content-Type)

 

Parameters:

Name

Type

Summary

Required

Related Action

folder

string

(Folder id)

Select a contacts folder

True

ContactGetTablesV2

id

string

(Item id)

Unique identifier of a contact to update photo

True

body

string(binary)

 

 

True

Content-Type

string

(Content-Type)

Image content type (like 'image/jpeg')

False

 

Returns:

 

ReceiveResponseGet

Summary: Receives response from user

Description: This operation gets a response from the user.

 

Syntax:

Office365Outlook.ReceiveResponseGet (string state, [Optional]string sig, [Optional]boolean showConfirm)

 

Parameters:

Name

Type

Summary

Required

Related Action

state

string

(callback state)

callback state.

True

sig

string

 

 

False

showConfirm

boolean

(showConfirm query parameter, if true, then confirmation page will be returned)

showConfirm query parameter, if true, then confirmation page will be returned.

False

 

Returns:

          Type:string

 

ReceiveResponsePost

Summary: Receives response from user

Description: This operation gets a response from the user.

 

Syntax:

Office365Outlook.ReceiveResponsePost (string state, [Optional]string sig, [Optional]boolean fromConfirm)

 

Parameters:

Name

Type

Summary

Required

Related Action

state

string

(callback state)

callback state.

True

sig

string

 

 

False

fromConfirm

boolean

(fromConfirm query parameter, if true, then request is from confirmation page)

fromConfirm query parameter, if true, then request is from confirmation page.

False

 

Returns:

          Type:string

 

ReceiveMailFromSubscription

Summary: Receive mail

Description: This operation validates the subscription request.

 

Syntax:

Office365Outlook.ReceiveMailFromSubscription (string state, SubscriptionPayload[OutlookReceiveMessage] subscriptionPayload, [Optional]string validationtoken)

 

Parameters:

Name

Type

Summary

Required

Related Action

state

string

(Callback state)

Callback state.

True

subscriptionPayload

SubscriptionPayload[OutlookReceiveMessage]

 

Payload from backend containing subscription metadata as well as data

True

validationtoken

string

(Validation token)

Validation token.

False

 

Returns:

 

ReceiveMailFromSubscriptionV2

Summary: Receive mail (V2)

Description: This operation validates the subscription request.

 

Syntax:

Office365Outlook.ReceiveMailFromSubscriptionV2 (string state, SubscriptionPayload[OutlookReceiveMessage] subscriptionPayload, [Optional]string validationtoken, string subscribedConnectionId)

 

Parameters:

Name

Type

Summary

Required

Related Action

state

string

(Callback state)

Callback state.

True

subscriptionPayload

SubscriptionPayload[OutlookReceiveMessage]

 

Payload from backend containing subscription metadata as well as data

True

validationtoken

string

(Validation token)

Validation token.

False

subscribedConnectionId

string

 

 

True

 

Returns:

 

ReceiveEventFromSubscription

Summary: Receive event

Description: This operation validates the subscription request.

 

Syntax:

Office365Outlook.ReceiveEventFromSubscription (string state, SubscriptionPayload[SubscriptionEvent] subscriptionPayload, [Optional]string validationtoken)

 

Parameters:

Name

Type

Summary

Required

Related Action

state

string

(Callback state)

Callback state.

True

subscriptionPayload

SubscriptionPayload[SubscriptionEvent]

 

Payload from backend containing subscription metadata as well as data

True

validationtoken

string

(Validation token)

Validation token.

False

 

Returns:

 

ReceiveEventFromSubscriptionV2

Summary: Receive event (V2)

Description: This operation validates the subscription request.

 

Syntax:

Office365Outlook.ReceiveEventFromSubscriptionV2 (string state, SubscriptionPayload[SubscriptionEvent] subscriptionPayload, [Optional]string validationtoken, string subscribedConnectionId)

 

Parameters:

Name

Type

Summary

Required

Related Action

state

string

(Callback state)

Callback state.

True

subscriptionPayload

SubscriptionPayload[SubscriptionEvent]

 

Payload from backend containing subscription metadata as well as data

True

validationtoken

string

(Validation token)

Validation token.

False

subscribedConnectionId

string

 

 

True

 

Returns:

 

Triggers:

Trigger OnUpcomingEvents

Summary: When an upcoming event is starting soon

Description: This operation triggers a flow when an upcoming calendar event is starting.

 

Syntax:

Office365Outlook.OnUpcomingEvents (string table, [advanced][Optional]integer lookAheadTimeInMinutes)

 

Parameters:

Name

Type

Summary

Required

Related Action

table

string

(Calendar Id)

Unique identifier of the calendar.

True

CalendarGetTables

lookAheadTimeInMinutes

integer(int32)

(Look-Ahead Time)

Time (in minutes) to look ahead for upcoming events.

False

 

Returns:

          Type:CalendarEventList

          Description: The list of calendar items

 

Trigger OnUpcomingEventsV2

Summary: When an upcoming event is starting soon (V2)

Description: This operation triggers a flow when an upcoming calendar event is starting.

 

Syntax:

Office365Outlook.OnUpcomingEventsV2 (string table, [advanced][Optional]integer lookAheadTimeInMinutes)

 

Parameters:

Name

Type

Summary

Required

Related Action

table

string

(Calendar Id)

Unique identifier of the calendar.

True

CalendarGetTables

lookAheadTimeInMinutes

integer(int32)

(Look-Ahead Time)

Time (in minutes) to look ahead for upcoming events.

False

 

Returns:

          Type:CalendarEventListClientReceive

          Description: The list of calendar items

 

Trigger OnUpcomingEventsV3

Summary: When an upcoming event is starting soon (V3)

Description: This operation triggers a flow when an upcoming calendar event is starting.

 

Syntax:

Office365Outlook.OnUpcomingEventsV3 (string table, [advanced][Optional]integer lookAheadTimeInMinutes)

 

Parameters:

Name

Type

Summary

Required

Related Action

table

string

(Calendar Id)

Unique identifier of the calendar.

True

CalendarGetTables_V2

lookAheadTimeInMinutes

integer(int32)

(Look-Ahead Time)

Time (in minutes) to look ahead for upcoming events.

False

 

Returns:

          Type:GraphCalendarEventListClientReceive

          Description: The list of calendar items returned by Graph API

 

Trigger OnNewEmail

Summary: When a new email arrives

Description: This operation triggers a flow when a new email arrives. It will skip any email that has a total message size greater than the limit put by your Exchange Admin or 50 MB, whichever is less. It may also skip protected emails and emails with invalid body or attachments.

 

Syntax:

Office365Outlook.OnNewEmail ([Optional]string folderPath, [advanced][Optional]string to, [advanced][Optional]string cc, [advanced][Optional]string toOrCc, [advanced][Optional]string from, [advanced][Optional]string importance, [advanced][Optional]boolean fetchOnlyWithAttachment, [advanced][Optional]boolean includeAttachments, [advanced][Optional]string subjectFilter, [internal][Optional]string x-ms-operation-context)

 

Parameters:

Name

Type

Summary

Required

Related Action

folderPath

string

(Folder)

Mail folder to check for new emails.

False

to

string(email)

(To)

Recipient email addresses separated by semicolons (If any match, the trigger will run).

False

cc

string(email)

(CC)

CC recipient email addresses separated by semicolons (If any match, the trigger will run).

False

toOrCc

string(email)

(To or CC)

To or CC recipient email addresses separated by semicolons (If any match, the trigger will run).

False

from

string(email)

(From)

Sender email addresses separated by semicolons (If any match, the trigger will run).

False

importance

string

(Importance)Values: [Any, Low, Normal, High]

Importance of the email (Any, High, Normal, Low).

False

fetchOnlyWithAttachment

boolean

(Only with Attachments)

If set to true, only emails with an attachment will be retrieved. Emails without any attachments will be skipped. If set to false, all emails will be retrieved.

False

includeAttachments

boolean

(Include Attachments)

Should the response of the trigger include the attachments.

False

subjectFilter

string

(Subject Filter)

String to look for in the subject line.

False

x-ms-operation-context

string

(x-ms-operation-context)

Special header to enable operation simulation.

False

 

Returns:

          Type:TriggerBatchResponse[ClientReceiveMessage]

          Description: Represents a wrapper object for batch trigger response

 

Trigger OnNewEmailV2

Summary: When a new email arrives (V2)

Description: This operation triggers a flow when a new email arrives. It will skip any email that has a total message size greater than the limit put by your Exchange Admin or 50 MB, whichever is less. It may also skip protected emails and emails with invalid body or attachments.

 

Syntax:

Office365Outlook.OnNewEmailV2 ([Optional]string folderPath, [advanced][Optional]string to, [advanced][Optional]string cc, [advanced][Optional]string toOrCc, [advanced][Optional]string from, [advanced][Optional]string importance, [advanced][Optional]boolean fetchOnlyWithAttachment, [advanced][Optional]boolean includeAttachments, [advanced][Optional]string subjectFilter, [internal][Optional]string x-ms-operation-context)

 

Parameters:

Name

Type

Summary

Required

Related Action

folderPath

string

(Folder)

Mail folder to check for new emails.

False

to

string(email)

(To)

Recipient email addresses separated by semicolons (If any match, the trigger will run).

False

cc

string(email)

(CC)

CC recipient email addresses separated by semicolons (If any match, the trigger will run).

False

toOrCc

string(email)

(To or CC)

To or CC recipient email addresses separated by semicolons (If any match, the trigger will run).

False

from

string(email)

(From)

Sender email addresses separated by semicolons (If any match, the trigger will run).

False

importance

string

(Importance)Values: [Any, Low, Normal, High]

Importance of the email (Any, High, Normal, Low).

False

fetchOnlyWithAttachment

boolean

(Only with Attachments)

If set to true, only emails with an attachment will be retrieved. Emails without any attachments will be skipped. If set to false, all emails will be retrieved.

False

includeAttachments

boolean

(Include Attachments)

Should the response of the trigger include the attachments.

False

subjectFilter

string

(Subject Filter)

String to look for in the subject line.

False

x-ms-operation-context

string

(x-ms-operation-context)

Special header to enable operation simulation.

False

 

Returns:

          Type:TriggerBatchResponse[GraphClientReceiveMessage]

          Description: Represents a wrapper object for batch trigger response

 

Trigger OnNewEmailV3

Summary: When a new email arrives (V3)

Description: This operation triggers a flow when a new email arrives. It will skip any email that has a total message size greater than the limit put by your Exchange Admin or 50 MB, whichever is less. It may also skip protected emails and emails with invalid body or attachments.

 

Syntax:

Office365Outlook.OnNewEmailV3 ([Optional]string folderPath, [advanced][Optional]string to, [advanced][Optional]string cc, [advanced][Optional]string toOrCc, [advanced][Optional]string from, [advanced][Optional]string importance, [advanced][Optional]boolean fetchOnlyWithAttachment, [advanced][Optional]boolean includeAttachments, [advanced][Optional]string subjectFilter, [internal][Optional]string x-ms-operation-context)

 

Parameters:

Name

Type

Summary

Required

Related Action

folderPath

string

(Folder)

Mail folder to check for new emails.

False

to

string(email)

(To)

Recipient email addresses separated by semicolons (If any match, the trigger will run).

False

cc

string(email)

(CC)

CC recipient email addresses separated by semicolons (If any match, the trigger will run).

False

toOrCc

string(email)

(To or CC)

To or CC recipient email addresses separated by semicolons (If any match, the trigger will run).

False

from

string(email)

(From)

Sender email addresses separated by semicolons (If any match, the trigger will run).

False

importance

string

(Importance)Values: [Any, Low, Normal, High]

Importance of the email (Any, High, Normal, Low).

False

fetchOnlyWithAttachment

boolean

(Only with Attachments)

If set to true, only emails with an attachment will be retrieved. Emails without any attachments will be skipped. If set to false, all emails will be retrieved.

False

includeAttachments

boolean

(Include Attachments)

Should the response of the trigger include the attachments.

False

subjectFilter

string

(Subject Filter)

String to look for in the subject line.

False

x-ms-operation-context

string

(x-ms-operation-context)

Special header to enable operation simulation.

False

 

Returns:

          Type:TriggerBatchResponse[GraphClientReceiveMessage]

          Description: Represents a wrapper object for batch trigger response

 

Trigger OnFlaggedEmail

Summary: When an email is flagged

Description: This operation triggers a flow when an email is flagged.

 

Syntax:

Office365Outlook.OnFlaggedEmail ([Optional]string folderPath, [advanced][Optional]string to, [advanced][Optional]string cc, [advanced][Optional]string toOrCc, [advanced][Optional]string from, [advanced][Optional]string importance, [advanced][Optional]boolean fetchOnlyWithAttachment, [advanced][Optional]boolean includeAttachments, [advanced][Optional]string subjectFilter, [internal][Optional]string x-ms-operation-context)

 

Parameters:

Name

Type

Summary

Required

Related Action

folderPath

string

(Folder)

Mail folder to check for new emails.

False

to

string(email)

(To)

Recipient email addresses separated by semicolons (If any match, the trigger will run).

False

cc

string(email)

(CC)

CC recipient email addresses separated by semicolons (If any match, the trigger will run).

False

toOrCc

string(email)

(To or CC)

To or CC recipient email addresses separated by semicolons (If any match, the trigger will run).

False

from

string(email)

(From)

Sender email addresses separated by semicolons (If any match, the trigger will run).

False

importance

string

(Importance)Values: [Any, Low, Normal, High]

Importance of the email (Any, High, Normal, Low).

False

fetchOnlyWithAttachment

boolean

(Only with Attachments)

If set to true, only emails with an attachment will be retrieved. Emails without any attachments will be skipped. If set to false, all emails will be retrieved.

False

includeAttachments

boolean

(Include Attachments)

Should the response of the trigger include the attachments.

False

subjectFilter

string

(Subject Filter)

String to look for in the subject line.

False

x-ms-operation-context

string

(x-ms-operation-context)

Special header to enable operation simulation.

False

 

Returns:

          Type:TriggerBatchResponse[ClientReceiveMessage]

          Description: Represents a wrapper object for batch trigger response

 

Trigger OnFlaggedEmailV2

Summary: When an email is flagged (V2)

Description: This operation triggers a flow when an email is flagged.

 

Syntax:

Office365Outlook.OnFlaggedEmailV2 ([Optional]string folderPath, [advanced][Optional]string to, [advanced][Optional]string cc, [advanced][Optional]string toOrCc, [advanced][Optional]string from, [advanced][Optional]string importance, [advanced][Optional]boolean fetchOnlyWithAttachment, [advanced][Optional]boolean includeAttachments, [advanced][Optional]string subjectFilter)

 

Parameters:

Name

Type

Summary

Required

Related Action

folderPath

string

(Folder)

Mail folder to check for new emails.

False

to

string(email)

(To)

Recipient email addresses separated by semicolons (If any match, the trigger will run).

False

cc

string(email)

(CC)

CC recipient email addresses separated by semicolons (If any match, the trigger will run).

False

toOrCc

string(email)

(To or CC)

To or CC recipient email addresses separated by semicolons (If any match, the trigger will run).

False

from

string(email)

(From)

Sender email addresses separated by semicolons (If any match, the trigger will run).

False

importance

string

(Importance)Values: [Any, Low, Normal, High]

Importance of the email (Any, High, Normal, Low).

False

fetchOnlyWithAttachment

boolean

(Only with Attachments)

If set to true, only emails with an attachment will be retrieved. Emails without any attachments will be skipped. If set to false, all emails will be retrieved.

False

includeAttachments

boolean

(Include Attachments)

Should the response of the trigger include the attachments.

False

subjectFilter

string

(Subject Filter)

String to look for in the subject line.

False

 

Returns:

          Type:TriggerBatchResponse[GraphClientReceiveMessage]

          Description: Represents a wrapper object for batch trigger response

 

Trigger OnFlaggedEmailV3

Summary: When an email is flagged (V3)

Description: This operation triggers a flow when an email is flagged.

 

Syntax:

Office365Outlook.OnFlaggedEmailV3 ([Optional]string folderPath, [advanced][Optional]string to, [advanced][Optional]string cc, [advanced][Optional]string toOrCc, [advanced][Optional]string from, [advanced][Optional]string importance, [advanced][Optional]boolean fetchOnlyWithAttachment, [advanced][Optional]boolean includeAttachments, [advanced][Optional]string subjectFilter)

 

Parameters:

Name

Type

Summary

Required

Related Action

folderPath

string

(Folder)

Mail folder to check for new emails.

False

to

string(email)

(To)

Recipient email addresses separated by semicolons (If any match, the trigger will run).

False

cc

string(email)

(CC)

CC recipient email addresses separated by semicolons (If any match, the trigger will run).

False

toOrCc

string(email)

(To or CC)

To or CC recipient email addresses separated by semicolons (If any match, the trigger will run).

False

from

string(email)

(From)

Sender email addresses separated by semicolons (If any match, the trigger will run).

False

importance

string

(Importance)Values: [Any, Low, Normal, High]

Importance of the email (Any, High, Normal, Low).

False

fetchOnlyWithAttachment

boolean

(Only with Attachments)

If set to true, only emails with an attachment will be retrieved. Emails without any attachments will be skipped. If set to false, all emails will be retrieved.

False

includeAttachments

boolean

(Include Attachments)

Should the response of the trigger include the attachments.

False

subjectFilter

string

(Subject Filter)

String to look for in the subject line.

False

 

Returns:

          Type:TriggerBatchResponse[GraphClientReceiveMessage]

          Description: Represents a wrapper object for batch trigger response

 

Trigger OnNewMentionMeEmail

Summary: When a new email mentioning me arrives

Description: This operation triggers a flow when a new email mentioning me arrives. It will skip any email that has a total message size greater than the limit put by your Exchange Admin or 50 MB, whichever is less. It may also skip protected emails and emails with invalid body or attachments.

 

Syntax:

Office365Outlook.OnNewMentionMeEmail ([internal][Optional]string messageIdToFireOnFirstTriggerRun, [Optional]string folderPath, [advanced][Optional]string to, [advanced][Optional]string cc, [advanced][Optional]string toOrCc, [advanced][Optional]string from, [advanced][Optional]string importance, [advanced][Optional]boolean fetchOnlyWithAttachment, [advanced][Optional]boolean includeAttachments, [advanced][Optional]string subjectFilter)

 

Parameters:

Name

Type

Summary

Required

Related Action

messageIdToFireOnFirstTriggerRun

string

(Message Id to Fire on First Trigger Run)

Id of message to fire on first trigger run if supplied.

False

folderPath

string

(Folder)

Mail folder to check for new emails.

False

to

string(email)

(To)

Recipient email addresses separated by semicolons (If any match, the trigger will run).

False

cc

string(email)

(CC)

CC recipient email addresses separated by semicolons (If any match, the trigger will run).

False

toOrCc

string(email)

(To or CC)

To or CC recipient email addresses separated by semicolons (If any match, the trigger will run).

False

from

string(email)

(From)

Sender email addresses separated by semicolons (If any match, the trigger will run).

False

importance

string

(Importance)Values: [Any, Low, Normal, High]

Importance of the email (Any, High, Normal, Low).

False

fetchOnlyWithAttachment

boolean

(Only with Attachments)

If set to true, only emails with an attachment will be retrieved. Emails without any attachments will be skipped. If set to false, all emails will be retrieved.

False

includeAttachments

boolean

(Include Attachments)

Should the response of the trigger include the attachments.

False

subjectFilter

string

(Subject Filter)

String to look for in the subject line.

False

 

Returns:

          Type:TriggerBatchResponse[ClientReceiveMessage]

          Description: Represents a wrapper object for batch trigger response

 

Trigger OnNewMentionMeEmailV2

Summary: When a new email mentioning me arrives (V2)

Description: This operation triggers a flow when a new email mentioning me arrives. It will skip any email that has a total message size greater than the limit put by your Exchange Admin or 50 MB, whichever is less. It may also skip protected emails and emails with invalid body or attachments.

 

Syntax:

Office365Outlook.OnNewMentionMeEmailV2 ([internal][Optional]string messageIdToFireOnFirstTriggerRun, [Optional]string folderPath, [advanced][Optional]string to, [advanced][Optional]string cc, [advanced][Optional]string toOrCc, [advanced][Optional]string from, [advanced][Optional]string importance, [advanced][Optional]boolean fetchOnlyWithAttachment, [advanced][Optional]boolean includeAttachments, [advanced][Optional]string subjectFilter)

 

Parameters:

Name

Type

Summary

Required

Related Action

messageIdToFireOnFirstTriggerRun

string

(Message Id to Fire on First Trigger Run)

Id of message to fire on first trigger run if supplied.

False

folderPath

string

(Folder)

Mail folder to check for new emails.

False

to

string(email)

(To)

Recipient email addresses separated by semicolons (If any match, the trigger will run).

False

cc

string(email)

(CC)

CC recipient email addresses separated by semicolons (If any match, the trigger will run).

False

toOrCc

string(email)

(To or CC)

To or CC recipient email addresses separated by semicolons (If any match, the trigger will run).

False

from

string(email)

(From)

Sender email addresses separated by semicolons (If any match, the trigger will run).

False

importance

string

(Importance)Values: [Any, Low, Normal, High]

Importance of the email (Any, High, Normal, Low).

False

fetchOnlyWithAttachment

boolean

(Only with Attachments)

If set to true, only emails with an attachment will be retrieved. Emails without any attachments will be skipped. If set to false, all emails will be retrieved.

False

includeAttachments

boolean

(Include Attachments)

Should the response of the trigger include the attachments.

False

subjectFilter

string

(Subject Filter)

String to look for in the subject line.

False

 

Returns:

          Type:TriggerBatchResponse[GraphClientReceiveMessage]

          Description: Represents a wrapper object for batch trigger response

 

Trigger OnNewMentionMeEmailV3

Summary: When a new email mentioning me arrives (V3)

Description: This operation triggers a flow when a new email mentioning me arrives. It will skip any email that has a total message size greater than the limit put by your Exchange Admin or 50 MB, whichever is less. It may also skip protected emails and emails with invalid body or attachments.

 

Syntax:

Office365Outlook.OnNewMentionMeEmailV3 ([internal][Optional]string messageIdToFireOnFirstTriggerRun, [Optional]string folderPath, [advanced][Optional]string to, [advanced][Optional]string cc, [advanced][Optional]string toOrCc, [advanced][Optional]string from, [advanced][Optional]string importance, [advanced][Optional]boolean fetchOnlyWithAttachment, [advanced][Optional]boolean includeAttachments, [advanced][Optional]string subjectFilter)

 

Parameters:

Name

Type

Summary

Required

Related Action

messageIdToFireOnFirstTriggerRun

string

(Message Id to Fire on First Trigger Run)

Id of message to fire on first trigger run if supplied.

False

folderPath

string

(Folder)

Mail folder to check for new emails.

False

to

string(email)

(To)

Recipient email addresses separated by semicolons (If any match, the trigger will run).

False

cc

string(email)

(CC)

CC recipient email addresses separated by semicolons (If any match, the trigger will run).

False

toOrCc

string(email)

(To or CC)

To or CC recipient email addresses separated by semicolons (If any match, the trigger will run).

False

from

string(email)

(From)

Sender email addresses separated by semicolons (If any match, the trigger will run).

False

importance

string

(Importance)Values: [Any, Low, Normal, High]

Importance of the email (Any, High, Normal, Low).

False

fetchOnlyWithAttachment

boolean

(Only with Attachments)

If set to true, only emails with an attachment will be retrieved. Emails without any attachments will be skipped. If set to false, all emails will be retrieved.

False

includeAttachments

boolean

(Include Attachments)

Should the response of the trigger include the attachments.

False

subjectFilter

string

(Subject Filter)

String to look for in the subject line.

False

 

Returns:

          Type:TriggerBatchResponse[GraphClientReceiveMessage]

          Description: Represents a wrapper object for batch trigger response

 

Trigger CreateOnNewEmailSubscription

Summary: When a new email arrives (webhook)

Description: This operation triggers a flow when a new email arrives.

 

Syntax:

Office365Outlook.CreateOnNewEmailSubscription (ClientSubscription subscription, [Optional]string folderPath, [advanced][Optional]string importance, [advanced][Optional]string hasAttachment)

 

Parameters:

Name

Type

Summary

Required

Related Action

subscription

ClientSubscription

 

Describes the subscription information.

True

folderPath

string

(Folder)

Mail folder to check for new emails.

False

importance

string

(Importance)Values: [Any, Low, Normal, High]

Importance of the received email ("Any", "High", "Normal", "Low").

False

hasAttachment

string

(Has Attachment)Values: [Any, Yes, No]

Whether the email has attachments ("Any", "Yes", "No").

False

 

Returns:

          Type:SubscriptionResponse

          Description: Base response model that connector returns to LA engine

 

Trigger SharedMailboxOnNewEmail

Summary: When a new email arrives in a shared mailbox

Description: This operation triggers a flow when a new email arrives in a shared mailbox. Your account should have permission to access the mailbox for this operation to succeed. It will skip any email that has a total message size greater than the limit put by your Exchange Admin or 50 MB, whichever is less. It may also skip protected emails and emails with invalid body or attachments.

 

Syntax:

Office365Outlook.SharedMailboxOnNewEmail (string mailboxAddress, [Optional]string folderId, [advanced][Optional]string to, [advanced][Optional]string cc, [advanced][Optional]string toOrCc, [advanced][Optional]string from, [advanced][Optional]string importance, [advanced][Optional]boolean hasAttachments, [advanced][Optional]boolean includeAttachments, [advanced][Optional]string subjectFilter, [internal][Optional]string x-ms-operation-context)

 

Parameters:

Name

Type

Summary

Required

Related Action

mailboxAddress

string

(Original Mailbox Address)

Address of the shared mailbox.

True

folderId

string

(Folder)

Mail folder to check for new emails.

False

to

string(email)

(To)

Recipient email addresses separated by semicolons (If any match, the trigger will run).

False

cc

string(email)

(CC)

CC recipient email addresses separated by semicolons (If any match, the trigger will run).

False

toOrCc

string(email)

(To or CC)

To or CC recipient email addresses separated by semicolons (If any match, the trigger will run).

False

from

string(email)

(From)

Sender email addresses separated by semicolons (If any match, the trigger will run).

False

importance

string

(Importance)Values: [Any, Low, Normal, High]

Importance of the email (Any, High, Normal, Low).

False

hasAttachments

boolean

(Only with Attachments)

If set to true, only emails with an attachment will be retrieved. Emails without any attachments will be skipped. If set to false, all emails will be retrieved.

False

includeAttachments

boolean

(Include Attachments)

Should the response of the trigger include the attachments.

False

subjectFilter

string

(Subject Filter)

String to look for in the subject line.

False

x-ms-operation-context

string

(x-ms-operation-context)

Special header to enable operation simulation.

False

 

Returns:

          Type:TriggerBatchResponse[ClientReceiveMessage]

          Description: Represents a wrapper object for batch trigger response

 

Trigger SharedMailboxOnNewEmailV2

Summary: When a new email arrives in a shared mailbox (V2)

Description: This operation triggers a flow when a new email arrives in a shared mailbox. Your account should have permission to access the mailbox for this operation to succeed. It will skip any email that has a total message size greater than the limit put by your Exchange Admin or 50 MB, whichever is less. It may also skip protected emails and emails with invalid body or attachments.

 

Syntax:

Office365Outlook.SharedMailboxOnNewEmailV2 (string mailboxAddress, [Optional]string folderId, [advanced][Optional]string to, [advanced][Optional]string cc, [advanced][Optional]string toOrCc, [advanced][Optional]string from, [advanced][Optional]string importance, [advanced][Optional]boolean hasAttachments, [advanced][Optional]boolean includeAttachments, [advanced][Optional]string subjectFilter, [internal][Optional]string x-ms-operation-context)

 

Parameters:

Name

Type

Summary

Required

Related Action

mailboxAddress

string

(Original Mailbox Address)

Address of the shared mailbox.

True

folderId

string

(Folder)

Mail folder to check for new emails.

False

to

string(email)

(To)

Recipient email addresses separated by semicolons (If any match, the trigger will run).

False

cc

string(email)

(CC)

CC recipient email addresses separated by semicolons (If any match, the trigger will run).

False

toOrCc

string(email)

(To or CC)

To or CC recipient email addresses separated by semicolons (If any match, the trigger will run).

False

from

string(email)

(From)

Sender email addresses separated by semicolons (If any match, the trigger will run).

False

importance

string

(Importance)Values: [Any, Low, Normal, High]

Importance of the email (Any, High, Normal, Low).

False

hasAttachments

boolean

(Only with Attachments)

If set to true, only emails with an attachment will be retrieved. Emails without any attachments will be skipped. If set to false, all emails will be retrieved.

False

includeAttachments

boolean

(Include Attachments)

Should the response of the trigger include the attachments.

False

subjectFilter

string

(Subject Filter)

String to look for in the subject line.

False

x-ms-operation-context

string

(x-ms-operation-context)

Special header to enable operation simulation.

False

 

Returns:

          Type:TriggerBatchResponse[GraphClientReceiveMessage]

          Description: Represents a wrapper object for batch trigger response

 

Trigger CalendarGetOnNewItems

Summary: When a new event is created (V1)

Description: This operation triggers a flow when a new event is created in a calendar. (V1)

 

Syntax:

Office365Outlook.CalendarGetOnNewItems (string table, [internal][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip, [internal][Optional]string x-ms-operation-context)

 

Parameters:

Name

Type

Summary

Required

Related Action

table

string

(Calendar id)

Select a calendar

True

CalendarGetTables

$filter

string

(Filter Query)

An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123).

False

$orderby

string

(Order By)

An ODATA orderBy query for specifying the order of entries.

False

$top

integer(int32)

(Top Count)

Total number of entries to retrieve (default = all).

False

$skip

integer(int32)

(Skip Count)

The number of entries to skip (default = 0).

False

x-ms-operation-context

string

(x-ms-operation-context)

Special header to enable operation simulation.

False

 

Returns:

          Type:CalendarEventList

          Description: The list of calendar items

 

Trigger CalendarGetOnUpdatedItems

Summary: When an event is modified (V1)

Description: This operation triggers a flow when an event is modified in a calendar. (V1)

 

Syntax:

Office365Outlook.CalendarGetOnUpdatedItems (string table, [internal][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip)

 

Parameters:

Name

Type

Summary

Required

Related Action

table

string

(Calendar id)

Select a calendar

True

CalendarGetTables

$filter

string

(Filter Query)

An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123).

False

$orderby

string

(Order By)

An ODATA orderBy query for specifying the order of entries.

False

$top

integer(int32)

(Top Count)

Total number of entries to retrieve (default = all).

False

$skip

integer(int32)

(Skip Count)

The number of entries to skip (default = 0).

False

 

Returns:

          Type:CalendarEventList

          Description: The list of calendar items

 

Trigger ODataStyleGetOnNewItems

Summary: When a new item is created in a table

Description: This operation triggers a flow when a new item is created in a table.

 

Syntax:

Office365Outlook.ODataStyleGetOnNewItems (string dataset, string table, [internal][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip)

 

Parameters:

Name

Type

Summary

Required

Related Action

dataset

string

(Dataset)

dataset name

True

table

string

(Calendar id)

table name

True

$filter

string

(Filter Query)

An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123).

False

$orderby

string

(Order By)

An ODATA orderBy query for specifying the order of entries.

False

$top

integer(int32)

(Top Count)

Total number of entries to retrieve (default = all).

False

$skip

integer(int32)

(Skip Count)

The number of entries to skip (default = 0).

False

 

Returns:

          Type:CalendarEventList

          Description: The list of calendar items

 

Trigger ODataStyleCalendarGetOnUpdatedItems

Summary: When an item is modified

Description: This operation triggers a flow when an item is modified in a table.

 

Syntax:

Office365Outlook.ODataStyleCalendarGetOnUpdatedItems (string dataset, string table, [internal][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip)

 

Parameters:

Name

Type

Summary

Required

Related Action

dataset

string

(Dataset)

dataset name

True

table

string

(Calendar id)

table name

True

$filter

string

(Filter Query)

An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123).

False

$orderby

string

(Order By)

An ODATA orderBy query for specifying the order of entries.

False

$top

integer(int32)

(Top Count)

Total number of entries to retrieve (default = all).

False

$skip

integer(int32)

(Skip Count)

The number of entries to skip (default = 0).

False

 

Returns:

          Type:CalendarEventList

          Description: The list of calendar items

 

Trigger CalendarGetOnNewItemsV2

Summary: When a new event is created (V2)

Description: This operation triggers a flow when a new event is created in a calendar. (V2)

 

Syntax:

Office365Outlook.CalendarGetOnNewItemsV2 (string table, [internal][Optional]string $filter, [advanced][Optional]string $orderby, [advanced][Optional]integer $top, [advanced][Optional]integer $skip, [internal][Optional]string x-ms-operation-context)

 

Parameters:

Name

Type

Summary

Required

Related Action

table

string

(Calendar id)

Select a calendar<