NET邮件协议Mail基特(Kit)组件解析,跨平台的

   发起的.NET
Core开源协会号召,进展的快慢是自我自己也未曾想到的,很多园友都积极参加(固然有些人目不窥园砸场子,假诺以本人在此此前的宝脾气,那会应该被自己打住院了呢,可是幸而是少数,做一件事总有人说好,也有人说是用夏洛特话说“闹眼子”),.NET社区不是从未有过愿意共享文化的人,只是没有一个整机和出色的生态环境,可想而知希望国内的.NET发展进一步强大。我在此间想到一句话“大家盼望自己可以做巨浪,但大家也愿意做巨浪来袭前的小浪”。

   发起的.NET
Core开源社团号召,进展的快慢是自我自己也远非想到的,很多园友都积极参预(固然有些人全神贯注砸场子,假设以自我原先的宝脾气,那会应该被自己打住院了吗,可是幸而是个别,做一件事总有人说好,也有人说是用夏洛特话说“闹眼子”),.NET社区不是从未愿意共享知识的人,只是没有一个一体化和精美的生态环境,总而言之希望国内的.NET发展越发强大。我在此处想到一句话“大家期望团结能够做巨浪,但大家也愿意做巨浪来袭前的小浪”。

 
 上面扯淡完成(我那人干正事前,都要将一部分闲话的话,那一个习惯改不掉了…)

 
 上边扯淡完结(我那人干正事前,都要将一部分闲谈的话,那么些习惯改不掉了…)

 
 项目中为了及时的通信,有间接发多少到页面,也有选用短信通告,也有我门前日介绍的邮件组件。大家前几日的要害任务就是执教一下有一个.NET的免费开源的邮件组件Mail基特。本文将依然的结缘实例和零部件底层代码讲解一下相关组件的学问。(项目招人的时候,我都会问一下.NET的最底层原理,有一个大神问我如此有啥含义呢?大家也写不出.NET底层那样的精粹处理格局,为什么取通晓这几个,其实我个人认为,问底层的规律,只是向为了跟好的处理局部主次出现的题目,以及对程序编码的时候,选取最合适的章程提高性能,任何一种艺术都有优势和逆风局,.NET的类库代码也是这般,假诺大家知道.NET的底部完成,大家在项指标需求已毕时,能够依照.NET底层完成,选取适合的法子,以求性能最优)。

 
 项目中为了及时的通信,有平素发多少到页面,也有利用短信文告,也有我门后天牵线的邮件组件。大家后天的机要任务就是教学一下有一个.NET的免费开源的邮件组件MailKit。本文将依然的重组实例和组件底层代码讲解一下连锁组件的文化。(项目招人的时候,我都会问一下.NET的底部原理,有一个大神问我如此有如何含义呢?大家也写不出.NET底层那样的精粹处理情势,为何取通晓这一个,其实我个人认为,问底层的原理,只是向为了跟好的处理局地顺序出现的题目,以及对程序编码的时候,接纳最合适的章程进步性能,任何一种艺术都有优势和逆风局,.NET的类库代码也是那般,固然大家知道.NET的底部落成,大家在类型的需要完成时,可以按照.NET底层完成,选用适合的情势,以求性能最优)。

一.Mailkit组件概述

 
 项目中动用Email的操作机会比较多,一般不怎么大一些的连串,都会选拔到邮件操作这几个操作。对于.NET邮件操作的机件和艺术相比较多,今日大家就介绍一款邮件操作的组件Mail基特,这么些邮件组件是一个开源免费的,我们后天就来精通一下那几个零部件的特点。Mime基特目的在于通过尽可能接近地遵从MIME规范来化解那个题目,同时还为程序员提供了一个分外不难使用的高档API。

 
 组件的援助的客户端类型相比较多,例如SMTP客户端、POP3客户端、IMAP客户端。该器件是一个跨平台的Email组件,该零件接济.NET
