Tuesday, January 15, 2008

Exporting the OOF (Out of Office) Setting for every user on a server using CDO 1.2 and VBS

This is another one that came out of the Ether the Out of office functionality was one of the things that received a welcome makeover with Exchange 2007 / Outlook 2007. If you’re moving, migrating or just wondering if people are actually using the Out of Office Assistant then this might be the script for you. This script is broken down into 2 parts the first part of the script takes one command line parameter which is the name of the server you want to export the information from and then it does a ADSI query of Active Directory to get the detail of every account on the server in question. The second part of the script connects to each of the mailboxes the ADSI query found and looks to see if the oof setting is enabled. One of the good things about CDO 1.2 is that it makes getting and setting the oof setting on a mailbox very simple basically once you have logged on you can pull the oof setting from the outofoffice and outofofficetext property of the session object. The format this script uses to export the oofsetting is XML the text of the OOF message is held in a Cdata section to allow for any non standard characters that were used in the oof message that might throw the format.

Exporting the OOF setting is great but if you want to do more than just analyze the data you get back you need something that will read the data you exported and reset them on a mailbox. With the increased functionality of the OOF in Exchange 2007 has come extra complexity so while you could reset the OOF setting on Exchange 2007 using CDO 1.2 to make use of the extra functionality like internal and external OOF message you need to use Exchange Web Service. So watch this space for a sample.

To run the script you need to give it one cmdline parameter which is the servername of the server you want to run it against. Eg cscript exportoof.vbs servername it will write a file to c:\temp\offexport-servername.xml

I’ve put a download of the script here the script itself looks like

servername = wscript.arguments(0)
Set fso = CreateObject("Scripting.FileSystemObject")
set wfile = fso.opentextfile("c:\temp\offexport-" & servername & ".xml",2,true)

wfile.writeline("<?xml version=""1.0""?>")
wfile.writeline("<ExportedOffs ExportDate=""" & WeekdayName(weekday(now),3) & ",
" & day(now()) & " " & Monthname(month(now()),3) & " " & year(now()) & " " &
formatdatetime(now(),4) & ":00" & """>")
set conn = createobject("ADODB.Connection")
set com = createobject("ADODB.Command")
Set iAdRootDSE = GetObject("LDAP://RootDSE")
strNameingContext = iAdRootDSE.Get("configurationNamingContext")
strDefaultNamingContext = iAdRootDSE.Get("defaultNamingContext")
Conn.Provider = "ADsDSOObject"
Conn.Open "ADs Provider"
svcQuery = "<LDAP://" & strNameingContext & ">;(&(objectCategory=msExchExchangeServer)(cn="
& Servername & "));cn,name,legacyExchangeDN;subtree"
Com.ActiveConnection = Conn
Com.CommandText = svcQuery
Set Rs = Com.Execute
while not rs.eof
GALQueryFilter = "(&(&(&(& (mailnickname=*)(!msExchHideFromAddressLists=TRUE)(|
(&(objectCategory=person)(objectClass=user)(msExchHomeServerName=" &
rs.fields("legacyExchangeDN") & ")) )))))"
strQuery = "<LDAP://" & strDefaultNamingContext & ">;" & GALQueryFilter & ";distinguishedName,mailnickname,mail;subtree"
com.Properties("Page Size") = 100
Com.CommandText = strQuery
Set Rs1 = Com.Execute
while not Rs1.eof
call procmailboxes(servername,rs1.fields("mail"))
wscript.echo rs1.fields("mail")
set fso = nothing
set conn = nothing
set com = Nothing

wscript.echo "Done"

sub procmailboxes(servername,MailboxAlias)

Set msMapiSession = CreateObject("MAPI.Session")
on error Resume next
msMapiSession.Logon "","",False,True,True,True,Servername & vbLF & MailboxAlias
if err.number = 0 then
on error goto 0
if msMapiSession.outofoffice = false and msMapiSession.outofofficetext = "" then
wscript.echo "No OOF Data for user"
wfile.writeline("<OOFSetting DisplayName=""" & msMapiSession.CurrentUser & """
EmailAddress=""" & MailboxAlias & """ Offset=""" _
& msMapiSession.outofoffice & """><![CDATA[ " & msMapiSession.outofofficetext & "]]></OOFSetting>")
End if
Wscript.echo "Error Opening Mailbox"
end if
Set msMapiSession = Nothing
Set mrMailboxRules = Nothing

End Sub


klynnlynch said...

Is this script just for Exchange 2007/Outlook 2007? Could I use this scrip on Exchange 2003/Outlook 2003?

I need to tell if users have their Out of Office on in our environment.

Thank you

Glen said...

This script because it uses Mapi and CDO 1.2 will work on any version of Exchange if you get an error on 2003 let me know and i can let you know how to fix it. You might also be interested in Andy's tool for oof http://telnetport25.wordpress.com/downloads/


Anonymous said...

This is great Glen. Thanks so much! It has been working like a charm for a while and then all of the sudden this week it stops before the closing "ExportedOffs" tag and doesn't display properly on the web page. What could I be missing. Thanks.

Glen said...

It sounds like the script is hitting a error somewhere you could try a "On error resume next" at the top of the script to make it skip errors. Or have a look at what the error you get is when you run it from the cmdline eg permissions ,disabled account etc.


Anonymous said...

Hi Glen, I am having trouble using your code on Exchange 2003 and VS 2008. I get the dreaded Logon Failure. You mentioned in an earlier post that you may have a fix for 2003?

Thank you

Glen said...

It depends what logon failure your getting what happens in VBS is that CDO 1.2 doesn't close the session properly even if you call the logoff method. This means after you have processed about 30-50 mailboxs you will hit the session limit. The way i fixed this with VBS is to use 2 scripts basically when the Mapi script finished running the object go out of scope and the session closed. Mapi and CDO 1.2 isn't supported in .NET so you may or may not have his problem and you may have another problem altogther.