我的Office Outlook插件开发之旅（一）

罗夫

目的

开发一款可以同步Outlook邮件通讯录信息的插件。
方案

• VSTO 外接程序
  
• 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

1. using System;
2. using System.Collections.Generic;
3. using System.Linq;
4. using System.Text;
5. using System.Xml.Linq;
6. using Outlook = Microsoft.Office.Interop.Outlook;
7. using Office = Microsoft.Office.Core;
8. using Microsoft.Office.Interop.Outlook;
9. using System.Windows.Forms;
10. using System.Data;
11. using System.Data.SqlClient;
12. using System.IO;
13. using System.Threading;
14. using System.Collections;
16. namespace ContactsSynchronization
17. {
18.     public partial class ThisAddIn
19.     {
20.         
21.         private void ThisAddIn_Startup(object sender, System.EventArgs e)
22.         {
23.             // Outlook启动时执行
24.             MessageBox.Show("Hello VSTO!");
25.         }
27.         private void ThisAddIn_Shutdown(object sender, System.EventArgs e)
28.         {
29.             // Outlook关闭时执行
30.         }
32.         #region VSTO 生成的代码
34.         /// <summary>
35.         /// 设计器支持所需的方法 - 不要
36.         /// 使用代码编辑器修改此方法的内容。
37.         /// </summary>
38.         private void InternalStartup()
39.         {
40.             // 绑定声明周期函数
41.             this.Startup += new System.EventHandler(ThisAddIn_Startup);
42.             this.Shutdown += new System.EventHandler(ThisAddIn_Shutdown);
43.         }
45.         #endregion
46.     }
47. }

复制代码

启动试试看
到这里我们就已经把项目搭建起来了，但在写代码之前不如再认识认识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上挂载了我们用到大多数函数和属性。

1. Application.Session;// 会话实例
2. Application.Version;// DLL动态链接库版本
3. Application.Name;// 应用名称

复制代码

Application.Session会话实例，可以获取Outlook的大多数状态，数据。如文件夹、联系人、邮件等。
Outlook文件夹结构

Outlook 按照邮件账号区分用户数据，即每个邮件账号都有独立的收件箱，联系人等。

Outlook 默认情况下的文件夹结构

获取第一个邮箱账号的默认联系人文件夹

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

复制代码

获取Outlook的状态信息

获取联系人信息

1. MAPIFolder folder = Application.Session.GetDefaultFolder(OlDefaultFolders.olFolderContacts);//获取默认的通讯录文件夹
2. IEnumerable<ContactItem> contactItems = folder.Items.OfType<ContactItem>(); // 获取文件夹下的子项，OfType<ContactItem>只拿联系人的
3. foreach (ContactItem it in contactItems)
4. {
5.     // 拿联系人的各种信息
6.     string fullName = it.FullName;
7.     // 注意在此处修改联系人信息，再Save()是不生效的
8. }

复制代码

添加联系人

1. MAPIFolder folder = Application.Session.GetDefaultFolder(OlDefaultFolders.olFolderContacts);// 获取默认的联系人文件夹
2. ContactItem contact = folder.Items.Add(OlItemType.olContactItem);// 新增联系人子项
3. // 设置各种信息
4. contact.FirstName = "三";
5. contact.LastName = "张";
6. contact.Email1Address = "zhangsan@163.com";
7. // 存储联系人
8. contact.Save();

复制代码

删除联系人

1. Microsoft.Office.Interop.Outlook.MAPIFolder deletedFolder = application.Session.GetDefaultFolder(OlDefaultFolders.olFolderDeletedItems);// 默认的联系人文件夹
2. int count = deletedFolder.Items.Count;// 获取子项数，包含联系人和群组
3. for (int i = count; i > 0; i--)// 遍历删除
4. {
5.     deletedFolder.Items.Remove(i);
6. }

复制代码

成品代码

