Connectors Reference
The Office 365 Groups Mail connector allows users to work with data located in a Office 365 Group mailbox. The functionality in this connector works independently from a single user's personal mailbox and allows users to work with any Group they can access within their organization. The connector works off the Microsoft Graph API, and uses terminology specified in a Office 365 Groups documentation within the Graph API. Learn more in the connector documentation.
|
Status: Preview |
Tier: Standard |
Version: 1.0 |
|
Name |
Summary |
|
When a new email arrives to a group |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
New Conversation body |
|
|
Created conversation object |
|
|
|
|
|
New forward post body |
|
|
New forward post body |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Reply conversation thread body |
Summary: List the conversations of a group
Description: Get all the conversations in this group.
Syntax:
Office365GroupsMail.ListConversations (string groupId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
groupId |
string (Group ID) |
Pick a group from the drop down or enter group id. |
True |
Returns:
Type:ListConversationsResponse
Summary: Create a new conversation in a group
Description: Create a new conversation in this group.
Syntax:
Office365GroupsMail.CreateConversation (string groupId, [internal]string content-type, CreateConversationBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
groupId |
string (Group ID) |
Pick a group from the drop down or enter group id. |
True |
|
|
content-type |
string
|
|
True |
|
|
body |
(New Conversation body) |
New Conversation body. |
True |
Returns:
Type:CreateConversationResponse
Summary: Created conversation object
Description: The response of with the created conversation details.
Summary: Get a group conversation
Description: Retrieves the properties of a particular conversation.
Syntax:
Office365GroupsMail.GetGroupConversation (string groupId, string conversationId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
groupId |
string (Group ID) |
Pick a group from the drop down or enter group id. |
True |
|
|
conversationId |
string (Conversation ID) |
Enter the conversation ID. |
True |
Returns:
Type:Conversation
Description: Conversation object.
Summary: List the conversation threads of a conversation
Description: Get all the threads in a group conversation.
Syntax:
Office365GroupsMail.ListConversationThreads (string groupId, string conversationId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
groupId |
string (Group ID) |
Pick a group from the drop down or enter group id. |
True |
|
|
conversationId |
string (Conversation ID) |
Enter the conversation ID. |
True |
Returns:
Type:ListConversationThreadsResponse
Summary: Create a conversation thread
Description: Create a new thread in the specified conversation.
Syntax:
Office365GroupsMail.CreateConversationThread (string groupId, string conversationId, [internal]string content-type, CreateConversationBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
groupId |
string (Group ID) |
Pick a group from the drop down or enter group id. |
True |
|
|
conversationId |
string (Conversation ID) |
Enter the conversation ID. |
True |
|
|
content-type |
string
|
|
True |
|
|
body |
(New Conversation body) |
New Conversation body. |
True |
Returns:
Type:NewConversationThreadResponse
Summary: List the threads of a group
Description: Get all the threads of a group.
Syntax:
Office365GroupsMail.ListGroupThreads (string groupId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
groupId |
string (Group ID) |
Pick a group from the drop down or enter group id. |
True |
Returns:
Summary: Start a new group conversation by creating a thread
Description: Start a new group conversation by first creating a thread.
Syntax:
Office365GroupsMail.CreateGroupThread (string groupId, [internal]string content-type, CreateConversationBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
groupId |
string (Group ID) |
Pick a group from the drop down or enter group id. |
True |
|
|
content-type |
string
|
|
True |
|
|
body |
(New Conversation body) |
New Conversation body. |
True |
Returns:
Type:NewConversationThreadResponse
Summary: Get a conversation thread
Description: Get a specific thread that belongs to a group.
Syntax:
Office365GroupsMail.GetConversationThread (string groupId, string threadId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
groupId |
string (Group ID) |
Pick a group from the drop down or enter group id. |
True |
|
|
threadId |
string (Thread ID) |
Enter the conversation thread ID. |
True |
Returns:
Type:ConversationThread
Description: Conversation thread object.
Summary: Delete a conversation thread
Description: Deletes the specified conversation thread.
Syntax:
Office365GroupsMail.DeleteConversationThread (string groupId, string threadId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
groupId |
string (Group ID) |
Pick a group from the drop down or enter group id. |
True |
|
|
threadId |
string (Thread ID) |
Enter the conversation thread ID. |
True |
Returns:
Summary: List the posts of a conversation thread
Description: Get all the posts of the specified conversation thread.
Syntax:
Office365GroupsMail.ListThreadPosts (string groupId, string threadId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
groupId |
string (Group ID) |
Pick a group from the drop down or enter group id. |
True |
|
|
threadId |
string (Thread ID) |
Enter the conversation thread ID. |
True |
Returns:
Summary: Get a thread post
Description: Retrieves a post in a specified thread.
Syntax:
Office365GroupsMail.GetThreadPost (string groupId, string threadId, string postId, [internal]string $expand)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
groupId |
string (Group ID) |
Pick a group from the drop down or enter group id. |
True |
|
|
threadId |
string (Thread ID) |
Enter the conversation thread ID. |
True |
|
|
postId |
string (Post ID) |
Enter the post ID. |
True |
|
|
$expand |
string
|
|
True |
Returns:
Type:Post
Description: Represents an individual Post item within a conversationThread entity.
Summary: List the attachments of a post
Description: Retrieve a list of attachments that belong to a post.
Syntax:
Office365GroupsMail.GetAttachments (string groupId, string threadId, string postId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
groupId |
string (Group ID) |
Pick a group from the drop down or enter group id. |
True |
|
|
threadId |
string (Thread ID) |
Enter the conversation thread ID. |
True |
|
|
postId |
string (Post ID) |
Enter the post ID. |
True |
Returns:
Summary: List user groups
Description: Retrieves all Office 365 Groups the user is part of.
Syntax:
Office365GroupsMail.ListGroups ([internal]string $filter, [internal]string $select, [internal]integer $top)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
$filter |
string
|
|
True |
|
|
$select |
string
|
|
True |
|
|
$top |
integer
|
|
True |
Returns:
Type:ListGroupsResponse
Summary: Reply to a conversation thread
Description: Reply to a thread in a group conversation and add a new post to it.
Syntax:
Office365GroupsMail.ReplyToAThread (string groupId, string threadId, [internal]string content-type, ReplyConversationThreadBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
groupId |
string (Group ID) |
Pick a group from the drop down or enter group id. |
True |
|
|
threadId |
string (Thread ID) |
Enter the conversation thread ID. |
True |
|
|
content-type |
string
|
|
True |
|
|
body |
(Reply conversation thread body) |
Reply Conversation Thread body. |
True |
Returns:
Summary: Reply to a post
Description: Reply to a post and add a new post to the specified thread in a group conversation.
Syntax:
Office365GroupsMail.ReplyPost (string groupId, string threadId, string postId, [internal]string content-type, ReplyConversationThreadBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
groupId |
string (Group ID) |
Pick a group from the drop down or enter group id. |
True |
|
|
threadId |
string (Thread ID) |
Enter the conversation thread ID. |
True |
|
|
postId |
string (Post ID) |
Enter the post ID. |
True |
|
|
content-type |
string
|
|
True |
|
|
body |
(Reply conversation thread body) |
Reply Conversation Thread body. |
True |
Returns:
Summary: Forward a post
Description: Forward a post to a recipient.
Syntax:
Office365GroupsMail.ForwardPost_V2 (string groupMail, [internal]string Prefer, string conversationId, string threadId, string postId, [internal]string content-type, ForwardPost_V2Body body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
groupMail |
string (Group mail) |
Pick a group from the drop down or enter the group mail address. |
True |
|
|
Prefer |
string
|
|
True |
|
|
conversationId |
string (Conversation ID) |
Enter the conversation ID. |
True |
|
|
threadId |
string (Thread ID) |
Enter the conversation thread ID. |
True |
|
|
postId |
string (Post ID) |
Enter the post ID. |
True |
|
|
content-type |
string
|
|
True |
|
|
body |
(New forward post body) |
New forward post body. |
True |
Returns:
Summary: Forward a post
Description: Forward a post to a recipient.
Syntax:
Office365GroupsMail.ForwardPost (string groupId, string threadId, string postId, [internal]string content-type, ForwardPostBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
groupId |
string (Group ID) |
Pick a group from the drop down or enter group id. |
True |
|
|
threadId |
string (Thread ID) |
Enter the conversation thread ID. |
True |
|
|
postId |
string (Post ID) |
Enter the post ID. |
True |
|
|
content-type |
string
|
|
True |
|
|
body |
(New forward post body) |
New forward post body. |
True |
Returns:
Summary: When a new email arrives to a group
Description: When a new email arrives to a group.
Syntax:
Office365GroupsMail.OnNewEmailInGroup (string groupId, [internal][Optional]string $filter, [internal]string $select, [internal]string $expand, [internal]string $orderby)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
groupId |
string (Group ID) |
Pick a group from the drop down or enter group id. |
True |
|
|
$filter |
string
|
|
False |
|
|
$select |
string
|
|
True |
|
|
$expand |
string
|
|
True |
|
|
$orderby |
string
|
|
True |
Returns:
Type:OnNewEmailInGroupResponse
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string Attachment ID |
Id of the attachment. |
|
name |
string Attachment name |
Name of attachment. |
|
contentType |
string Attachment content Type |
Content type of attachment. |
|
size |
integer(int32) Attachment size |
Size of attachment. |
|
contentBytes |
string(byte) Attachment content bytes |
Content of attachment. |
Summary:
Description: File attachment.
Properties:
|
Name |
Type |
Summary |
|
@odata.type |
string File attachment @odata.type |
@odata.type for a file attachment. |
|
Name |
string Attachment name |
Name of the attachment. |
|
ContentBytes |
string(byte) Attachment content |
Content of the attachment. |
Summary:
Description: Conversation object.
Properties:
|
Name |
Type |
Summary |
|
id |
string Conversation ID |
The conversations's unique identifier. |
|
topic |
string Conversation topic |
The topic of the conversation. |
|
hasAttachments |
boolean Has attachments? |
Indicates whether any of the posts within this Conversation has at least one attachment. |
|
lastDeliveredDateTime |
string(date-time) Last delivered timestamp |
The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. |
|
uniqueSenders |
array of (string) Unique senders array |
All the users that sent a message to this Conversation. |
|
preview |
string Preview |
A short summary from the body of the latest post in this Conversation. |
|
threads |
array of (ConversationThread)
|
|
Summary:
Description: Conversation thread object.
Properties:
|
Name |
Type |
Summary |
|
id |
string Conversation thread ID |
The conversation thread's unique identifier. |
|
topic |
string Conversation topic |
The topic of the conversation. |
|
hasAttachments |
boolean Has attachments? |
Indicates whether any of the posts within this Conversation has at least one attachment. |
|
lastDeliveredDateTime |
string(date-time) Last delivered timestamp |
The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. |
|
uniqueSenders |
array of (string) Unique senders array |
All the users that sent a message to this Conversation. |
|
preview |
string Preview |
A short summary from the body of the latest post in this Conversation. |
|
isLocked |
boolean Is Locked? |
Indicates if the thread is locked. |
|
toRecipients |
array of (EmailAddress)
|
The To: recipients for the thread. |
|
ccRecipients |
array of (EmailAddress)
|
The Cc: recipients for the thread. |
|
posts |
array of (Post)
|
|
Summary:
Description: Conversation thread object.
Properties:
|
Name |
Type |
Summary |
|
id |
string Conversation thread ID |
The conversation thread's unique identifier. |
|
posts |
array of (PostTriggerResponse)
|
|
Summary:
Description: When a new email arrives trigger response.
Properties:
|
Name |
Type |
Summary |
|
id |
string Conversation ID |
The conversation unique identifier. |
|
lastDeliveredDateTime |
string(date-time) Last delivered timestamp |
The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. |
|
threads |
array of (ConversationThreadTriggerResponse)
|
|
Summary: New Conversation body
Description: New Conversation body.
Properties:
|
Name |
Type |
Summary |
|
topic |
string New topic |
Topic of the new conversation. |
|
post |
|
|
Summary: Created conversation object
Description: The response of with the created conversation details.
Properties:
|
Name |
Type |
Summary |
|
@odata.context |
string @odata.context |
The @odata.context link. |
|
id |
string Conversation ID |
New Conversation ID. |
|
threads@odata.context |
string threads@odata.context |
The threads@odata.context link. |
|
threads |
array of (ThreadsItem) Conversation threads |
Created conversation thread. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string Thread ID |
The new thread ID. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
emailAddress |
|
Represents information about a user in the sending or receiving end of an event, message or group post. |
Summary:
Description: Represents information about a user in the sending or receiving end of an event, message or group post.
Properties:
|
Name |
Type |
Summary |
|
name |
string Name of the user |
|
|
address |
string(email) Email address of the user |
|
Summary: New forward post body
Description: New forward post body.
Properties:
|
Name |
Type |
Summary |
|
comment |
string Comment |
Comment to forward with the post. |
|
toRecipients |
array of (GetUsers__GraphAction) Recipients |
The recipients to whom the threaded is forwarded to. |
Summary: New forward post body
Description: New forward post body.
Properties:
|
Name |
Type |
Summary |
|
Comment |
string(html) Comment |
Comment to forward with the post. |
|
ToRecipients |
array of (GetUsers__GraphAction) Recipients |
The recipients to whom the threaded is forwarded to. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
@odata.nextLink |
string Next link |
Link to get next page of results |
|
@odata.context |
string
|
The @odata.context link. |
|
value |
array of (Attachment)
|
Array containing the attachments of the post. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
EmailAddress |
Email address |
User email address. |
Summary: Email address
Description: User email address.
Properties:
|
Name |
Type |
Summary |
|
Address |
string(email)
|
Email address. |
Summary:
Description: Represents properties of the body of an item, such as a message, event or group post.
Properties:
|
Name |
Type |
Summary |
|
contentType |
string Body content type |
Content type of the body. |
|
content |
string Body content |
Content of the body. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
@odata.nextLink |
string Next link |
Link to get next page of results |
|
value |
array of (Conversation)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
@odata.nextLink |
string Next link |
Link to get next page of results |
|
@odata.context |
string OData context |
The Odata.context link. |
|
value |
array of (ConversationThread)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
value |
array of (ValueItem)
|
Array with the groups the user is part of. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string Group ID |
|
|
displayName |
string Group display name |
|
|
visibility |
string Group visibility |
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
@odata.nextLink |
string Next link |
Link to get next page of results |
|
value |
array of (ConversationThread)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
@odata.nextLink |
string Next link |
Link to get next page of results |
|
@odata.context |
string
|
The @odata.context link. |
|
value |
array of (Post)
|
Array containing the posts in the specified thread. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
@odata.context |
string @odata.context |
The @odata.context link. |
|
id |
string Conversation thread ID |
New conversation thread ID. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
body |
Body |
Body of the new post. |
|
categories |
array of (string) Post categories |
The categories associated with the post. |
|
newParticipants |
array of (GetUsers__GraphAction) New participants |
Add participants to the thread as part of this post. |
|
attachments |
array of (ClientSendAttachment) File attachments |
File attachments to include. |
Summary: Body
Description: Body of the new post.
Properties:
|
Name |
Type |
Summary |
|
content |
string(html) Content |
Content of the new conversation. |
|
contentType |
string Content type |
Type of the body content: HTML or text. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
value |
array of (ConversationTriggerResponse)
|
Response of the trigger. |
Summary:
Description: Represents an individual Post item within a conversationThread entity.
Properties:
|
Name |
Type |
Summary |
|
id |
string Post ID |
The post's unique identifier. |
|
createdDateTime |
string(date-time) Post created timestamp |
|
|
lastModifiedDateTime |
string(date-time) Post last modified timestamp |
|
|
changeKey |
string Post change Key |
Identifies the version of the post. |
|
conversationId |
string Post conversation ID |
Unique ID of the conversation the post belongs to. |
|
conversationThreadId |
string Post conversation thread ID |
Unique ID of the conversation thread the post belongs to. |
|
categories |
array of (string) Post categories |
The categories associated with the post. |
|
receivedDateTime |
string(date-time) Post received timestamp |
Post received timestamp. |
|
hasAttachments |
boolean Has attachments? |
Indicates whether the post has at least one attachment. |
|
newParticipants |
array of (EmailAddress) New participants |
Conversation participants that were added to the thread as part of this post. |
|
body |
|
Represents properties of the body of an item, such as a message, event or group post. |
|
from |
|
|
|
sender |
|
|
|
attachments |
array of (Attachment)
|
|
Summary:
Description: Represents an individual Post item within a conversationThread entity.
Properties:
|
Name |
Type |
Summary |
|
id |
string Post ID |
The post's unique identifier. |
|
lastModifiedDateTime |
string(date-time) Post last modified timestamp |
|
|
changeKey |
string Post change Key |
Identifies the version of the post. |
Summary: Reply conversation thread body
Description: Reply Conversation Thread body.
Properties:
|
Name |
Type |
Summary |
|
post |
|
|