我的Office Outlook插件開發之旅(一)

来源:https://www.cnblogs.com/heirem/archive/2023/10/26/17782541.html
-Advertisement-
Play Games

目的 開發一款可以同步Outlook郵件通訊錄信息的插件。 方案 VSTO 外接程式 COM 載入項 VSTO 外接程式對Outlook的支持,是從2010版本之後開始的。 VSTO 4.0 支持Outlook 2010以後的版本,所以編寫一次代碼,就可以在不同的版本上運行。 COM 載入項十分依賴 ...


目的

開發一款可以同步Outlook郵件通訊錄信息的插件。

方案

  1. VSTO 外接程式
  2. COM 載入項

VSTO 外接程式對Outlook的支持,是從2010版本之後開始的。
VSTO 4.0 支持Outlook 2010以後的版本,所以編寫一次代碼,就可以在不同的版本上運行。

COM 載入項十分依賴於.NET Framework框架和Office的版本,之後講到的時候你就明白。

VSTO 外接程式

VSTO,全稱是Visual Studio Tools for Office,在微軟的Visual Studio平臺中進行Office專業開發。VSTO是VBA的替代產品,使用該工具包使開發Office應用程式變得更簡單,VSTO還能使用Visual Studio開發環境中的眾多功能。
VSTO依賴於.NET Framework框架,並且不能在.net core或者.net 5+以上的平臺運行。

創建VSTO程式

使用Visual Studio 2013的新建項目,如果你使用更新版本的話,那麼你大概率找不到。因為被移除了。比如Visual Studio 2019最低創建的Outlook 2013 外接程式

Office/SharePoint -> .Net Framework 4 -> Outlook 2010 外接程式

之後我們會得到,這樣的項目結構

打開ThisAddIn.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Xml.Linq;
using Outlook = Microsoft.Office.Interop.Outlook;
using Office = Microsoft.Office.Core;
using Microsoft.Office.Interop.Outlook;
using System.Windows.Forms;
using System.Data;
using System.Data.SqlClient;
using System.IO;
using System.Threading;
using System.Collections;

namespace ContactsSynchronization
{
    public partial class ThisAddIn
    {
        
        private void ThisAddIn_Startup(object sender, System.EventArgs e)
        {
            // Outlook啟動時執行
            MessageBox.Show("Hello VSTO!");
        }

        private void ThisAddIn_Shutdown(object sender, System.EventArgs e)
        {
            // Outlook關閉時執行
        }

        #region VSTO 生成的代碼

        /// <summary>
        /// 設計器支持所需的方法 - 不要
        /// 使用代碼編輯器修改此方法的內容。
        /// </summary>
        private void InternalStartup()
        {
            // 綁定聲明周期函數
            this.Startup += new System.EventHandler(ThisAddIn_Startup);
            this.Shutdown += new System.EventHandler(ThisAddIn_Shutdown);
        }

        #endregion
    }
}

啟動試試看

到這裡我們就已經把項目搭建起來了,但在寫代碼之前不如再認識認識Outlook的個個對象吧。

認識VSTO中常用對象

微軟文檔
https://learn.microsoft.com/zh-cn/dotnet/api/microsoft.office.interop.outlook.application?view=outlook-pia

常用類型

  • MAPIFolder表示Outlook中的一個文件夾
  • ContactItem 表示一個聯繫人
  • DistListItem 表示一個聯繫人文件夾中的群組
  • OlDefaultFolders 獲取預設文件類型的枚舉
  • OlItemType 獲取文件夾子項類型的枚舉

全局實例Application上掛載了我們用到大多數函數和屬性。

Application.Session;// 會話實例
Application.Version;// DLL動態鏈接庫版本
Application.Name;// 應用名稱

Application.Session會話實例,可以獲取Outlook的大多數狀態,數據。如文件夾、聯繫人、郵件等。

Outlook文件夾結構

Outlook 按照郵件賬號區分用戶數據,即每個郵件賬號都有獨立的收件箱,聯繫人等。

