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

# Email Receive Connector

> Retrieves messages from an IMAP mail server with OAuth 2.0 support, advanced filtering, and configurable message retention and deletion policies.

export const NameDescription = ({extraRows}) => <table>
    <thead>
      <tr>
        <th>設定</th>
        <th>説明</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><strong>Connector Id</strong></td>
        <td>コネクタの静的で一意の識別子です。</td>
      </tr>
      <tr>
        <td><strong>Connector Type</strong></td>
        <td>コネクタ名とその機能の説明を表示します。</td>
      </tr>
      <tr>
        <td><strong>Connector Description</strong></td>
        <td>コネクタおよびフロー内でのその役割について自由形式の説明を提供するためのオプションフィールドです。</td>
      </tr>
      {extraRows}
    </tbody>
  </table>;

export const CommonProxySettings = () => <>
    <p>これらは、接続のルーティング先となるプロキシを識別し認証するための一連の設定です。デフォルトでは、このセクションは<a href="/26.3/self-hosted/ja/getting-started/administration/settings/security">Security Settings</a> ページの<a href="/26.3/self-hosted/ja/getting-started/administration/settings/proxy-settings">Proxy Settings</a> 部分にあるグローバル設定を使用します。チェックボックスをオフにすると、コネクタ固有の設定を指定できます。</p>
    <table>
      <thead>
        <tr><th>設定</th><th>説明</th></tr>
      </thead>
      <tbody>
        <tr>
          <td><strong>Proxy Type</strong></td>
          <td>プロキシベースのファイアウォールで使用されるプロトコル。</td>
        </tr>
        <tr>
          <td><strong>Proxy Host</strong></td>
          <td>プロキシベースのファイアウォールの名前またはIP アドレス。</td>
        </tr>
        <tr>
          <td><strong>Proxy Port</strong></td>
          <td>プロキシベースのファイアウォールのTCP ポート。</td>
        </tr>
        <tr>
          <td><strong>Proxy User</strong></td>
          <td>プロキシベースのファイアウォールで認証するために使用するユーザー名。</td>
        </tr>
        <tr>
          <td><strong>Proxy Password</strong></td>
          <td>プロキシベースのファイアウォールで認証するために使用するパスワード。</td>
        </tr>
        <tr>
          <td><strong>Authentication Scheme</strong></td>
          <td>デフォルトの<strong>None</strong> のままにするか、次の認証スキームのいずれかを選択します：<strong>Basic</strong>、<strong>Digest</strong>、<strong>Proprietary</strong>、または<strong>NTLM</strong>。</td>
        </tr>
      </tbody>
    </table>
  </>;

