Email Functionaliteiten In Webapplicaties

Door Tim Musschoot
20 augustus 2003

1. Inleiding

Een van de meest voorkomende vragen op nieuwsgroepen en forums betreft het versturen van email vanuit een ASP pagina. Hoewel email formulieren een van de meest frequente toepassingen zijn van de ASP technologie, blijken veel beginnende web programmeurs er moeite mee te hebben om deze zelf foutloos te implementeren. In dit artikel wordt een overzicht gegeven van de verschillende opties die u hebt, en hoe u deze in de praktijk kunt toepassen.

2. Algemeen

ASP is in feite niets meer dan een serverside scripting technologie, toegepast op webdevelopment. Het laat u toe om een serverside scripting taal zoals VBScript en JScript in een webpagina te gebruiken. In plaats van een volledig nieuw platform op te bouwen, gaan men zich oriënteren op de mogelijkheden van die bestaande scripting talen. Het voordeel van die scripting talen is dat men min of meer toegang heeft tot het volledige server systeem (afhankelijk van de ingestelde permissies uiteraard). Vooral de mogelijkheid om COM objecten te gaan gebruiken maakt dit bijzonder interessant. ASP maakt namelijk gebruik van COM objecten om specifieke zaken te gaan verwezenlijken (denk maar aan database operaties, email functionaliteit, ...). In principe kan men alle externe interfaces die aan hand van een COM object geïmplementeerd zijn gaan aanspreken vanuit een ASP pagina.

Om email-functionaliteiten te gaan gebruiken in een webpagina, gaat men een zogenaamd email object, dat op de webserver is geïnstalleerd, in de webpagina oproepen. Er bestaan nu echter een aantal verschillende van die email objecten:

