Smtp.RetryFailedJobs Method

Puts all failed send-mail jobs back into the queue.

public void RetryFailedJobs();

Remarks

This method can be used to retry processing of all failed jobs. For instance, there had been some kind of network failure during processing jobs and certain e-mails failed to be sent. Then, however, the network problem was fixed. In this case, the developer can issue RetryFailedJobs to put failed jobs back into the pending queue. Then, any method which processes jobs (such as SendJobs) can be called to resume processing.

RetryFailedJobs method takes all the jobs from JobsFailed collection and puts them back to JobsPending.

Note This method is thread-safe. The developer may safely call it even if some jobs are already being actively processed in the current moment. This may be useful in the case if it's needed to retry failed jobs not waiting for completion of processing the remaining jobs. For instance, if SendJobs method was still running when RetryFailedJobs was called, it will then process the newly added failed jobs as well as the remaining pending jobs.
If you want to move only specific jobs (not all failed jobs) from JobsFailed into JobsPending, use methods of SendMailJobCollection class (all job collections, including JobsFailed and JobsPending, are SendMailJobCollection instances).

Example

This console sample performs mail merge in two runs. On the second run, all the data rows which failed to be sent out as e-mail messages on the first run are tried again. The application may complete in a single run if all the data rows have been successfully sent as e-mails within the first run.

Note In the case if the application terminates after the first run and wishes to retry mail merge of failed data rows later in a separate run of the application, it needs to somehow save the list of data rows which failed on the first run (e.g. save this list in a file or database) and then pass this list to the second instance of the application (which is executed later). See GetIndicesAsString topic for details.