export const SlasTab = ({siteName = "CData Arc"}) => <>
    <p><em>サービスレベルアグリーメント（SLA）の設定に関する設定です。</em></p>
    <p>
      SLA を使用すると、フロー内のコネクタが送受信すると見込まれるボリュームを設定し、そのボリュームを達成すると見込まれる期間を設定できます。{siteName} は、SLA が達成されない場合にユーザーへ警告するメールを送信し、SLA を<em>At Risk</em> としてマークします。これは、SLA が間もなく達成されない場合に<em>Violated</em> としてマークされることを意味します。これにより、ユーザーは介入してSLA が達成されない理由を特定し、適切な対応を取る機会を得られます。At Risk 期間の終了時点でもSLA が達成されない場合、SLA はviolated としてマークされ、ユーザーに再度通知されます。
    </p>
    <p>
      SLA を定義するには、<strong>Expected Volume</strong> をオンに切り替え、<strong>Settings</strong> タブをクリックします。
    </p>
    <img src="/public/images/sla_empty.png" alt="SLA Empty" />
    <ul>
      <li>コネクタに送信と受信の個別のアクションがある場合は、ラジオボタンを使用してSLA がどちらの方向に適用されるかを指定します。</li>
      <li>ウィンドウの<strong>Expect at least</strong> 部分で、次を設定します。
        <ul>
          <li>処理を見込む最小トランザクション数（ボリューム）を設定します。</li>
          <li><strong>Every</strong> フィールドを使用して期間を指定します。</li>
          <li>SLA を有効にするタイミングを指定します。<strong>Starting on</strong> を選択した場合は、日付および時刻フィールドを入力します。</li>
          <li>SLA を有効にしたい曜日のチェックボックスをオンにします。必要に応じて、ドロップダウンで<strong>Everyday</strong> を選択します。</li>
        </ul>
      </li>
      <li>ウィンドウの<strong>Set status to 'At Risk'</strong> 部分で、SLA をAt Risk としてマークするタイミングを指定します。
        <ul>
          <li>デフォルトでは、SLA が違反状態になるまで通知は送信されません。これを変更するには、<strong>Send an 'At Risk' notification</strong> をオンにします。</li>
        </ul>
      </li>
    </ul>
    <p>
      次の例は、月曜日から金曜日まで毎日1000 件のファイルを受信すると見込むコネクタ向けに設定されたSLA を示しています。1000 件のファイルが受信されていない場合、期間の終了の1時間前にAt Risk 通知が送信されます。
    </p>
    <img src="/public/images/sla_defined.png" alt="SLA Configuration Example" />
    <Note>
      必要に応じてSLA アラートをオフにすることができます。これはメンテナンスウィンドウ中に役立ちます。navbar で<strong>Settings</strong> をクリックし、<strong>Alerts &gt; General Alerts</strong> に移動します。タブレットと鉛筆のアイコンをクリックして編集し、<strong>SLA Alerts</strong> 設定のチェックを外します。
    </Note>
  </>;

export const AlertsTab = ({siteNameShort = "Arc"}) => <>
    <p><em>アラートの設定に関する設定です。</em></p>
    <p>
      サービスレベルアグリーメント（SLA）を実行する前に、通知用のメールアラートをセットアップする必要があります。デフォルトでは、{siteNameShort} は<a href="/26.3/self-hosted/ja/getting-started/administration/settings/alerts">Alerts</a> タブのグローバル設定を使用します。このコネクタに別の設定を使用するには、<strong>Override global setting</strong> をオンに切り替えます。
    </p>
    <p>
      デフォルトではエラーアラートが有効になっており、エラーが発生するたびにメールが送信されます。これをオフにするには、<strong>Enable</strong> チェックボックスのチェックを外します。
    </p>
    <p>
      <strong>Subject</strong>（必須）を入力します。<strong>Allow {siteNameShort}Script in Subject</strong> をチェックすると、<strong>Subject</strong> フィールドで{siteNameShort}Script を使用できます。これを選択すると、<strong>{siteNameShort}Script エディタ</strong>ボタンが表示されます（<img src="/public/images/rest_arcscript_editor.png" alt="arcscript editor button" style={{
  display: 'inline',
  verticalAlign: 'middle',
  margin: 0
}} />）。
    </p>
    <p>
      必要に応じて<strong>Recipient</strong> のメールアドレスをカンマ区切りのリストで入力します。
    </p>
  </>;

export const Message = () => <>
    <p><em>Message 設定は、コネクタがメッセージを検索する方法と、処理後にメッセージを管理する方法を決定します。</em></p>
    <p><strong>Note：</strong> 以下の設定は非推奨となり、デフォルトで非表示になっています。以前に有効化またはデフォルト以外の値に設定されていたコネクタにのみ表示されます。処理済みファイルのコピーを保持するには、フロー内のコネクタを右クリックし、<strong>成功パスを表示</strong>を選択して、成功パスを<a href="/26.3/self-hosted/ja/connectors/file">File コネクタ</a>に接続してください。</p>
    <table>
      <thead>
        <tr><th>設定</th><th>説明</th></tr>
      </thead>
      <tbody>
        <tr>
          <td><strong>Sent フォルダに保存</strong>（非推奨）</td>
          <td>コネクタが処理したファイルをSent フォルダにコピーします。デフォルトで無効です。Sent フォルダに保存されたファイルは<a href="/26.3/self-hosted/ja/getting-started/administration/settings/encryption-at-rest">保存データの暗号化</a>の対象外です。</td>
        </tr>
        <tr>
          <td><strong>Sent フォルダのスキーム</strong>（非推奨）</td>
          <td>選択した時間間隔で<strong>Sent</strong> フォルダ内のファイルをグループ化します。<strong>Sent フォルダに保存</strong>が有効な場合のみ適用されます。</td>
        </tr>
      </tbody>
    </table>
  </>;

