foreach (var mailbox in message.To.Mailboxes)
diff --git a/Documentation/Content/GettingStarted.aml b/Documentation/Content/GettingStarted.aml
index 85e326b79f..0b1e0491a4 100644
--- a/Documentation/Content/GettingStarted.aml
+++ b/Documentation/Content/GettingStarted.aml
@@ -1,4 +1,4 @@
-
+
Package Manager Console
http://docs.nuget.org/docs/start-here/using-the-package-manager-console
- , simply enter the following command:
+ , enter the following command:
Install-Package MimeKit
@@ -97,7 +97,7 @@
Once you've opened the appropriate MimeKit solution
file in either Xamarin Studio or
- Visual Studio (either will work), you can simply
+ Visual Studio (either will work), you can
choose the Debug or Release build configuration and then build.
diff --git a/Documentation/Content/WorkingWithPGP.aml b/Documentation/Content/WorkingWithPGP.aml
index 2ed3759e1f..2b5026bb97 100644
--- a/Documentation/Content/WorkingWithPGP.aml
+++ b/Documentation/Content/WorkingWithPGP.aml
@@ -1,4 +1,4 @@
-
+
multipart/encrypted mime-type
to encapsulate encrypted data. To encrypt any
T:MimeKit.MimeEntity ,
- simply use the
+ use the
Overload:MimeKit.Cryptography.MultipartEncrypted.Create
diff --git a/Documentation/Content/WorkingWithSMime.aml b/Documentation/Content/WorkingWithSMime.aml
index e6cdb0a169..e1222c1b98 100644
--- a/Documentation/Content/WorkingWithSMime.aml
+++ b/Documentation/Content/WorkingWithSMime.aml
@@ -1,4 +1,4 @@
-
+
multipart/encrypted MIME part to encapsulate
encrypted content like OpenPGP, S/MIME uses application/pkcs7-mime .
To encrypt any T:MimeKit.MimeEntity ,
- simply use the
+ use the
Overload:MimeKit.Cryptography.ApplicationPkcs7Mime.Encrypt
diff --git a/Documentation/Documentation.shfbproj b/Documentation/Documentation.shfbproj
index 1ee6febd83..56c2af87e5 100644
--- a/Documentation/Documentation.shfbproj
+++ b/Documentation/Documentation.shfbproj
@@ -1,5 +1,5 @@
-
+
@@ -7,7 +7,7 @@
AnyCPU
2.0
59115814-a1e3-46ae-ae30-4065ae8f4caf
- 1.9.9.0
+ 2017.9.26.0
Documentation
Documentation
@@ -85,16 +85,23 @@
-
- BouncyCastle
- {4c235092-820c-4deb-9074-d356fb797d8b}
- True
-
MimeKit
- {d5f54a4f-d84b-430f-9271-f7861e285b3e}
+ {76894ada-0818-4556-83bd-6510d8ea2809}
True
+
\ No newline at end of file
diff --git a/Documentation/Examples/ArcSignerExample.cs b/Documentation/Examples/ArcSignerExample.cs
new file mode 100644
index 0000000000..d51ab53750
--- /dev/null
+++ b/Documentation/Examples/ArcSignerExample.cs
@@ -0,0 +1,124 @@
+using System;
+using System.IO;
+using System.Text;
+using System.Threading;
+using System.Threading.Tasks;
+using System.Collections.Generic;
+
+using MimeKit;
+using MimeKit.Cryptography;
+
+namespace ArcSignerExample
+{
+ class ExampleArcSigner : ArcSigner
+ {
+ public ExampleArcSigner (Stream stream, string domain, string selector, DkimSignatureAlgorithm algorithm = DkimSignatureAlgorithm.RsaSha256) : base (stream, domain, selector, algorithm)
+ {
+ }
+
+ public DummyArcSigner (string fileName, string domain, string selector, DkimSignatureAlgorithm algorithm = DkimSignatureAlgorithm.RsaSha256) : base (fileName, domain, selector, algorithm)
+ {
+ }
+
+ public DummyArcSigner (AsymmetricKeyParameter key, string domain, string selector, DkimSignatureAlgorithm algorithm = DkimSignatureAlgorithm.RsaSha256) : base (key, domain, selector, algorithm)
+ {
+ }
+
+ public string AuthenticationServiceIdentifier {
+ get; set;
+ }
+
+ ///
+ /// Generate the ARC-Authentication-Results header.
+ ///
+ ///
+ /// The ARC-Authentication-Results header contains information detailing the results of
+ /// authenticating/verifying the message via ARC, DKIM, SPF, etc.
+ ///
+ /// In the following implementation, we assume that all of these authentication results
+ /// have already been determined by other mail software that has added some Authentication-Results
+ /// headers containing this information.
+ ///
+ /// Note: This method is used when ArcSigner.Sign() is called instead of ArcSigner.SignAsync().
+ ///
+ protected override AuthenticationResults GenerateArcAuthenticationResults (FormatOptions options, MimeMessage message, CancellationToken cancellationToken)
+ {
+ var results = new AuthenticationResults (AuthenticationServiceIdentifier);
+
+ for (int i = 0; i < message.Headers.Count; i++) {
+ var header = message.Headers[i];
+
+ if (header.Id != HeaderId.AuthenticationResults)
+ continue;
+
+ if (!AuthenticationResults.TryParse (header.RawValue, out AuthenticationResults authres))
+ continue;
+
+ if (authres.AuthenticationServiceIdentifier != AuthenticationServiceIdentifier)
+ continue;
+
+ foreach (var result in authres.Results) {
+ if (!results.Results.Any (r => r.Method == result.Method))
+ results.Results.Add (result);
+ }
+ }
+
+ return results;
+ }
+
+ protected override Task GenerateArcAuthenticationResultsAsync (FormatOptions options, MimeMessage message, CancellationToken cancellationToken)
+ {
+ return Task.FromResult (GenerateArcAuthenticationResults (options, message, cancellationToken));
+ }
+ }
+
+ class Program
+ {
+ public static void Main (string[] args)
+ {
+ if (args.Length < 2) {
+ Help ();
+ return;
+ }
+
+ for (int i = 0; i < args.Length; i++) {
+ if (args[i] == "--help") {
+ Help ();
+ return;
+ }
+ }
+
+ var headers = new HeaderId[] { HeaderId.From, HeaderId.Subject, HeaderId.Date };
+ var signer = new ExampleArcSigner ("privatekey.pem", "example.com", "brisbane", DkimSignatureAlgorithm.RsaSha256) {
+ HeaderCanonicalizationAlgorithm = DkimCanonicalizationAlgorithm.Simple,
+ BodyCanonicalizationAlgorithm = DkimCanonicalizationAlgorithm.Simple,
+ AgentOrUserIdentifier = "@eng.example.com",
+ };
+
+ if (!File.Exists (args[0])) {
+ Console.Error.WriteLine ("{0}: No such file.", args[0]);
+ return;
+ }
+
+ var message = MimeMessage.Load (args[0]);
+
+ // Prepare the message body to be sent over a 7bit transport (such as older versions of SMTP).
+ // Note: If the SMTP server you will be sending the message over supports the 8BITMIME extension,
+ // then you can use `EncodingConstraint.EightBit` instead.
+ message.Prepare (EncodingConstraint.SevenBit);
+
+ signer.Sign (message, headers);
+
+ using (var stream = File.Create (args[1]))
+ message.WriteTo (stream);
+ }
+
+ static void Help ()
+ {
+ Console.WriteLine ("Usage is: ArcSigner [options] [message] [output]");
+ Console.WriteLine ();
+ Console.WriteLine ("Options:");
+ Console.WriteLine (" --help This help menu.");
+ }
+ }
+}
diff --git a/Documentation/Examples/ArcVerifierExample.cs b/Documentation/Examples/ArcVerifierExample.cs
new file mode 100644
index 0000000000..7b3b8e2c0c
--- /dev/null
+++ b/Documentation/Examples/ArcVerifierExample.cs
@@ -0,0 +1,139 @@
+using System;
+using System.IO;
+using System.Text;
+using System.Threading;
+using System.Threading.Tasks;
+using System.Collections.Generic;
+
+using Heijden.DNS;
+
+using Org.BouncyCastle.Crypto;
+
+using MimeKit;
+using MimeKit.Cryptography;
+
+namespace ArcVerifierExample
+{
+ // Note: By using the DkimPublicKeyLocatorBase, we avoid having to parse the DNS TXT records
+ // in order to get the public key ourselves.
+ class ExamplePublicKeyLocator : DkimPublicKeyLocatorBase
+ {
+ readonly Dictionary cache;
+ readonly Resolver resolver;
+
+ public ExamplePublicKeyLocator ()
+ {
+ cache = new Dictionary ();
+
+ resolver = new Resolver ("8.8.8.8") {
+ TransportType = TransportType.Udp,
+ UseCache = true,
+ Retries = 3
+ };
+ }
+
+ AsymmetricKeyParameter DnsLookup (string domain, string selector, CancellationToken cancellationToken)
+ {
+ var query = selector + "._domainkey." + domain;
+ AsymmetricKeyParameter pubkey;
+
+ // checked if we've already fetched this key
+ if (cache.TryGetValue (query, out pubkey))
+ return pubkey;
+
+ // make a DNS query
+ var response = resolver.Query (query, QType.TXT);
+ var builder = new StringBuilder ();
+
+ // combine the TXT records into 1 string buffer
+ foreach (var record in response.RecordsTXT) {
+ foreach (var text in record.TXT)
+ builder.Append (text);
+ }
+
+ var txt = builder.ToString ();
+
+ // DkimPublicKeyLocatorBase provides us with this helpful method.
+ pubkey = GetPublicKey (txt);
+
+ cache.Add (query, pubkey);
+
+ return pubkey;
+ }
+
+ public AsymmetricKeyParameter LocatePublicKey (string methods, string domain, string selector, CancellationToken cancellationToken = default (CancellationToken))
+ {
+ var methodList = methods.Split (new char[] { ':' }, StringSplitOptions.RemoveEmptyEntries);
+ for (int i = 0; i < methodList.Length; i++) {
+ if (methodList[i] == "dns/txt")
+ return DnsLookup (domain, selector, cancellationToken);
+ }
+
+ throw new NotSupportedException (string.Format ("{0} does not include any suported lookup methods.", methods));
+ }
+
+ public Task LocatePublicKeyAsync (string methods, string domain, string selector, CancellationToken cancellationToken = default (CancellationToken))
+ {
+ return Task.Run (() => {
+ return LocatePublicKey (methods, domain, selector, cancellationToken);
+ }, cancellationToken);
+ }
+ }
+
+ class Program
+ {
+ public static void Main (string[] args)
+ {
+ if (args.Length == 0) {
+ Help ();
+ return;
+ }
+
+ for (int i = 0; i < args.Length; i++) {
+ if (args[i] == "--help") {
+ Help ();
+ return;
+ }
+ }
+
+ var locator = new ExamplePublicKeyLocator ();
+ var verifier = new ArcVerifier (locator);
+
+ for (int i = 0; i < args.Length; i++) {
+ if (!File.Exists (args[i])) {
+ Console.Error.WriteLine ("{0}: No such file.", args[i]);
+ continue;
+ }
+
+ Console.Write ("{0} -> ", args[i]);
+
+ var message = MimeMessage.Load (args[i]);
+ var result = verifier.Verify (message);
+
+ switch (result.Chain) {
+ case ArcSignatureValidationResult.None:
+ Console.WriteLine ("No ARC signatures to verify.");
+ break;
+ case ArcSignatureValidationResult.Pass:
+ Console.ForegroundColor = ConsoleColor.Green;
+ Console.WriteLine ("PASS");
+ Console.ResetColor ();
+ break;
+ case ArcSignatureValidationResult.Fail:
+ Console.ForegroundColor = ConsoleColor.Red;
+ Console.WriteLine ("FAIL");
+ Console.ResetColor ();
+ break;
+ }
+ }
+ }
+
+ static void Help ()
+ {
+ Console.WriteLine ("Usage is: ArcVerifier [options] [messages]");
+ Console.WriteLine ();
+ Console.WriteLine ("Options:");
+ Console.WriteLine (" --help This help menu.");
+ }
+ }
+}
diff --git a/Documentation/Examples/AttachmentExamples.cs b/Documentation/Examples/AttachmentExamples.cs
new file mode 100644
index 0000000000..ed81446736
--- /dev/null
+++ b/Documentation/Examples/AttachmentExamples.cs
@@ -0,0 +1,76 @@
+using System;
+
+using MimeKit;
+
+namespace MimeKit.Examples
+{
+ public static class AttachmentExamples
+ {
+ public static void SaveMimePart (MimePart attachment, string fileName)
+ {
+ #region SaveMimePart
+ using (var stream = File.Create (fileName))
+ attachment.Content.DecodeTo (stream);
+ #endregion SaveMimePart
+ }
+
+ public static void SaveMimePart (MessagePart attachment, string fileName)
+ {
+ #region SaveMessagePart
+ using (var stream = File.Create (fileName))
+ attachment.Message.WriteTo (stream);
+ #endregion SaveMessagePart
+ }
+
+ public static void SaveAttachments (MimeMessage message)
+ {
+ #region SaveAttachments
+ foreach (var attachment in message.Attachments) {
+ if (attachment is MessagePart) {
+ var fileName = attachment.ContentDisposition?.FileName;
+ var rfc822 = (MessagePart) attachment;
+
+ if (string.IsNullOrEmoty (fileName))
+ fileName = "attached-message.eml";
+
+ using (var stream = File.Create (fileName))
+ rfc822.Message.WriteTo (stream);
+ } else {
+ var part = (MimePart) attachment;
+ var fileName = part.FileName;
+
+ using (var stream = File.Create (fileName))
+ part.Content.DecodeTo (stream);
+ }
+ }
+ #endregion SaveAttachments
+ }
+
+ public static void SaveAttachments (MimeMessage message)
+ {
+ #region SaveBodyParts
+ foreach (var bodyPart in message.BodyParts) {
+ if (!bodyPart.IsAttachment)
+ continue;
+
+ if (bodyPart is MessagePart) {
+ var fileName = attachment.ContentDisposition?.FileName;
+ var rfc822 = (MessagePart) attachment;
+
+ if (string.IsNullOrEmoty (fileName))
+ fileName = "attached-message.eml";
+
+ using (var stream = File.Create (fileName))
+ rfc822.Message.WriteTo (stream);
+ } else {
+ var part = (MimePart) attachment;
+ var fileName = part.FileName;
+
+ using (var stream = File.Create (fileName))
+ part.Content.DecodeTo (stream);
+ }
+ }
+ #endregion SaveBodyParts
+ }
+ }
+}
diff --git a/Documentation/Examples/BodyBuilder.cs b/Documentation/Examples/BodyBuilder.cs
index 1a5fbe973d..034659228b 100644
--- a/Documentation/Examples/BodyBuilder.cs
+++ b/Documentation/Examples/BodyBuilder.cs
@@ -1,12 +1,21 @@
-var message = new MimeMessage ();
-message.From.Add (new MailboxAddress ("Joey", "joey@friends.com"));
-message.To.Add (new MailboxAddress ("Alice", "alice@wonderland.com"));
-message.Subject = "How you doin?";
+using MimeKit;
-var builder = new BodyBuilder ();
+namespace BodyBuilderExamples
+{
+ public class Program
+ {
+ public static void Complex ()
+ {
+ #region Complex
+ var message = new MimeMessage ();
+ message.From.Add (new MailboxAddress ("Joey", "joey@friends.com"));
+ message.To.Add (new MailboxAddress ("Alice", "alice@wonderland.com"));
+ message.Subject = "How you doin?";
-// Set the plain-text version of the message text
-builder.TextBody = @"Hey Alice,
+ var builder = new BodyBuilder ();
+
+ // Set the plain-text version of the message text
+ builder.TextBody = @"Hey Alice,
What are you up to this weekend? Monica is throwing one of her parties on
Saturday and I was hoping you could make it.
@@ -16,20 +25,54 @@ Will you be my +1?
-- Joey
";
-// Set the html version of the message text
-builder.HtmlBody = @"Hey Alice,
+ // In order to reference selfie.jpg from the html text, we'll need to add it
+ // to builder.LinkedResources and then use its Content-Id value in the img src.
+ var image = builder.LinkedResources.Add (@"C:\Users\Joey\Documents\Selfies\selfie.jpg");
+ image.ContentId = MimeUtils.GenerateMessageId ();
+
+ // Set the html version of the message text
+ builder.HtmlBody = string.Format (@"
Hey Alice,
What are you up to this weekend? Monica is throwing one of her parties on
Saturday and I was hoping you could make it.
Will you be my +1?
-- Joey
-
![]()
![]()
cache;
+ readonly Resolver resolver;
+
+ public ExamplePublicKeyLocator ()
+ {
+ cache = new Dictionary ();
+
+ resolver = new Resolver ("8.8.8.8") {
+ TransportType = TransportType.Udp,
+ UseCache = true,
+ Retries = 3
+ };
+ }
+
+ AsymmetricKeyParameter DnsLookup (string domain, string selector, CancellationToken cancellationToken)
+ {
+ var query = selector + "._domainkey." + domain;
+ AsymmetricKeyParameter pubkey;
+
+ // checked if we've already fetched this key
+ if (cache.TryGetValue (query, out pubkey))
+ return pubkey;
+
+ // make a DNS query
+ var response = resolver.Query (query, QType.TXT);
+ var builder = new StringBuilder ();
+
+ // combine the TXT records into 1 string buffer
+ foreach (var record in response.RecordsTXT) {
+ foreach (var text in record.TXT)
+ builder.Append (text);
+ }
+
+ var txt = builder.ToString ();
+
+ // DkimPublicKeyLocatorBase provides us with this helpful method.
+ pubkey = GetPublicKey (txt);
+
+ cache.Add (query, pubkey);
+
+ return pubkey;
+ }
+
+ public AsymmetricKeyParameter LocatePublicKey (string methods, string domain, string selector, CancellationToken cancellationToken = default (CancellationToken))
+ {
+ var methodList = methods.Split (new char[] { ':' }, StringSplitOptions.RemoveEmptyEntries);
+ for (int i = 0; i < methodList.Length; i++) {
+ if (methodList[i] == "dns/txt")
+ return DnsLookup (domain, selector, cancellationToken);
+ }
+
+ throw new NotSupportedException (string.Format ("{0} does not include any suported lookup methods.", methods));
+ }
+
+ public Task LocatePublicKeyAsync (string methods, string domain, string selector, CancellationToken cancellationToken = default (CancellationToken))
+ {
+ return Task.Run (() => {
+ return LocatePublicKey (methods, domain, selector, cancellationToken);
+ }, cancellationToken);
+ }
+ }
+
+ class Program
+ {
+ public static void Main (string[] args)
+ {
+ if (args.Length == 0) {
+ Help ();
+ return;
+ }
+
+ for (int i = 0; i < args.Length; i++) {
+ if (args[i] == "--help") {
+ Help ();
+ return;
+ }
+ }
+
+ var locator = new ExamplePublicKeyLocator ();
+ var verifier = new DkimVerifier (locator);
+
+ for (int i = 0; i < args.Length; i++) {
+ if (!File.Exists (args[i])) {
+ Console.Error.WriteLine ("{0}: No such file.", args[i]);
+ continue;
+ }
+
+ Console.Write ("{0} -> ", args[i]);
+
+ var message = MimeMessage.Load (args[i]);
+ var index = message.Headers.IndexOf (HeaderId.DkimSignature);
+
+ if (index == -1) {
+ Console.WriteLine ("NO SIGNATURE");
+ continue;
+ }
+
+ var dkim = message.Headers[index];
+
+ if (verifier.Verify (message, dkim)) {
+ // the DKIM-Signature header is valid!
+ Console.ForegroundColor = ConsoleColor.Green;
+ Console.WriteLine ("VALID");
+ Console.ResetColor ();
+ } else {
+ // the DKIM-Signature is invalid!
+ Console.ForegroundColor = ConsoleColor.Red;
+ Console.WriteLine ("INVALID");
+ Console.ResetColor ();
+ }
+ }
+ }
+
+ static void Help ()
+ {
+ Console.WriteLine ("Usage is: DkimVerifier [options] [messages]");
+ Console.WriteLine ();
+ Console.WriteLine ("Options:");
+ Console.WriteLine (" --help This help menu.");
+ }
+ }
+}
diff --git a/Documentation/Examples/ForwardExamples.cs b/Documentation/Examples/ForwardExamples.cs
new file mode 100644
index 0000000000..a7ca86cd09
--- /dev/null
+++ b/Documentation/Examples/ForwardExamples.cs
@@ -0,0 +1,104 @@
+//
+// MimeVisitorExamples.cs
+//
+// Author: Jeffrey Stedfast
+//
+// Copyright (c) 2013-2016 Xamarin Inc. (www.xamarin.com)
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+//
+
+using System;
+using System.IO;
+using System.Linq;
+using System.Text;
+using System.Collections.Generic;
+
+using MimeKit;
+
+namespace MimeKit.Examples
+{
+ public static class ForwardExamples
+ {
+ #region ForwardAttached
+ public static MimeMessage Forward (MimeMessage original, MailboxAddress from, IEnumerable to)
+ {
+ var message = new MimeMessage ();
+ message.From.Add (from);
+ message.To.AddRange (to);
+
+ // set the forwarded subject
+ if (!original.Subject.StartsWith ("FW:", StringComparison.OrdinalIgnoreCase))
+ message.Subject = "FW: " + original.Subject;
+ else
+ message.Subject = original.Subject;
+
+ // create the main textual body of the message
+ var text = new TextPart ("plain") { Text = "Here's the forwarded message:" };
+
+ // create the message/rfc822 attachment for the original message
+ var rfc822 = new MessagePart { Message = original };
+
+ // create a multipart/mixed container for the text body and the forwarded message
+ var multipart = new Multipart ("mixed");
+ multipart.Add (text);
+ multipart.Add (rfc822);
+
+ // set the multipart as the body of the message
+ message.Body = multipart;
+
+ return message;
+ }
+ #endregion ForwardAttached
+
+ #region ForwardInline
+ public static MimeMessage Forward (MimeMessage original, MailboxAddress from, IEnumerable to)
+ {
+ var message = new MimeMessage ();
+ message.From.Add (from);
+ message.To.AddRange (to);
+
+ // set the forwarded subject
+ if (!original.Subject.StartsWith ("FW:", StringComparison.OrdinalIgnoreCase))
+ message.Subject = "FW: " + original.Subject;
+ else
+ message.Subject = original.Subject;
+
+ // quote the original message text
+ using (var text = new StringWriter ()) {
+ text.WriteLine ();
+ text.WriteLine ("-----Original Message-----");
+ test.WriteLine ("From: {0}", original.From);
+ text.WriteLine ("Sent: {0}", DateUtils.FormatDate (original.Date));
+ text.WriteLine ("To: {0}", original.To);
+ text.WriteLine ("Subject: {0}", original.Subject);
+ text.WriteLine ();
+
+ text.Write (original.TextBody);
+
+ message.Body = new TextPart ("plain") {
+ Text = text.ToString ()
+ };
+ }
+
+ return message;
+ }
+ #endregion ForwardInline
+ }
+}
\ No newline at end of file
diff --git a/Documentation/Examples/MessageDeliveryStatusExamples.cs b/Documentation/Examples/MessageDeliveryStatusExamples.cs
new file mode 100644
index 0000000000..8658655842
--- /dev/null
+++ b/Documentation/Examples/MessageDeliveryStatusExamples.cs
@@ -0,0 +1,86 @@
+//
+// MessageDeliveryStatusExamples.cs
+//
+// Author: Jeffrey Stedfast
+//
+// Copyright (c) 2013-2018 Xamarin Inc. (www.xamarin.com)
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+//
+
+using System;
+using System.Linq;
+
+using MimeKit;
+
+namespace MimeKit.Examples {
+ public static class MessageDeliveryStatusExamples
+ {
+ #region ProcessDeliveryStatusNotification
+ 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 ()) {
+ // 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;
+ }
+ }
+ }
+ }
+ #endregion
+ }
+}
diff --git a/Documentation/Examples/MimeIterator.cs b/Documentation/Examples/MimeIterator.cs
index a2760e38a0..56e9831aaa 100644
--- a/Documentation/Examples/MimeIterator.cs
+++ b/Documentation/Examples/MimeIterator.cs
@@ -1,16 +1,17 @@
var attachments = new List ();
var multiparts = new List ();
-var iter = new MimeIterator (message);
-// collect our list of attachments and their parent multiparts
-while (iter.MoveNext ()) {
- var multipart = iter.Parent as Multipart;
- var part = iter.Current as MimePart;
+using (var iter = new MimeIterator (message)) {
+ // collect our list of attachments and their parent multiparts
+ while (iter.MoveNext ()) {
+ var multipart = iter.Parent as Multipart;
+ var part = iter.Current as MimePart;
- if (multipart != null && part != null && part.IsAttachment) {
- // keep track of each attachment's parent multipart
- multiparts.Add (multipart);
- attachments.Add (part);
+ if (multipart != null && part != null && part.IsAttachment) {
+ // keep track of each attachment's parent multipart
+ multiparts.Add (multipart);
+ attachments.Add (part);
+ }
}
}
diff --git a/Documentation/Examples/MimeVisitorExamples.cs b/Documentation/Examples/MimeVisitorExamples.cs
new file mode 100644
index 0000000000..43ac3451a0
--- /dev/null
+++ b/Documentation/Examples/MimeVisitorExamples.cs
@@ -0,0 +1,547 @@
+//
+// MimeVisitorExamples.cs
+//
+// Author: Jeffrey Stedfast
+//
+// Copyright (c) 2013-2016 Xamarin Inc. (www.xamarin.com)
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+//
+
+using System;
+using System.IO;
+using System.Linq;
+using System.Text;
+using System.Collections.Generic;
+
+using MimeKit;
+using MimeKit.Text;
+using MimeKit.Tnef;
+
+namespace MimeKit.Examples
+{
+ #region HtmlPreviewVisitor
+ ///
+ /// Visits a MimeMessage and generates HTML suitable to be rendered by a browser control.
+ ///
+ class HtmlPreviewVisitor : MimeVisitor
+ {
+ List stack = new List ();
+ List attachments = new List ();
+ readonly string tempDir;
+ string body;
+
+ ///
+ /// Creates a new HtmlPreviewVisitor.
+ ///
+ /// A temporary directory used for storing image files.
+ public HtmlPreviewVisitor (string tempDirectory)
+ {
+ tempDir = tempDirectory;
+ }
+
+ ///
+ /// The list of attachments that were in the MimeMessage.
+ ///
+ public IList Attachments {
+ get { return attachments; }
+ }
+
+ ///
+ /// The HTML string that can be set on the BrowserControl.
+ ///
+ 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;
+ }
+
+ // Save the image to our temp directory and return a "file://" url suitable for
+ // the browser control to load.
+ // Note: if you'd rather embed the image data into the HTML, you can construct a
+ // "data:" url instead.
+ string SaveImage (MimePart image, string url)
+ {
+ string fileName = url.Replace (':', '_').Replace ('\\', '_').Replace ('/', '_');
+
+ string path = Path.Combine (tempDir, fileName);
+
+ if (!File.Exists (path)) {
+ using (var output = File.Create (path))
+ image.Content.DecodeTo (output);
+ }
+
+ return "file://" + path.Replace ('\\', '/');
+ }
+
+ // Replaces 
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.Image && !ctx.IsEndTag && stack.Count > 0) {
+ ctx.WriteTag (htmlWriter, false);
+
+ // replace the src attribute with a file:// URL
+ foreach (var attribute in ctx.Attributes) {
+ if (attribute.Id == HtmlAttributeId.Src) {
+ MimePart image;
+ string url;
+
+ if (!TryGetImage (attribute.Value, out image)) {
+ htmlWriter.WriteAttribute (attribute);
+ continue;
+ }
+
+ url = SaveImage (image, attribute.Value);
+
+ htmlWriter.WriteAttributeName (attribute.Name);
+ htmlWriter.WriteAttributeValue (url);
+ } else {
+ htmlWriter.WriteAttribute (attribute);
+ }
+ }
+ } else if (ctx.TagId == HtmlTagId.Body && !ctx.IsEndTag) {
+ ctx.WriteTag (htmlWriter, false);
+
+ // add and/or replace oncontextmenu="return false;"
+ foreach (var attribute in ctx.Attributes) {
+ if (attribute.Name.ToLowerInvariant () == "oncontextmenu")
+ continue;
+
+ htmlWriter.WriteAttribute (attribute);
+ }
+
+ htmlWriter.WriteAttribute ("oncontextmenu", "return false;");
+ } 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.ToLowerInvariant () == "yes";
+
+ 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
+ attachments.AddRange (entity.ExtractAttachments ());
+ }
+
+ 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);
+ }
+ }
+ #endregion
+
+ #region ReplyVisitor
+ public class ReplyVisitor : MimeVisitor
+ {
+ readonly Stack stack = new Stack ();
+ MimeMessage message;
+ MimeEntity body;
+
+ ///
+ /// Creates a new ReplyVisitor.
+ ///
+ public ReplyVisitor ()
+ {
+ }
+
+ ///
+ /// Gets the reply.
+ ///
+ /// The reply.
+ public MimeEntity Body {
+ get { return body; }
+ }
+
+ void Push (MimeEntity entity)
+ {
+ var multipart = entity as Multipart;
+
+ if (body == null) {
+ body = entity;
+ } else {
+ var parent = stack.Peek ();
+ parent.Add (entity);
+ }
+
+ if (multipart != null)
+ stack.Push (multipart);
+ }
+
+ void Pop ()
+ {
+ stack.Pop ();
+ }
+
+ public static string GetOnDateSenderWrote (MimeMessage message)
+ {
+ var sender = message.Sender != null ? message.Sender : message.From.Mailboxes.FirstOrDefault ();
+ var name = sender != null ? (!string.IsNullOrEmpty (sender.Name) ? sender.Name : sender.Address) : "someone";
+
+ return string.Format ("On {0}, {1} wrote:", message.Date.ToString ("f"), name);
+ }
+
+ ///
+ /// Visit the specified message.
+ ///
+ /// The message.
+ public override void Visit (MimeMessage message)
+ {
+ this.message = message;
+ stack.Clear ();
+
+ base.Visit (message);
+ }
+
+ protected override void VisitMultipartAlternative (MultipartAlternative alternative)
+ {
+ var multipart = new MultipartAlternative ();
+
+ Push (multipart);
+
+ for (int i = 0; i < alternative.Count; i++)
+ alternative[i].Accept (this);
+
+ Pop ();
+ }
+
+ protected override void VisitMultipartRelated (MultipartRelated related)
+ {
+ var multipart = new MultipartRelated ();
+ var root = related.Root;
+
+ Push (multipart);
+
+ root.Accept (this);
+
+ for (int i = 0; i < related.Count; i++) {
+ if (related[i] != root)
+ related[i].Accept (this);
+ }
+
+ Pop ();
+ }
+
+ protected override void VisitMultipart (Multipart multipart)
+ {
+ foreach (var part in multipart) {
+ if (part is MultipartAlternative)
+ part.Accept (this);
+ else if (part is MultipartRelated)
+ part.Accept (this);
+ else if (part is TextPart)
+ part.Accept (this);
+ }
+ }
+
+ void HtmlTagCallback (HtmlTagContext ctx, HtmlWriter htmlWriter)
+ {
+ if (ctx.TagId == HtmlTagId.Body && !ctx.IsEmptyElementTag) {
+ if (ctx.IsEndTag) {
+ // end our opening
+ htmlWriter.WriteEndTag (HtmlTagId.BlockQuote);
+
+ // pass the