OutlookEX UDF - General - Revision history

Water at 09:28, 27 July 2023

2023-07-27T09:28:57Z

← Older revision		Revision as of 09:28, 27 July 2023
Line 1:		Line 1:
	[[Category:UDF]]		[[Category:UDF]]
			[[Category:Outlook]]
	The OutlookEX UDF offers basic functions to control and manipulate Microsoft Outlook. This page describes the OutlookEX UDF in general.		The OutlookEX UDF offers basic functions to control and manipulate Microsoft Outlook. This page describes the OutlookEX UDF in general.

Water: /* Outlook security */

2022-01-31T21:59:15Z

Outlook security

← Older revision		Revision as of 21:59, 31 January 2022
Line 130:		Line 130:

	== Outlook security ==		== Outlook security ==
	[[File:outlook_security_warning_1.gif\|~~frame\|alt=~~Outlook Security Warning\|Outlook Security ~~Warning]]~~		<gallery>
			File:outlook_security_warning_1.gif\|Outlook Security Warning
			Outlook Security Popup.jpg\|Outlook Security Popup
			</gallery>
	Some Outlook objects (address book, mail items ...) including their properties and methods are protected by security settings.		Some Outlook objects (address book, mail items ...) including their properties and methods are protected by security settings.
	Accessing such objects makes the Outlook Object Model Guard present a popup warning like "a program is trying to access your Address book or Contacts" or "a program is trying to access e-mail addresses you have stored in Outlook...".		Accessing such objects makes the Outlook Object Model Guard present a popup warning like "a program is trying to access your Address book or Contacts" or "a program is trying to access e-mail addresses you have stored in Outlook...".

	However, the Outlook Security Warning message does not appear if a valid Anti-Virus is installed.		However, the Outlook Security Warning message does not appear if a valid Anti-Virus is installed.


	A small function (''_OL_Warnings.au3''), which has to be compiled and run separately, clicks away all Outlook Security Warnings. Setting parameter ''$bWarningClick'' to ''True'' when you call function ''_OL_Open()'' runs the ''_OL_Warnings.exe''.		A small function (''_OL_Warnings.au3''), which has to be compiled and run separately, clicks away all Outlook Security Warnings. Setting parameter ''$bWarningClick'' to ''True'' when you call function ''_OL_Open()'' runs the ''_OL_Warnings.exe''.

Water: /* Outlook security */

2022-01-31T21:46:27Z

Outlook security

← Older revision		Revision as of 21:46, 31 January 2022
Line 137:		Line 137:


	A small function (''_OL_Warnings.au3''), which has to be compiled and run separately, clicks away all Outlook Security Warnings. Setting parameter ''$~~fOL_WarningClick~~'' to ''True'' when you call function ''_OL_Open()'' runs the ''_OL_Warnings.exe''.		A small function (''_OL_Warnings.au3''), which has to be compiled and run separately, clicks away all Outlook Security Warnings. Setting parameter ''$bWarningClick'' to ''True'' when you call function ''_OL_Open()'' runs the ''_OL_Warnings.exe''.
	The ''_OL_Warnings.exe'' stays active and clicks away all warnings until the calling script is ended.		The ''_OL_Warnings.exe'' stays active and clicks away all warnings until the calling script is ended.

Water at 17:38, 28 August 2021

2021-08-28T17:38:53Z

