> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kasoftware.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Email Receive 端口（已棄用）

> Email Receive 端口支援從 IMAP 郵件伺服器檢索訊息，支援 OAuth 2.0 和進階過濾。

Email Receive 端口支援從 IMAP 郵件伺服器檢索郵件。

## 核心功能

* 基於 IMAP 的郵件輪詢，支援現代服務商的 OAuth 2.0 認證
* 具備符合 IMAP RFC 標準的搜尋過濾器，實現進階過濾
* 支援僅下載附件或下載完整郵件
* 可配置的郵件保留與刪除策略

## 概覽

Email Receive 端口提供了一種自動化接收電子郵件的簡單方法。端口連線到指定的 IMAP 伺服器，並輪詢指定的郵箱以處理新訊息。預設情況下，該端口僅接收尚未處理的訊息，並支援其他 IMAP 過濾條件。

端口支援接收 EML 格式的完整訊息，或僅下載正在處理的電子郵件附件。

> [!NOTE]
>
> Outlook 和 Gmail 郵件伺服器的 OAuth 2.0 配置是 Email Receive 端口中最常見的兩種連線配置。

## 端口配置

本節包含所有可配置的端口屬性。

### 設定

#### 郵件接收配置

*與建立連線相關的設定。*

<table><thead><tr><th>設定</th>
<th>描述</th></tr></thead>
<tbody><tr><td>**端口 Id**</td>
<td>端口的靜態、唯一識別碼。</td></tr>
<tr><td>**端口型別**</td>
<td>顯示端口型別及其用途的描述。</td></tr>
<tr><td>**端口描述**</td>
<td>一個可選欄位，用於提供端口及其在流中的角色的自由格式描述。</td></tr></tbody></table>

#### IMAP 連線

*與建立到 IMAP 伺服器的連線相關的設定。*

| 設定 | 描述 |
| - | - |
| **Host** | IMAP 伺服器的主機名或 IP 地址。 |
| **Port** | 連線到 IMAP 伺服器的端口。典型值包括 143 和 993。 |
| **Mailbox** | 用於輪詢訊息的 IMAP 郵箱。 |
| **TLS Type** | 連線到伺服器時用於協商 SSL/TLS 的方法：**STARTTLS**：先建立明文連線，然後可以透過顯式命令啟動 SSL/TLS。**SSL/TLS**：無需先建立明文連線，立即進行協商。**None (Plain Text)**：建立明文連線，不使用 SSL/TLS。 |

### 認證

*與連線身分驗證相關的設定。*

| 設定 | 描述 |
| - | - |
| **User** | 登入 IMAP 伺服器的使用者名稱。 |
| **Authentication Mechanism** | 用於登入伺服器的身分驗證型別。可用選項會根據你的選擇而變化。 |
| **Password** | （Basic 和 NTLM）IMAP 伺服器的密碼。 |
| **Auth URL** | （OAuth 2.0）服務的授權 URL。點選 **Connect** 按鈕登入並授予應用程式權限時，會定向到此 URL。 |
| **Access Token URL** | （OAuth 2.0）存取權杖的 URL。 |
| **Client Id** | （OAuth 2.0）註冊 OAuth 時分配的用戶端 Id。 |
| **Client Secret** | （OAuth 2.0）註冊 OAuth 時分配的金鑰。 |
| **Scope** | （OAuth 2.0）應用程式應有權存取的範圍清單。 |
| **Callback URL** | （OAuth 2.0）所連線服務傳回權杖以提供存取權限的 URL。服務通常要求你將允許的 URL 加入白名單，因此在服務中配置應用程式註冊時應使用此值。 |

#### 下載

*與處理訊息相關的設定。*