export const MiscConnector = () => <>
    <p><em>Miscellaneous 設定は、特定のユースケース向けの設定です。</em></p>
    <table>
      <thead>
        <tr>
          <th>設定</th>
          <th>説明</th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <td><strong>Other Settings</strong></td>
          <td>非表示のコネクタ設定をセミコロン区切りのリストで設定できます（例：<code>setting1=value1;setting2=value2</code>）。通常のコネクタのユースケースや機能では、これらの設定の使用は必要ありません。</td>
        </tr>
      </tbody>
    </table>
  </>;

export const Logging = () => <>
    <p><em>ログの作成と保存を制御する設定です。</em></p>
    <table>
      <thead>
        <tr>
          <th>設定</th>
          <th>説明</th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <td><strong>Log Level</strong></td>
          <td>コネクタが生成するログの詳細度です。サポートを依頼する際は、これを<strong>Debug</strong> に設定してください。</td>
        </tr>
        <tr>
          <td><strong>Log Subfolder Scheme</strong></td>
          <td>選択した間隔に従って、コネクタがLogs フォルダ内のファイルをグループ化するよう指示します。<strong>Weekly</strong> オプション（デフォルト）は、コネクタが毎週新しいサブフォルダを作成し、その週のすべてのログをそのフォルダに保存するよう指示します。この設定を空白のままにすると、コネクタはすべてのログをLogs フォルダに直接保存します。多数のトランザクションを処理するコネクタでは、サブフォルダを使用することでログを整理しやすくなり、パフォーマンスが向上します。</td>
        </tr>
        <tr>
          <td><strong>Log Messages</strong></td>
          <td>処理したファイルのログエントリにファイル自体のコピーを含めるには、これをオンにします。これを無効にすると、<strong>Transactions</strong> タブからファイルのコピーをダウンロードできなくなる場合があります。</td>
        </tr>
      </tbody>
    </table>
  </>;

export const MacrosExamples = ({extraMacros = []}) => <>
    <p>
      %Ext% や %ShortDate% などの一部のマクロは引数を必要としませんが、引数を必要とするものもあります。
      引数を取るすべてのマクロは次の構文を使用します。<code>%Macro:argument%</code>
    </p>

    <p>引数を取るマクロの例を次に示します。</p>

    <ul>
      <li>%Header:headername%：<code>headername</code> はメッセージ上のヘッダーの名前です。</li>
      <li>%Header:mycustomheader% は、入力メッセージに設定された<code>mycustomheader</code> ヘッダーの値に解決されます。</li>
      <li>%Header:ponum% は、入力メッセージに設定された<code>ponum</code> ヘッダーの値に解決されます。</li>
      <li>%RegexFilename:pattern%：<code>pattern</code> は正規表現パターンです。例えば、<code>%RegexFilename:^([\w][A-Za-z]+)%</code> は、ファイル名の最初の単語にマッチしてそれに解決され、大文字・小文字を区別しません（<code>test_file.xml</code> は<code>test</code> に解決されます）。</li>
      <li>%Vault:vaultitem%：<code>vaultitem</code> は<a href="/26.3/self-hosted/ja/getting-started/administration/settings/global-settings-vault">Vault</a> 内のアイテムの名前です。例えば、<code>%Vault:companyname%</code> は、Vault に保存された<code>companyname</code> アイテムの値に解決されます。</li>
      <li>%DateFormat:format%：<code>format</code> は許容される日付形式です（詳細は<a href="/26.3/self-hosted/ja/scripting/value-formatters/date-formatters#sample-date-formats">日付形式のサンプル</a>を参照してください）。例えば、<code>%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%</code> は、ファイルの日付とタイムスタンプに解決されます。</li>
      {extraMacros.filter(item => item.example).map(item => <li key={`ex-${item.name}`}>{item.example}</li>)}
    </ul>

    <p>次の例に示すように、より高度なマクロを作成することもできます。</p>

    <ul>
      <li>1 つのファイル名で複数のマクロを組み合わせる：<code>%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%%EXT%</code></li>
      <li>マクロの外側にテキストを含める：<code>MyFile_%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%</code></li>
      <li>マクロの内側にテキストを含める：<code>%DateFormat:'DateProcessed-'yyyy-MM-dd_'TimeProcessed-'HH-mm-ss%</code></li>
    </ul>
  </>;

