IMultipartReport Interface

An interface for a multipart/report MIME entity.

Definition

Namespace: MimeKit
Assembly: MimeKit.Core (in MimeKit.Core.dll) Version: 5.0.0
C#
public interface IMultipartReport : IMultipart, 
	IMimeEntity, IDisposable, ICollection<MimeEntity>, IEnumerable<MimeEntity>, 
	IEnumerable, IList<MimeEntity>
Implements
IMimeEntity, IMultipart, ICollectionMimeEntity, IEnumerableMimeEntity, IListMimeEntity, IEnumerable, IDisposable

Remarks

A multipart/related MIME entity is a general container part for electronic mail reports of any kind.

Example

C#
                    public void ProcessDeliveryStatusNotification (MimeMessage message)
{
    var report = message.Body as MultipartReport;

    if (report == null || report.ReportType == null || !report.ReportType.Equals ("delivery-status", StringComparison.OrdinalIgnoreCase)) {
        // this is not a delivery status notification message...
        return;
    }

    // process the report
    foreach (var mds in report.OfType<MessageDeliveryStatus> ()) {
        // process the status groups - each status group represents a different recipient

        // The first status group contains information about the message
        var envelopeId = mds.StatusGroups[0]["Original-Envelope-Id"];

        // all of the other status groups contain per-recipient information
        for (int i = 1; i < mds.StatusGroups.Length; i++) {
            var recipient = mds.StatusGroups[i]["Original-Recipient"];
            var action = mds.StatusGroups[i]["Action"];

            if (recipient == null)
                recipient = mds.StatusGroups[i]["Final-Recipient"];

            // the recipient string should be in the form: "rfc822;user@domain.com"
            var index = recipient.IndexOf (';');
            var address = recipient.Substring (index + 1);

            switch (action) {
            case "failed":
                Console.WriteLine ("Delivery of message {0} failed for {1}", envelopeId, address);
                break;
            case "delayed":
                Console.WriteLine ("Delivery of message {0} has been delayed for {1}", envelopeId, address);
                break;
            case "delivered":
                Console.WriteLine ("Delivery of message {0} has been delivered to {1}", envelopeId, address);
                break;
            case "relayed":
                Console.WriteLine ("Delivery of message {0} has been relayed for {1}", envelopeId, address);
                break;
            case "expanded":
                Console.WriteLine ("Delivery of message {0} has been delivered to {1} and relayed to the the expanded recipients", envelopeId, address);
                break;
            }
        }
    }
}
                  

Properties

Boundary Get or set the boundary.
(Inherited from IMultipart)
ContentBase Get or set the base content URI.
(Inherited from IMimeEntity)
ContentDisposition Get or set the content disposition.
(Inherited from IMimeEntity)
ContentId Get or set the Content-Id.
(Inherited from IMimeEntity)
ContentLocation Get or set the content location.
(Inherited from IMimeEntity)
ContentType Get the type of the content.
(Inherited from IMimeEntity)
Count Gets the number of elements contained in the ICollectionT.
(Inherited from ICollectionMimeEntity)
Epilogue Get or set the epilogue.
(Inherited from IMultipart)
Headers Get the list of headers.
(Inherited from IMimeEntity)
IsAttachment Get a value indicating whether this entity is an attachment.
(Inherited from IMimeEntity)
IsReadOnly Gets a value indicating whether the ICollectionT is read-only.
(Inherited from ICollectionMimeEntity)
Item Gets or sets the element at the specified index.
(Inherited from IListMimeEntity)
Preamble Get or set the preamble.
(Inherited from IMultipart)
ReportType Get or set the type of the report.

Methods

Accept Dispatches to the specific visit method for this MIME entity.
(Inherited from IMimeEntity)
Add Adds an item to the ICollectionT.
(Inherited from ICollectionMimeEntity)
Clear Removes all items from the ICollectionT.
(Inherited from ICollectionMimeEntity)
Contains Determines whether the ICollectionT contains a specific value.
(Inherited from ICollectionMimeEntity)
CopyTo Copies the elements of the ICollectionT to an Array, starting at a particular Array index.
(Inherited from ICollectionMimeEntity)
Dispose Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from IDisposable)
GetEnumerator Returns an enumerator that iterates through the collection.
(Inherited from IEnumerableMimeEntity)
IndexOf Determines the index of a specific item in the IListT.
(Inherited from IListMimeEntity)
Insert Inserts an item to the IListT at the specified index.
(Inherited from IListMimeEntity)
Prepare Prepare the MIME entity for transport using the specified encoding constraints.
(Inherited from IMimeEntity)
Remove Removes the first occurrence of a specific object from the ICollectionT.
(Inherited from ICollectionMimeEntity)
RemoveAt Removes the IListT item at the specified index.
(Inherited from IListMimeEntity)
WriteTo(Stream, CancellationToken) Write the IMimeEntity to the specified output stream.
(Inherited from IMimeEntity)
WriteTo(String, CancellationToken) Write the IMimeEntity to the specified file.
(Inherited from IMimeEntity)
WriteTo(FormatOptions, Stream, CancellationToken) Write the IMimeEntity to the specified output stream.
(Inherited from IMimeEntity)
WriteTo(FormatOptions, String, CancellationToken) Write the IMimeEntity to the specified file.
(Inherited from IMimeEntity)
WriteTo(Stream, Boolean, CancellationToken) Write the IMimeEntity to the specified output stream.
(Inherited from IMimeEntity)
WriteTo(String, Boolean, CancellationToken) Write the IMimeEntity to the specified file.
(Inherited from IMimeEntity)
WriteTo(FormatOptions, Stream, Boolean, CancellationToken) Write the IMimeEntity to the specified output stream.
(Inherited from IMimeEntity)
WriteTo(FormatOptions, String, Boolean, CancellationToken) Write the IMimeEntity to the specified file.
(Inherited from IMimeEntity)
WriteToAsync(Stream, CancellationToken) Asynchronously write the IMimeEntity to the specified output stream.
(Inherited from IMimeEntity)
WriteToAsync(String, CancellationToken) Asynchronously write the IMimeEntity to the specified file.
(Inherited from IMimeEntity)
WriteToAsync(FormatOptions, Stream, CancellationToken) Asynchronously write the IMimeEntity to the specified output stream.
(Inherited from IMimeEntity)
WriteToAsync(FormatOptions, String, CancellationToken) Asynchronously write the IMimeEntity to the specified file.
(Inherited from IMimeEntity)
WriteToAsync(Stream, Boolean, CancellationToken) Asynchronously write the IMimeEntity to the specified output stream.
(Inherited from IMimeEntity)
WriteToAsync(String, Boolean, CancellationToken) Asynchronously write the IMimeEntity to the specified file.
(Inherited from IMimeEntity)
WriteToAsync(FormatOptions, Stream, Boolean, CancellationToken) Asynchronously write the IMimeEntity to the specified output stream.
(Inherited from IMimeEntity)
WriteToAsync(FormatOptions, String, Boolean, CancellationToken) Asynchronously write the IMimeEntity to the specified file.
(Inherited from IMimeEntity)

See Also