逾平台的.NET邮件协议MailKit组件解析

   发起的.NET
Core开源组织号召,进展的进度是本人要好吗没想到的,很多园友都积极参与(虽然有些人由衷砸场子,要是坐自身原先的宝脾气,这会当为我从住院了咔嚓,不过幸而是个别,做同项事究竟有人说好,也有人说是用武汉讲话说“闹眼子”),.NET社区不是从来不愿意共享知识之人头,只是没有一个完好和拔尖的生态环境,总之要国内的.NET发展进一步强。我以这里想到一句话“我们要自己得开巨浪,但咱也心甘情愿做巨浪来袭前的小浪”。

 
 上面拉了(我就丁提到正事前,都设拿部分拉扯的言辞,这个习惯变更不丢了…)

 
 项目蒙为及时的通信,有直接发多少及页面,也闹动短信通知,也有我门今天介绍的邮件组件。我们今天之重要职责便是执教一下来一个.NET底免费开源之邮件组件MailKit。本文将仍旧的重组实例和组件底层代码讲解一下相关组件的知。(项目招人的时,我还见面咨询一样下.NET的底色原理,有一个大神问我如此有啊意义也?我们也勾勒不出.NET底层那样的地道处理方式,为何取了解这些,其实我个人觉得,问底的规律,只是向以与好之处理局部顺序出现的问题,以及针对性程序编码的时光,选择最适于的法子提升性能,任何一样栽方式都发优势以及劣势,.NET的类库代码也是这样,如果我们知道.NET的根实现,我们于品种的要求实现时,可以根据.NET底层实现,选择适宜的章程,以要性能最美好)。

一.Mailkit组件概述

 
 项目蒙以Email的操作会比多,一般小大一些底档次,都见面采取到邮件操作就一个操作。对于.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.2、支持OpenPGP、支持DKIM签名等等方式。Mailkit组件可以通过CancellationToken取消相应之操作,CancellationToken传播应注销操作的通告,一个底CancellationToken使线程,线程池工作项目内,或吊销合作任务的目标。过实例化CancellationTokenSource对象来创造取消令牌,该目标管理于那CancellationTokenSource.Token属性检索的撤销令牌。然后,将注销令牌传递至该接收取消通知的人身自由数量的线程,任务或操作。令牌不能够用于启动取消。

  MailKit组件支持异步操作,在其中编写的关于I/O异步操作的切近。

二.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;
        }

 
 调用该器件发送邮件及也邮件上加附件是比较简单的,第一步是实例化MimeMessage对象,对于拖欠目标的解析将以底下进行,得到MimeMessage对象后,指定邮件的地点和主题等等相关信息。第二步实例化TextPart对象,为对象设定文本信息。若得咨询邮件创建文件的附件,可以使用MimePart对象,包含内容(如信息正文文本或)的叶节点MIME部分一个附件。第四步为开创的邮件主体及文书和附件信息后,可以创建Multipart对象,创建邮件容器,用来装文本信息及附件。最后调用MimeMessage.body属性获取或设置信息之正文。

    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部分的塑造结构。的 内容处置头是为给接客户端提供提醒为怎样有凡为着显得作为消息体的一律片,并且完全在受解释为附件。另外两种方式当下相差就未开牵线了。

三.MailKit核心对象解析

 
 上面介绍了Email的基本操作就未做过多的介绍,在动用该零件时,较为的简约。这里虽来探视该器件的类别结构以及组成部分核心目标。类库结构发生如下图:

房地产项目 1

    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判断是否可写。该方式定义也虚方法,在延续这道后,可以在子类种对该法开展重写。

四.总结

 
 本人认为在列支出中,如果引入了第三着组件,我们尽量引入组件的源码,这样咱们针对全部组件的结构发生一个认识,组件的兑现方式我们吧足以展开精雕细刻了解,尤其是我们以开展调剂之后更为有因此,我们好逐一的拓断点调试。以上是指向拖欠器件的一个概括介绍,有趣味之得错过深入之了解和上学。

相关文章