4.0,.NET 4.5,Xamarin.Android,Xamarin.iOS,Windows Phone
8.1等等平台。该零件提供了一个MIME解析器,组件具备的分析特性灵活、性能高、很好的拍卖千头万绪的破损的MIME格式化。Mime基特的习性实际上与GMime很是。

   该零件在安全性的依然相比较高的,处理平安的办法较多,SASL认证、帮衬S /
MIME v3.2、帮助OpenPGP、扶助DKIM签名等等格局。Mailkit组件可以通过CancellationToken打消相应的操作,CancellationToken传播应注销操作的通报,一个的CancellationToken使线程,线程池工作项目里面,或打消合营任务的靶子。过实例化CancellationTokenSource对象来创建撤废令牌,该对象管理从其CancellationTokenSource.Token属性检索的撤销令牌。然后,将吊销令牌传递到应有吸纳废除文告的随意数量的线程,任务或操作。令牌无法用于启动裁撤。

  MailKit组件帮衬异步操作,在其中编写的关于I/O异步操作的类。

一.Mailkit组件概述

 
 项目中行使Email的操作机会相比较多,一般不怎么大一点的连串,都会选取到邮件操作那些操作。对于.NET邮件操作的机件和章程比较多,前天大家就介绍一款邮件操作的零件Mail基特(Kit),那个邮件组件是一个开源免费的,大家前几日就来驾驭一下那么些零件的特性。Mime基特意在通过尽可能接近地遵从MIME规范来缓解那个问题,同时还为程序员提供了一个十分不难使用的高档API。

 
 组件的支撑的客户端类型相比较多,例如SMTP客户端、POP3客户端、IMAP客户端。该零件是一个跨平台的Email组件,该器件协理.NET
4.0,.NET 4.5,Xamarin.Android,Xamarin.iOS,Windows Phone
8.1之类平台。该零件提供了一个MIME解析器,组件具备的剖析特性灵活、性能高、很好的处理千头万绪的破损的MIME格式化。MimeKit的属性实际上与GMime相当。

   该器件在安全性的照旧相比较高的,处理平安的法子较多,SASL认证、协理S /
MIME v3.2、扶助OpenPGP、扶助DKIM签名等等格局。Mailkit组件可以通过CancellationToken裁撤相应的操作,CancellationToken传播应打消操作的通知,一个的CancellationToken使线程,线程池工作项目里面,或吊销合作义务的对象。过实例化CancellationTokenSource对象来制造取消令牌,该对象管理从其CancellationTokenSource.Token属性检索的废除令牌。然后,将吊销令牌传递到相应吸纳撤废文告的肆意数量的线程,职责或操作。令牌不可以用来启动取消。

  MailKit组件援助异步操作,在其中编写的关于I/O异步操作的类。

二.MailKit实例:

   
上边介绍了MailKit组件的背景和特点,这里就介绍一下Email组件的简短利用。