Outlook 預設情況下的文件夾結構

獲取第一個郵箱賬號的預設聯繫人文件夾

Application.Session.Stores.Cast<Outlook.Store()>.First().GetDefaultFolder(OlDefaultFolders.olFolderContacts);

獲取Outlook的狀態信息

獲取聯繫人信息

MAPIFolder folder = Application.Session.GetDefaultFolder(OlDefaultFolders.olFolderContacts);//獲取預設的通訊錄文件夾
IEnumerable<ContactItem> contactItems = folder.Items.OfType<ContactItem>(); // 獲取文件夾下的子項,OfType<ContactItem>只拿聯繫人的
foreach (ContactItem it in contactItems)
{
    // 拿聯繫人的各種信息
    string fullName = it.FullName;
    // 註意在此處修改聯繫人信息,再Save()是不生效的
}

添加聯繫人

MAPIFolder folder = Application.Session.GetDefaultFolder(OlDefaultFolders.olFolderContacts);// 獲取預設的聯繫人文件夾
ContactItem contact = folder.Items.Add(OlItemType.olContactItem);// 新增聯繫人子項
// 設置各種信息
contact.FirstName = "三";
contact.LastName = "張";
contact.Email1Address = "[email protected]";
// 存儲聯繫人
contact.Save();

刪除聯繫人

Microsoft.Office.Interop.Outlook.MAPIFolder deletedFolder = application.Session.GetDefaultFolder(OlDefaultFolders.olFolderDeletedItems);// 預設的聯繫人文件夾
int count = deletedFolder.Items.Count;// 獲取子項數,包含聯繫人和群組
for (int i = count; i > 0; i--)// 遍歷刪除
{
    deletedFolder.Items.Remove(i);
}

成品代碼

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Xml.Linq;
using Outlook = Microsoft.Office.Interop.Outlook;
using Office = Microsoft.Office.Core;
using Microsoft.Office.Interop.Outlook;
using System.Windows.Forms;
using System.Data;
using System.Data.SqlClient;
using System.IO;
using System.Threading;
using System.Collections;

namespace ContactsSynchronization
{
    public partial class ThisAddIn
    {
        

        private void ThisAddIn_Startup(object sender, System.EventArgs e)
        {
            OperatorContact operatorInstance = new OperatorContact(this.Application);
            operatorInstance.Task();
        }

        private void ThisAddIn_Shutdown(object sender, System.EventArgs e)
        {
        }

        #region VSTO 生成的代碼

        /// <summary>
        /// 設計器支持所需的方法 - 不要
        /// 使用代碼編輯器修改此方法的內容。
        /// </summary>
        private void InternalStartup()
        {
            this.Startup += new System.EventHandler(ThisAddIn_Startup);
            this.Shutdown += new System.EventHandler(ThisAddIn_Shutdown);
        }

        #endregion
    }

    class OperatorContact
    {
        public OperatorContact(Microsoft.Office.Interop.Outlook.Application application)
        {
            this.application = application;
        }

        Microsoft.Office.Interop.Outlook.Application application = null; // outlook程式實例

        private static string addressBookName = "湯石集團通訊錄";// 通訊錄名稱

        private Microsoft.Office.Interop.Outlook.MAPIFolder addressBookFolder = null; // 通訊錄文件夾實例

        public void Task()
        {
            new Thread(Run).Start();
        }

        /// <summary>
        /// 開個新線程執行任務,不要堵塞原來的線程
        /// </summary>
        private void Run()
        {
            try
            {
                if (NeedUpdate())
                {
                    addressBookFolder = getAddressBookFolder();// 覆蓋式創建通訊錄
                    List<Contact> remoteContacts = readRemoteContacts();// 讀取遠程郵箱通訊錄
                    if (remoteContacts == null) return;
                    Adjust(remoteContacts);// 調整聯繫人和群組
                    updateClientVersion();// 更新本地通訊錄版本號
                } 
            }
            catch (System.Exception ex)
            {
                const string path = @"C:\TONS\email-plugin-error.log";
                FileInfo fileInfo = new FileInfo(path);
                long length = 0;
                if (fileInfo.Exists && fileInfo.Length != 0) length = fileInfo.Length / 1024 / 1024;
                if (length <= 3) File.AppendAllText(path, ex.Message + "\r\n");
                else File.WriteAllText(path, ex.Message + "\r\n");
            }
        }