| 設定 | 描述 |
| - | - |
| **New Messages** | 勾選此項以僅處理新訊息。這通常透過跟蹤已下載訊息的 UID 來控制。如果 UID 值變為無效，端口會回退到使用上次處理訊息的時間戳，或在尚未處理任何訊息時使用 **Days to Search** 設定。 |
| **Days to Search** | 搜尋訊息的天數。如果勾選 **Only process new messages**，則僅當端口無法按 UID 或上次處理訊息的時間戳搜尋時，才會使用此值。 |
| **Additional Search Filters** | 提供符合 IMAP RFC 的搜尋過濾器，以附加到基於 **New Messages** 和 **Days to Search** 設定自動構建的查詢。 |
| **Download Type** | 選擇下載 EML 格式的完整郵件訊息或僅下載電子郵件附件。 |
| **Delete Emails** | 勾選此項以從郵箱中刪除成功下載的訊息。 |
| **Expunge After Delete** | 勾選此項以從郵箱中永久刪除成功下載的電子郵件。**警告**：伺服器可能會立即永久刪除（清除）訊息，使其無法恢復。 |

### 自動化

#### 自動化設定

*與端口自動處理檔案相關的設定。*

| 設定 | 描述 |
| - | - |
| **Receive** | 端口是否應自動輪詢遠端郵箱以下載訊息。 |
| **Receive Interval** | 自動下載嘗試之間的間隔。 |
| **Minutes Past the Hour** | 小時計劃的分鐘偏移量。僅當上面的間隔設定為 *Hourly* 時適用。例如，如果此值設定為 5，自動化服務會在 1:05、2:05、3:05 等時間下載。 |
| **Time** | 應執行嘗試的當天時間。僅當上面的間隔設定為 *Daily*、*Weekly* 或 *Monthly* 時適用。 |
| **Day** | 應執行嘗試的日期。僅當上面的間隔設定為 *Weekly* 或 *Monthly* 時適用。 |
| **Minutes** | 嘗試下載前等待的分鐘數。僅當上面的間隔設定為 *Minute* 時適用。 |
| **Cron Expression** | 表示 cron 運算式的五段字串，用於確定何時執行嘗試。僅當上面的間隔設定為 *Advanced* 時適用。 |
| **開始日期和時間** | 自動化首次執行的日期和時間。之後的每次執行都遵循上方的間隔設定。上次和下次執行時間顯示在 [自動化狀態](#自動化狀態) 區段中。 |

#### 自動化狀態

*唯讀摘要，顯示自動化是否正在執行、上次執行的結果以及下次執行的時間。*

**自動化狀態**卡片顯示在 **自動化** 索引標籤的 **啟用** 核取方塊下方，適用於 **接收**、**下載** 和 **定時傳送** 自動化。該卡片回答三個問題：自動化是否已執行、執行是否成功，以及下次執行的時間。

在儲存端口之前，當您變更 **啟用** 核取方塊，或者變更 **間隔** 或 **開始日期和時間** 設定時，卡片會隨之更新。

![自動化索引標籤上的自動化狀態卡片，顯示已暫停狀態、失敗的上次處理結果以及下次執行時間](https://docs.kasoftware.com/26.4/images/automation-status-card.png)

狀態

端口自動化的目前狀態。

<table><thead><tr><th>狀態</th>
<th>描述</th></tr></thead>
<tbody><tr><td>**進行中**</td>
<td>目前有一次執行正在進行，或者其他執行個體已鎖定該排程時段。</td></tr>
<tr><td>**閒置**</td>
<td>自動化正在等待下一次排程執行。</td></tr>
<tr><td>**已暫停**</td>
<td>端口在多次執行失敗後處於[退避](https://docs.kasoftware.com/26.4/self-hosted/zh/connectors/connector-backoff.md)狀態，自動化服務會略過該端口。</td></tr>
<tr><td>**已停用**</td>
<td>該端口的自動化已關閉。</td></tr></tbody></table>

上次執行時間

最近一次執行的結果。

<table><thead><tr><th>欄位</th>
<th>描述</th></tr></thead>
<tbody><tr><td>**日期**</td>
<td>上次執行的排程時間。</td></tr>
<tr><td>**上次處理開始時間**</td>
<td>端口實際開始處理上次執行的時間。該時間可能略晚於排程時間。</td></tr>
<tr><td>**上次處理結果**</td>
<td>上次執行的結果：
<ul><li>**成功**：執行已完成並處理了資料。</li>
<li>**無資料**：執行已完成，但沒有需要處理的內容，例如查詢未傳回任何資料列。</li>
<li>**失敗**：執行未完成。</li></ul></td></tr>
<tr><td>**上次成功時間**</td>
<td>最近一次成功執行的日期和時間。當上次執行失敗或未傳回資料時，會顯示此欄位，讓您瞭解端口已有多長時間未成功執行。</td></tr></tbody></table>

下次執行時間

**日期** 欄位顯示自動化下一次排程執行的時間。自動化停用時，該欄位為空白。

檢視詳細資料

**已暫停** 狀態、**失敗** 結果和 **無資料** 結果都包含一個 **檢視詳細資料** 連結，點選後會開啟一個顯示完整訊息的對話方塊：

<ul><li>**已暫停**：列出每個處於退避狀態的執行個體、其失敗次數以及自動化服務恢復的時間。有關端口如何退出此狀態，請參閱[端口退避](https://docs.kasoftware.com/26.4/self-hosted/zh/connectors/connector-backoff.md)。</li>
<li>**失敗**：顯示上次失敗執行的錯誤訊息。</li>
<li>**無資料**：顯示端口回報的訊息，例如 `0 rows returned`。</li></ul>

未執行與無資料

該卡片會區分尚未執行的端口與已執行但未找到任何內容的端口。如果 **上次處理結果** 為空白，表示自動化尚未執行，請檢查 **下次執行時間** 和排程設定。如果結果為 **無資料**，表示自動化已按排程執行，但資料來源未傳回任何內容，請檢查資料來源中是否有新資料。

已停用的端口

已停用的端口會保留其上次執行資訊，因此您仍可以檢視其上次執行的時間及結果。只有 **下次執行時間** 會被清除。

### 警示

*與配置通知相關的設定。*

在執行服務級別協議 (SLA) 之前，需要設定電子郵件通知以接收通知。預設情況下，知行之桥 使用 [通知](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/alerts.md) 索引標籤上的全域設定。要為此端口使用其他設定，請啟用 **覆蓋全域設定**。

預設情況下，錯誤通知處於啟用狀態，這意味著每當出現錯誤時都會傳送電子郵件。要關閉錯誤通知，請取消選中 **啟用** 核取方塊。

輸入 **主題**（必填）。勾選**允許在主題中使用 ArcScript**，即可在**主題**欄位中使用 ArcScript。選中後會顯示 **ArcScript 編輯器**按鈕（![ArcScript 編輯器按鈕](https://docs.kasoftware.com/26.4/images/rest_arcscript_editor.png)）。

（可選）輸入以逗號分隔的**收件人**電子郵件地址清單。

### SLA

*與配置服務級別協議 (SLA) 相關的設定。*

SLA 允許配置預期流程中端口傳送或接收的資料量，並設定預期達到該資料量的時間範圍。當 SLA 未達到時，知行之桥 會傳送電子郵件警告使用者，並將 SLA 標記為 *存在風險*，這意味著如果 SLA 未能儘快達到，則會被標記為 *已違反*。這讓使用者有機會介入並確定 SLA 未達到的原因，並採取適當的措施。如果在風險時間段結束時仍未達到 SLA，則會將 SLA 標記為已違反，並再次通知使用者。

SLA 轉換為 *存在風險* 或 *已違反* 狀態時，也會寫入[應用程式日誌](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/activity.md#应用程序日志)，這意味著應用程式效能監控 (APM) 和日誌擷取工具也可以針對這些狀態發出警示。

要定義 SLA，請啟用 **預期資料量**，然後點選 **設定** 索引標籤。

![SLA Empty](https://docs.kasoftware.com/26.4/images/sla_empty.png)
<ul><li>如果端口具有單獨的傳送和接收操作，請使用選項按鈕指定 SLA 適用的方向。</li>
<li>在視窗的 **預計至少** 部分中：
<ul><li>設定預計處理的最小交易數量（交易量）</li>
<li>使用 **每個** 欄位指定時間範圍</li>
<li>指示 SLA 生效的時間。如果選擇 **開始於**，請填寫日期和時間欄位。</li>
<li>勾選希望 SLA 生效的星期幾對應的核取方塊。如有必要，請使用下拉功能表選擇 **每天**。</li></ul></li>
<li>在視窗的 **將狀態設定為“有風險”** 部分中，指定應將 SLA 標記為有風險的時間。
<ul><li>預設情況下，只有在違反 SLA 的情況下才會傳送通知。要更改此設定，請勾選 **傳送“有風險”通知**。</li></ul></li></ul>

以下範例顯示了為端口配置的 SLA，該端口預計在週一至週五每天接收 1000 個檔案。如果尚未收到 1000 個檔案，則會在時間段結束前 1 小時傳送風險通知。

![SLA Configuration Example](https://docs.kasoftware.com/26.4/images/sla_defined.png)

> [!NOTE]
>
> 如果有必要，可以關閉 SLA 通知。這在維護視窗期間非常有用。點選導覽列上的 **設定**，然後跳轉到 **通知 > 通用通知**。點選平板和鉛筆圖示進行編輯，並取消勾選 **SLA 通知** 設定。

### 進階頁面

#### 代理配置

這是一組用於識別連線所經代理並對其進行身分驗證的設定。預設情況下，本節使用 [安全設定](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/security.md) 頁面的 [代理設定](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/proxy-settings.md) 部分中的全域設定。清除此核取方塊可為您的端口提供特定的設定。

<table><thead><tr><th>設定</th><th>描述</th></tr></thead>
<tbody><tr><td>**代理型別**</td>
<td>基於代理的防火牆使用的協議。</td></tr>
<tr><td>**代理主機**</td>
<td>基於代理的防火牆的名稱或 IP 地址。</td></tr>
<tr><td>**代理端口**</td>
<td>基於代理的防火牆的 TCP 端口。</td></tr>
<tr><td>**代理使用者**</td>
<td>用於透過基於代理的防火牆進行身分驗證的使用者名稱。</td></tr>
<tr><td>**代理密碼**</td>
<td>用於對基於代理的防火牆進行身分驗證的密碼。</td></tr>
<tr><td>**身分驗證方案**</td>
<td>保留預設值 **None** 或選擇以下身分驗證方案之一：**Basic**、**Digest**、**Proprietary** 或 **NTLM**。</td></tr></tbody></table>

#### 進階設定

*前面類別中未包含的設定。*

| 設定 | 描述 |
| - | - |
| **IMAP Headers** | IMAP 訊息頭中以逗號分隔的清單，這些訊息頭應提升為下載檔案中的中繼資料。 |
| **Incoming Server Public Certificate** | 用於驗證 TLS/SSL 伺服器身份的公開金鑰憑證。如果目標伺服器使用 TLS/SSL，請將此欄位設定為標識伺服器的憑證。如果伺服器憑證不可用，可以將此設定留空以允許底層 OS/JVM 執行憑證驗證，或將其設定為 `Any Certificate` 以隱式信任伺服器身份。 |
| **Command Timeout (seconds)** | 命令執行逾時時間，以秒為單位。 |
| **本地檔案方案** | 用於為端口輸出的訊息分配檔名的方案。可以在檔名中動態使用宏，以包含識別碼和時間戳等資訊。有關更多資訊，請參閱[宏](#宏)。 |

#### 訊息

*訊息設定確定端口如何搜尋訊息並在處理後管理它們。*

**注意：**以下設定已棄用，預設處於隱藏狀態。只有先前已啟用這些設定或將其配置為非預設值的端口才會顯示它們。若要保留成功處理的檔案副本，請在工作流程中右鍵單擊該端口，選擇**顯示成功路徑**，然後將成功路徑連線到 [File 端口](https://docs.kasoftware.com/26.4/self-hosted/zh/connectors/file.md)。

<table><thead><tr><th>設定</th><th>描述</th></tr></thead>
<tbody><tr><td>**儲存到已傳送資料夾**（已棄用）</td>
<td>將端口處理的檔案複製到 Sent 資料夾。預設停用。儲存到 Sent 資料夾中的檔案不受[靜態加密](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/encryption-at-rest.md)保護。</td></tr>
<tr><td>**已傳送資料夾方案**（已棄用）</td>
<td>按所選時間間隔對 **Sent** 資料夾中的檔案進行分組。僅在啟用**儲存到已傳送資料夾**時適用。</td></tr></tbody></table>

#### 日誌

| 設定 | 描述 |
| - | - |
| **Log Level** | 端口生成日誌的詳細程度。請求支援時，請將其設定為 **Debug**。 |
| **Log Subfolder Scheme** | 指示端口按所選時間間隔對 Logs 資料夾中的檔案進行分組。**Weekly** 選項（預設值）會指示端口每週建立一個新子資料夾，並將當週所有日誌儲存在該資料夾中。將此設定留空表示端口將所有日誌直接儲存到 Logs 資料夾。對於處理大量交易的端口，使用子資料夾有助於保持日誌井然有序並提升效能。 |
| **Log Messages** | 勾選此項可使已處理檔案的日誌項目包含檔案本身的副本。如果停用此選項，可能無法從 **Input** 或 **Output** 索引標籤下載檔案副本。 |

#### 其他設定

*特殊設定適用於特定用例。*

<table><thead><tr><th>設定</th>
<th>描述</th></tr></thead>
<tbody><tr><td>**其他設定**</td>
<td>允許在以分號分隔的清單中配置隱藏的端口設定，例如 `setting1=value1;setting2=value2`。正常的端口用例和功能不需要使用這些設定。</td></tr></tbody></table>

## 建立連線

建立與 IMAP 伺服器的網路級連線需要以下設定：

* Host
* Port
* TLS Type

使用 **Test Connection** 按鈕驗證端口是否可以連線到伺服器。

建立網路級連線後，需要以下設定才能存取 IMAP 伺服器上儲存的訊息：

* User
* Password 或 OAuth 2.0 身分驗證憑據
* Mailbox

## 接收郵件

如果啟用了 **Receive Automation**，Email Receive 端口會自動輪詢配置的 IMAP 郵箱以下載訊息。預設情況下，端口只接收尚未下載的訊息。端口第一次接收訊息時，請使用[下載](#下載)配置部分中的 **Days to Search** 設定來指定要下載的訊息範圍。

也可以點選端口 Output 索引標籤上的 **Receive** 按鈕手動檢索訊息。

**Download Type** 設定決定下載完整郵件還是僅下載郵件附件。下載的檔案會放置在 **Output Folder** 中，或傳遞到流程中的下一個端口。

當 **Download Type** 設定為 *Attachments* 時，端口會向每條訊息新增兩個訊息頭：

* EmailReceive-Attachment-Index：每個附件的附件編號
* EmailReceive-Attachment-Count：電子郵件中的附件總數

### 搜尋過濾器

**IMAP Search Filter** 設定允許進一步自定義要檢索的訊息範圍。此欄位接受標準 IMAP 協議過濾器，並且僅下載與配置的過濾器匹配的訊息。

支援以下過濾器：

| 過濾器 | 描述 |
| - | - |
| `<message set>` | 訊息序列號對應於指定訊息序列號集的訊息。 |
| **ALL** | 郵箱中的所有訊息：這是用於 AND 組合的預設初始關鍵字。 |
| **ANSWERED** | 設定了 `\Answered` 標誌的訊息。 |
| **BCC** `<string>` | 信封結構的 BCC 欄位中包含指定字串的訊息。 |
| **BEFORE** `<date>` | 內部日期早於指定日期的訊息。 |
| **BODY** `<string>` | 訊息正文中包含指定字串的訊息。 |
| **CC** `<string>` | 信封結構的 CC 欄位中包含指定字串的訊息。 |
| **DELETED** | 設定了 `\Deleted` 標誌的訊息。 |
| **DRAFT** | 設定了 `\Draft` 標誌的訊息。 |
| **FLAGGED** | 設定了 `\Flagged` 標誌的訊息。 |
| **FROM** `<string>` | 信封結構的 FROM 欄位中包含指定字串的訊息。 |
| **HEADER** `<field-name> <string>` | 具有指定欄位名（如 \[RFC-822] 中定義）的訊息頭，並且 \[RFC-822] 欄位正文中包含指定字串的訊息。 |
| **KEYWORD** `<flag>` | 設定了指定關鍵字的訊息。 |
| **LARGER** `<n>` | RFC822.SIZE 大於指定八位位元組數的訊息。 |
| **NEW** | 設定了 `\Recent` 標誌但未設定 `\Seen` 標誌的訊息。此功能等同於 "(RECENT UNSEEN)"。 |
| **NOT** `<search-key>` | 與指定搜尋鍵不匹配的訊息。 |
| **OLD** | 未設定 `\Recent` 標誌的訊息。此功能等同於 "NOT RECENT"（與 "NOT NEW" 相對）。 |
| **ON** `<date>` | 內部日期在指定日期內的訊息。 |
| **OR** `<search-key1> <search-key2>` | 與任一搜尋鍵匹配的訊息。 |
| **RECENT** | 設定了 `\Recent` 標誌的訊息。 |
| **SEEN** | 設定了 `\Seen` 標誌的訊息。 |
| **SENTBEFORE** `<date>` | \[RFC-822] Date: 訊息頭早於指定日期的訊息。 |
| **SENTON** `<date>` | \[RFC-822] Date: 訊息頭在指定日期內的訊息。 |
| **SENTSINCE** `<date>` | \[RFC-822] Date: 訊息頭在指定日期之內或之後的訊息。 |
| **SINCE** `<date>` | 內部日期在指定日期之內或之後的訊息。 |
| **SMALLER** `<n>` | RFC822.SIZE 小於指定八位位元組數的訊息。 |
| **SUBJECT** `<string>` | 信封結構的 SUBJECT 欄位中包含指定字串的訊息。 |
| **TEXT** `<string>` | 訊息頭或訊息正文中包含指定字串的訊息。 |
| **TO** `<string>` | 信封結構的 TO 欄位中包含指定字串的訊息。 |
| **UID** `<message set>` | 唯一識別碼對應於指定唯一識別碼集的訊息。 |
| **UNANSWERED** | 未設定 `\Answered` 標誌的訊息。 |
| **UNDELETED** | 未設定 `\Deleted` 標誌的訊息。 |
| **UNDRAFT** | 未設定 `\Draft` 標誌的訊息。 |
| **UNFLAGGED** | 未設定 `\Flagged` 標誌的訊息。 |
| **UNKEYWORD** `<flag>` | 未設定指定關鍵字的訊息。 |
| **UNSEEN** | 未設定 `\Seen` 標誌的訊息。 |

## 宏

在檔案命名策略中使用宏可以提高組織效率和對資料的上下文理解。透過將宏合併到檔名中，可以動態地包含相關資訊，例如識別碼、時間戳和訊息頭資訊，從而為每個檔案提供有價值的上下文。這有助於確保檔名反映對組織重要的詳細資訊。

知行之桥 支援這些宏，它們都使用以下語法：`%Macro%`。

<table><thead><tr><th>宏</th><th>描述</th></tr></thead>
<tbody><tr><td>ConnectorID</td><td>替換為端口的 ConnectorID。</td></tr>
<tr><td>ConnectorName</td><td>替換為端口名稱。可用於在檔名或路徑中包含連線名稱，例如按生成備份檔案的資料庫連線標記檔案。</td></tr>
<tr><td>Ext</td><td>替換為端口當前正在處理的檔案的副檔名。</td></tr>
<tr><td>Filename</td><td>替換為端口當前正在處理的檔案的檔名（包括副檔名）。</td></tr>
<tr><td>FilenameNoExt</td><td>替換為端口當前正在處理的檔案的檔名（不帶副檔名）。</td></tr>
<tr><td>MessageId</td><td>計算端口輸出的訊息的 MessageId。</td></tr>
<tr><td>RegexFilename:*pattern*</td><td>將規則運算式模式應用於端口當前正在處理的檔案的檔名。</td></tr>
<tr><td>Header:*headername*</td><td>替換為端口正在處理的當前訊息的目標訊息頭（`headername`）的值。</td></tr>
<tr><td>LongDate</td><td>以常規格式計算系統的當前日期時間（例如，2024 年 1 月 24 日星期三）。</td></tr>
<tr><td>ShortDate</td><td>以 yyyy-MM-dd 格式計算系統的當前日期時間（例如 2024-01-24）。</td></tr>
<tr><td>DateFormat:*format*</td><td>以指定格式（`format`）計算系統的當前日期時間。有關可用的日期時間格式，請參閱 [範例日期格式](https://docs.kasoftware.com/26.4/self-hosted/zh/scripting/value-formatters/date-formatters.md#date-formats-with-literal-characters)。</td></tr>
<tr><td>Vault:*vaultitem*</td><td>計算指定保管庫專案的值。</td></tr></tbody></table>

### 範例

某些宏（例如 %Ext% 和 %ShortDate%）不需要參數，但其他宏則需要。所有帶有參數的宏都使用以下語法：`%Macro:argument%`

以下是帶有參數的宏的一些範例：

<ul><li>%Header:headername%：其中 `headername` 是訊息上訊息頭的名稱。</li>
<li>%Header:mycustomheader% 解析為輸入訊息上設定的 `mycustomheader` 訊息頭的值。</li>
<li>%Header:ponum% 解析為輸入訊息上設定的 `ponum` 訊息頭的值。</li>
<li>%RegexFilename:pattern%：其中 `pattern` 是規則運算式模式。例如，`%RegexFilename:^([\w][A-Za-z]+)%` 匹配並解析為檔名中的第一個單詞，並且不區分大小寫（`test_file.xml` 解析為 `test`）。</li>
<li>%Vault:vaultitem%：其中 `vaultitem` 是 [vault](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/global-settings-vault.md) 中專案的名稱。例如，`%Vault:companyname%` 解析為儲存在保管庫中的 `companyname` 項的值。</li>
<li>%DateFormat:format%：其中 `format` 是可接受的日期格式（有關詳細資訊，請參閱 [範例日期格式](https://docs.kasoftware.com/26.4/self-hosted/zh/scripting/value-formatters/date-formatters.md#sample-date-formats)）。例如，`%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%` 解析為檔案上的日期和時間戳。</li></ul>

還可以建立更復雜的宏，如以下範例所示：

<ul><li>將多個宏組合在一個檔名中：`%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%%EXT%`</li>
<li>包括宏之外的文字：`MyFile_%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%`</li>
<li>在宏中包含文字：`%DateFormat:'DateProcessed-'yyyy-MM-dd_'TimeProcessed-'HH-mm-ss%`</li></ul>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.