大红鹰葡京会跨平台的,NET邮件协议MailKit组件解析

   发起的.NET
Core开源组织号召,进展的速度是小编自身也从未想到的,很多园友都积极参加(就算有点人率真砸场子,倘诺以自小编原先的宝本性,那会相应被小编打住院了吧,但是还好是个别,做一件事总有人说好,也有人说是用德雷斯顿话说“闹眼子”),.NET社区不是尚未愿意共享知识的人,只是没有贰个完整和完美的生态环境,由此可知希望国内的.NET发展更为强大。作者在此地想到一句话“我们目的在于本身能够做巨浪,但大家也真心地服气做巨浪来袭前的小浪”。

   发起的.NET
Core开源协会号召,进展的快慢是自小编自个儿也未曾想到的,很多园友都积极参加(即使有点人由衷砸场子,要是以自家原先的宝特性,那会相应被自身打住院了吗,可是万幸是个别,做一件事总有人说好,也有人说是用弗罗茨瓦夫话说“闹眼子”),.NET社区不是从未愿意大利共产党享文化的人,只是没有2个完好和美妙的生态环境,总而言之希望国内的.NET发展更为强大。我在此处想到一句话“大家期望团结能够做巨浪,但我们也愿意做巨浪来袭前的小浪”。

 
 上面扯淡完成(小编这人干正事前,都要将一部分闲话的话,这么些习惯改不掉了…)

 
 下边扯淡完结(笔者那人干正事前,都要将部分聊天的话,这么些习惯改不掉了…)

 
 项目中为了及时的通讯,有直接发多少到页面,也有使用短信文告,也有我门后天牵线的邮件组件。我们今日的根本职务正是执教一下有八个.NET的免费开源的邮件组件MailKit。本文将如故的三结合实例和组件底层代码讲解一下有关组件的学问。(项目招人的时候,作者都会问一下.NET的最底层原理,有1个大神问笔者如此有何意义吗?大家也写不出.NET底层那样的可观处理格局,为什么取理解这个,其实本人个人认为,问底层的原理,只是向为了跟好的处理局地主次出现的标题,以及对程序编码的时候,选拔最合适的措施进步品质,任何一种艺术都有优势和劣势,.NET的类库代码也是那般,假设大家知道.NET的平底完成,大家在类型的供给完成时,能够依照.NET底层达成,选用稳妥的方法,以求品质最优)。

 
 项目中为了及时的通讯,有直接发多少到页面,也有利用短信通告,也有小编门前天牵线的邮件组件。大家今日的根本职分正是执教一下有1个.NET的免费开源的邮件组件MailKit。本文将还是的整合实例和组件底层代码讲解一下生死相依组件的文化。(项目招人的时候,作者都会问一下.NET的尾部原理,有一个大神问小编这样有怎么着意义吗?大家也写不出.NET底层那样的大好处理方式,为什么取明白那些,其实笔者个人认为,问底层的规律,只是向为了跟好的处理局地顺序出现的难点,以及对程序编码的时候,选取最合适的艺术进步品质,任何一种方法都有优势和劣势,.NET的类库代码也是这么,假诺大家知道.NET的底层完毕,我们在品种的必要完结时,能够依据.NET底层完成,选用适用的法子,以求品质最优)。

一.Mailkit组件概述

 
 项目中选择Email的操作机会比较多,一般不怎么大学一年级些的品种,都会使用到邮件操作那3个操作。对于.NET邮件操作的零部件和格局相比多,明天我们就介绍一款邮件操作的零件MailKit,那一个邮件组件是四个开源免费的,大家前几天就来明白一下那多少个组件的性状。MimeKit意在通过尽恐怕接近地坚守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.二 、帮忙OpenPGP、辅助DKIM签名等等形式。Mailkit组件能够经过CancellationToken撤除相应的操作,CancellationToken传播应废除操作的通报,三个的CancellationToken使线程,线程池工作类型里面,或收回合营职责的对象。超过实际例化CancellationTokenSource对象来创立撤销令牌,该指标管理从其CancellationTokenSource.Token属性检索的吊销令牌。然后,将注销令牌传递到应该接收撤废通告的任性数量的线程,职责或操作。令牌不能够用来运维撤销。

  MailKit组件协理异步操作,在个中编写的有关I/O异步操作的类。

