今天就跟大家聊聊有關(guān)如何使用email-ext替換Jenkins的默認郵件通知，可能很多人都不太了解，為了讓大家更加了解，小編給大家總結(jié)了以下內(nèi)容，希望大家根據(jù)這篇文章可以有所收獲。
為潛山等地區(qū)用戶提供了全套網(wǎng)頁設(shè)計制作服務(wù)，及潛山網(wǎng)站建設(shè)行業(yè)解決方案。主營業(yè)務(wù)為做網(wǎng)站、成都網(wǎng)站設(shè)計、潛山網(wǎng)站設(shè)計，以傳統(tǒng)方式定制建設(shè)網(wǎng)站，并提供域名空間備案等一條龍服務(wù)，秉承以專業(yè)、用心的態(tài)度為用戶提供真誠的服務(wù)。我們深信只要達到每一位用戶的要求，就會得到認可，從而選擇與我們長期合作。這樣，我們也可以走得更遠！眾所周知，Jenkins 默認提供了一個郵件通知，能在構(gòu)建失敗、構(gòu)建不穩(wěn)定等狀態(tài)后發(fā)送郵件。但是它本身有很多局限性，比如它的郵件通知無法提供詳細的郵件內(nèi)容、無法定義發(fā)送郵件的格式、無法定義靈活的郵件接收配置等等。在這樣的情況下，我們找到了 Jenkins Email Extension Plugin。該插件能允許你自定義郵件通知的方方面面，比如在發(fā)送郵件時你可以自定義發(fā)送給誰，發(fā)送具體什么內(nèi)容等等。
它主要包含兩個部分：全局配置和項目配置。
當然，在一個項目中應(yīng)用 email-ext 插件之前，您必須做一些全局的配置?，F(xiàn)在先跳轉(zhuǎn)到 Jenkins 的“系統(tǒng)設(shè)置”頁面，如下圖：找到標題為“Extended E-mail Notification”的片段，你就能配置一些全局的 email-ext 屬性。這些屬性必須匹配你 SMTP郵件服務(wù)器的設(shè)置。這一節(jié)不僅能配置成 Jenkins 原有郵件通知的鏡像(雖然有很多配置是一樣的，但這是個不同的擴展點)，而且還增加了一些額外的功能。輸入框中名為 Default Subject 和 Default Content 的項允許你在全局級別配置郵件的內(nèi)
容。這樣做的話，可以使您為所有的項目按您的需求做更好的、更簡單的配置。如下圖。
釋放個我的配置：
Default Subject：構(gòu)建通知:$PROJECT_NAME - Build # $BUILD_NUMBER - $BUILD_STATUS!
Default Content：
(本郵件是程序自動下發(fā)的，請勿回復！)
項目名稱：$PROJECT_NAME
構(gòu)建編號：$BUILD_NUMBER
svn 版本號：${SVN_REVISION}
構(gòu)建狀態(tài)：$BUILD_STATUS
觸發(fā)原因：${CAUSE}
構(gòu)建日志地址：
構(gòu)建地址：
變更集:${JELLY_SCRIPT,template="html"}
下面解釋一下常用的屬性。
1. Override Global Settings：如果不選，該插件將使用默認的 E-mail Notification 通知選項。反之，您可以通過指定不同于( 默認選項)的設(shè)置來進行覆蓋。
2. Default Content Type：指定構(gòu)建后發(fā)送郵件內(nèi)容的類型，有 Text 和 HTML 兩種.
3. Use List-ID Email Header：為所有的郵件設(shè)置一個 List-ID 的郵件信頭，這樣你就可以在郵件客戶端使用過濾。它也能阻止郵件發(fā)件人大部分的自動回復(諸如離開辦公室、休假等等)。你可以使用習慣的任何名稱或者 ID 號，但是他們必須符合如下其中一種格式(真實的 ID 必須要包含在<和>標記里)：
Build Notifications
“Build Notifications”
關(guān)于更詳細的 List-ID 說明請參閱 RFC-2919.
4. Add 'Precedence: bulk' Email Header：設(shè)置優(yōu)先級,更詳細說明請參閱 RFC-3834.
5. Default Recipients：自定義默認電子郵件收件人列表。如果沒有被項目配置覆蓋,該插件會使用這個列表。您可以在項目配置使用$ DEFAULT_RECIPIENTS 參數(shù)包括此默認列表，以及添加新的地址在項目級別。添加抄送：cc:電子郵件地址例如,CC:someone@somewhere.com
6. Reply To List：回復列表, A comma separated list of e-mail addresses to use in the ReplyTo header ofthe email. This value will be available as $DEFAULT_REPLYTO in the project configuration.
7. Emergency reroute：如果這個字段不為空，所有的電子郵件將被單獨發(fā)送到該地址（或地址列表）。
8. Excluded Committers：防止郵件被郵件系統(tǒng)認為是垃圾郵件,郵件列表應(yīng)該沒有擴展的賬戶名
(如:@domain.com),并且使用逗號分隔
9. Default Subject：自定義郵件通知的默認主題名稱。該選項能在郵件的主題字段中替換一些參數(shù)，這樣你就可以在
構(gòu)建中包含指定的輸出信息。
10. Maximum Attachment Size：郵件大附件大小。
11. Default Content：自定義郵件通知的默認內(nèi)容主體。該選項能在郵件的內(nèi)容中替換一些參數(shù)，這樣你就可以在構(gòu)建
中包含指定的輸出信息。
12. Default Pre-send Script：默認發(fā)送前執(zhí)行的腳本（注：grooy 腳本，這是我在某篇文章上看到的，不一定準確）。
13. Enable Debug Mode：啟用插件的調(diào)試模式。這將增加額外的日志輸出，構(gòu)建日志以及 Jenkins 的日志。在調(diào)試
時是有用的，但不能用于生產(chǎn)。
14. Enable Security：啟用時，會禁用發(fā)送腳本的能力，直接進入 Jenkins 實例。如果用戶試圖訪問 Jenkins 管理對
象實例，將拋出一個安全異常。
15. Content Token Reference：郵件中可以使用的變量，所有的變量都是可選的。具體介紹請查看全局郵件變量
章節(jié)。
Ps：看著感覺有點暈頭，對比著 Jenkins 頁面看要好些。
email-ext 插件允許使用變量來動態(tài)插入數(shù)據(jù)到郵件的主題和內(nèi)容主體中。變量是一個以$(美元符號)開始，并以空格結(jié)束的字符串。當一個郵件觸發(fā)時，主題和內(nèi)容主體字段的所有變量都會通過真實的值動態(tài)地替換。同樣，變量中的“值”能包含其它的變量，都將被替換成真實的內(nèi)容。比如，項目配置頁的默認主題和內(nèi)容分別對應(yīng)的是全局配置頁面的 DEFAULT_SUBJECT 和 DEFAULT_CONTENT，因此它會自動地使用全局的配置。同理，觸發(fā)器中的 Subject 和 Content 分別對應(yīng)的是項目配置頁面的 DEFAULT_SUBJECT 和
DEFAULT_CONTENT，所以它也會自動地使用項目的配置。由于變量中的“值”能包含其它的變量，所以就能為變量快速地創(chuàng)建不同的切入點：全局級別(所有項目)，專屬級別(單一項目)，觸發(fā)器級別(構(gòu)建結(jié)果)。如果你要查看所有可用的變量，你可以點擊配置頁的 Content Token Reference 的問號獲取詳細的信息。所有的變量都是可選的，每個變量可以如下表示，字符串類型使用 name=“value”，而布爾型和數(shù)字型使用 name=value。如果{和}標記里面沒有變量，則不會被解析。示例：$TOKEN,${TOKEN},${TOKEN,count=100},${ENV,var=”PATH”}
提示：用英文逗號分隔變量的參數(shù)。下面我解釋一下常用的屬性。
${FILE,path="PATH"} 包括指定文件（路徑）的含量相對于工作空間根目錄。path 文件路徑，注意：是工作區(qū)目錄的相對路徑。
${BUILD_NUMBER} 顯示當前構(gòu)建的編號。
${JOB_DESCRIPTION} 顯示項目描述。
${SVN_REVISION} 顯示 svn 版本號。還支持 Subversion 插件出口的 SVN_REVISION_n 版本。
${CAUSE} 顯示誰、通過什么渠道觸發(fā)這次構(gòu)建。
${CHANGES } -顯示上一次構(gòu)建之后的變化。
showPaths 如果為 true,顯示提交修改后的地址。默認 false。
showDependencies 如果為 true，顯示項目構(gòu)建依賴。默認為 false
format 遍歷提交信息，一個包含%X 的字符串，其中%a 表示作者，%d 表示日期，%m 表示消息，%p 表示路徑，%r 表示版本。注意，并不是所有的版本系統(tǒng)都支持%d 和%r。如果指定 showPaths 將被忽略。默認“[%a] %m\n”。
pathFormat 一個包含“%p”的字符串，用來標示怎么打印路徑。
${BUILD_ID}顯示當前構(gòu)建生成的 ID。
${PROJECT_NAME} 顯示項目的全名。（見 AbstractProject.getFullDisplayName）
${PROJECT_DISPLAY_NAME} 顯示項目的顯示名稱。（見 AbstractProject.getDisplayName）
${SCRIPT} 從一個腳本生成自定義消息內(nèi)容。自定義腳本應(yīng)該放在"$JENKINS_HOME/email-templates"。當使用自定義腳本時會默認搜索$JENKINS_HOME/email-templatesdirectory 目錄。其他的目錄將不會被搜索。
script 當其使用的時候，僅僅只有最后一個值會被腳本使用（不能同時使用 script 和 template）。
template 常規(guī)的 simpletemplateengine 格式模板。
${JENKINS_URL} 顯示 Jenkins 服務(wù)器的 url 地址（你可以再系統(tǒng)配置頁更改）。
${BUILD_LOG_MULTILINE_REGEX}按正則表達式匹配并顯示構(gòu)建日志。
regex java.util.regex.Pattern 生成正則表達式匹配的構(gòu)建日志。無默認值，可為空。
maxMatches 匹配的大數(shù)量。如果為 0，將匹配所有。默認為 0。
showTruncatedLines 如果為 true，包含[...truncated ### lines...]行。默認為 true。
substText 如果非空，就把這部分文字（而不是整行）插入該郵件。默認為空。
escapeHtml 如果為 true，格式化 HTML。默認為 false。
matchedSegmentHtmlStyle 如果非空，輸出 HTML。匹配的行數(shù)將變?yōu)?b
style=”your-style-value”> html escaped matched line 格式。默認為空。
${BUILD_LOG} 顯示最終構(gòu)建日志。
maxLines 日志最多顯示的行數(shù)，默認 250 行。
escapeHtml 如果為 true，格式化 HTML。默認 false。
${PROJECT_URL} 顯示項目的 URL 地址。
${BUILD_STATUS} -顯示當前構(gòu)建的狀態(tài)(失敗、成功等等)
${BUILD_URL} -顯示當前構(gòu)建的 URL 地址。
${CHANGES_SINCE_LAST_SUCCESS} -顯示上一次成功構(gòu)建之后的變化。
reverse 在頂部標示新近的構(gòu)建。默認 false。
format 遍歷構(gòu)建信息，一個包含%X 的字符串，其中%c 為所有的改變，%n 為構(gòu)建編號。默認”Changes for Build #%nn%cn”。
showPaths,changesFormat,pathFormat 分別定義如${CHANGES}的 showPaths、format 和pathFormat 參數(shù)。
${CHANGES_SINCE_LAST_UNSTABLE} -顯示顯示上一次不穩(wěn)固或者成功的構(gòu)建之后的變化。
reverse 在頂部標示新近的構(gòu)建。默認 false。
format 遍歷構(gòu)建信息，一個包含%X 的字符串，其中%c 為所有的改變，%n 為構(gòu)建編號。默認”Changes for Build #%nn%cn”。
showPaths,changesFormat,pathFormat 分別定義如${CHANGES}的 showPaths、format 和pathFormat 參數(shù)。
${ENV} –顯示一個環(huán)境變量。
var– 顯示該環(huán)境變量的名稱。如果為空，顯示所有，默認為空。
${FAILED_TESTS} -如果有失敗的測試，顯示這些失敗的單元測試信息。
${JENKINS_URL} -顯示 Jenkins 服務(wù)器的地址。(你能在“系統(tǒng)配置”頁改變它)。
${HUDSON_URL} -不推薦，請使用$JENKINS_URL
${PROJECT_URL} -顯示項目的 URL。
${SVN_REVISION} -顯示 SVN 的版本號。
${JELLY_SCRIPT} -從一個 Jelly 腳本模板中自定義消息內(nèi)容。有兩種模板可供配置：HTML 和 TEXT。你可以在
$JENKINS_HOME/email-templates 下自定義替換它。當使用自動義模板時，”template”參數(shù)的名稱不包含“.jelly”。
template 模板名稱，默認”html”。
${TEST_COUNTS} -顯示測試的數(shù)量。
var– 默認“total”。
total -所有測試的數(shù)量。
fail -失敗測試的數(shù)量。
skip -跳過測試的數(shù)量。
要想在一個項目中使用 email-ext 插件，你首先必須在項目配置頁激活它。在構(gòu)建后操作——”Add Post-build Actions”選項中勾選”Editable Email Notification”標簽。
當插件激活后你就能編輯如下字段（只列出常用的字段）：
Project Recipient List：這是一個以逗號(或者空格)分隔的收件人郵件的郵箱地址列表。允許您為每封郵件指定單獨的列表。Ps：如果你想在默認收件人的基礎(chǔ)上添加收件人：$DEFAULT_RECIPIENTS,<新的收件人>
Default Subject：允許你配置此項目郵件的主題。
Default Content：跟 Default Subject 的作用一樣，但是是替換郵件內(nèi)容。
Attach Build Log：附件構(gòu)建日志。
Compress Build Log before sending：發(fā)送前壓縮生成日志（zip 格式）。
要查看插件的高級配置，請點擊”高級”按鈕。該選項允許您各種類型的郵件觸發(fā)器指定接收者。默認情況下，是沒有配置的觸發(fā)器，所以默認情況下不會發(fā)送郵件。要增加更多的觸發(fā)器，選擇“Add a Trigger”旁邊下拉列表中的類型，它會增加到控件上面的列表中。一旦你增加了一個觸發(fā)器，你就可以對它做一些選擇。如果你點擊一個觸發(fā)器旁邊的”?”號，它將告訴你在什么條件下會觸發(fā)郵件發(fā)送。如下圖。
Send to Recipient List：如果勾選，郵件將發(fā)送到”Project Recipient List”中的所有郵件地址。
Send to Committers：該郵件會發(fā)給上次構(gòu)建時檢查過代碼的人員，該插件會基于提交者的 ID 和追加 Jenkins配置頁面的(default email suffix)默認郵件后綴來生成一個郵件地址。譬如，上次提交代碼的人是”first.last”， 默認的電子郵件后綴為“@somewhere.com”，那么電子郵件將被發(fā)送到“first.last@ somewhere.com”。
Send To Requester：如果勾選，郵件將發(fā)送給構(gòu)建觸發(fā)者。
Include Culprits：如果勾選，而且 “Send To Committers”勾選，郵件將包含最后成功構(gòu)建的提交者。
More Configuration：通過單擊”+(expand)”鏈接您能為每個郵件觸發(fā)器作更多單獨的設(shè)置。
Recipient List：這是一個以逗號(或者空格)分隔的可接受郵件的郵箱地址列表。如果觸發(fā)就發(fā)送郵件到該列表。該列表會追加在”Global Recipient List”里。
Subject：指定選擇郵件的主題。注意：高級選項中的郵件觸發(fā)器類型可覆蓋對它的配置。
Content：指定選擇郵件的內(nèi)容主體。注意：高級選項中的郵件觸發(fā)器類型可覆蓋對它的配置。
Remove 通過單擊指定觸發(fā)器當前行的”Delete”按鈕，你可以刪除該觸發(fā)器。
注意：所有的觸發(fā)器都只能配置一次。
Failure：即時發(fā)送構(gòu)建失敗的郵件。如果”Still Failing”觸發(fā)器已配置，而上一次構(gòu)建的狀態(tài)是”Failure”，那么”Still Failing”觸發(fā)器將發(fā)送一封郵件來替代(它)。
Unstable：即時發(fā)送構(gòu)建不穩(wěn)固的郵件。如果”Still Unstable”觸發(fā)器已配置，而上一次構(gòu)建的狀態(tài)是”Unstable”，那么”Still
Unstable”觸發(fā)器將發(fā)送一封郵件來替代(它)。
Still Failing：如果兩次或兩次以上連續(xù)構(gòu)建的狀態(tài)為”Failure”，發(fā)送該郵件。
Success：如果構(gòu)建的狀態(tài)為”Successful”發(fā)送郵件。如果”Fixed”已配置，而上次構(gòu)建的狀態(tài)為“Failure”或“Unstable”，那么”Fixed”觸發(fā)器將發(fā)送一封郵件來替代(它)。
Fixed：當構(gòu)建狀態(tài)從“Failure”或“Unstable”變?yōu)椤盨uccessful”時發(fā)送郵件。
Still Unstable：如果兩次或兩次以上連續(xù)構(gòu)建的狀態(tài)為” Unstable “，發(fā)送該郵件。
Before Build：當構(gòu)建開始時發(fā)送郵件。
注意：這里只解釋全局配置頁面中缺少的變量。
${DEFAULT_SUBJECT}：這是 Jenkins 系統(tǒng)配置頁面默認配置的郵件主題
${DEFAULT_CONTENT}：這是 Jenkins 系統(tǒng)配置頁面默認配置的郵件內(nèi)容主體
${PROJECT_DEFAULT_SUBJECT}：這是項目的默認郵件主題。高級配置中使用該令牌的結(jié)果要優(yōu)先于 Default Subject字段。警告：不要在 Default Subject 或者 Default Content 中使用該令牌，它會產(chǎn)生一個未知的結(jié)果。
${PROJECT_DEFAULT_CONTENT}：這是項目的默認郵件內(nèi)容主體。高級配置中使用該令牌的結(jié)果要優(yōu)先于 Default
Content 字段。警告：不要在 Default Subject 或者 Default Content 中使用該令牌，它會產(chǎn)生一個未知的結(jié)果。
從 Jenkins 2.9 版本開始我們可以使用 Jelly 腳本。Jelly 腳本跟 Hudson 的 API 掛鉤，能獲得你想要的任何信息，所以它很強大。插件有兩個打包后的 Jelly 腳本，當然你也可以自定義(腳本)。
關(guān)于插件中默認的兩個 Jelly 腳本：一個用來設(shè)計 HTML 格式郵件，另一個則是定義 TEXT 格式郵件。你能通過使用模板參數(shù)指定插件調(diào)用哪一個腳本。它們的使用方法如下：
文本格式：${JELLY_SCRIPT,template=”text”}
HTML 格式:${JELLY_SCRIPT,template=”html”}
你也能編寫屬于自己的 Jelly 腳本。Jelly 腳本能跟 Jenkins 的 API(包括 hudson.model.AbstractBuild 和hudson.model.AbstractProject)掛鉤，因而特別強大。如果你打算這么做，你可以先參考現(xiàn)有的 html 和 text 腳本一探究竟。值得注意的是，擁有 Hudson 管理員權(quán)限是使用自定義 Jelly 腳本(該腳本沒有跟 email-ext 打包)的前提。腳本的生成步驟本身其實相對簡單：
1. 創(chuàng)建 Jelly 腳本。腳本的名稱應(yīng)該是<名稱>.jelly。名稱以.jelly 結(jié)尾是很重要的。
2. 把腳本存放在 JENKINS_HOMEemail-templates 文件夾里。
3. 使用 Jelly 變量，讓 template 匹配你的腳本名稱(不要包含后綴)。比如，腳本的名稱為 foobar.jelly，則郵件內(nèi)容中應(yīng)該是${JELLY_SCRIPT,template=”foobar”}。下面兩個圖就是就是使用 Jelly 腳本生成的郵件（最新版 Email-ext 新增 html_gamil 模板，它跟 html 模板類似，所以這里不再顯示它的截圖）：
看完上述內(nèi)容，你們對如何使用email-ext替換Jenkins的默認郵件通知有進一步的了解嗎？如果還想了解更多知識或者相關(guān)內(nèi)容，請關(guān)注創(chuàng)新互聯(lián)-成都網(wǎng)站建設(shè)公司行業(yè)資訊頻道，感謝大家的支持。
重慶分公司
重慶分公司