        /// <summary>
        /// 覆蓋式創建通訊錄
        /// </summary>
        /// <returns>通訊錄文件夾實例</returns>
        private Microsoft.Office.Interop.Outlook.MAPIFolder getAddressBookFolder()
        {
            // 獲取用戶第一個PST檔的通訊錄文件夾的枚舉器
            IEnumerator en = application.Session.Stores.Cast<Outlook.Store>().First()
                .GetDefaultFolder(OlDefaultFolders.olFolderContacts)
                .Folders.GetEnumerator();
            bool exits = false;
            Microsoft.Office.Interop.Outlook.MAPIFolder folder = null;

            // 遍歷文件夾
            while (en.MoveNext()) {
                Microsoft.Office.Interop.Outlook.MAPIFolder current = (Microsoft.Office.Interop.Outlook.MAPIFolder)en.Current;
                if (current.Name == addressBookName) {
                    exits = true;
                    folder = current;
                }
            }

            if (!exits)
             {
                 // 創建湯石集團通訊錄,並映射成通訊錄格式
                 Microsoft.Office.Interop.Outlook.MAPIFolder newFolder = application.Session.Stores.Cast<Outlook.Store>().First()
                          .GetDefaultFolder(OlDefaultFolders.olFolderContacts)
                          .Folders.Add(addressBookName);
                 newFolder.ShowAsOutlookAB = true;// 設置成“聯繫人”文件夾
                 return newFolder;
             }
             else {
                // 返回已經存在的同時集團通訊錄文件夾,並刪除裡面的內容
                int count = folder.Items.Count;
                for (int i = count; i > 0; i--)
                {
                    folder.Items.Remove(i);
                }
                Microsoft.Office.Interop.Outlook.MAPIFolder deletedFolder = application.Session.GetDefaultFolder(OlDefaultFolders.olFolderDeletedItems);
                count = deletedFolder.Items.Count;
                for (int i = count; i > 0; i--)
                {
                    deletedFolder.Items.Remove(i);
                }
                return folder;
             }
        }



        /// <summary>
        /// 更新本地的銅須錄版本
        /// </summary>
        private void updateClientVersion()
        {
            String path = @"C:\TONS\email-plugin-version.conf";
            string version = getRemoteVersion();
            if (!File.Exists(path))
            {
                File.WriteAllText(path,version);
            }
            else {
                File.WriteAllText(path, version);
            }
        }

        /// <summary>
        /// 判斷是否需要更新
        /// </summary>
        /// <returns>boolean值</returns>
        private bool NeedUpdate()
        {
            string remoteVersion = getRemoteVersion();
            if (remoteVersion == null) return false;
            string clientVersion = getClientVersion();
            return !(clientVersion == remoteVersion);
        }

        /// <summary>
        /// 讀取伺服器的通訊錄版本
        /// </summary>
        /// <returns>通訊錄版本</returns>
        private string getRemoteVersion()
        {
            List<Dictionary<string, object>> items = SelectList(
                "SELECT TOP(1) [version] FROM TonsOfficeA..VersionControl WHERE applicationID = N'EmailContact'"
                , "Server=192.168.2.1;Database=TonsOfficeA;uid=sa;pwd=dsc");
            if (items == null) return null;
            return items[0]["version"].ToString();
        }

        /// <summary>
        /// 獲取本地的通訊錄版本
        /// </summary>
        /// <returns>通訊錄版本</returns>
        private string getClientVersion()
        {
            String path = @"C:\TONS\email-plugin-version.conf";
            if (!File.Exists(path)) return null;
            return File.ReadAllText(path);
        }

