MailClient.Delete Method


Marks the specified email as deleted.

[Visual Basic]
Public Sub Delete( _
    info As MailInfo
)
[C#]
public void Delete(
    MailInfo info
);
[C++]
public: void Delete(
    MailInfo* info
);
[JScript]
public function Delete( 
    info: MailInfo
);

Parameters

info
The MailInfo instance to delete.

Remarks

Delete method only marks the email as deleted, only the MailClient.Quit method (POP3 and IMAP4) or MailClient.Expunge method(IMAP4 only) pures the deleted email from server. For POP3, deleted flag will lose if the connection is closed; FOR IMAP4, the deleted flag is permant even the connection is closed.

Example

[Visual Basic, C#, C++] The following example demonstrates how to receive email with EAGetMail POP3 & IMAP Component, 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]
Imports EAGetMail

Public Sub ReceiveMail( _
ByVal sServer As String, _
ByVal sUserName As String, _
ByVal sPassword As String, _
ByVal bSSLConnection As Boolean)
    Dim oClient As New MailClient("TryIt")
    'To receive email from imap4 server, please change
    'ServerProtocol.Pop3 to ServerProtocol.Imap4 in MailServer constructor

    Dim oServer As New MailServer(sServer, _
        sUserName, sPassword, bSSLConnection, _
        ServerAuthType.AuthLogin, ServerProtocol.Pop3)

    '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
    
    ' generates a log file
    ' oClient.LogFileName = "c:\pop.log"
    
    Try
        oClient.Connect(oServer)
        Dim infos() As MailInfo = oClient.GetMailInfos()
        Dim count As Integer = infos.Length
        For i As Integer = 0 To count - 1
            Dim info As MailInfo = infos(i)
            
            Console.WriteLine( "UIDL: {0}", info.UIDL )
            Console.WriteLine( "Index: {0}", info.Index )
            Console.WriteLine( "Size: {0}", info.Size )
            'For POP3 server, the IMAP4MailFlags is meaningless.
            Console.WriteLine( "Flags: {0}", info.IMAP4MailFlags )
            
            Dim oMail As Mail = oClient.GetMail(info)
            ''Save mail to local    file
            oMail.SaveAs(String.Format("c:\{0}.eml", i), True)
        Next

        For i As Integer = 0 To count - 1
            Dim info As MailInfo = infos(i)
            oClient.Delete(info)
        Next
        '
        ' Delete method just mark the email as deleted, 
        ' Quit method pure the emails from server exactly.
        oClient.Quit()

    Catch ep As MailServerException
        ''Message contains the information returned by mail server
        Console.WriteLine("Server Respond: {0}", ep.Message)
    Catch ep As System.Net.Sockets.SocketException
        Console.WriteLine("Socket Error: {0}", ep.Message)
    Catch ep As Exception
        Console.WriteLine("System Error: {0}", ep.Message)
    End Try
    
    ' show the conversation between server and client.
    Console.WriteLine( oClient.Conversation )
    oClient.Close()
End Sub

[C#]
using System;
using System.Collections;
using EAGetMail;

public void ReceiveMail( 
    string sServer, 
    string sUserName,
    string sPassword,
    bool bSSLConnection)
{
    MailClient oClient = new MailClient("TryIt");
    //To receive email from imap4 server, please change
    //ServerProtocol.Pop3 to ServerProtocol.Imap4 in MailServer constructor

    MailServer oServer  = new MailServer(sServer, 
        sUserName, sPassword, bSSLConnection, 
        ServerAuthType.AuthLogin, ServerProtocol.Pop3);

    //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;
    
    // generates a log file
    // oClient.LogFileName = "c:\\pop3.log";
    
    try
    {
        oClient.Connect(oServer);
        MailInfo [] infos = oClient.GetMailInfos();
        int count = infos.Length;
        for( int i = 0; i < count; i++ )
        {
            MailInfo info = infos[i];
            
            Console.WriteLine( "UIDL: {0}", info.UIDL );
            Console.WriteLine( "Index: {0}", info.Index );
            Console.WriteLine( "Size: {0}", info.Size );
            //For POP3 server, the IMAP4MailFlags is meaningless.
            Console.WriteLine( "Flags: {0}", info.IMAP4MailFlags );
                        
            Mail oMail = oClient.GetMail(info);
            //Save mail to local file
            oMail.SaveAs(String.Format("c:\\{0}.eml", i), true);
        }

        for( int i = 0; i < count; i++ )
        {
            MailInfo info = infos[i];
            oClient.Delete(info);
        }
    
        // Delete method just mark the email as deleted, 
        // Quit method pure the emails from server exactly.
        oClient.Quit();
    }
    catch( MailServerException ep ) 
    {
        //Message contains the information returned by mail server
        Console.WriteLine("Server Respond: {0}", ep.Message);
    }
    catch( System.Net.Sockets.SocketException ep ) 
    {
        Console.WriteLine("Socket Error: {0}", ep.Message);
    }
    catch( Exception ep ) 
    {
        Console.WriteLine("System Error: {0}", ep.Message);
    }

    // show the conversation between server and client.
    Console.WriteLine( oClient.Conversation );
    oClient.Close();
}

[C++]
using namespace System;
using namespace System::Collections;
using namespace EAGetMail; 

Void ReceiveMail( 
        String *sServer, 
        String *sUserName,
        String *sPassword,
        bool bSSLConnection)
{
    MailClient *oClient = new MailClient(S"TryIt");
    //To receive email from imap4 server, please change
    //ServerProtocol::Pop3 to ServerProtocol::Imap4 in MailServer constructor

    MailServer *oServer  = new MailServer(sServer, 
        sUserName, sPassword, bSSLConnection, 
        ServerAuthType::AuthLogin, ServerProtocol::Pop3);

    //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;
    
    // generates a log file
    // oClient-> = S"c:\\pop.log";
    try
    {
        oClient->Connect(oServer);
        MailInfo *infos[]= oClient->GetMailInfos();
        int count = infos->Length;
        for( int i = 0; i < count; i++ )
        {
            MailInfo *info = infos[i];

            Console::WriteLine( "UIDL: {0}", info->UIDL );
            Console::WriteLine( "Index: {0}", __box(info->Index));
            Console::WriteLine( "Size: {0}", __box(info->Size));
            //For POP3 server, the IMAP4MailFlags is meaningless.
            Console::WriteLine( "Flags: {0}", info->IMAP4MailFlags );
                        
            Mail *oMail = oClient->GetMail(info);
            //Save mail to local file
            oMail->SaveAs(String::Format(S"c:\\{0}.eml", __box(i)), true);
        }

        for( int i = 0; i < count; i++ )
        {
            MailInfo *info = infos[i];
            oClient->Delete(info);
        }
    
        // Delete method just mark the email as deleted, 
        // Quit method pure the emails from server exactly.
        oClient->Quit();
    }
    catch( MailServerException *ep ) 
    {
        //Message contains the information returned by mail server
        Console::WriteLine( S"Server Respond: {0}", ep->Message);
    }
    catch( System::Net::Sockets::SocketException *ep ) 
    {
        Console::WriteLine( S"Socket Error: {0}", ep->Message);
    }
    catch( Exception *ep ) 
    {
        Console::WriteLine( S"System Error: {0}", ep->Message);
    }
    
    // show the conversation between server and client.
    Console::WriteLine( oClient->Conversation );
    oClient->Close();
}