二.MailKit实例:

   
下边介绍了Mail基特组件的背景和特性,那里就介绍一下Email组件的概括利用。

  1.开立邮件形式:

 public void SentEmail(string path)
        {
            var message = new MimeMessage();
            //获取From标头中的地址列表,添加指定的地址
            message.From.Add(new MailboxAddress("Joey", "joey@friends.com"));
            //获取To头中的地址列表,添加指定的地址
            message.To.Add(new MailboxAddress("Alice", "alice@wonderland.com"));
            //获取或设置消息的主题
            message.Subject = "How you doin?";
            // 创建我们的消息文本,就像以前一样(除了不设置为message.Body)
            var body = new TextPart("plain")
            {
                Text = @"Hey Alice-- Joey"
            };
            // 为位于路径的文件创建图像附件
            var attachment = new MimePart("image", "gif")
            {
                ContentObject = new ContentObject(File.OpenRead(path), ContentEncoding.Default),
                ContentDisposition = new ContentDisposition(ContentDisposition.Attachment),
                ContentTransferEncoding = ContentEncoding.Base64,
                FileName = Path.GetFileName(path)
            };
            // 现在创建multipart / mixed容器来保存消息文本和图像附件
            var multipart = new Multipart("mixed")
            {
                body, attachment
            };
            // 现在将multipart / mixed设置为消息正文 
            message.Body = multipart;
        }

 
 调用该零件发送邮件和为邮件添加附件是相比较简单的,第一步是实例化MimeMessage对象,对于该对象的解析将在底下举办,得到MimeMessage对象后,指定邮件的地方和大旨等等相关消息。第二步实例化TextPart对象,为目的设定文本音讯。若必要问邮件创设文件的附件,可以接纳MimePart对象,包括内容(如音信正文文本或)的叶节点MIME部分一个附件。第四步为创设的邮件主体和文件以及附件新闻后,可以创建Multipart对象,创制邮件容器,用来装载文本音信和附件。最终调用MimeMessage.body属性获取或设置音信的正文。

  1.成立邮件情势:

 public void SentEmail(string path)
        {
            var message = new MimeMessage();
            //获取From标头中的地址列表,添加指定的地址
            message.From.Add(new MailboxAddress("Joey", "joey@friends.com"));
            //获取To头中的地址列表,添加指定的地址
            message.To.Add(new MailboxAddress("Alice", "alice@wonderland.com"));
            //获取或设置消息的主题
            message.Subject = "How you doin?";
            // 创建我们的消息文本,就像以前一样(除了不设置为message.Body)
            var body = new TextPart("plain")
            {
                Text = @"Hey Alice-- Joey"
            };
            // 为位于路径的文件创建图像附件
            var attachment = new MimePart("image", "gif")
            {
                ContentObject = new ContentObject(File.OpenRead(path), ContentEncoding.Default),
                ContentDisposition = new ContentDisposition(ContentDisposition.Attachment),
                ContentTransferEncoding = ContentEncoding.Base64,
                FileName = Path.GetFileName(path)
            };
            // 现在创建multipart / mixed容器来保存消息文本和图像附件
            var multipart = new Multipart("mixed")
            {
                body, attachment
            };
            // 现在将multipart / mixed设置为消息正文 
            message.Body = multipart;
        }

 
 调用该零件发送邮件和为邮件添加附件是相比简单的,第一步是实例化MimeMessage对象,对于该目的的解析将在底下举行,得到MimeMessage对象后,指定邮件的地址和主旨等等相关音信。第二步实例化TextPart对象,为对象设定文本音信。若要求问邮件创制文件的附件,可以动用MimePart对象,包括内容(如新闻正文文本或)的叶节点MIME部分一个附件。第四步为创立的邮件主体和文件以及附件新闻后,可以创制Multipart对象,创制邮件容器,用来装载文本音信和附件。最后调用MimeMessage.body属性获取或安装新闻的正文。

    2.邮件音信的剖析:

var message = MimeMessage.Load(stream);

 
 邮件的音信大家须要进行对应的分析,那里我们运用MimeMessage的Load方法,该办法从指定的流加载MimeKit.MimeMessage。另一个加载数据的情势,可以运用MimeParser类,那里就不再解析了。

    2.邮件新闻的剖析:

var message = MimeMessage.Load(stream);

 
 邮件的新闻大家要求展开相应的辨析,那里大家运用MimeMessage的Load方法,该方式从指定的流加载Mime基特(Kit).MimeMessage。另一个加载数据的法门,可以行使MimeParser类,那里就不再解析了。

    3.邮件的收纳:

   public static void HandleMimeEntity(MimeEntity entity)
        {
            //MimeEntity转化为Multipart实体
            var multipart = entity as Multipart;
            if (multipart != null)
            {
                for (int i = 0; i < multipart.Count; i++)
                    HandleMimeEntity(multipart[i]);
                return;
            }
            var rfc822 = entity as MessagePart;

            if (rfc822 != null)
            {
                var message = rfc822.Message;
                HandleMimeEntity(message.Body);
                return;
            }
            var part = (MimePart)entity;
        }

 
 以上是对收到到的音讯的一个遍历,拔取递归遍历MIME结构。MIME是内容的树结构,很像一个文件系统。MIME确实定义了一组通用规则,用于邮件客户端怎么样分解MIME部分的树结构。的 内容处置头是为了给接受客户端提供提示以什么样部分是为着展现作为信息体的一有的,并且目的在于被诠释为附件。此外二种情势那离就不做牵线了。

    3.邮件的收受:

   public static void HandleMimeEntity(MimeEntity entity)
        {
            //MimeEntity转化为Multipart实体
            var multipart = entity as Multipart;
            if (multipart != null)
            {
                for (int i = 0; i < multipart.Count; i++)
                    HandleMimeEntity(multipart[i]);
                return;
            }
            var rfc822 = entity as MessagePart;

            if (rfc822 != null)
            {
                var message = rfc822.Message;
                HandleMimeEntity(message.Body);
                return;
            }
            var part = (MimePart)entity;
        }

 
 以上是对收取到的音信的一个遍历,选择递归遍历MIME结构。MIME是内容的树结构,很像一个文件系统。MIME确实定义了一组通用规则,用于邮件客户端怎样解释MIME部分的树结构。的 内容处置头是为着给接受客户端提供提示以什么样部分是为了突显作为信息体的一部分,并且目的在于被演说为附件。其它二种办法那离就不做牵线了。

三.Mail基特主题对象解析

 
 上边介绍了Email的基本操作就不做过多的介绍,在利用该器件时,较为的简约。那里就来探望该器件的种类结构和局地主导目标。类库结构有如下图:

图片 1

三.MailKit焦点对象解析

 
 上面介绍了Email的基本操作就不做过多的介绍,在行使该零件时,较为的简约。那里就来探视该器件的序列结构和一部分主干目标。类库结构有如下图:

图片 2

    1.MimeMessage.Load():

public static MimeMessage Load (ParserOptions options, Stream stream, bool persistent, 
                                CancellationToken cancellationToken = default (CancellationToken))
        {
            if (options == null)
                throw new ArgumentNullException (nameof (options));

            if (stream == null)
                throw new ArgumentNullException (nameof (stream));

            var parser = new MimeParser (options, stream, MimeFormat.Entity, persistent);

            return parser.ParseMessage (cancellationToken);
        }

   
 该办法从指定的流加载MimeMessage,具有6个情势重载。该措施再次回到一个MimeMessage对象,有源码能够看到,在该形式内部创设了一个MimeParser对象,MimeParser包括内容(例如邮件正文文本或附件)的叶节点MIME部分。调用ParseMessage方法,解析来自流的消息。

   2.TextPart.Text:

public string Text {
            get {
                if (ContentObject == null)
                    return string.Empty;
                var charset = ContentType.Parameters["charset"];
                using (var memory = new MemoryStream ()) {
                    ContentObject.DecodeTo (memory);
                    var content = memory.ToArray ();
                    Encoding encoding = null;
                    if (charset != null) {
                        try {
                            encoding = CharsetUtils.GetEncoding (charset);
                        } catch (NotSupportedException) {
                        }
                    }
                    if (encoding == null) {
                        try {
                            return CharsetUtils.UTF8.GetString (content, 0, (int) memory.Length);
                        } catch (DecoderFallbackException) {
                            encoding = CharsetUtils.Latin1;
                        }
                    }
                    return encoding.GetString (content, 0, (int) memory.Length);
                }
            }
            set {
                SetText (Encoding.UTF8, value);
            }
        }

   
该属性获取解码的文本内容。该属性是一个可读可写的性能。ContentType.Parameters[“charset”]用以获取charset参数的值。该方法用来将参数的值设置为多少流并设置相应的编码。看到此间的不得了处理协会,就想大概的谈几句,.NET的万分相比较的脆弱,很多时候在写.NET的相当时就尤其的简练,以上是对丰盛知识捕获,有些地方并没有做处理,有些地点是对格外的地点进行复苏。

    1.MimeMessage.Load():