• AspEmail : een betalende component (http://www.aspemail.com)
• Chilkat Asp Email : een andere betalende component (http://www.//chilkatsoft.com)
• CDONTS : een gratis component die bij IIS zit

Voor de betalende componenten verwijs ik u door naar de website van de producent. Daar kunt u voorbeelden zijn hoe u de component kunt gebruiken. In dit artikel wordt CDONTS als referentie gebruikt.

3.CDONTS

3.1 Installatie

Deze component wordt normaal gezien standaard geïnstalleerd als u IIS 4.0 installeert. De component bestaat uit één DLL : cdonts.dll. De afkorting betekent Collaboration Data Objects for NT Server. Zoals het tweede gedeelte van de naam laat vermoeden is dit niet de enige versie die bestaat. Het is een beperkte versie van CDO. Deze laatste is niet gratis, en wordt met Exchange Server geïnstalleerd. Naast email functionaliteit biedt de volledige versie ook de mogelijkheid tot beheer van contactpersonen, afspraken, ... Het wordt door Microsoft omschreven als een Active Messaging Library, die samenwerkt met Exchange Server. Meer info over CDO vindt u op http://www.cdolive.com

Zoals CDO het programma Microsoft Exchange Server nodig heeft, heeft CDONTS de SMTP service nodig die u optioneel met IIS kunt installeren. De component beschikt namelijk niet over een eigen SMTP server, die gebruikt wordt om email te kunnen versturen, maar gebruikt deze van IIS. Om de functionaliteit die deze component biedt te kunnen gebruiken, dient u ervoor te zorgen dat de SMTP service goed geïnstalleerd en geconfigureerd is. Hiervoor verwijs ik u naar het artikel op http://www.more.net/technical/netserv/servers/microsoft/iis4smtpnt4.html#configure

3.2 Gebruik

3.2.1. Creatie van een nieuw object
CDONTS is in feite een bibliotheek met een aantal objecten. Indien u een email wenst aan te maken, dan creëert u een instantie van het NewMail object. Dit doet u als volgt:

Dim objMsg
Set objMsg = Server.CreateObject("CDONTS.NewMail")
' Gebruik hier de functionaliteit van het NewMail object
objMsg = nothing

Zoals alle COM objecten die u in ASP gebruikt, roept u de Server.CreateObject functie aan om een nieuwe instantie van het object aan te maken.

Indien de installatie van de CDONTS dll niet of verkeerd gebeurd is, dan krijgt u hoogstwaarschijnlijk volgende foutmelding te zien:

Server object error 'ASP 0177 : 800401f3'
Server.CreateObject Failed
<asp_pagina_naam>.asp, line <lijn_met_createobject_instructie>
Invalid class string

3.2.2.Attributen van NewMail
In vorige paragraaf werd uitgelegd hoe u een nieuw email object kunt aanmaken. In deze paragraaf gaan we de verschillende eigenschappen van de email invullen (de velden aan, van, onderwerp, ...). Volgende tabel geeft een overzicht van de meestgebruikte velden die u kunt ingeven:

3.2.3.Attachments
Om een bijlage aan uw email toe te voegen kunt u volgende functie gebruiken:
AttachFile(String source, String fileName, long encodingMethod) Hierbij is:

• source : de locatie waar het bestand zich bevindt (pad + bestandsnaam)
• fileName : de naam die je aan deze attachment wil geven (optioneel)
• encodingMethod : de manier waarop de bijlage gecodeerd moet worden (optioneel)

3.2.4.Extra Headers
Wie vertrouwd is met het SMTP protocol (Simple Mail Transfer Protocol) weet dat er naast de standaard headers (from, to, ...) nog een aantal extra headers gebruikt kunnen worden (de zogenaamde X-Headers). Deze kunnen vanaf versie 1.2 van CDO for NTS aan een email toegevoegd worden. Een omschrijving van deze headers is hier niet aan de orde. Het volgende voorbeeld illustreert enkel de manier waarop u zelf headers kunt toevoegen.

3.2.5. Verzenden
De email kan verstuurd worden wanneer u de functie NewMail::Send oproept. Wanneer de email met success werd verstuurd, dan wordt de inhoud ervan ongeldig. Het is niet mogelijk om het object nog voor andere doeleinden te gebruiken. U moet het object gelijkstellen aan nothing (of null in javascript) opdat het gealloceerde geheugen terug vrijgegeven zou worden.

3.2.6. Voorbeeld
Volgende voorbeeldcode demonstreert hoe u vanuit een ASP pagina een email kunt versturen. Indien u deze code wenst te gebruiken, plak deze dan gewoon in uw pagina, en vervang de gegevens (email adressen, onderwerp, ...) door de gegevens die bij u van toepassing zijn.

4.Windows 2000 en Windows XP

4.1.Installatie CDONTS

4.2.Gebruik van CDOSYS

4.2.1.Creatie van een nieuw object
De creatie van een nieuw object gebeurt uiteraard op dezelfde manier als bij de creatie van een nieuw CDONTS object. De naam van het object dat we aanmaken is verschillend. Ter illustratie van de uitbreiding aan functionaliteit van CDOSYS, maken we tevens een object aan van het type CDO.Configuration. Meer hierover echter in de volgende paragraaf.

Zoals het als 'common practice' aanzien wordt, worden de objecten eenmaal deze niet meer nodig zijn, opgeruimd.

(1)Wanneer u de MimeFormatted optie activeert, maar geen HTMLBody instelt, dan wordt de HTMLBody automatisch van het bericht verwijderd. Omgekeerd zal het instellen van een HTMLBody tot gevolg hebben dat de MimeFormatted optie wordt geactiveerd.

In bovenstaande tabel komt geen optie voor die toelaat de prioriteit van het email bericht in te stellen. Dit wil echter niet zeggen dat dit niet mogelijk is. De manier waarop u dit kunt doen is echter niet zo eenvoudig als het instellen van het onderwerp van de email bvb...
Eén van de properties van het Message object heet Fields. Dit object is een container object dat een aantal andere objecten kan bevatten. Het uitleggen van de betekenis van deze collectie zou ons te ver van het onderwerp van dit artikel brengen. et belangrijkste is dat u de prioriteit van het email bericht kunt instellen via een object in deze container. Dit wordt geïllustreerd in volgend voorbeeld:

Door het aanpassen van een object in de Fields collectie stelt men de email prioriteit in. De mogelijke waarden zijn : 0 voor lage prioriteit, 1 voor normale prioriteit en 2 voor hoge prioriteit. Nadat u de prioriteit hebt ingesteld, moet u de Update functie aanroepen. Indien dit niet gebeurt worden de aanpassingen niet doorgevoerd.

Naast deze voornaamste member functies worden nog een aantal extra mogelijkheden geboden, zoals het aanmaken van een reply op een bericht, een forward van een bericht, ... Hier gaan we echter niet op in. Voor de geïnteresseerden verwijs ik naar de MSDN voor meer uitleg (zoek naar het IMessage object).

Bepaalde SMTP servers vereisen authenticatie vooraleer u een mail kunt versturen. Ook in dit geval kunt u de server gebruiken, mits het instellen van de login gegevens.

Het Configuration object maakt deel uit van het Message object. De instellingen worden opgeslagen in het attribuut met naam Message.Configuration.

4.2.3.Voorbeeldcode

Dim iMsg
Dim iConf
Dim iBp
Dim Flds
Set iMsg = CreateObject("CDO.Message")
Set iConf = CreateObject("CDO.Configuration")
Set Flds = iConf.Fields
Flds(“sendusing”) = 2
Flds(“smtpserver”) = "mail.mydomain.com"
Flds(“smtpserverport”) = 25
Flds(“smtpauthenticate”) = 0 ' anoniem
Flds.Update
With iMsg
   Set .Configuration = iConf
   .To = "John@doe.com"
   .From = "fourth@doe.com"
   .Sender = "finally@doe.com"
   .Subject = "Betreft vergaderverzoek"
   .TextBody = "Gelieve de vergadering van aanstaande maandag te verplaatsen”
   Set iBp = .AddAttachment("c:\bijlage.doc")
   iBp.ContentMediaType="application/msword"
   Set iBp = .AddAttachment("c:\anderebijlage.html")
   iBp.ContentMediaType="text/html"
   .Send
End With

Het resultaat van de functie AddAttachment(...) is een object van het type IBodyPart. In dit artikel wordt niet ingegaan op de details van dit object. Het enige wat we vermelden is dat men hiervan het attribuut ContentMediaType kan instellen. Dit is een vorm van identificatie van het type bijlage. De mogelijkheden zijn onder andere “application/msword” voor een Word document, “image/gif” voor een GIF afbeelding, ... Dergelijke specificaties zijn voornamelijk van belang voor de emailsoftware op de client. Deze kan op die manier bepalen hoe de bijlage geopend kan worden.

5. Besluit

Ondanks de herhaalde vraag op verschillende forums en mailing lists betreffende het installeren van CDONTS op een Windows XP machine, wordt deze methode ten stelligste afgeraden. De technologie waarop deze component gebaseerd is, is verouderd. Het spijtige aan CDOSYS is het feit dat de code niet compatibel is met deze van zijn voorganger. Een migratie van alle modules die gebruik maken van email functionaliteit zal dus noodzakelijk zijn.

Het gebruik van email functionaliteit in een webapplicatie is een stuk eenvoudiger geworden in ASP.NET. De componenten die in het .NET framework aanwezig zijn maken gebruik van CDOSYS. De mogelijkheden die daar geboden worden zijn gelijkaardig aan deze beschreven in de CDOSYS sectie.

copyright 2003 Tim Musschoot