Outlook Mail tools
The 12 Outlook Mail operations your product runs on your customer's account through Connect. All of them use the same endpoint, POST /api/tools/{tool}/execute.
- List mail foldersGETLists the mail folders directly under the root of the mailbox, with id, displayName, unreadItemCount and totalItemCount. Child folders are not included, and only the first page comes back. The well-known names inbox, sentitems, drafts, deleteditems, archive and junkemail work as folder ids in the other tools without this call.
- List messagesGETLists the messages of a folder, 10 per page, with subject, from, receivedDateTime, isRead and bodyPreview, the first 255 characters of the body. Only the first page comes back: to reach older messages, use Search messages, which pages with from. Read the full text of one message with Get message.
- Search messagesPOSTSearches the mailbox, attachments included, and returns the hits newest first, up to 25 per page. Each hit has hitId, the message id for the other tools, a summary and the main fields in resource. moreResultsAvailable says whether to ask for the next page with from. Only work or school accounts can search; personal Outlook.com accounts get an error.
- Get messageGETReturns one message with its body as plain text, from, toRecipients, ccRecipients, receivedDateTime, conversationId, hasAttachments and webLink. Attachments are not included.
- Send messagePOSTSends a new email from the user's mailbox right away and saves a copy in Sent Items. The response is 202 with no body, so no message id comes back. To let someone review the email first, use Create draft.
- Reply to messagePOSTReplies right away to the sender of a message, or to its replyTo addresses when it has them, with the comment above the quoted original, and saves the reply in Sent Items. The response is 202 with no body. To answer everyone, use Reply all to message.
- Reply all to messagePOSTReplies right away to the sender and every recipient of a message, with the comment above the quoted original, and saves the reply in Sent Items. The response is 202 with no body.
- Forward messagePOSTForwards a message right away to new recipients, with the comment above the original, and saves it in Sent Items. The response is 202 with no body.
- Create draftPOSTSaves a new email in Drafts without sending it and returns it with its id. Change it with Update message and send it with Send draft, or let the user review and send it from Outlook.
- Update messagePATCHChanges a message and returns it: marks it read or unread, flags it, sets its categories or importance, or moves it between Focused and Other. On a draft it also changes subject, body and recipients. Only the fields sent change.
- Send draftPOSTSends a draft and saves it in Sent Items. The response is 202 with no body.
- Move messagePOSTMoves a message to another folder and returns it with a new id, because the move creates a copy in the destination and removes the original. Moving to deleteditems is how to delete a message: it stays recoverable in Deleted Items.
Toolkits in the same category
See all 100 toolkitsSee Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