public static MimeMessage Load (ParserOptions options, Stream stream, bool persistent, 
                                CancellationToken cancellationToken = default (CancellationToken))
        {
            if (options == null)
                throw new ArgumentNullException (nameof (options));

            if (stream == null)
                throw new ArgumentNullException (nameof (stream));

            var parser = new MimeParser (options, stream, MimeFormat.Entity, persistent);

            return parser.ParseMessage (cancellationToken);
        }

   
 该方法从指定的流加载MimeMessage,具有6个点子重载。该办法重回一个MimeMessage对象,有源码可以观察,在该格局内部创制了一个MimeParser对象,MimeParser包罗内容(例如邮件正文文本或附件)的叶节点MIME部分。调用ParseMessage方法,解析来自流的新闻。

   2.TextPart.Text:

public string Text {
            get {
                if (ContentObject == null)
                    return string.Empty;
                var charset = ContentType.Parameters["charset"];
                using (var memory = new MemoryStream ()) {
                    ContentObject.DecodeTo (memory);
                    var content = memory.ToArray ();
                    Encoding encoding = null;
                    if (charset != null) {
                        try {
                            encoding = CharsetUtils.GetEncoding (charset);
                        } catch (NotSupportedException) {
                        }
                    }
                    if (encoding == null) {
                        try {
                            return CharsetUtils.UTF8.GetString (content, 0, (int) memory.Length);
                        } catch (DecoderFallbackException) {
                            encoding = CharsetUtils.Latin1;
                        }
                    }
                    return encoding.GetString (content, 0, (int) memory.Length);
                }
            }
            set {
                SetText (Encoding.UTF8, value);
            }
        }

   
该属性获取解码的文本内容。该属性是一个可读可写的习性。ContentType.Parameters[“charset”]用于获取charset参数的值。该方法用来将参数的值设置为数量流并设置相应的编码。看到此间的百般处理社团,就想几乎的谈几句,.NET的足够相比的脆弱,很多时候在写.NET的老大时就尤其的粗略,以上是对越发知识捕获,有些地方并从未做处理,有些地点是对那么些的地方进行复苏。

   3.MimeEntity.WriteTo():

public virtual void WriteTo (FormatOptions options, Stream stream, bool contentOnly, 
                            CancellationToken cancellationToken = default (CancellationToken))
        {
            if (options == null)
                throw new ArgumentNullException (nameof (options));

            if (stream == null)
                throw new ArgumentNullException (nameof (stream));

            if (!contentOnly)
                Headers.WriteTo (options, stream, cancellationToken);
        }

   
该办法将MimeEntity写入到指定的多少流中,该措施接受参数options格式选项。stream输出数据流,contentOnly判断是否可写。该方法定义为虚方法,在后续此方法后,可以在子类种对该办法开展重写。

   3.MimeEntity.WriteTo():

public virtual void WriteTo (FormatOptions options, Stream stream, bool contentOnly, 
                            CancellationToken cancellationToken = default (CancellationToken))
        {
            if (options == null)
                throw new ArgumentNullException (nameof (options));

            if (stream == null)
                throw new ArgumentNullException (nameof (stream));

            if (!contentOnly)
                Headers.WriteTo (options, stream, cancellationToken);
        }

   
该办法将MimeEntity写入到指定的多寡流中,该措施接受参数options格式选项。stream输出数据流,contentOnly判断是否可写。该方法定义为虚方法,在继续此办法后,可以在子类种对该办法开展重写。

四.总结

 
 本人觉得在档次开销中,如若引入了第三方组件,大家尽量引入组件的源码,那样大家对一切组件的构造有一个认识,组件的贯彻形式大家也得以拓展细心了然,尤其是大家在开展调剂的未来愈来愈有用,大家可以逐一的拓展断点调试。以上是对该器件的一个简单介绍,有趣味的可以去深远的摸底和读书。

四.总结

 
 本人认为在类型支付中,若是引入了第三方组件,大家尽量引入组件的源码,那样大家对总体组件的布局有一个认识,组件的已毕形式大家也得以开展细致驾驭,尤其是大家在拓展调试的以后越发有用,大家得以逐一的进展断点调试。以上是对该零件的一个大概介绍,有趣味的可以去长远的垂询和读书。

相关文章

发表评论

电子邮件地址不会被公开。 必填项已用*标注