DeliveryStatusNotification Class

Visual Basic (Declaration)
Visual Basic (Usage)
C#
Managed Extensions for C++
C++/CLI

Public Class DeliveryStatusNotification

Dim instance As DeliveryStatusNotification

public class DeliveryStatusNotification

public __gc class DeliveryStatusNotification

public ref class DeliveryStatusNotification

Because in the original SMTP specification the support for notification of the success or failure of a sent message was quite limited, RFC 1891 defined an extension to the SMTP protocol to allow for Delivery Status Notification, or DSN. DSN allows much greater control over what conditions should the sender be notified and the construction of the notification itself. This was achieved by extending the SMTP RCPT and MAIL commands to allow the specification of notification parameters. These parameters include:

A NOTIFY parameter (appended to RCPT command) to specify under what conditions the sender should be notified (NEVER, SUCCESS, FAILURE, or DELAY).
A RET parameter (appended to MAIL command) to specify whether or not the message should be included in the DSN.
A ENVID parameter (appended to MAIL command) specifying an envelope identifier to be transmitted with the DSN.
A ORCPT parameter (appended to RCPT command) specifying the original recipient.

The properties of the DeliveryStatusNotification object control the use of these parameters:

Set DeliveryStatusNotification.Type to specify under what conditions a DSN should be sent (DSNType.Default, DSNType.Delay, DSNType.Failure, DSNType.Never, or DSNType.Success).
Set DeliveryStatusNotification.ReturnMessage to true to specify that the entire message should be included with the DSN, and false if only the header should be included.
Set DeliveryStatusNotification.EnvelopeID to the envelope identifier to be transmitted with the DSN.

Once the properties of the DeliveryStatusNotification object have been set, all DSN related communication will occur transparently. The ORCPT parameter is automatically added and set to the recipient.

This example demonstrates sending a message with Delivery Status Notification (DSN).

C#

using System.Net.Mail;

private void sendWithDsn()
{
    //Specify a DSN ID to use
    smtp1.DeliveryStatusNotification.EnvelopeID = "ID1234567";

    //Return the entire message instead of the headers
    smtp1.DeliveryStatusNotification.ReturnMessage = true;

    //Send a DSN on failure or delay
    smtp1.DeliveryStatusNotification.Options = DeliveryNotificationOptions.Delay | DeliveryNotificationOptions.OnFailure;

    //Send a message
    smtp1.Session.RemoteEndPoint = new IPEndPoint(myServer, Smtp.GetDefaultPort(smtp1.Session));
    smtp1.Session.Username = myUsername;
    smtp1.Session.Password = myPassword;
    smtp1.Send(toAddress, fromAddress, "Test", "Test Message.");
    //Gracefully logout
    smtp1.Close();
}

Visual Basic

Imports System.Net.Mail

Private Sub sendWithDsn()
    'Specify a DSN ID to use
    smtp1.DeliveryStatusNotification.EnvelopeID = "ID1234567"

    'Return the entire message instead of the headers
    smtp1.DeliveryStatusNotification.ReturnMessage = True

    'Send a DSN on failure or delay
    smtp1.DeliveryStatusNotification.Options = DeliveryNotificationOptions.Delay Or DeliveryNotificationOptions.OnFailure

    'Send a message
    smtp1.Session.RemoteEndPoint = New IPEndPoint(myServer, Smtp.GetDefaultPort(smtp1.Session))
    smtp1.Session.Username = myUsername
    smtp1.Session.Password = myPassword
    smtp1.Send(toAddress, fromAddress, "Test", "Test Message.")
    'Gracefully logout
    smtp1.Close()
End Sub

System.Object
Dart.Mail.DeliveryStatusNotification

Reference

DeliveryStatusNotification Members
Dart.Mail Namespace