第三章 持續集成jenkins工具使用之郵件配置
1 Email Extension Plugin插件安裝
持續集成很重要的一環就是及時將構建結果通知到對應的責任人，如:構建失敗了，至少需要下發通知給造成本次構建失敗的開發人員，如果包含自動化測試，將測試結果通知到項目組成員也是非常重要的。
發送通知我們最常用的都是郵件通知，如果你對郵件要求不高只是隨便發送個通知，可以使用系統默認的郵件發送功能即可，但是通常情況下我們都會有一些比較特殊的要求，比如：構建失敗時通知導致問題出現的人員，構建成功時通知全員，諸如此類。
需要實現這些功能，我們需要使用到Email Extension Plugin插件。
在開始之前我們需要確認是否已經安裝該插件，確認方法有兩種：
其一：進入系統管理(Manage Jenkins)——插件管理（Manage Plugins）——installed頁面，搜索Email Extension Plugin，如圖：
其二：進入系統管理(Manage Jenkins)——系統配置（Configure System），滑動頁面可以看到：Extended E-mail Notification，如圖：
如果尚未安裝，則需要進行安裝，安裝方式如下：
進入系統管理(Manage Jenkins)——插件管理（Manage Plugins）——available，搜索Extended E-mail Notification按照指引進行安裝
1.2 郵件配置
進入系統管理(Manage Jenkins)——系統配置（Configure System），配置如下：
- 首先配置Jenkins Location：
- 接下來配置Extended E-mail Notification信息：
SMTP server：郵件服務器，如：smtp.163.com
Default user E-mail suffix：郵件後綴，如：@163.com
Default Recipients：默認郵件接收者
Default Subject：默認主題
Maximum Attachment Size：附件的最大大小
Default Content：默認郵件內容
Default Triggers：配置郵件觸發規則
配置如下圖（詳細配置以實際需要為準）
以上配置完成後，可以勾選“Test configuration by sending test e-mail”項測試配置是否正確，如上圖
至此郵件配置基本完成。
1.3 郵件模板配置
根據3上一章節配置，基本能滿足小團隊開發需求，但是在中大型公司裏面，一個jenkins裏面可能需要配置n+個項目，而且每個項目的幹系人又不一致，尤其是當配置庫賬號並非使用郵箱賬號時，每個項目（或毎幾個項目）需要配置不同的郵件發送規則（如：收件人），這時我們希望通過模板來配置，已減小配置及後續維護的工作量。
這裏我們需要使用到Email Extension Template Plugin插件，插件安裝不再贅述，可參考第二章 Manage Plugins進行安裝，如圖：
available安裝
安裝完成之後在系統管理(Manage Jenkins)——系統配置（Configure System）頁面增加了“Editable Email Notification Templates”功能項。
點擊進入後，可進行郵件模板的增加、修改、刪除。
以下只講解增加功能，修改基本跟增加一樣。
進入“Editable Email Notification Templates”功能項後，可看到如下頁面：
點擊“Add New Template”，進入增加頁面，如圖：
圖中其他項上文已經解釋，不再贅述。將圖中Project Recipient List的內容刪除。
配置的重點內容是advanceed settings。詳細不做解釋，相信大家都能看懂，如果不明白可私信。
1.1 郵件配置變量
郵件通知配置相關的全局屬性詳解
1. Override Global Settings：如果不選，該插件將使用默認的E-mail Notification通知選項。反之，您可以通過指定不同於( 默認選項)的設置來進行覆蓋。
2. Default Content Type：指定構建後發送郵件內容的類型，有Text和HTML兩種.
3. Use List-ID Email Header：為所有的郵件設置一個List-ID的郵件信頭
4. Add ‘Precedence: bulk‘ Email Header：設置優先級
5. Default Recipients：自定義默認電子郵件收件人列表。如果沒有被項目配置覆蓋,該插件會使用這個列表。您可以在項目配置使用$ DEFAULT_RECIPIENTS參數包括此默認列表，以及添加新的地址在項目級別。添加抄送：cc:電子郵件地址例如,CC:[email protected]
6. Reply To List：回復列表, A comma separated list of e-mail addresses to use in the Reply-To header of the email. This value will be available as $DEFAULT_REPLYTO in the project configuration.
7. Emergency reroute：如果這個字段不為空，所有的電子郵件將被單獨發送到該地址（或地址列表）。
8. Excluded Committers：防止郵件被郵件系統認為是垃圾郵件,郵件列表應該沒有擴展的賬戶名(如:@domain.com),並且使用逗號分隔
9. Default Subject：自定義郵件通知的默認主題名稱。該選項能在郵件的主題字段中替換一些參數，這樣你就可以在構建中包含指定的輸出信息。
10. Maximum Attachment Size：郵件最大附件大小。
11. Default Content：自定義郵件通知的默認內容主體。該選項能在郵件的內容中替換一些參數，這樣你就可以在構建中包含指定的輸出信息。
12. Default Pre-send Script：默認發送前執行的腳本（註：grooy腳本，這是我在某篇文章上看到的，不一定準確）。
13. Enable Debug Mode：啟用插件的調試模式。這將增加額外的日誌輸出，構建日誌以及Jenkins的日誌。在調試時是有用的，但不能用於生產。
14. Enable Security：啟用時，會禁用發送腳本的能力，直接進入Jenkins實例。如果用戶試圖訪問Jenkins管理對象實例，將拋出一個安全異常。
15. Content Token Reference：郵件中可以使用的變量，所有的變量都是可選的。
全局郵件變量
email-ext插件允許使用變量來動態插入數據到郵件的主題和內容主體中。變量是一個以$(美元符號)開始，並以空格結束的字符串。當一個郵件觸發時，主題和內容主體字段的所有變量都會通過真實的值動態地替換。同樣，變量中的“值”能包含其它的變量，都將被替換成真實的內容。
比如，項目配置頁的默認主題和內容分別對應的是全局配置頁面的DEFAULT_SUBJECT和DEFAULT_CONTENT，因此它會自動地使用全局的配置。同理，觸發器中的Subject和Content分別對應的是項目配置頁面的DEFAULT_SUBJECT和DEFAULT_CONTENT，所以它也會自動地使用項目的配置。由於變量中的“值”能包含其它的變量，所以就能為變量快速地創建不同的切入點：全局級別(所有項目)，專屬級別(單一項目)，觸發器級別(構建結果)。
如果你要查看所有可用的變量，你可以點擊配置頁的Content Token Reference的問號獲取詳細的信息。
所有的變量都是可選的，每個變量可以如下表示，字符串類型使用name=“value”，而布爾型和數字型使用name=value。如果{和}標記裏面沒有變量，則不會被解析。示例：$TOKEN,${TOKEN},${TOKEN,count=100},${ENV,var=”PATH”}
提示：用英文逗號分隔變量的參數。
常用的屬性如下：
${FILE,path="PATH"} 包括指定文件（路徑）的含量相對於工作空間根目錄。
path文件路徑，註意：是工作區目錄的相對路徑。
${BUILD_NUMBER} 顯示當前構建的編號。
${JOB_DESCRIPTION} 顯示項目描述。
${SVN_REVISION} 顯示svn版本號。還支持Subversion插件出口的SVN_REVISION_n版本。
${CAUSE} 顯示誰、通過什麽渠道觸發這次構建。
${CHANGES } -顯示上一次構建之後的變化。
showPaths 如果為 true,顯示提交修改後的地址。默認false。
showDependencies 如果為true，顯示項目構建依賴。默認為false
format 遍歷提交信息，一個包含%X的字符串，其中%a表示作者，%d表示日期，%m表示消息，%p表示路徑，%r表示版本。註意，並不是所有的版本系統都支持%d和%r。如果指定showPaths將被忽略。默認“[%a] %m\\n”。
pathFormat 一個包含“%p”的字符串，用來標示怎麽打印路徑。
${BUILD_ID}顯示當前構建生成的ID。
${PROJECT_NAME} 顯示項目的全名。
${PROJECT_DISPLAY_NAME} 顯示項目的顯示名稱。
${SCRIPT} 從一個腳本生成自定義消息內容。自定義腳本應該放在"$JENKINS_HOME/email-templates"。當使用自定義腳本時會默認搜索$JENKINS_HOME/email-templatesdirectory目錄。其他的目錄將不會被搜索。
script 當其使用的時候，僅僅只有最後一個值會被腳本使用（不能同時使用script和template）。
template常規的simpletemplateengine格式模板。
${JENKINS_URL} 顯示Jenkins服務器的url地址（你可以再系統配置頁更改）。
${BUILD_LOG_MULTILINE_REGEX}按正則表達式匹配並顯示構建日誌。
regex java.util.regex.Pattern 生成正則表達式匹配的構建日誌。無默認值，可為空。
maxMatches 匹配的最大數量。如果為0，將匹配所有。默認為0。
showTruncatedLines 如果為true，包含[...truncated ### lines...]行。默認為true。
substText 如果非空，就把這部分文字（而不是整行）插入該郵件。默認為空。
escapeHtml 如果為true，格式化HTML。默認為false。
matchedSegmentHtmlStyle 如果非空，輸出HTML。匹配的行數將變為<b style=”your-style-value”> html escaped matched line </b>格式。默認為空。
${BUILD_LOG} 顯示最終構建日誌。
maxLines 日誌最多顯示的行數，默認250行。
escapeHtml 如果為true，格式化HTML。默認false。
${PROJECT_URL} 顯示項目的URL地址。
${BUILD_STATUS} -顯示當前構建的狀態(失敗、成功等等)
${BUILD_URL} -顯示當前構建的URL地址。
${CHANGES_SINCE_LAST_SUCCESS} -顯示上一次成功構建之後的變化。
reverse在頂部標示新近的構建。默認false。
format遍歷構建信息，一個包含%X的字符串，其中%c為所有的改變，%n為構建編號。默認”Changes for Build #%n\n%c\n”。
showPaths,changesFormat,pathFormat分別定義如${CHANGES}的showPaths、format和pathFormat參數。
${CHANGES_SINCE_LAST_UNSTABLE} -顯示顯示上一次不穩固或者成功的構建之後的變化。
reverse在頂部標示新近的構建。默認false
format遍歷構建信息，一個包含%X的字符串，其中%c為所有的改變，%n為構建編號。默認”Changes for Build #%n\n%c\n”。
showPaths,changesFormat,pathFormat分別定義如${CHANGES}的showPaths、format和pathFormat參數。
${ENV} –顯示一個環境變量。
var– 顯示該環境變量的名稱。如果為空，顯示所有，默認為空。
${FAILED_TESTS} -如果有失敗的測試，顯示這些失敗的單元測試信息。
${JENKINS_URL} -顯示Jenkins服務器的地址。(你能在“系統配置”頁改變它)。
${HUDSON_URL} -不推薦，請使用$JENKINS_URL
${PROJECT_URL} -顯示項目的URL。
${SVN_REVISION} -顯示SVN的版本號。
${JELLY_SCRIPT} -從一個Jelly腳本模板中自定義消息內容。有兩種模板可供配置：HTML和TEXT。你可以在$JENKINS_HOME/email-templates下自定義替換它。當使用自動義模板時，”template”參數的名稱不包含“.jelly”。
template模板名稱，默認”html”。
${TEST_COUNTS} -顯示測試的數量。
var– 默認“total”。
total -所有測試的數量。
fail -失敗測試的數量。
skip -跳過測試的數量。
第三章 持續集成jenkins工具使用之郵件配置