export const MacrosTable = ({siteName = "CData Arc", extraMacros = []}) => <>
    <p>
      ファイル命名戦略でマクロを使用すると、データの整理効率と文脈の理解を高めることができます。
      ファイル名にマクロを組み込むことで、識別子、タイムスタンプ、ヘッダー情報などの関連情報を
      動的に含めることができ、各ファイルに有用な文脈を提供します。
    </p>

    <p>{siteName} は次のマクロをサポートしています。これらはすべて次の構文を使用します。<code>%Macro%</code></p>

    <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:<em>pattern</em></td><td>コネクタが現在処理しているファイルのファイル名に正規表現パターンを適用します。</td></tr>
        <tr><td>Header:<em>headername</em></td><td>コネクタが現在処理しているメッセージ上の対象ヘッダー（<code>headername</code>）の値に評価されます。</td></tr>
        <tr><td>LongDate</td><td>システムの現在の日時を長い形式（例：Wednesday, January 24, 2024）で評価します。</td></tr>
        <tr><td>ShortDate</td><td>システムの現在の日時をyyyy-MM-dd 形式（例：2024-01-24）で評価します。</td></tr>
        <tr><td>DateFormat:<em>format</em></td><td>システムの現在の日時を指定された形式（<code>format</code>）で評価します。利用可能な日時形式については、<a href="/26.3/self-hosted/ja/scripting/value-formatters/date-formatters#date-formats-with-literal-characters">日付形式のサンプル</a>を参照してください。</td></tr>
        <tr><td>Vault:<em>vaultitem</em></td><td>指定されたVault アイテムの値に評価されます。</td></tr>
        {extraMacros.map(item => <tr key={item.name}>
            <td>{item.name}</td>
            <td>{item.description}</td>
          </tr>)}
      </tbody>
    </table>
  </>;

export const siteNameShort = "Arc";

export const siteName = "CData Arc";

export const extraMacros = [{
  name: "Subject",
  description: "Evaluates to the subject of the email currently being received by the connector."
}];

The Email Receive connector supports retrieving messages from an IMAP mail server.

## Key Capabilities

* IMAP-based email polling with OAuth 2.0 support for modern providers
* Advanced filtering with IMAP RFC compliant search filters
* Support for downloading full messages or attachments only
* Configurable message retention and deletion policies

## Overview

The Email Receive connector provides a simple way to automate the process of receiving emails. The connector connects to an IMAP server and polls a specified mailbox for new messages to process. By default the connector only receives messages that have not yet been processed, and it supports additional IMAP filters.

The connector supports receiving entire messages in EML format or only downloading attachments on the emails being processed.

