Outlook

Outlook module for RobinPath.

Package: @robinpath/outlook | Category: Productivity | Type: Integration

Authentication

outlook.setCredentials "your-credentials"

Call this once at the start of your script before using any other function. Credentials persist for the duration of the script execution.

Use Cases

Use the outlook module when you need to:

• listMessages -- Use outlook.listMessages to perform this operation
• getMessage -- Use outlook.getMessage to perform this operation
• sendEmail -- Use outlook.sendEmail to perform this operation
• replyToEmail -- Use outlook.replyToEmail to perform this operation
• forwardEmail -- Use outlook.forwardEmail to perform this operation

Quick Reference

Function	Description	Returns
setCredentials	Configure outlook credentials.	object
listMessages	listMessages	object
getMessage	getMessage	object
sendEmail	sendEmail	object
replyToEmail	replyToEmail	object
forwardEmail	forwardEmail	object
createDraft	createDraft	object
sendDraft	sendDraft	object
listDrafts	listDrafts	object
deleteMessage	deleteMessage	object
moveMessage	moveMessage	object
copyMessage	copyMessage	object
listFolders	listFolders	object
createFolder	createFolder	object
listAttachments	listAttachments	object
getAttachment	getAttachment	object
createRule	createRule	object
getProfile	getProfile	object
searchMessages	searchMessages	object
flagMessage	flagMessage	object
listCategories	listCategories	object

Functions

setCredentials

Configure outlook credentials.

Module: outlook | Returns: object -- API response.

outlook.setCredentials

Parameter	Type	Required	Description
accessToken	string	Yes	accessToken

---

listMessages

listMessages

Module: outlook | Returns: object -- API response.

outlook.listMessages

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getMessage

getMessage

Module: outlook | Returns: object -- API response.

outlook.getMessage

Parameter	Type	Required	Description
input	string	No	Input parameter

---

sendEmail

sendEmail

Module: outlook | Returns: object -- API response.

outlook.sendEmail

Parameter	Type	Required	Description
input	string	No	Input parameter

---

replyToEmail

replyToEmail

Module: outlook | Returns: object -- API response.

outlook.replyToEmail

Parameter	Type	Required	Description
input	string	No	Input parameter

---

forwardEmail

forwardEmail

Module: outlook | Returns: object -- API response.

outlook.forwardEmail

Parameter	Type	Required	Description
input	string	No	Input parameter

---

createDraft

createDraft

Module: outlook | Returns: object -- API response.

outlook.createDraft

Parameter	Type	Required	Description
input	string	No	Input parameter

---

sendDraft

sendDraft

Module: outlook | Returns: object -- API response.

outlook.sendDraft

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listDrafts

listDrafts

Module: outlook | Returns: object -- API response.

outlook.listDrafts

Parameter	Type	Required	Description
input	string	No	Input parameter

---

deleteMessage

deleteMessage

Module: outlook | Returns: object -- API response.

outlook.deleteMessage

Parameter	Type	Required	Description
input	string	No	Input parameter

---

moveMessage

moveMessage

Module: outlook | Returns: object -- API response.

outlook.moveMessage

Parameter	Type	Required	Description
input	string	No	Input parameter

---

copyMessage

copyMessage

Module: outlook | Returns: object -- API response.

outlook.copyMessage

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listFolders

listFolders

Module: outlook | Returns: object -- API response.

outlook.listFolders

Parameter	Type	Required	Description
input	string	No	Input parameter

---

createFolder

createFolder

Module: outlook | Returns: object -- API response.

outlook.createFolder

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listAttachments

listAttachments

Module: outlook | Returns: object -- API response.

outlook.listAttachments

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getAttachment

getAttachment

Module: outlook | Returns: object -- API response.

outlook.getAttachment

Parameter	Type	Required	Description
input	string	No	Input parameter

---

createRule

createRule

Module: outlook | Returns: object -- API response.

outlook.createRule

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getProfile

getProfile

Module: outlook | Returns: object -- API response.

outlook.getProfile

Parameter	Type	Required	Description
input	string	No	Input parameter

---

searchMessages

searchMessages

Module: outlook | Returns: object -- API response.

outlook.searchMessages

Parameter	Type	Required	Description
input	string	No	Input parameter

---

flagMessage

flagMessage

Module: outlook | Returns: object -- API response.

outlook.flagMessage

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listCategories

listCategories

Module: outlook | Returns: object -- API response.

outlook.listCategories

Parameter	Type	Required	Description
input	string	No	Input parameter

---

Error Handling

All functions throw on failure. Common errors:

Error	Cause
Outlook API error (${res.status}): ${t}	Check the error message for details
outlook.setCredentials requires accessToken.	Check the error message for details
outlook.deleteMessage requires an ID.	Check the error message for details
outlook.moveMessage requires an ID.	Check the error message for details
outlook.copyMessage requires an ID.	Check the error message for details
Outlook: "..." not configured. Call outlook.setCredentials first.	Check the error message for details

@desc "List messages and validate result"
do
  set $result as outlook.listMessages
  if $result != null
    print "Success"
  else
    print "No result"
  end
enddo

Recipes

1. List and iterate Messages

Retrieve all items and loop through them.

@desc "Setup authentication"
do
  outlook.setCredentials $token
enddo

@desc "List messages and iterate results"
do
  set $result as outlook.listMessages
  each $item in $result
    print $item
  end
enddo

2. Create a new item with sendEmail

Create a new resource and capture the result.

@desc "Setup authentication"
do
  outlook.setCredentials $token
enddo

@desc "Send email"
do
  set $result as outlook.sendEmail
  print "Created: " + $result
enddo

3. Check before creating

List existing items and only create if needed.

@desc "Setup authentication"
do
  outlook.setCredentials $token
enddo

@desc "List messages and send email"
do
  set $existing as outlook.listMessages
  if $existing == null
    outlook.sendEmail
    print "Item created"
  else
    print "Item already exists"
  end
enddo

4. Multi-step Outlook workflow

Chain multiple outlook operations together.

@desc "Setup authentication"
do
  outlook.setCredentials $token
enddo

@desc "List messages, get message, and more"
do
  set $r_listMessages as outlook.listMessages
  set $r_getMessage as outlook.getMessage
  set $r_sendEmail as outlook.sendEmail
  print "All operations complete"
enddo

5. Safe listMessages with validation

Check results before proceeding.

@desc "Setup authentication"
do
  outlook.setCredentials $token
enddo

@desc "List messages and validate result"
do
  set $result as outlook.listMessages
  if $result != null
    print "Success: " + $result
  else
    print "Operation returned no data"
  end
enddo

Related Modules

• google-sheets -- Google Sheets module for complementary functionality
• google-calendar -- Google Calendar module for complementary functionality
• google-contacts -- Google Contacts module for complementary functionality
• google-forms -- Google Forms module for complementary functionality
• gmail -- Gmail module for complementary functionality