Skip to main content

MicrosoftOutlook Connector

Suggest edit Updated on November 10, 2021

Use the MicrosoftOutlook connector to access Microsoft Outlook through a Pega Robot Studio solution.

When you add this component to an automation, the system places it in the Globals container of the Project. This component must be global to be referenced by other automations in the project.

Properties

PropertyDescription
NameThe name of the control used in the automation.
FolderFolder name to monitor. Use the slash ( \ ) to indicate folder path.
MonitorIndicates whether to monitor configured folder on startup. (Boolean)
ReadType

The email read type to monitor for. The options are:

  • All
  • Read
  • Unread
SensitiveCheck the box to hide this component's values in logs and the Automation Surface.
IsRunningThis property indicates whether the application is running.

Events

EventDescription
LogonCompleteThis event occurs when a logon is complete.
MailClosedThis event occurs whenever an email is closed. Occurs for newly-arrived, monitored folder, and messages processed by a RetrieveEmail method.
MailDeletedOnly applies to Office 2007. Occurs when an email is deleted. Occurs for newly-arrived, monitored folde,r and messages processed by a RetrieveEmail method.
MailForwardedOccurs when an email is forwarded. Occurs for newly-arrived, monitored folders, and messages processed by a RetrieveEmail method.
MailOpenedOccurs when an email is opened. Occurs for newly-arrived, monitored folders, and messages processed by a RetrieveEmail method.
MailReadOccurs when an email is read. Occurs for newly-arrived, monitored folders, and messages processed by a RetrieveEmail method.
MailRepliedOccurs when an email is replied to. Occurs for newly-arrived, monitored folders, and messages processed by a RetrieveEmail method.
MailRepliedAllOccurs when an email is replied to all. Occurs for newly-arrived, monitored folders, and messages processed by a RetrieveEmail method.
MailSentOccurs when an email is sent. Occurs for newly-arrived, monitored folders, and messages processed by a RetrieveEmail method.
NewMailOccurs when an email is received in the inbox. Occurs before any Outlook rules are applied.
QuitOccurs when the main Outlook window is closed manually.
ReminderOccurs when a reminder is displayed.

Methods

MethodDescriptionParametersResult Type
CloseCloses the Outlook application. NoneVoid
FindAppointmentFinds an appointment. Returns True if appointments are found. DateTime startdate, String subjectMicrosoft Outlook Appointment appointment, Boolean Result
FindContactFinds a contact. Returns True if contacts are found. String name, String email MicrosoftOutlookContact contact, Boolean Result
FindEmailFinds an email in a specified folder. Use the slash ( \ ) to indicate the folder path. Returns True if emails are found. String folder, String from, String to, String subject MicrosoftOutlookMail mail, Boolean Result
FindNoteFinds a note. Returns True if notes are found. String subject MicrosoftOutlookNote note, Boolean Result
FindTaskFinds a task. Returns True if tasks are found. DateTime startDate, String subject MicrosoftOutlookTask task, Boolean Result
NewAppointmentCreates an appointment. Use the Save method on the proxy object to commit the changes. NoneMicrosoftOutlookAppointment Result
NewContactCreates a contact. Use the Save method on the proxy object to commit the changes. NoneMicrosoftOutlookContact Result
NewEmailCreates an email. Use the Save method on the proxy object to commit the changes. NoneMicrosoftOutlookMail Result
NewNoteCreates a note. Use the Save method on the proxy object to commit the changes. NoneMicrosoftOutlookNote Result
NewTaskCreates a task. Use the Save method on the proxy object to commit the changes. NoneMicrosoftOutlookTask Result
OpenOpens the Outlook application. NoneVoid
RetrieveEmailRetrieves an email from a given folder. Use the slash ( \ ) to indicate the folder path. String folder, ReadType readtype MicorsoftOutlookMailCollection Result
Did you find this content helpful? YesNo

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

We'd prefer it if you saw us at our best.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us