1. using System;
2. using System.Collections.Generic;
3. using System.Linq;
4. using System.Text;
5. using System.Xml.Linq;
6. using Outlook = Microsoft.Office.Interop.Outlook;
7. using Office = Microsoft.Office.Core;
8. using Microsoft.Office.Interop.Outlook;
9. using System.Windows.Forms;
10. using System.Data;
11. using System.Data.SqlClient;
12. using System.IO;
13. using System.Threading;
14. using System.Collections;
16. namespace ContactsSynchronization
17. {
18.     public partial class ThisAddIn
19.     {
20.         
22.         private void ThisAddIn_Startup(object sender, System.EventArgs e)
23.         {
24.             OperatorContact operatorInstance = new OperatorContact(this.Application);
25.             operatorInstance.Task();
26.         }
28.         private void ThisAddIn_Shutdown(object sender, System.EventArgs e)
29.         {
30.         }
32.         #region VSTO 生成的代码
34.         /// <summary>
35.         /// 设计器支持所需的方法 - 不要
36.         /// 使用代码编辑器修改此方法的内容。
37.         /// </summary>
38.         private void InternalStartup()
39.         {
40.             this.Startup += new System.EventHandler(ThisAddIn_Startup);
41.             this.Shutdown += new System.EventHandler(ThisAddIn_Shutdown);
42.         }
44.         #endregion
45.     }
47.     class OperatorContact
48.     {
49.         public OperatorContact(Microsoft.Office.Interop.Outlook.Application application)
50.         {
51.             this.application = application;
52.         }
54.         Microsoft.Office.Interop.Outlook.Application application = null; // outlook程序实例
56.         private static string addressBookName = "汤石集团通讯录";// 通讯录名称
58.         private Microsoft.Office.Interop.Outlook.MAPIFolder addressBookFolder = null; // 通讯录文件夹实例
60.         public void Task()
61.         {
62.             new Thread(Run).Start();
63.         }
65.         /// <summary>
66.         /// 开个新线程执行任务，不要堵塞原来的线程
67.         /// </summary>
68.         private void Run()
69.         {
70.             try
71.             {
72.                 if (NeedUpdate())
73.                 {
74.                     addressBookFolder = getAddressBookFolder();// 覆盖式创建通讯录
75.                     List<Contact> remoteContacts = readRemoteContacts();// 读取远程邮箱通讯录
76.                     if (remoteContacts == null) return;
77.                     Adjust(remoteContacts);// 调整联系人和群组
78.                     updateClientVersion();// 更新本地通讯录版本号
79.                 }
80.             }
81.             catch (System.Exception ex)
82.             {
83.                 const string path = @"C:\TONS\email-plugin-error.log";
84.                 FileInfo fileInfo = new FileInfo(path);
85.                 long length = 0;
86.                 if (fileInfo.Exists && fileInfo.Length != 0) length = fileInfo.Length / 1024 / 1024;
87.                 if (length <= 3) File.AppendAllText(path, ex.Message + "\r\n");
88.                 else File.WriteAllText(path, ex.Message + "\r\n");
89.             }
90.         }
92.         /// <summary>
93.         /// 覆盖式创建通讯录
94.         /// </summary>
95.         /// <returns>通讯录文件夹实例</returns>
96.         private Microsoft.Office.Interop.Outlook.MAPIFolder getAddressBookFolder()
97.         {
98.             // 获取用户第一个PST档的通讯录文件夹的枚举器
99.             IEnumerator en = application.Session.Stores.Cast<Outlook.Store>().First()
100.                 .GetDefaultFolder(OlDefaultFolders.olFolderContacts)
101.                 .Folders.GetEnumerator();
102.             bool exits = false;
103.             Microsoft.Office.Interop.Outlook.MAPIFolder folder = null;
105.             // 遍历文件夹
106.             while (en.MoveNext()) {
107.                 Microsoft.Office.Interop.Outlook.MAPIFolder current = (Microsoft.Office.Interop.Outlook.MAPIFolder)en.Current;
108.                 if (current.Name == addressBookName) {
109.                     exits = true;
110.                     folder = current;
111.                 }
112.             }
114.             if (!exits)
115.              {
116.                  // 创建汤石集团通讯录,并映射成通讯录格式
117.                  Microsoft.Office.Interop.Outlook.MAPIFolder newFolder = application.Session.Stores.Cast<Outlook.Store>().First()
118.                           .GetDefaultFolder(OlDefaultFolders.olFolderContacts)
119.                           .Folders.Add(addressBookName);
120.                  newFolder.ShowAsOutlookAB = true;// 设置成“联系人”文件夹
121.                  return newFolder;
122.              }
123.              else {
124.                 // 返回已经存在的同时集团通讯录文件夹,并删除里面的内容
125.                 int count = folder.Items.Count;
126.                 for (int i = count; i > 0; i--)
127.                 {
128.                     folder.Items.Remove(i);
129.                 }
130.                 Microsoft.Office.Interop.Outlook.MAPIFolder deletedFolder = application.Session.GetDefaultFolder(OlDefaultFolders.olFolderDeletedItems);
131.                 count = deletedFolder.Items.Count;
132.                 for (int i = count; i > 0; i--)
133.                 {
134.                     deletedFolder.Items.Remove(i);
135.                 }
136.                 return folder;
137.              }
138.         }
142.         /// <summary>
143.         /// 更新本地的铜须录版本
144.         /// </summary>
145.         private void updateClientVersion()
146.         {
147.             String path = @"C:\TONS\email-plugin-version.conf";
148.             string version = getRemoteVersion();
149.             if (!File.Exists(path))
150.             {
151.                 File.WriteAllText(path,version);
152.             }
153.             else {
154.                 File.WriteAllText(path, version);
155.             }
156.         }
158.         /// <summary>
159.         /// 判断是否需要更新
160.         /// </summary>
161.         /// <returns>boolean值</returns>
162.         private bool NeedUpdate()
163.         {
164.             string remoteVersion = getRemoteVersion();
165.             if (remoteVersion == null) return false;
166.             string clientVersion = getClientVersion();
167.             return !(clientVersion == remoteVersion);
168.         }
170.         /// <summary>
171.         /// 读取服务器的通讯录版本
172.         /// </summary>
173.         /// <returns>通讯录版本</returns>
174.         private string getRemoteVersion()
175.         {
176.             List<Dictionary<string, object>> items = SelectList(
177.                 "SELECT TOP(1) [version] FROM TonsOfficeA..VersionControl WHERE applicationID = N'EmailContact'"
178.                 , "Server=192.168.2.1;Database=TonsOfficeA;uid=sa;pwd=dsc");
179.             if (items == null) return null;
180.             return items[0]["version"].ToString();
181.         }
183.         /// <summary>
184.         /// 获取本地的通讯录版本
185.         /// </summary>
186.         /// <returns>通讯录版本</returns>
187.         private string getClientVersion()
188.         {
189.             String path = @"C:\TONS\email-plugin-version.conf";
190.             if (!File.Exists(path)) return null;
191.             return File.ReadAllText(path);
192.         }
194.         /// <summary>
195.         /// 读取远程的通讯录
196.         /// </summary>
197.         /// <returns>联系人实例集合</returns>
198.         private List<Contact> readRemoteContacts()
199.         {
200.             List<Contact> remoteContacts = new List<Contact>();
201.             List<Dictionary<string, object>> items =
202.                 SelectList(
203.                     "select [emailAddress],[firstName],[lastName],[companyName],[department],[_group] as 'group',[jobTitle] from [TonsOfficeA].[dbo].[EmailContacts]",
204.                     "Server=192.168.2.1;Database=TonsOfficeA;uid=sa;pwd=dsc");
205.             items.ForEach(it =>
206.             {
207.                 Contact contact = new Contact();
208.                 contact.email1Address = it["emailAddress"].ToString();
209.                 contact.firstName = it["firstName"].ToString();
210.                 contact.lastName = it["lastName"].ToString();
211.                 contact.companyName = it["companyName"].ToString();
212.                 contact.department = it["department"].ToString();
213.                 if (it["jobTitle"] != null) contact.jobTitle = it["jobTitle"].ToString();
214.                 contact.groups = it["group"].ToString().Split(',').ToList();
215.                 remoteContacts.Add(contact);
216.             });
217.             return remoteContacts;
218.         }
220.         /// <summary>
221.         /// 执行select语句
222.         /// </summary>
223.         /// <param name="sql">select语句</param>
224.         /// <param name="connection">数据库链接语句</param>
225.         /// <returns>List<Dictionary<string, object>>结果</returns>
226.         /// <exception cref="System.Exception"></exception>
227.         public List<Dictionary<string, object>> SelectList(string sql, string connection)
228.         {
229.             if (sql == null || connection == null || sql == "" || connection == "")
230.                 throw new System.Exception("未传入SQL语句或者Connection链接语句");
231.             List<Dictionary<string, object>> list = new List<Dictionary<string, object>>();
232.             SqlConnection conn = new SqlConnection(connection);
233.             SqlCommand cmd = new SqlCommand(sql, conn);
234.             try
235.             {
236.                 conn.Open();
237.                 SqlDataReader sqlDataReader = cmd.ExecuteReader(CommandBehavior.CloseConnection);
238.                 if (sqlDataReader == null) return null;
239.                 while (sqlDataReader.Read())
240.                 {
241.                     int count = sqlDataReader.FieldCount;
242.                     if (count <= 0) continue;
243.                     Dictionary<string, object> map = new Dictionary<string, object>();
244.                     for (int i = 0; i < count; i++)
245.                     {
246.                         string name = sqlDataReader.GetName(i);
247.                         object value = sqlDataReader.GetValue(i);
248.                         map.Add(name, value);
249.                     }
250.                     list.Add(map);
251.                 }
253.                 conn.Close();
254.                 return list;
255.             }
256.             catch (System.Exception)
257.             {
258.                 conn.Close();
259.                 return null;
260.             }
261.         }
263.         /// <summary>
264.         /// 调整通讯录联系人
265.         /// </summary>
266.         /// <param name="remoteContacts">数据库导入的联系人信息的源</param>
267.         private void Adjust(List<Contact> remoteContacts)
268.         {            
269.             // copy一份以来做群组
270.             List<Contact> distListItems = new List<Contact>();
271.             Contact[] tempItems = new Contact[remoteContacts.Count];
272.             remoteContacts.CopyTo(tempItems);
273.             tempItems.ToList().ForEach(it =>
274.             {
275.                 it.groups.ForEach(g =>
276.                 {
277.                     Contact con = new Contact
278.                     {
279.                         firstName = it.firstName,
280.                         lastName = it.lastName,
281.                         email1Address = it.email1Address,
282.                         companyName = it.companyName,
283.                         department = it.department,
284.                         group = g
285.                     };
286.                     distListItems.Add(con);
287.                 });
288.             });
289.            
290.             // 添加联系人
291.             remoteContacts.ForEach(it =>
292.             {
294.                 ContactItem contact = addressBookFolder.Items.Add();
295.                 contact.FirstName = it.firstName;
296.                 contact.LastName = it.lastName;
297.                 contact.Email1Address = it.email1Address;
298.                 contact.CompanyName = it.companyName;
299.                 contact.Department = it.department;
300.                 if (it.jobTitle != null) contact.JobTitle = it.jobTitle;
301.                 contact.Save();
302.             });
304.             // 按群组分组，并创建群组保存
305.             List<ContactStore> contactStores = distListItems
306.                 .GroupBy(it => it.group)
307.                 .Select(it => new ContactStore { group = it.Key, contacts = it.ToList() })
308.                 .ToList();
309.             contactStores.ForEach(it =>
310.             {
311.                 DistListItem myItem = addressBookFolder.Items.Add(OlItemType.olDistributionListItem);
312.                 it.contacts.ForEach(contact =>
313.                 {
314.                     string id = String.Format("{0}{1}({2})", contact.lastName, contact.firstName,
315.                         contact.email1Address);
316.                     Recipient recipient = application.Session.CreateRecipient(id);
317.                     recipient.Resolve();
318.                     myItem.AddMember(recipient);
319.                 });
320.                 myItem.DLName = it.group;
321.                 myItem.Save();
322.             });
323.         }
325.         struct Contact
326.         {
327.             public string email1Address; // 邮箱
328.             public string firstName; // 姓氏
329.             public string lastName; // 姓名
330.             public string companyName; // 公司名称
331.             public string department; // 部门名称
332.             public List<string> groups; // 分组集合
333.             public string group; // 分组
334.             public string jobTitle; // 职称
335.         }
337.         struct ContactStore
338.         {
339.             public string group;
340.             public List<Contact> contacts;
341.         }
342.     }
343. }

复制代码

打包、安装和卸载

右键项目 -> 发布

发布后你会看到这样的结构

点击setup.exe即可安装了
卸载需要使用VSTOInstaller.exe

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

复制代码

来源:https://www.cnblogs.com/heirem/archive/2023/10/26/17782541.html
免责声明：由于采集信息均来自互联网，如果侵犯了您的权益，请联系我们【E-Mail:cb@itdo.tech】 我们会及时删除侵权内容，谢谢合作！