← Older revision		Revision as of 17:38, 28 August 2021
Line 22:		Line 22:
	=== Outlook ===		=== Outlook ===

	===== ~~Terms~~ =====		===== Definitions =====
	* An '''event''' is an activity that lasts 24 hours or longer.		* An '''event''' is an activity that lasts 24 hours or longer.
	* An '''appointment''' is an activity that does not involve reserving resources or inviting other people.		* An '''appointment''' is an activity that does not involve reserving resources or inviting other people.
	* A '''meeting''' is an appointment for which you reserve a period of time, invite people to, or reserve resources.		* A '''meeting''' is an appointment for which you reserve a period of time, invite people to, or reserve resources.
	A more detailed description of this ~~terms~~ can be found [http://www.knowledgewave.com/blog/msoffice/outlook/whats-the-dif-events-appointments-and-meeting-requests-in-microsoft-outlook-2013.html here].		A more detailed description of this definitions can be found [http://www.knowledgewave.com/blog/msoffice/outlook/whats-the-dif-events-appointments-and-meeting-requests-in-microsoft-outlook-2013.html here].

	===== Concepts =====		===== Concepts =====

Water at 18:09, 31 July 2021

2021-07-31T18:09:08Z

← Older revision		Revision as of 18:09, 31 July 2021
Line 5:		Line 5:
	== Concepts ==		== Concepts ==
	=== UDF ===		=== UDF ===
	The OutlookEX UDF is based ~~upon this~~ concept:		The OutlookEX UDF is based on the following concept:

	* Every item in Outlook is uniquely identified by EntryID and StoreID. The default StoreID is your inbox		* Every item in Outlook is uniquely identified by EntryID and StoreID. The default StoreID is your inbox

Water: /* Events */

2021-02-24T22:19:17Z

Events

← Older revision		Revision as of 22:19, 24 February 2021
Line 60:		Line 60:

	'''Responding to Events'''<br>		'''Responding to Events'''<br>
	~~To respond to item-level events, add event-handler procedures to the script of the form that displays the item. For~~ example~~, to run code when an item is opened in the form, add a procedure like the following to the script in the form.~~		The following example (reduced to the minimum) shows how to handle events:
	~~Responding to Events~~


	~~Function Item_Open()~~
	~~MsgBox "A new item has opened in this form."~~
	~~End Function~~

	~~Responding to application-level events is somewhat more involved because steps must be taken to associate the event handler with the part of Outlook in which the event is occurring.~~
	~~Example~~ (reduced to the minimum):
	<syntaxhighlight lang="autoit">		<syntaxhighlight lang="autoit">
	Global $oOL = _OL_Open()		Global $oOL = _OL_Open()
Line 78:		Line 69:
	Func oOL_NewMailEx($sEntryIDs)		Func oOL_NewMailEx($sEntryIDs)
	Local $iItemCount, $oItem		Local $iItemCount, $oItem
	Local $aEntryIDs = StringSplit($sEntryIDs, ",", $STR_NOCOUNT)		Local $aEntryIDs = StringSplit($sEntryIDs, ",", $STR_NOCOUNT) ; multiple EntryIDs are separated by ,
	$iItemCount = UBound($aEntryIDs)		$iItemCount = UBound($aEntryIDs)
	ConsoleWrite("OutlookEX UDF Example Script - " & ($iItemCount = 1 ? "new item has" : "new items have") & " arrived!" & @CRLF & @CRLF)		ConsoleWrite("OutlookEX UDF Example Script - " & ($iItemCount = 1 ? "new item has" : "new items have") & " arrived!" & @CRLF & @CRLF)
	For $i = 0 To $iItemCount - 1		For $i = 0 To $iItemCount - 1
	$oItem = $oOL.Session.GetItemFromID($aEntryIDs[$i], Default)		$oItem = $oOL.Session.GetItemFromID($aEntryIDs[$i], Default) ; Translate the EntryID string to the item object
	ConsoleWrite("From: " & $oItem.SenderName & @CRLF & "Subject: " & $oItem.Subject & @CRLF & "Class: " & $oItem.Class & " (43=Mail, 53=MeetingRequest ...)" & @CRLF)		ConsoleWrite("From: " & $oItem.SenderName & @CRLF & "Subject: " & $oItem.Subject & @CRLF & "Class: " & $oItem.Class & " (43=Mail, 53=MeetingRequest ...)" & @CRLF)
	Next		Next
	EndFunc		EndFunc
	</syntaxhighlight>		</syntaxhighlight>
			More examples come with the UDF.

	===== Object model =====		===== Object model =====

Water: /* Events */

2021-02-18T21:51:31Z

Events

@@ Line 69: / Line 69: @@
 Responding to application-level events is somewhat more involved because steps must be taken to associate the event handler with the part of Outlook in which the event is occurring.
-Example:
+Example (reduced to the minimum):
 ===== Object model =====

Water: /* Events */

2021-02-18T21:01:22Z

Events

@@ Line 58: / Line 58: @@
 * '''Item.PropertyChange'''<br>Occurs when an explicit built-in property (e.g. Subject) of an instance of the parent object (e.g. mail or contact item)is changed.
 * '''Items.ItemAdd'''<br>Occurs when one or more items are added to the specified collection.<br>This event gets triggered as well when a mail has been sent and the sent mail gets moved to the "Sent Mail" folder.
 ===== Object model =====

Water: /* Outlook */

2021-02-18T20:29:13Z

Outlook

← Older revision		Revision as of 20:29, 18 February 2021
Line 30:		Line 30:
	===== Concepts =====		===== Concepts =====
	You can get an overview of the concepts of Outlook on [https://docs.microsoft.com/en-us/office/vba/api/overview/outlook this website].		You can get an overview of the concepts of Outlook on [https://docs.microsoft.com/en-us/office/vba/api/overview/outlook this website].

	~~===== Object model =====~~
	~~The Outlook object model is described [https://docs.microsoft.com/en-us/office/vba/api/overview/outlook/object-model here].~~

	====== Events ======		====== Events ======
Line 45:		Line 42:
	* An item has been opened, sent, posted, saved or closed,		* An item has been opened, sent, posted, saved or closed,
	* the user has replied to or forwarded a message or initiated a custom action,		* the user has replied to or forwarded a message or initiated a custom action,
	* ~~when~~ an item property has changed.		* an item property has changed.

	'''Application-level events''' typically pertain to more than the items associated with a particular Outlook form. ~~Examples:~~ Events can pertain to		'''Application-level events''' typically pertain to more than the items associated with a particular Outlook form. Events can pertain to
	* the application itself,		* the application itself,
	* to explorer collections and windows,		* to explorer collections and windows,
Line 57:		Line 54:
	The following list describes the most commonly used events:		The following list describes the most commonly used events:

	* '''Application.NewMailEx'''<br>Occurs when a new item is received in the Inbox.		* '''Application.ItemSend'''<br> occurs whenever an Microsoft Outlook item is sent, either by the user through an Inspector (before the inspector is closed, but after the user clicks the Send button) or when the Send method for an Outlook item, such as MailItem, is used in a program.
	* '''Items.ItemAdd'''<br>Occurs when one or more items are added to the specified collection. This event ~~does not run~~ when a ~~large number of items are added~~ to the folder ~~at once~~.		* '''Application.NewMailEx'''<br>Occurs when a new item is received in the Inbox. This does only work for your primary inbox. To monitor shared mailboxes or mailboxes of other users use the ItemAdd event.
			* '''Item.PropertyChange'''<br>Occurs when an explicit built-in property (e.g. Subject) of an instance of the parent object (e.g. mail or contact item)is changed.
			* '''Items.ItemAdd'''<br>Occurs when one or more items are added to the specified collection.<br>This event gets triggered as well when a mail has been sent and the sent mail gets moved to the "Sent Mail" folder.

			===== Object model =====
			The Outlook object model is described [https://docs.microsoft.com/en-us/office/vba/api/overview/outlook/object-model here].

	== Folders ==		== Folders ==

Water: Events added

2021-02-18T20:11:16Z

Events added

@@ Line 33: / Line 33: @@
 ===== Object model =====
 The Outlook object model is described [https://docs.microsoft.com/en-us/office/vba/api/overview/outlook/object-model here].
 == Folders ==