ActiveX - SLPOP

ActiveX: SLPOP (Filnamn: SLPOP3.OCX)

SLPOP är en komponent med vars hjälp du kan hämta e-post från en POP3-server. Komponenten kan också returnera information om väntande mejl, tex antal väntande mejl och deras storlekar. SLPOP tillämpar asynkron överföring vilket innebär att e-post kan hämtas i bakgrunden medan ditt program fortsätter med annat. Komponenten använder protokollet POP3 vid kommunikationen med e-postservern.

Datatyperna nedan är angivna enligt VB 6.0 standard. I VB.NET ska Integer ersättas med Short (16 bitar) och Long ersättas med Integer (32 bitar).

Egenskaper

Namn	Datatyp	Beskrivning
AppendToLog	Boolean	Om denna egenskap sätts till True så kommer en tidigare loggfil inte att raderas utan nya logg placeras sist i befintlig loggfil. Om denna egenskap sätts till False så kommer tidigare loggfil att raderas när metoden Connect anropas. Egenskapen UseLog måste vara satt till True för att denna egenskap ska vara relevant. .
IsErrorBounce	Boolean	Returnerar True om mailet är en e-poststuds (felretur), annars False. Den egenskap kan endast avläsas. .
MailBody	String	Via denna egenskap kan du erhålla själva mail-texten. Dock måste du ladda ned ett e-mail först och det gör du genom anrop av metoden ReceiveMail. Läs denna för mer information. .
MailDate	String	Via egenskap returneras datum och klockslag som mailet skickades iväg (avläser fältet Date i e-posthuvudet). .
MailFrom	String	I denna egenskap lagras avsändarens e-postadress. Informationen finns lagrad i e-postmeddelandets e-posthuvud och du måste först ladda ned den med metoden GetMailHeader. Läs denna för mer information. .
MailHeader	String	I denna egenskap lagras ett e-postmeddelandes e-posthuvud. Här hittar du detaljerade uppgifter om exempelvis avsändare, mottagare, datum osv. För att ladda ned ett huvud måste metoden GetMailHeader anropas. .
MailPort	Long	Här anger du den port hos e-postservern som ska användas till kommunikation. Normalt används port 110. .
MailReplyTo	String	I denna egenskap lagras den e-postadress som avsändaren vill ha ett svar till. Informationen finns lagrad i e-postmeddelandets e-posthuvud och du måste först ladda ned den med metoden GetMailHeader. Läs denna för mer information. .
MailServer	String	Här anger du den e-postserver (POP3-server) varifrån e-mail ska hämtas ifrån. .
MailSubject	String	I denna egenskap lagras ämnesraden till ett e-mail. Innan du kan läsa av denna egenskap måste du anropa metoden GetMailHeader för att erhålla e-postmeddelandets e-posthuvud. .
Password	String	Här anger du eventuellt lösenord som krävs för kommunikation med e-postservern. .
UseLog	Boolean	Sätter på eller stänger av logghantering i komponenten. Om denna egenskap sätts till True kommer en loggfil som innehåller detaljerad information om kommunikationen mellan klient och server att skapas. Filnamnet på loggfilen är alltid SLPOP3AX.LOG och i Windows Vista och senare skapas loggfilen i mappen \Users\<Användare>\AppData\Roaming\SamLogic\Log Files. I Windows XP och äldre skapas loggfilen i Windows-katalogen (oftast C:\Windows). För att erhålla aktuell sökväg kan metoden GetLogPath användas. .
UserName	String	Här anger du eventuellt användarnamn som krävs för kommunikation med e-postservern. .

Händelser

Namn	Beskrivning
Connected	Denna händelse sänds när en förbindelse har etablerats till e-postservern. .
Disconnected	Denna händelse sänds när en förbindelsen till e-postservern har avslutats utan problem. .
ErrorOccured	Denna händelse sänds om ett fel inträffar i nåt skede vid användning av komponenten. .
MailHeaderReceived	Denna händelse sänds när ett e-posthuvud har laddats hem efter anrop av metoden GetMailHeader. .
MailReceived	Denna händelse sänds när ett mejl har laddats hem efter anrop av metoden ReceiveMail. .
MailServerReportedError	Denna händelse sänds när e-postservern indikerar att ett fel har inträffat. Denna händelse har en parameter som heter Operation som talar om vid vilken operation som felet inträffade. Några vanliga värden för Operation är: 1 = Felet inträffade när användarnamnet skickades. 2 = Felet inträffade när lösenordet skickades. 5 = Felet inträffade när e-posthuvudet hämtades. 7 = Felet inträffade när meddelandet hämtades. .
MailSizeReceived	Denna händelse sänds när storleken har erhållits efter ett anrop av metoden GetMailSize. Storleken på mejlet kan läsas från parametern MailSize. .