一.Mailkit组件概述

 
 项目中选用Email的操作机会相比较多,一般不怎么大学一年级点的品类,都会使用到邮件操作那二个操作。对于.NET邮件操作的组件和艺术相比多,明日我们就介绍一款邮件操作的零部件MailKit,那几个邮件组件是3个开源免费的,咱们明天就来打探一下那多个零部件的特点。Mime基特意在通过尽恐怕接近地遵循MIME规范来消除那些标题,同时还为程序员提供了2个万分不难使用的高档API。

 
 组件的帮助的客户端类型比较多,例如SMTP客户端、POP3客户端、IMAP客户端。该器件是1个跨平台的Email组件,该器件扶助.NET
4.0,.NET 4.5,Xamarin.Android,Xamarin.iOS,Windows Phone
8.1之类平台。该器件提供了五个MIME解析器,组件具备的分析天性灵活、质量高、很好的处理千头万绪的破碎的MIME格式化。MimeKit的习性实际上与GMime极度。

   该器件在安全性的依旧比较高的,处理平安的艺术较多,SASL认证、协理S /
MIME v3.② 、支持OpenPGP、帮忙DKIM签名等等方式。Mailkit组件可以因此CancellationToken撤消相应的操作,CancellationToken传播应注销操作的通告,三个的CancellationToken使线程,线程池工作项目里面,或撤销合作职务的目的。超过实际例化CancellationTokenSource对象来创建撤除令牌,该指标管理从其CancellationTokenSource.Token属性检索的撤销令牌。然后,将收回令牌传递到相应接受撤废文告的轻易数量的线程,职务或操作。令牌无法用于运维撤废。

  Mail基特组件协助异步操作,在中间编写的关于I/O异步操作的类。

二.MailKit实例:

   
下边介绍了MailKit组件的背景和特征,那里就介绍一下Email组件的归纳利用。

二.MailKit实例:

   
上边介绍了MailKit组件的背景和特点,那里就介绍一下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;
        }

 
 调用该零件发送邮件和为邮件添加附属类小部件是相比较简单的,第1步是实例化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对象后,钦命邮件的地方和宗旨等等相关新闻。第2步实例化TextPart对象,为指标设定文本新闻。若要求问邮件创设文件的附属类小部件,能够运用MimePart对象,蕴含内容(如音信正文文本或)的叶节点MIME部分2个附件。第4步为创造的邮件主体和文书以及附属类小部件音信后,可以创造Multipart对象,制造邮件容器,用来装载文本消息和附属类小部件。最终调用MimeMessage.body属性获取或设置消息的正文。

    2.邮件音讯的解析:

var message = MimeMessage.Load(stream);

 
 邮件的音讯大家须求展开对应的解析,那里大家使用MimeMessage的Load方法,该方法从钦赐的流加载MimeKit.MimeMessage。另二个加载数据的方法,能够动用MimeParser类,那里就不再解析了。

    2.邮件音讯的辨析:

var message = MimeMessage.Load(stream);

 
 邮件的新闻我们供给举办相应的剖析,那里大家运用MimeMessage的Load方法,该方式从钦命的流加载MimeKit.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部分的树结构。的 内容处置头是为了给接受客户端提供提示以什么样部分是为了展现作为音信体的一有些,并且旨在被分解为附件。别的二种艺术那离就不做牵线了。

三.MailKit宗旨对象解析

 
 下边介绍了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,具有5个艺术重载。该办法再次回到五个MimeMessage对象,有源码能够见见,在该格局内部成立了1个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,具有多少个方法重载。该措施重回一个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判断是还是不是可写。该措施定义为虚方法,在此起彼伏此方式后,能够在子类种对该情势开展重写。

四.总结

 
 本身认为在类型支付中,假如引入了第③方组件,大家尽量引入组件的源码,那样大家对一切组件的协会有一个认识,组件的落实情势我们也能够进行精心精晓,尤其是我们在展开调节的之后尤其有用,大家可以逐一的拓展断点调节和测试。以上是对该零件的一个粗略介绍,有趣味的能够去深入的询问和读书。

四.总结

 
 本人觉得在类型支付中,假如引入了第叁方组件,大家尽量引入组件的源码,那样我们对整个组件的组织有一个认识,组件的落到实处际情时势大家也能够进行神工鬼斧领会,尤其是大家在拓展调节和测试的事后更进一步有用,大家能够逐一的进行断点调节和测试。以上是对该零件的3个简约介绍,有趣味的能够去深切的摸底和上学。

admin

网站地图xml地图