<Note>OAuth 2.0 configuration for Outlook and Gmail mail servers are the two most common connection configurations made in the Email Receive connector. You can access additional guides and resources for these two mail servers in the CData Community. See [Using OAuth 2.0 in the Email Send and Receive Connectors](https://community.cdata.com/cdata-arc-48/using-oauth-2-0-in-the-email-send-and-receive-connectors-106?tid=106\&fid=48).</Note>

## Connector Configuration

This section contains all of the configurable connector properties.

### Settings Tab

#### Email Receive Configuration

*Settings related to establishing the connection.*

<NameDescription />

#### Establish a Connection

To allow {siteNameShort} to receive emails, you must first establish an Email Receive connection. Once established, connections can be shared across multiple Email Receive connectors. There are several ways to establish this connection:

1. Add an Email Receive connector to your flow. Then use the **Connection** dropdown to select an existing connection or click **Create** to add a new connection.
2. Open the {siteNameShort} **Settings** page, then open the **Connections** tab. Click **Add**, select **Email Receive**, and click **Next**.
   <Note>
     If you create the connection this way, you must still select it from the **Connection** dropdown on the connector.
   </Note>

Complete the following properties:

| Setting                      | Description                                                                                                                                                                                                                                                                                                                                                                                  |
| ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Host**                     | The hostname or IP address of the IMAP server.                                                                                                                                                                                                                                                                                                                                               |
| **Port**                     | The port on which to connect to the IMAP server. Typical values include 143 and 993.                                                                                                                                                                                                                                                                                                         |
| **TLS Type**                 | The method used to negotiate SSL/TLS when connecting to the server:<br />**STARTTLS**: A plain text connection is established. Afterwards, SSL/TLS can be started with an explicit command.<br />**SSL/TLS**: Negotiation occurs immediately without first establishing a plain text connection.<br />**None (Plain Text)**: A plain text connection is established, and no SSL/TLS is used. |
| **User**                     | The username to login to the IMAP server.                                                                                                                                                                                                                                                                                                                                                    |
| **Authentication Mechanism** | The type of authentication to use to login to the server. The options vary based on your choice.                                                                                                                                                                                                                                                                                             |
| **Password**                 | (Basic and NTLM) The password to the IMAP server.                                                                                                                                                                                                                                                                                                                                            |
| **Auth URL**                 | (OAuth 2.0) The authorization URL for the service. This is the URL you are directed to when clicking the **Connect** button to log in and grant permission to the application.                                                                                                                                                                                                               |
| **Access Token URL**         | (OAuth 2.0) The URL to the access token.                                                                                                                                                                                                                                                                                                                                                     |
| **Client Id**                | (OAuth 2.0) The client Id assigned when you registered for OAuth.                                                                                                                                                                                                                                                                                                                            |
| **Client Secret**            | (OAuth 2.0) The secret assigned when you registered for OAuth.                                                                                                                                                                                                                                                                                                                               |
| **Scope**                    | (OAuth 2.0) A list of scopes that the application should have access to.                                                                                                                                                                                                                                                                                                                     |
| **Callback URL**             | (OAuth 2.0) The URL where the service you connect to returns tokens to provide access. Services often require you to whitelist the URLs that are allowed, so this is the value to use when configuring the application registration with your service.                                                                                                                                       |

The following settings are required to establish a network-level connection to the IMAP server:

* Host
* Port
* TLS Type

Once network-level connectivity has been established, the following settings are required to access the messages stored on the IMAP server:

* User
* Password or OAuth 2.0 authentication credentials
* Mailbox

Use the **Add and Test** button to verify that the connector can reach the server.

#### Download

*Settings related to processing messages.*

| Setting                       | Description                                                                                                                                                                                                                                                                                           |
| ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Mailbox**                   | The IMAP mailbox to poll for messages.                                                                                                                                                                                                                                                                |
| **Only process new messages** | Check this to only process new messages. This is usually controlled by tracking the UID of downloaded messages. If the UID values become invalid, the connector falls back to using the timestamp of the last processed message or the **Days to Search** setting if no messages have been processed. |
| **Days to Search**            | The number of days to search for messages. If **Only process new messages** is checked, this value is only used if the connector cannot search by UID or the timestamp of the last processed message.                                                                                                 |
| **Additional Search Filters** | Supply an IMAP RFC compliant search filter to append to the query that is automatically built based on the **New Messages** and **Days to Search** settings.                                                                                                                                          |
| **Download Type**             | Choose to download full messages in EML format or only email attachments.                                                                                                                                                                                                                             |
| **Delete Emails**             | Check this to delete successfully downloaded messages from the mailbox.                                                                                                                                                                                                                               |
| **Move to Folder**            | ダウンロード成功後にメッセージを移動するメールボックスのフォルダ。指定したフォルダが存在しない場合は自動的に作成されます。設定すると、**Delete Emails** は効果がありません。フォルダパスには[マクロ](#macros)を使用できます。                                                                                                                                                                         |
| **Expunge After Delete**      | Check this to permanently delete successfully downloaded emails from the mailbox. **Warning**: The server might permanently delete (expunge) messages immediately, making them unrecoverable.                                                                                                         |

### Advanced Tab

#### Advanced Settings

*Settings not included in the previous categories.*

| Setting                                | Description                                                                                                                                                                                                                                                                                                                                                                                             |
| -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **IMAP Headers**                       | A comma-delimited list of headers from the IMAP message that should be promoted as metadata in the downloaded file.                                                                                                                                                                                                                                                                                     |
| **Incoming Server Public Certificate** | The public key certificate used to verify the identity of a TLS/SSL server. If the target server uses TLS/SSL, set this field to the certificate that identifies the server. If the server's certificate is not available, you can leave this setting blank to allow the underlying OS/JVM to perform certificate validation, or set it to `Any Certificate` to implicitly trust the server's identity. |
| **Command Timeout (seconds)**          | The command execution timeout duration in seconds.                                                                                                                                                                                                                                                                                                                                                      |
| **TLS Enabled Protocols**              | The list of TLS/SSL protocols supported when establishing outgoing connections. Best practice is to only use TLS protocols. SSL v2 and SSL v3 are considered vulnerable and should only be used if your partner does not support higher versions. Keep in mind that TLS v1.3 is not universally adopted, and might be refused if the destination server does not support it.                            |
| **Local File Scheme**                  | A scheme for assigning filenames to messages that are output by the connector. You can use macros in your filenames dynamically to include information such as identifiers and timestamps. For more information, see [Macros](#macros).                                                                                                                                                                 |

#### Proxy Settings

<CommonProxySettings />

#### Message

<Message />

#### Logging

<Logging />

#### Miscellaneous

<MiscConnector />

### Automation Tab

#### Automation Settings

*Settings related to the automatic processing of files by the connector.*

| Setting                   | Description                                                                                                                                                                                                       |
| ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Receive**               | Whether the connector should automatically poll the remote mailbox for messages to download.                                                                                                                      |
| **Interval**              | The interval between automatic download attempts.                                                                                                                                                                 |
| **Minutes Past the Hour** | The minutes offset for an hourly schedule. Only applicable when the interval setting above is set to *Hourly*. For example, if this value is set to 5, the automation service downloads at 1:05, 2:05, 3:05, etc. |
| **Time**                  | The time of day that the attempt should occur. Only applicable when the interval setting above is set to *Daily*, *Weekly*, or *Monthly*.                                                                         |
| **Day**                   | The day on which the attempt should occur. Only applicable when the interval setting above is set to *Weekly* or *Monthly*.                                                                                       |
| **Minutes**               | The number of minutes to wait before attempting the download. Only applicable when the interval setting above is set to *Minute*.                                                                                 |
| **Cron Expression**       | A five-position string representing a cron expression that determines when the attempt should occur. Only applicable when the interval setting above is set to *Advanced*.                                        |

### Alerts Tab

<AlertsTab />

### SLAs Tab

<SlasTab />

### Transactions Tab

This tab lists all messages associated with the connector. Use the search bar to find specific messages, or click the funnel icon to apply a filter. You can filter by tracked headers, time, and/or status.

## Receiving Emails

If **Receive Automation** is enabled, the Email Receive connector automatically polls the configured IMAP mailbox for messages to download. By default, the connector only receives messages it has not already downloaded. The first time the connector receives messages, use the **Days to Search** setting in the [Download](#download) configuration section to specify the range of messages to download.

Messages can also be manually retrieved by clicking the **Receive** button on the **Transactions** tab of the connector.

The **Download Type** setting determines whether full messages or just message attachments are downloaded. Downloaded files are placed in the **Output Folder** or passed along to the next connector in the flow.

When **Download Type** is set to *Attachments*, the connector adds two headers to each message:

* EmailReceive-Attachment-Index: The attachment number for each attachment
* EmailReceive-Attachment-Count: The total number of attachments on the email

### Search Filters

The **IMAP Search Filter** setting allows for further customization of the range of messages to retrieve. This field accepts standard IMAP protocol filters and only downloads messages that match the configured filters.

The following filters are supported:

| Filter                               | Description                                                                                                                                              |
| ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `<message set>`                      | Messages with message sequence numbers corresponding to the specified message sequence number set.                                                       |
| **ALL**                              | All messages in the mailbox: this is the default initial key for AND-ing.                                                                                |
| **ANSWERED**                         | Messages with the `\Answered` flag set.                                                                                                                  |
| **BCC** `<string>`                   | Messages that contain the specified string in the envelope structure's BCC field.                                                                        |
| **BEFORE** `<date>`                  | Messages whose internal date is earlier than the specified date.                                                                                         |
| **BODY** `<string>`                  | Messages that contain the specified string in the body of the message.                                                                                   |
| **CC** `<string>`                    | Messages that contain the specified string in the envelope structure's CC field.                                                                         |
| **DELETED**                          | Messages with the `\Deleted` flag set.                                                                                                                   |
| **DRAFT**                            | Messages with the `\Draft` flag set.                                                                                                                     |
| **FLAGGED**                          | Messages with the `\Flagged` flag set.                                                                                                                   |
| **FROM** `<string>`                  | Messages that contain the specified string in the envelope structure's FROM field.                                                                       |
| **HEADER** `<field-name> <string>`   | Messages that have a header with the specified field-name (as defined in \[RFC-822]) and that contain the specified string in the \[RFC-822] field-body. |
| **KEYWORD** `<flag>`                 | Messages with the specified keyword set.                                                                                                                 |
| **LARGER** `<n>`                     | Messages with an RFC822.SIZE larger than the specified number of octets.                                                                                 |
| **NEW**                              | Messages that have the `\Recent` flag set but not the `\Seen` flag. This is functionally equivalent to "(RECENT UNSEEN)".                                |
| **NOT** `<search-key>`               | Messages that do not match the specified search key.                                                                                                     |
| **OLD**                              | Messages that do not have the `\Recent` flag set. This is functionally equivalent to "NOT RECENT" (as opposed to "NOT NEW").                             |
| **ON** `<date>`                      | Messages whose internal date is within the specified date.                                                                                               |
| **OR** `<search-key1> <search-key2>` | Messages that match either search key.                                                                                                                   |
| **RECENT**                           | Messages that have the `\Recent` flag set.                                                                                                               |
| **SEEN**                             | Messages that have the `\Seen` flag set.                                                                                                                 |
| **SENTBEFORE** `<date>`              | Messages whose \[RFC-822] Date: header is earlier than the specified date.                                                                               |
| **SENTON** `<date>`                  | Messages whose \[RFC-822] Date: header is within the specified date.                                                                                     |
| **SENTSINCE** `<date>`               | Messages whose \[RFC-822] Date: header is within or later than the specified date.                                                                       |
| **SINCE** `<date>`                   | Messages whose internal date is within or later than the specified date.                                                                                 |
| **SMALLER** `<n>`                    | Messages with an RFC822.SIZE smaller than the specified number of octets.                                                                                |
| **SUBJECT** `<string>`               | Messages that contain the specified string in the envelope structure's SUBJECT field.                                                                    |
| **TEXT** `<string>`                  | Messages that contain the specified string in the header or body of the message.                                                                         |
| **TO** `<string>`                    | Messages that contain the specified string in the envelope structure's TO field.                                                                         |
| **UID** `<message set>`              | Messages with unique identifiers corresponding to the specified unique identifier set.                                                                   |
| **UNANSWERED**                       | Messages that do not have the `\Answered` flag set.                                                                                                      |
| **UNDELETED**                        | Messages that do not have the `\Deleted` flag set.                                                                                                       |
| **UNDRAFT**                          | Messages that do not have the `\Draft` flag set.                                                                                                         |
| **UNFLAGGED**                        | Messages that do not have the `\Flagged` flag set.                                                                                                       |
| **UNKEYWORD** `<flag>`               | Messages that do not have the specified keyword set.                                                                                                     |
| **UNSEEN**                           | Messages that do not have the `\Seen` flag set.                                                                                                          |

## Macros

<MacrosTable />

### Examples

<MacrosExamples />