Jenkins配置郵件通知
配置普通郵件通知
需求：在每次構建完成後進行郵件通知構建結果，好判斷自動化構建後的結果如何！
所需要的插件：Email Extension Plugin
第一步安裝插件：進入Jenkins的插件管理
安裝插件完成後重啓Jenkins
第二步進行系統配置：進入Jenkins系統配置
注意的一點，先配置郵箱管理員：
第三步：進入job進行配置
配置完成後便可以完成普通的郵件通知
相關說明：
①SMTP服務器：如果你使用的是公司郵箱，那麼就詢問你自己公司裏的運維人員吧；他們一般都知道，至少我就是問公司裏的運維人員；要是你打算使用QQ郵箱，那麼你需要設置下，網上有教程；網易郵箱默認開啓。
說明：SMTP是一種協議
②用戶默認郵件後綴：根據自己情況去設置
③勾選使用SMTP認證，用戶名：根據自己情況設置，密碼也是。
④SMTP端口：默認25
配置好了後，可以勾選 測試，在Test e-mail recipient輸入自己的郵箱，看下能否成功。
配置擴展郵件通知：
設置擴展電子郵件通知的原因：
只設置郵件通知的話，只能發送給固定的接收人，並且郵件內容單一，不夠自由，因此需要設置擴展郵件通知。
所需要的插件：Email Extension
這個插件是Jenkins的電子郵件發佈者的替代品。它允許配置電子郵件通知的各個方面：發送電子郵件時，應該收到誰以及電子郵件說明的內容
第一步：進入系統配置頁面找到下圖所示進行配置
Html的代碼網上拉取的參考
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>${ENV, var="JOB_NAME"}-第${BUILD_NUMBER}次構建日誌</title>
</head>
<body leftmargin="8" marginwidth="0" topmargin="8" marginheight="4" offset="0">
<table width="95%" cellpadding="0" cellspacing="0" style="font-size: 11pt; font-family: Tahoma, Arial, Helvetica, sans-serif">
<tr>
<td>(本郵件由程序自動下發，請勿回覆！)</td>
</tr>
<tr>
<td>
<h2><font color="#FF0000">構建結果 - ${BUILD_STATUS}</font></h2>
</td>
</tr>
<tr>
<td><br />
<b><font color="#0B610B">構建信息</font></b>
<hr size="2" width="100%" align="center" />
</td>
</tr>
<tr><a href="${PROJECT_URL}">${PROJECT_URL}</a>
<td>
<ul>
<li>項目名稱：${PROJECT_NAME}</li>
<li>GIT路徑：<a href="${GIT_URL}">${GIT_URL}</a></li>
<li>構建編號：${BUILD_NUMBER}</li>
<li>觸發原因：${CAUSE}</li>
<li>構建日誌：<a href="${BUILD_URL}console">${BUILD_URL}console</a></li>
</ul>
</td>
</tr>
<tr>
<td>
<b><font color="#0B610B">變更信息:</font></b>
<hr size="2" width="100%" align="center" />
</td>
</tr>
<tr>
<td>
<ul>
<li>上次構建成功後變化 : ${CHANGES_SINCE_LAST_SUCCESS}</a></li>
</ul>
</td>
</tr>
<tr>
<td>
<ul>
<li>上次構建不穩定後變化 : ${CHANGES_SINCE_LAST_UNSTABLE}</a></li>
</ul>
</td>
</tr>
<tr>
<td>
<ul>
<li>歷史變更記錄 : <a href="${PROJECT_URL}changes">${PROJECT_URL}changes</a></li>
</ul>
</td>
</tr>
<tr>
<td>
<ul>
<li>變更集:${JELLY_SCRIPT,template="html"}</a></li>
</ul>
</td>
</tr>
<!--
<tr>
<td>
<b><font color="#0B610B">Failed Test Results</font></b>
<hr size="2" width="100%" align="center" />
</td>
</tr>
<tr>
<td>
<pre style="font-size: 11pt; font-family: Tahoma, Arial, Helvetica, sans-serif">$FAILED_TESTS</pre>
<br />
</td>
</tr>
<tr>
<td>
<b><font color="#0B610B">構建日誌 (最後 100行):</font></b>
<hr size="2" width="100%" align="center" />
</td>
</tr>-->
<!-- <tr>
<td>Test Logs (if test has ran): <a
href="${PROJECT_URL}ws/TestResult/archive_logs/Log-Build-${BUILD_NUMBER}.zip">${PROJECT_URL}/ws/TestResult/archive_logs/Log-Build-${BUILD_NUMBER}.zip</a>
<br />
<br />
</td>
</tr> -->
<!--
<tr>
<td>
<textarea cols="80" rows="30" readonly="readonly" style="font-family: Courier New">${BUILD_LOG, maxLines=100,escapeHtml=true}</textarea>
</td>
</tr>-->
<hr size="2" width="100%" align="center" />
</table>
</body>
</html>
第二步：
第三步：設置默認郵件出發通知
第四步：進入Job進行配置
第五步：添加配置完成後構建項目查看收件箱
如果發現收不到郵件請檢查手機列表是否爲空
配置系統消息
方法都是同樣的道理。展示的形式不一樣而已
所需要的插件：
OWASP Markup Formatter：
OWASP標記格式化程序插件
使用OWASP Java HTML Sanitizer ，可以在項目描述等中輸入安全的HTML標記。
第一步：
配置如圖：進入系統配置
這裏輸入需要展示的系統信息，如果是文本格式的就直接輸入展示的文本內容，若是html形式的就輸入代碼
<form><p><B><font size="5" color="red" >版本發佈通知</font></B></p></form>
<ul><li>
<p><B><font size="3" color="red" >此次發佈結果：</font></B></p>
<font size="3" color="green" >成功</font>
</li></ul>
<ul><li>
<p><B><font size="3" color="red" >此次發佈版本：</font></B></p>
<textarea text="TEXT" cols=value rows=value disabled="disabled">
系統版本名稱-版本號
</textarea>
</li></ul>
<ul><li>
<p><B><font size="3" color="red" >版本新增內容：</font></B></p>
<textarea text="TEXT" cols=value rows=value disabled="disabled">
（1）新增接口：
（2）修復bug：
</textarea>
</li></ul>
僅供參考
第二步：進入安全配置與管理選擇對應的系統消息展示方式
如果需要使用html格式的展示需要安裝插件：Markup Formatter
下面是html的展示效果圖：
這是文本形式的效果
擴展郵件的模板解釋
郵件通知配置相關的全局屬性詳解：
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：郵件中可以使用的變量，所有的變量都是可選的。
全局郵件變量解說
1.email-ext插件允許使用變量來動態插入數據到郵件的主題和內容主體中。
變量是一個以$(美元符號)開始，並以空格結束的字符串。
當一個郵件觸發時，主題和內容主體字段的所有變量都會通過真實的值動態地替換。
同樣，變量中的“值”能包含其它的變量，都將被替換成真實的內容。
2.比如，項目配置頁的默認主題和內容分別對應的是全局配置頁面的DEFAULT_SUBJECT和DEFAULT_CONTENT，因此它會自動地使用全局的配置。
3.同理，觸發器中的Subject和Content分別對應的是項目配置頁面的DEFAULT_SUBJECT和DEFAULT_CONTENT，所以它也會自動地使用項目的配置。
由於變量中的“值”能包含其它的變量，所以就能爲變量快速地創建不同的切入點：全局級別(所有項目)，專屬級別(單一項目)，觸發器級別(構建結果)。
4.如果你要查看所有可用的變量，你可以點擊配置頁的Content Token Reference的問號獲取詳細的信息。
5.所有的變量都是可選的，每個變量可以如下表示，字符串類型使用name=“value”，而布爾型和數字型使用name=value。如果{和}標記裏面沒有變量，則不會被解析。
示例：$TOKEN,${TOKEN},${TOKEN,count=100},${ENV,var=”PATH”}
提示：用英文逗號分隔變量的參數。
6.常用的屬性如下：
${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 -跳過測試的數量。
