IMultipart Related Interface
An interface for a multipart/related MIME entity.
Definition
Namespace: MimeKit
Assembly: MimeKit.Core (in MimeKit.Core.dll) Version: 5.0.0
Assembly: MimeKit.Core (in MimeKit.Core.dll) Version: 5.0.0
C#
public interface IMultipartRelated : IMultipart,
IMimeEntity, IDisposable, ICollection<MimeEntity>, IEnumerable<MimeEntity>,
IEnumerable, IList<MimeEntity>Remarks
A multipart/related MIME entity contains, as one might expect, inter-related MIME parts which
typically reference each other via URIs based on the Content-Id and/or Content-Location headers.
Example
C#
/// <summary>
/// Visits a MimeMessage and generates HTML suitable to be rendered by a browser control.
/// </summary>
class HtmlPreviewVisitor : MimeVisitor
{
List<MultipartRelated> stack = new List<MultipartRelated> ();
List<MimeEntity> attachments = new List<MimeEntity> ();
string body;
/// <summary>
/// Creates a new HtmlPreviewVisitor.
/// </summary>
public HtmlPreviewVisitor ()
{
}
/// <summary>
/// The list of attachments that were in the MimeMessage.
/// </summary>
public IList<MimeEntity> Attachments {
get { return attachments; }
}
/// <summary>
/// The HTML string that can be set on the BrowserControl.
/// </summary>
public string HtmlBody {
get { return body ?? string.Empty; }
}
protected override void VisitMultipartAlternative (MultipartAlternative alternative)
{
// walk the multipart/alternative children backwards from greatest level of faithfulness to the least faithful
for (int i = alternative.Count - 1; i >= 0 && body == null; i--)
alternative[i].Accept (this);
}
protected override void VisitMultipartRelated (MultipartRelated related)
{
var root = related.Root;
// push this multipart/related onto our stack
stack.Add (related);
// visit the root document
root.Accept (this);
// pop this multipart/related off our stack
stack.RemoveAt (stack.Count - 1);
}
// look up the image based on the img src url within our multipart/related stack
bool TryGetImage (string url, out MimePart image)
{
UriKind kind;
int index;
Uri uri;
if (Uri.IsWellFormedUriString (url, UriKind.Absolute))
kind = UriKind.Absolute;
else if (Uri.IsWellFormedUriString (url, UriKind.Relative))
kind = UriKind.Relative;
else
kind = UriKind.RelativeOrAbsolute;
try {
uri = new Uri (url, kind);
} catch {
image = null;
return false;
}
for (int i = stack.Count - 1; i >= 0; i--) {
if ((index = stack[i].IndexOf (uri)) == -1)
continue;
image = stack[i][index] as MimePart;
return image != null;
}
image = null;
return false;
}
/// <summary>
/// Get a data: URI for the image attachment.
/// </summary>
/// <remarks>
/// Encodes the image attachment into a string suitable for setting as a src= attribute value in
/// an img tag.
/// </remarks>
/// <returns>The data: URI.</returns>
/// <param name="image">The image attachment.</param>
string GetDataUri (MimePart image)
{
using (var memory = new MemoryStream ()) {
image.Content.DecodeTo (memory);
var buffer = memory.GetBuffer ();
var length = (int) memory.Length;
var base64 = Convert.ToBase64String (buffer, 0, length);
return string.Format ("data:{0};base64,{1}", image.ContentType.MimeType, base64);
}
}
// Replaces <img src=...> urls that refer to images embedded within the message with
// "file://" urls that the browser control will actually be able to load.
void HtmlTagCallback (HtmlTagContext ctx, HtmlWriter htmlWriter)
{
if (ctx.TagId == HtmlTagId.Meta && !ctx.IsEndTag) {
bool isContentType = false;
ctx.WriteTag (htmlWriter, false);
// replace charsets with "utf-8" since our output will be in utf-8 (and not whatever the original charset was)
foreach (var attribute in ctx.Attributes) {
if (attribute.Id == HtmlAttributeId.Charset) {
htmlWriter.WriteAttributeName (attribute.Name);
htmlWriter.WriteAttributeValue ("utf-8");
} else if (isContentType && attribute.Id == HtmlAttributeId.Content) {
htmlWriter.WriteAttributeName (attribute.Name);
htmlWriter.WriteAttributeValue ("text/html; charset=utf-8");
} else {
if (attribute.Id == HtmlAttributeId.HttpEquiv && attribute.Value != null
&& attribute.Value.Equals ("Content-Type", StringComparison.OrdinalIgnoreCase))
isContentType = true;
htmlWriter.WriteAttribute (attribute);
}
}
} else if (ctx.TagId == HtmlTagId.Image && !ctx.IsEndTag && stack.Count > 0) {
ctx.WriteTag (htmlWriter, false);
// replace the src attribute with a "data:" URL
foreach (var attribute in ctx.Attributes) {
if (attribute.Id == HtmlAttributeId.Src) {
if (!TryGetImage (attribute.Value, out var image)) {
htmlWriter.WriteAttribute (attribute);
continue;
}
var dataUri = GetDataUri (image);
htmlWriter.WriteAttributeName (attribute.Name);
htmlWriter.WriteAttributeValue (dataUri);
} else {
htmlWriter.WriteAttribute (attribute);
}
}
} else {
// pass the tag through to the output
ctx.WriteTag (htmlWriter, true);
}
}
protected override void VisitTextPart (TextPart entity)
{
TextConverter converter;
if (body != null) {
// since we've already found the body, treat this as an attachment
attachments.Add (entity);
return;
}
if (entity.IsHtml) {
converter = new HtmlToHtml {
HtmlTagCallback = HtmlTagCallback
};
} else if (entity.IsFlowed) {
var flowed = new FlowedToHtml ();
string delsp;
if (entity.ContentType.Parameters.TryGetValue ("delsp", out delsp))
flowed.DeleteSpace = delsp.Equals ("yes", StringComparison.OrdinalIgnoreCase);
converter = flowed;
} else {
converter = new TextToHtml ();
}
body = converter.Convert (entity.Text);
}
protected override void VisitTnefPart (TnefPart entity)
{
// extract any attachments in the MS-TNEF part
using (var tnef = entity.LoadTnefMessage ()) {
// the converted message (and its attachments) outlives the TnefMessage
var result = tnef.ConvertToMime ();
attachments.AddRange (result.Message.Attachments);
}
}
protected override void VisitMessagePart (MessagePart entity)
{
// treat message/rfc822 parts as attachments
attachments.Add (entity);
}
protected override void VisitMimePart (MimePart entity)
{
// realistically, if we've gotten this far, then we can treat this as an attachment
// even if the IsAttachment property is false.
attachments.Add (entity);
}
}
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) |
| Root | Get or set the root document of the multipart/related part and the appropriate Content-Type parameters. |
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(T) | Determines whether the ICollectionT contains a specific value. (Inherited from ICollectionMimeEntity) |
| Contains(Uri) | Check if the IMultipartRelated contains a part matching the specified URI. |
| 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(T) | Determines the index of a specific item in the IListT. (Inherited from IListMimeEntity) |
| IndexOf(Uri) | Get the index of the part matching the specified URI. |
| Insert | Inserts an item to the IListT at the specified index. (Inherited from IListMimeEntity) |
| Open(Uri) | Open a stream for reading the decoded content of the MIME part specified by the provided URI. |
| Open(Uri, String, String) | Open a stream for reading the decoded content of the MIME part specified by the provided URI. |
| 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) |