        /// <summary>
        /// 讀取遠程的通訊錄
        /// </summary>
        /// <returns>聯繫人實例集合</returns>
        private List<Contact> readRemoteContacts()
        {
            List<Contact> remoteContacts = new List<Contact>();
            List<Dictionary<string, object>> items =
                SelectList(
                    "select [emailAddress],[firstName],[lastName],[companyName],[department],[_group] as 'group',[jobTitle] from [TonsOfficeA].[dbo].[EmailContacts]",
                    "Server=192.168.2.1;Database=TonsOfficeA;uid=sa;pwd=dsc");
            items.ForEach(it =>
            {
                Contact contact = new Contact();
                contact.email1Address = it["emailAddress"].ToString();
                contact.firstName = it["firstName"].ToString();
                contact.lastName = it["lastName"].ToString();
                contact.companyName = it["companyName"].ToString();
                contact.department = it["department"].ToString();
                if (it["jobTitle"] != null) contact.jobTitle = it["jobTitle"].ToString();
                contact.groups = it["group"].ToString().Split(',').ToList();
                remoteContacts.Add(contact);
            });
            return remoteContacts;
        }

        /// <summary>
        /// 執行select語句
        /// </summary>
        /// <param name="sql">select語句</param>
        /// <param name="connection">資料庫鏈接語句</param>
        /// <returns>List<Dictionary<string, object>>結果</returns>
        /// <exception cref="System.Exception"></exception>
        public List<Dictionary<string, object>> SelectList(string sql, string connection)
        {
            if (sql == null || connection == null || sql == "" || connection == "")
                throw new System.Exception("未傳入SQL語句或者Connection鏈接語句");
            List<Dictionary<string, object>> list = new List<Dictionary<string, object>>();
            SqlConnection conn = new SqlConnection(connection);
            SqlCommand cmd = new SqlCommand(sql, conn);
            try
            {
                conn.Open();
                SqlDataReader sqlDataReader = cmd.ExecuteReader(CommandBehavior.CloseConnection);
                if (sqlDataReader == null) return null;
                while (sqlDataReader.Read())
                {
                    int count = sqlDataReader.FieldCount;
                    if (count <= 0) continue;
                    Dictionary<string, object> map = new Dictionary<string, object>();
                    for (int i = 0; i < count; i++)
                    {
                        string name = sqlDataReader.GetName(i);
                        object value = sqlDataReader.GetValue(i);
                        map.Add(name, value);
                    }
                    list.Add(map);
                }

                conn.Close();
                return list;
            }
            catch (System.Exception)
            {
                conn.Close();
                return null;
            }
        }

        /// <summary>
        /// 調整通訊錄聯繫人
        /// </summary>
        /// <param name="remoteContacts">資料庫導入的聯繫人信息的源</param>
        private void Adjust(List<Contact> remoteContacts)
        {            
            // copy一份以來做群組
            List<Contact> distListItems = new List<Contact>();
            Contact[] tempItems = new Contact[remoteContacts.Count];
            remoteContacts.CopyTo(tempItems);
            tempItems.ToList().ForEach(it =>
            {
                it.groups.ForEach(g =>
                {
                    Contact con = new Contact
                    {
                        firstName = it.firstName,
                        lastName = it.lastName,
                        email1Address = it.email1Address,
                        companyName = it.companyName,
                        department = it.department,
                        group = g
                    };
                    distListItems.Add(con);
                });
            });
           
            // 添加聯繫人
            remoteContacts.ForEach(it =>
            {

                ContactItem contact = addressBookFolder.Items.Add();
                contact.FirstName = it.firstName;
                contact.LastName = it.lastName;
                contact.Email1Address = it.email1Address;
                contact.CompanyName = it.companyName;
                contact.Department = it.department;
                if (it.jobTitle != null) contact.JobTitle = it.jobTitle;
                contact.Save();
            });

            // 按群組分組,並創建群組保存
            List<ContactStore> contactStores = distListItems
                .GroupBy(it => it.group)
                .Select(it => new ContactStore { group = it.Key, contacts = it.ToList() })
                .ToList();
            contactStores.ForEach(it =>
            {
                DistListItem myItem = addressBookFolder.Items.Add(OlItemType.olDistributionListItem);
                it.contacts.ForEach(contact =>
                {
                    string id = String.Format("{0}{1}({2})", contact.lastName, contact.firstName,
                        contact.email1Address);
                    Recipient recipient = application.Session.CreateRecipient(id);
                    recipient.Resolve();
                    myItem.AddMember(recipient);
                });
                myItem.DLName = it.group;
                myItem.Save();
            });
        }

