EAGetMail ActiveX Object References


EAGetMail ActiveX Object contains objects that allow you to parse and receive email messages. Parseing email message, winmail.dat (TNEF) and encrypted message becomes very easily. The objects in this namespace can be used from Visual Basic 6.0 or any COM compatible application.

Objects

Object Description
Attachment Provides properties and methods for presenting e-mail attachment.
Certificate Provides properties and methods for presenting a digital certificate.
HeaderCollection Collection of HeaderItem object.
HeaderItem Provides properties and methods for presenting an e-mail header.
Imap4Folder Provides properties and methods for presenting an IMAP4 folder.
Mail Provides properties and methods for presenting an e-mail message.
MailAddress Provides properties and methods for presenting an e-mail address including display name, e-mail address.
MailClient Provides properties and methods for receiving messages and managing IMAP4 folder.
MailInfo Provides properties and methods for presenting an e-mail information(size, uidl, flags) on mail server.
MailServer Provides properties and methods for constructing a pop3/imap4 server instance.
MailReport Represents a delivery report.

Example

[Visual Basic 6.0, Visual C++] The following example demonstrates how to receive email with EAGetMail POP3 & IMAP ActiveX Object, but it doesn't demonstrates the events and mail parsing usage. To get the full samples of EAGetMail, please refer to Samples section.

[Visual Basic 6.0]
Public Sub ReceiveMail( _
ByVal sServer As String, _
ByVal sUserName As String, _
ByVal sPassword As String, _
ByVal bSSLConnection As Boolean)
    
    Const MailServerPop3 = 0
    Const MailServerImap4 = 1

    'For evaluation usage, please use "TryIt" as the license code, otherwise the
    '"invalid license code" exception will be thrown. However, the object will expire in 1-2 months, then
    '"trial version expired" exception will be thrown.
    Dim oClient As New EAGetMailObjLib.MailClient
    oClient.LicenseCode = "TryIt"
    
    'To receive email from imap4 server, please change
    'MailServerPop3 to MailServerImap4 in MailServer constructor
    Dim oServer As New EAGetMailObjLib.MailServer
    oServer.Server = sServer
    oServer.User = sUserName
    oServer.Password = sPassword
    oServer.SSLConnection = bSSLConnection
    oServer.Protocol = MailServerPop3
    
    ''by default, the pop3 port is 110, imap4 port is 143,
    'the pop3 ssl port is 995, imap4 ssl port is 993
    'you can also change the port like this
    'oServer.Port = 110
    If oServer.Protocol = MailServerImap4 Then
        If oServer.SSLConnection Then
            oServer.Port = 993 'SSL IMAP4
        Else
            oServer.Port = 143 'IMAP4 normal
        End If
    Else
        If oServer.SSLConnection Then
            oServer.Port = 995 'SSL POP3
        Else
            oServer.Port = 110 'POP3 normal
        End If
    End If
    
    On Error GoTo ErrorHandle
        oClient.Connect oServer
        Dim infos
        infos = oClient.GetMailInfos()
        
        Dim i, Count
        Count = UBound(infos)
        For i = LBound(infos) To Count
            Dim info As EAGetMailObjLib.MailInfo
            Set info = infos(i)
            Dim oMail As EAGetMailObjLib.Mail
            Set oMail = oClient.GetMail(info)
            'Save mail to local
            oMail.SaveAs "d:\tempfolder\" & i & ".eml", True
        Next

        For i = LBound(infos) To Count
            oClient.Delete (infos(i))
        Next

        '' Delete method just mark the email as deleted,
        ' Quit method pure the emails from server exactly.
        oClient.Quit
        Exit Sub
ErrorHandle:
        ''Error handle
        MsgBox Err.Description
        
        oClient.Close
End Sub

[VBScript]