Metoder

Connect () As Boolean

Öppnar en förbindelse till en POP3-server. Uppstår ett fel returnerar metoden False, annars True. Innan någon data kan avläsas måste en lyckad förbindelse till e-postservern ha upprättats. Händelsen Connected sänds när en förbindelse har öppnats till e-postservern.

Disconnect () As Boolean

Stänger förbindelsen till den öppnade POP3-servern. Uppstår ett fel returnerar metoden False, annars True.

Break ()

Avbryter pågående operation. Metoden kan utnyttjas om komponenten väntar på svar från e-postservern och inget sådant kommer inom en förväntad tidsrymd. Då kan denna metod anropas för att bryta vänteläget.

Delete (MailNumber As Integer) As Boolean

Raderar specificerat mejl från servern. Parametern MailNumber anger det mejl som ska raderas. Första mejlet har värdet 1, det andra mejlet 2 osv. Mejlet plockas bort fysiskt från e-postservern först när förbindelsen brutits med Disconnect. Metoden returnerar True om allt gått bra, annars False.

GetLastError () As Long

Returnerar senast inträffade fel i komponenten.

GetLastReplyCode () As Long

Returnerar senaste svarskoden från e-postservern. Är alltid ett av följande värden: 1 = OK, 0 = fel eller 2 = kan ej fastställa svar.

GetLastReplyMsg () As String

Returnerar senaste svarsmeddelandet från e-postservern.

GetLogPath () As String

Returnerar aktuell sökväg till loggfil.

GetMailDateTime () As Date

Returnerar datum och klockslag som mailet skickades iväg (avläser fältet Date i e-posthuvudet).

GetMailHeader (MailNumber As Integer) As Boolean

Laddar hem e-posthuvudet till ett e-postmeddelande. Parametern MailNumber specificerar det mejl vars huvud ska laddas hem. Första mejlet har värdet 1. När ett e-posthuvud har laddats ned till din lokala dator sänds händelsen MailHeaderReceived. Du kan sedan läsa av e-posthuvudet via egenskapen MailHeader. Du kan också erhålla värden för vissa fält i huvudet genom att läsa av egenskaperna MailFrom, MailReplyTo och MailSubject. Metoden returnerar True om allt gått bra eller False vid fel.

GetMailSize (MailNumber As Integer) As Boolean

Hämtar storleken i bytes för ett e-postmeddelande i e-postservern. Parametern MailNumber specificerar det mejl som ska undersökas. Första mejlet har värdet 1. När storleken har erhållits sänds händelsen MailSizeReceived. Storleken på mejlet returneras via parametern MailSize i händelsen MailSizeReceived. Metoden returnerar True om allt gått bra eller False vid fel.

GetNumWaitingMails () As Integer

Returnerar antal väntande e-postmeddelanden i e-postservern.

GetNumWaitingMailsLong () As Long

Returnerar antal väntande e-postmeddelanden i e-postservern. Denna metod bör användas istället för GetNumWaitingMails om antal mejl i ett POP3-konto kan bli väldigt många, dvs riskerar att överstiga 32767 st.

GetSizeWaitingMails () As Long

Returnerar den sammanlagda storleken i bytes på de e-postmeddelanden som väntar i e-postservern.

ReceiveMail (MailNumber As Integer) As Boolean

Laddar hem ett väntande e-postmeddelande från e-postservern. Parametern MailNumber specificerar numret på det mejl som ska laddas hem. Första mejlet har numret 1. När ett e-postmeddelande har laddats ned till din lokala dator sänds händelsen MailReceived. Därefter kan du kan läsa av e-postmeddelandets text via egenskapen MailBody. Ämnesraden för mejlet kan du läsa från egenskapen MailSubject. Avsändare och returadress kan avläsas från MailFrom och MailReplyTo. Metoden plockar inte bort det nedladdade mejlet från servern utan det måste göras separat med metoden Delete. ReceiveMail returnerar True om allt gått bra eller False vid fel.
.

Exempel

Se exempelprogrammet POP3 för exempel på hur man använder denna komponent. Du hittar exemplet i mappen \Examples VB6\Pop3.