        struct Contact
        {
            public string email1Address; // 郵箱
            public string firstName; // 姓氏
            public string lastName; // 姓名
            public string companyName; // 公司名稱
            public string department; // 部門名稱
            public List<string> groups; // 分組集合
            public string group; // 分組
            public string jobTitle; // 職稱
        }

        struct ContactStore
        {
            public string group;
            public List<Contact> contacts;
        }
    }
}

打包、安裝和卸載

右鍵項目 -> 發佈

發佈後你會看到這樣的結構

點擊setup.exe即可安裝了
卸載需要使用VSTOInstaller.exe

"C:\Program Files (x86)\Common Files\microsoft shared\VSTO\10.0\VSTOInstaller.exe" /u "你的.vsto文件目錄"

您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 在查找二叉樹某個節點時,如果把二叉樹所有節點理理解為解空間,待找到那個節點理解為滿足特定條件的解,對此解答可以抽象描述為: _在解空間中搜索滿足特定條件的解_,這其實就是搜索演算法(Search)的一種描述。當然也有其他描述,比如是“指一類用於在數據集合中查找特定項或解決問題的演算法”,又或者是“指通過... ...
  • 相信大家對python-docx這個常用的操作docx文檔的庫都不陌生,它支持以內聯形狀(Inline Shape)的形式插入圖片,即圖片和文本之間沒有重疊,遵循流動版式(flow layout)。但是,截至最新的0.8.10版本,python-docx尚不支持插入浮動圖片(floating pic ...
  • Bean在Spring中的定義是_org.springframework.beans.factory.config.BeanDefinition_介面,BeanDefinition裡面存儲的就是我們編寫的Java類在Spring中的元數據 ...
  • 前言 最近博主在位元組面試中遇到這樣一個面試題,這個問題也是前端面試的高頻問題,因為在前端開發的日常開發中我們總是會與post請求打交道,一個小小的post請求也是牽扯到很多知識點的,博主在這給大家細細道來。 同源策略 在瀏覽器中,內容是很開放的,任何資源都可以接入其中,如 JavaScript 文件 ...
  • NPCAP 庫是一種用於在`Windows`平臺上進行網路數據包捕獲和分析的庫。它是`WinPcap`庫的一個分支,由`Nmap`開發團隊開發,併在`Nmap`軟體中使用。與`WinPcap`一樣,NPCAP庫提供了一些`API`,使開發人員可以輕鬆地在其應用程式中捕獲和處理網路數據包。NPCAP庫... ...
  • wmproxy將用Rust實現http/https代理, socks5代理, 反向代理, 靜態文件服務,講述的是主動式健康檢查可帶來的好處 ...
  • 本章將和大家分享在 Windows 系統上如何搭建 Elasticsearch 的開發環境。話不多說,下麵我們直接進入主題。 一、安裝Java的JDK Elasticsearch 其中最主要的開發語言就是 Java ,所以我們在安裝 Elasticsearch 之前,首先需要安裝的就是 Java 的 ...
  • 本文的項目環境為 .net 6.0 (.net 5.0 以上都支持) 在 .net 中獲取字元串的 MD5 相信是非常容易的事情吧, 但是隨便在網上搜一搜發現流傳的版本還不少呢,比如: StringBuilder 版本(應該算是官方版本了,使用的人最多,我發現在 ABP 中也是使用的這個) BitC ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...