Sub ReceiveMail( _
ByVal sServer, _
ByVal sUserName, _
ByVal sPassword, _
ByVal bSSLConnection)
    
    Const MailServerPop3 = 0
    Const MailServerImap4 = 1

    'For evaluation usage, please use "TryIt" as the license code, otherwise the
    '"invalid license code" exception will be thrown. However, the object will expire in 1-2 months, then
    '"trial version expired" exception will be thrown.
    Dim oClient
    Set oClient = CreateObject("EAGetMailObj.MailClient")
    oClient.LicenseCode = "TryIt"
    
    'To receive email from imap4 server, please change
    'MailServerPop3 to MailServerImap4 in MailServer constructor
    Dim oServer
    Set oServer = CreateObject("EAGetMailObj.MailServer")
    oServer.Server = sServer
    oServer.User = sUserName
    oServer.Password = sPassword
    oServer.SSLConnection = bSSLConnection
    oServer.Protocol = MailServerPop3
    
    ''by default, the pop3 port is 110, imap4 port is 143,
    'the pop3 ssl port is 995, imap4 ssl port is 993
    'you can also change the port like this
    'oServer.Port = 110
    If oServer.Protocol = MailServerImap4 Then
        If oServer.SSLConnection Then
            oServer.Port = 993 'SSL IMAP4
        Else
            oServer.Port = 143 'IMAP4 normal
        End If
    Else
        If oServer.SSLConnection Then
            oServer.Port = 995 'SSL POP3
        Else
            oServer.Port = 110 'POP3 normal
        End If
    End If
    

    oClient.Connect oServer
    Dim infos
    infos = oClient.GetMailInfos()
    
    Dim i, Count
    Count = UBound(infos)
    For i = LBound(infos) To Count
        Dim info
        Set info = infos(i)
        Dim oMail
        Set oMail = oClient.GetMail(info)
        'Save mail to local
        oMail.SaveAs "d:\tempfolder\" & i & ".eml", True
    Next

    For i = LBound(infos) To Count
        oClient.Delete (infos(i))
    Next

    '' Delete method just mark the email as deleted,
    ' Quit method pure the emails from server exactly.
    oClient.Quit
End Sub

[Visual C++]
#include "eagetmailobj.tlh"
using namespace EAGetMailObjLib;

void ReceiveMail( 
        LPCTSTR sServer, 
        LPCTSTR sUserName,
        LPCTSTR sPassword,
        bool bSSLConnection)
{
    ::CoInitialize( NULL );

    const int MailServerPop3 = 0;
    const int MailServerImap4 = 1;

    IMailClientPtr oClient;
    oClient.CreateInstance( "EAGetMailObj.MailClient" );

    IMailServerPtr oServer;
    oServer.CreateInstance( "EAGetMailObj.MailServer" );

    try
    {
        // For evaluation usage, please use "TryIt" as the license code, otherwise the
        // "invalid license code" exception will be thrown. However, the object will expire in 1-2 months, then
        // "trial version expired" exception will be thrown.
        oClient->LicenseCode = _T("TryIt");

        oServer->Server = sServer;
        oServer->User = sUserName;
        oServer->Password = sPassword;
        
        INT nProtocol = MailServerPop3;

        oServer->Protocol = nProtocol;
        if( nProtocol == MailServerPop3 )
        {
            if( bSSLConnection )
            {
                oServer->Port = 995;
                oServer->SSLConnection = VARIANT_TRUE;
            }
            else
            {
                oServer->Port = 110;
            }
        }
        else
        {
            if( bSSLConnection )
            {
                oServer->Port = 993;
                oServer->SSLConnection = VARIANT_TRUE;
            }
            else
            {
                oServer->Port = 143;
            }
        }

        oClient->Connect( oServer );

        _variant_t arInfo = oClient->GetMailInfos();
        SAFEARRAY *psa = arInfo.parray;

        long LBound = 0, UBound = 0;
        SafeArrayGetLBound( psa, 1, &LBound );
        SafeArrayGetUBound( psa, 1, &UBound );
    
        INT count = UBound-LBound+1;
        for( long i = LBound; i <= UBound; i++ )
        {
            _variant_t vtInfo;
            SafeArrayGetElement( psa, &i, &vtInfo );
            
            IMailInfoPtr pInfo;
            vtInfo.pdispVal->QueryInterface(__uuidof(IMailInfo), (void**)&pInfo);

            IMailPtr oMail = oClient->GetMail(pInfo);
            TCHAR szFile[MAX_PATH+1];
            memset(szFile, 0, sizeof(szFile));
            ::wsprintf( szFile, _T("d:\\tempfolder\\%d.eml"), i );
            //save to local disk
            oMail->SaveAs( szFile, VARIANT_TRUE );
            oMail.Release();
        }

        
        for( long i = LBound; i <= UBound; i++)
        {
            _variant_t vtInfo;
            SafeArrayGetElement( psa, &i, &vtInfo );

            IMailInfoPtr pInfo;
            vtInfo.pdispVal->QueryInterface(__uuidof(IMailInfo), (void**)&pInfo);

            //delete email from server
            oClient->Delete( pInfo );
        }

        // Delete method just mark the email as deleted, 
        // Quit method pure the emails from server exactly.
        arInfo.Clear();
        oClient->Quit();
    }
    catch( _com_error &ep )
    {
        MessageBox( NULL,  ep.Description(), _T("Error"), MB_OK );
    }
    

    oClient.Release();
    oServer.Release();

    ::CoUninitialize();
}