[C#]
using System;
using System.Data;
using System.Data.OleDb;
using MailBee;
using MailBee.Mime;
using MailBee.SmtpMail;

class Sample
{
    // Reports successful attempt of sending e-mail.
    static void mailer_MessageSent(object sender, SmtpMessageSentEventArgs e)
    {
        // Display e-mail address of the successful e-mail.
        Console.WriteLine(e.MergeTable.Rows[e.MergeRowIndex]["Email"] + " SUCCEEDED");
    }

    // Reports failed attempt of sending e-mail.
    static void mailer_MessageNotSent(object sender, SmtpMessageNotSentEventArgs e)
    {
        // Display e-mail address of the failed e-mail.
        Console.WriteLine(e.MergeTable.Rows[e.MergeRowIndex]["Email"] + " FAILED");
    }

    static void Main(string[] args)
    {
        Smtp mailer = new Smtp();

        // Logging into a file is useful for troubleshooting.
        mailer.Log.Filename = @"C:\log.txt";
        mailer.Log.Enabled = true;
        mailer.Log.Format = LogFormatOptions.AddContextInfo;
        mailer.Log.Clear();

        // Uncomment the line below to use unlimited number of worker threads (up to 60)
        // and increase performance. Note that not all SMTP servers support this.

        // mailer.MaxThreadCount = -1;

        // Subscribe to events to track send bulk mail progress.
        mailer.MessageSent += new SmtpMessageSentEventHandler(mailer_MessageSent);
        mailer.MessageNotSent += new SmtpMessageNotSentEventHandler(mailer_MessageNotSent);

        // Setup SMTP server parameters.
        mailer.SmtpServers.Add("mail.domain.com", "jdoe", "secret");

        // Setup e-mail message header template for mail merge.
        mailer.Message.From.AsString = "John Doe <john.doe@domain.com>";
        mailer.Message.To.AsString = "##Email##";
        mailer.Message.Subject = "Our Jan/2007 newsletter";

        // Setup HTML body template.
        mailer.Message.BodyHtmlText = "<html>##Body##</html>";

        // Specify database connection string (it may be different in your case).
        string connParams = @"Provider=Microsoft.Jet.OLEDB.4.0; Data Source=C:\Newsletter.mdb;";

        // Make two runs of mail merge. If e-mails created from some data rows fail,
        // we'll attempt to resend them on the second run.
        for (int i = 0; i < 2; i++)
        {
            // Initial run.
            if (i == 0)
            {
                // Connect to the database and populate mail merge job to-do list with
                // the data from "mailing_list" table.
                using (OleDbConnection conn = new OleDbConnection(connParams))
                {
                    // Open the connection and get the data.
                    OleDbCommand command = new OleDbCommand("SELECT * FROM mailing_list", conn);
                    conn.Open();
                    OleDbDataAdapter adapter = new OleDbDataAdapter();
                    DataTable table = new DataTable();
                    adapter.SelectCommand = command;
                    adapter.Fill(table);

                    // Create a job which is the following task for MailBee: perform mail merge over
                    // the specified data table and then send out each resulting e-mail to
                    // the recipients which appear in the resulting messages. "bounce@domain.com"
                    // address will be used as Return-Path (i.e. sender e-mail address).
                    mailer.AddJob(null, "bounce@domain.com", null, table);
                }
            }

            // Run the job. The actual mail merge takes place here.
            mailer.SendJobs();
            Console.WriteLine();

            // Report results (row indices in the data table) to the console.
            if (mailer.JobsFailed.Count == 0)
            {
                Console.WriteLine("All of the rows of the table have been processed and sent as e-mails.");
                break;
            }
            else
            {
                if (mailer.JobsSuccessful.Count == 0)
                {
                    Console.WriteLine("None of the rows of the table has been processed and sent as e-mail.");
                }
                else
                {
                    Console.WriteLine("Not all rows of the table have been processed and sent as e-mails.");
                    Console.WriteLine();

                    Console.WriteLine("Successful rows: ");
                    Console.WriteLine(mailer.JobsSuccessful.GetIndicesAsString(null, null));
                    Console.WriteLine();

                    Console.WriteLine("Failed rows: ");
                    Console.WriteLine(mailer.JobsFailed.GetIndicesAsString(null, null));
                }
                Console.WriteLine();

                // Put failed data rows from mailer.JobsFailed back into the pending queue (mailer.JobsPending).
                mailer.RetryFailedJobs();

                // Clear the list of successful rows because we already displayed all successful
                // results of the first run. Next time, we want to display only those successful
                // results which had been achieved on the second run only.
                mailer.JobsSuccessful.Clear();
            }
        }
    }
}

[Visual Basic]
Imports System
Imports System.Data
Imports System.Data.OleDb
Imports MailBee
Imports MailBee.Mime
Imports MailBee.SmtpMail

Class Sample
    ' Reports successful attempt of sending e-mail.
    Shared Sub mailer_MessageSent(ByVal sender As Object, ByVal e As SmtpMessageSentEventArgs)
        ' Display e-mail address of the successful e-mail.
        Console.WriteLine(e.MergeTable.Rows(e.MergeRowIndex)("Email") & " SUCCEEDED")
    End Sub

    ' Reports failed attempt of sending e-mail.
    Shared Sub mailer_MessageNotSent(ByVal sender As Object, ByVal e As SmtpMessageNotSentEventArgs)
        ' Display e-mail address of the failed e-mail.
        Console.WriteLine(e.MergeTable.Rows(e.MergeRowIndex)("Email") & " FAILED")
    End Sub

    Shared Sub Main(ByVal args() As String)
        Dim mailer As Smtp = New Smtp

        ' Logging into a file is useful for troubleshooting.
        mailer.Log.Filename = "C:\log.txt"
        mailer.Log.Enabled = True
        mailer.Log.Format = LogFormatOptions.AddContextInfo
        mailer.Log.Clear()

        ' Uncomment the line below to use unlimited number of worker threads (up to 60)
        ' and increase performance. Note that not all SMTP servers support this.

        ' mailer.MaxThreadCount = -1;

        ' Subscribe to events to track send bulk mail progress.
        AddHandler mailer.MessageSent, AddressOf mailer_MessageSent
        AddHandler mailer.MessageNotSent, AddressOf mailer_MessageNotSent

        ' Setup SMTP server parameters.
        mailer.SmtpServers.Add("mail.domain.com", "jdoe", "secret")

        ' Setup e-mail message header template for mail merge.
        mailer.Message.From.AsString = "John Doe <john.doe@domain.com>"
        mailer.Message.To.AsString = "##Email##"
        mailer.Message.Subject = "Our Jan/2007 newsletter"

        ' Setup HTML body template.
        mailer.Message.BodyHtmlText = "<html>##Body##</html>"

        ' Specify database connection string (it may be different in your case).
        Dim connParams As String = "Provider=Microsoft.Jet.OLEDB.4.0; Data Source=C:\Newsletter.mdb;"

        ' Make two runs of mail merge. If e-mails created from some data rows fail,
        ' we'll attempt to resend them on the second run.
        Dim i As Integer
        For i = 0 To 1
            ' Initial run.
            If i = 0 Then
                ' Connect to the database and populate mail merge job to-do list with
                ' the data from "mailing_list" table.
                Dim conn As OleDbConnection
                Try
                    conn = New OleDbConnection(connParams)

                    ' Open the connection and get the data.
                    Dim command As OleDbCommand = New OleDbCommand("SELECT * FROM mailing_list", conn)
                    conn.Open()
                    Dim adapter As OleDbDataAdapter = New OleDbDataAdapter
                    Dim table As DataTable = New DataTable
                    adapter.SelectCommand = command
                    adapter.Fill(table)

                    ' Create a job which is the following task for MailBee: perform mail merge over
                    ' the specified data table and then send out each resulting e-mail to
                    ' the recipients which appear in the resulting messages. "bounce@domain.com"
                    ' address will be used as Return-Path (i.e. sender e-mail address).
                    mailer.AddJob(Nothing, "bounce@domain.com", Nothing, table)
                Finally
                    If Not conn Is Nothing Then
                        conn.Close()
                    End If
                End Try
            End If

            ' Run the job. The actual mail merge takes place here.
            mailer.SendJobs()
            Console.WriteLine()

            ' Report results (row indices in the data table) to the console.
            If mailer.JobsFailed.Count = 0 Then
                Console.WriteLine("All of the rows of the table have been processed and sent as e-mails.")
                Exit For
            Else
                If mailer.JobsSuccessful.Count = 0 Then
                    Console.WriteLine("None of the rows of the table has been processed and sent as e-mail.")
                Else
                    Console.WriteLine("Not all rows of the table have been processed and sent as e-mails.")
                    Console.WriteLine()

                    Console.WriteLine("Successful rows: ")
                    Console.WriteLine(mailer.JobsSuccessful.GetIndicesAsString(Nothing, Nothing))
                    Console.WriteLine()

                    Console.WriteLine("Failed rows: ")
                    Console.WriteLine(mailer.JobsFailed.GetIndicesAsString(Nothing, Nothing))
                End If
                Console.WriteLine()

                ' Put failed data rows from mailer.JobsFailed back into the pending queue (mailer.JobsPending).
                mailer.RetryFailedJobs()

                ' Clear the list of successful rows because we already displayed all successful
                ' results of the first run. Next time, we want to display only those successful
                ' results which had been achieved on the second run only.
                mailer.JobsSuccessful.Clear()
            End If
        Next
    End Sub
End Class

Smtp.RetryFailedJobs Method

Remarks

Example

See Also