MicrosoftOutlook

MicrosoftOutlook Connector

Use the MicrosoftOutlook connector to access Microsoft Outlook through a Studio solution. Microsoft Outlook has numerous functions which also have their own connectors:

When you add this component to an automation, the system places it on the Global tab of the component tray. For more information, see Adding Global Components to an Automation. This component must be global to be referenced by other automations in the project.

For more information, see General Component Properties, Methods, and Events.

Properties

Property	Description
Folder	Folder name to monitor. Use the slash ( \ ) to indicate folder path.
Monitor	Indicates whether to monitor configured folder on startup. (Boolean)
ReadType	The email read type to monitor for. The options are: All Read Unread
IsRunning	This property indicates whether the application is running.
SupportedName	This property indicates the supported Microsoft Office name.
Version	Indicates the current running version of Microsoft Outlook.

Events

Event	Description
LogonComplete	This event occurs when a logon is complete.
MailClosed	This event occurs whenever an email is closed. Occurs for newly-arrived, monitored folder, and messages processed by a RetrieveEmail method.
MailDeleted	Only applies to Office 2007. Occurs when an email is deleted. Occurs for newly-arrived, monitored folde,r and messages processed by a RetrieveEmail method.
MailForwarded	Occurs when an email is forwarded. Occurs for newly-arrived, monitored folder, and messages processed by a RetrieveEmail method.
MailOpened	Occurs when an email is opened. Occurs for newly-arrived, monitored folder, and messages processed by a RetrieveEmail method.
MailRead	Occurs when an email is read. Occurs for newly-arrived, monitored folder, and messages processed by a RetrieveEmail method.
MailReplied	Occurs when an email is replied to. Occurs for newly-arrived, monitored folder, and messages processed by a RetrieveEmail method.
MailRepliedAll	Occurs when an email is replied to all. Occurs for newly-arrived, monitored folder, and messages processed by a RetrieveEmail method.
MailSent	Occurs when an email is sent. Occurs for newly-arrived, monitored folder, and messages processed by a RetrieveEmail method.
NewMail	Occurs when an email is received in the inbox. Occurs before any Outlook rules are applied.
Quit	Occurs when the main Outlook window is closed manually.
Reminder	Occurs when a reminder is displayed.

Methods

Method	Description	Parameters	Result Type
Close	Closes the Outlook application.	None	Void
FindAppointment	Finds an appointment. Returns True if appointments are found.	DateTime startdate, String subject,	Microsoft Outlook Appointment appointment, Boolean Result
FindContact	Finds a contact. Returns True if contacts are found.	String name, String email	MicrosoftOutlookContact contact, Boolean Result
FindEmail	Finds 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
FindNote	Finds a note. Returns True if notes are found.	String subject	MicrosoftOutlookNote note, Boolean Result
FindTask	Finds a task. Returns True if tasks are found.	DateTime startDate, String subject	MicrosoftOutlookTask task, Boolean Result
NewAppointment	Creates an appointment. Use the Save method on the proxy object to commit the changes.	None	MicrosoftOutlookAppointment Result
NewContact	Creates a contact. Use the Save method on the proxy object to commit the changes.	None	MicrosoftOutlookContact Result
NewEmail	Creates an email. Use the Save method on the proxy object to commit the changes.	None	MicrosoftOutlookMail Result
NewNote	Creates a note. Use the Save method on the proxy object to commit the changes.	None	MicrosoftOutlookNote Result
NewTask	Creates a task. Use the Save method on the proxy object to commit the changes.	None	MicrosoftOutlookTask Result
Open	Opens the Outlook application.	None	Void
RetrieveEmail	Retrieves an email from a given folder. Use the slash ( \ ) to indicate the folder path.	String folder, ReadType readtype	MicorsoftOutlookMailCollection Result

Related information

Using the MicrosoftOutlook Connector