MailKit Documentation

API Reference

MailKit

AccessControl Class

AccessControlList Class

AccessRight Structure

AccessRights Class

AlertEventArgs Class

Annotation Class

AnnotationAccess Enumeration

AnnotationAttribute Class

AnnotationEntry Class

AnnotationsChangedEventArgs Class

AnnotationScope Enumeration

AppendRequest Class

AuthenticatedEventArgs Class

AuthenticationSecret Structure

BodyPart Class

BodyPartBasic Class

BodyPartCollection Class

BodyPartMessage Class

BodyPartMultipart Class

BodyPartText Class

BodyPartVisitor Class

CommandException Class

ConnectedEventArgs Class

DeliveryStatusNotification Enumeration

DisconnectedEventArgs Class

Envelope Class

FetchRequest Class

FolderAccess Enumeration

FolderAttributes Enumeration

FolderCreatedEventArgs Class

FolderFeature Enumeration

FolderNamespace Class

FolderNamespaceCollection Class

FolderNotFoundException Class

FolderNotOpenException Class

FolderQuota Class

FolderRenamedEventArgs Class

HeaderSet Class

IAppendRequest Interface

IAuthenticationSecretDetector Interface

IFetchRequest Interface

IMailFolder Interface

IMailFolderExtensions Class

IMailService Interface

IMailSpool Interface

IMailStore Interface

IMailTransport Interface

IMessageSummary Interface

IProtocolLogger Interface

IReplaceRequest Interface

IStoreFlagsRequest Interface

IStoreLabelsRequest Interface

IStoreRequest Interface

ITransferProgress Interface

MessageEventArgs Class

MessageFlags Enumeration

MessageFlagsChangedEventArgs Class

MessageLabelsChangedEventArgs Class

MessageNotFoundException Class

MessageSentEventArgs Class

MessageSorter Class

MessageSummary Class

MessageSummaryFetchedEventArgs Class

MessageSummaryItems Enumeration

MessagesVanishedEventArgs Class

MessageThread Class

MessageThreader Class

Metadata Class

MetadataChangedEventArgs Class

MetadataCollection Class

MetadataOptions Class

MetadataTag Structure

ModSeqChangedEventArgs Class

NullProtocolLogger Class

ProtocolException Class

ProtocolLogger Class

ReplaceRequest Class

ServiceNotAuthenticatedException Class

ServiceNotConnectedException Class

SpecialFolder Enumeration

StatusItems Enumeration

StoreAction Enumeration

StoreFlagsRequest Class

StoreLabelsRequest Class

ThreadingAlgorithm Enumeration

WebAlertEventArgs Class

DeliveryStatusNotification Enumeration

Delivery status notification types.

Namespace: MailKit
Assembly: MailKit (in MailKit.dll) Version: 4.7.1

Syntax

Copy

[FlagsAttribute]
public enum DeliveryStatusNotification

Members

Member name	Value	Description
Never	0	Never send delivery status notifications.
Success	1	Send a notification on successful delivery to the recipient.
Failure	2	Send a notification on failure to deliver to the recipient.
Delay	4	Send a notification when the delivery to the recipient has been delayed for an unusual amount of time.

Remarks

A set of flags that may be bitwise-or'd together to specify when a delivery status notification should be sent for a particlar recipient.

Example

Copy

public class DSNSmtpClient : SmtpClient
{
    public DSNSmtpClient ()
    {
    }

    /// <summary>
    /// Get the envelope identifier to be used with delivery status notifications.
    /// </summary>
    /// <remarks>
    /// <para>The envelope identifier, if non-empty, is useful in determining which message
    /// a delivery status notification was issued for.</para>
    /// <para>The envelope identifier should be unique and may be up to 100 characters in
    /// length, but must consist only of printable ASCII characters and no white space.</para>
    /// <para>For more information, see rfc3461, section 4.4.</para>
    /// </remarks>
    /// <returns>The envelope identifier.</returns>
    /// <param name="message">The message.</param>
    protected override string GetEnvelopeId (MimeMessage message)
    {
        // Since you will want to be able to map whatever identifier you return here to the
        // message, the obvious identifier to use is probably the Message-Id value.
        return message.MessageId;
    }

    /// <summary>
    /// Get the types of delivery status notification desired for the specified recipient mailbox.
    /// </summary>
    /// <remarks>
    /// Gets the types of delivery status notification desired for the specified recipient mailbox.
    /// </remarks>
    /// <returns>The desired delivery status notification type.</returns>
    /// <param name="message">The message being sent.</param>
    /// <param name="mailbox">The mailbox.</param>
    protected override DeliveryStatusNotification? GetDeliveryStatusNotifications (MimeMessage message, MailboxAddress mailbox)
    {
        // In this example, we only want to be notified of failures to deliver to a mailbox.
        // If you also want to be notified of delays or successful deliveries, simply bitwise-or
        // whatever combination of flags you want to be notified about.
        return DeliveryStatusNotification.Failure;
    }
}

Reference

MailKit Namespace