Version 24.2.9039

• Overview
• Connector Configuration
  • Settings Tab
    • Email Receive Configuration
    • IMAP Connection
  • Authentication
    • Download
  • Automation Tab
    • Automation Settings
  • アラートタブ
    • コネクタのE メール設定
    • サービスレベル（SLA）の設定
  • Advanced Tab
    • Proxy Settings
    • Advanced Settings
    • Message
    • Logging
    • Miscellaneous
• Establishing a Connection
• Receiving Emails
  • Search Filters
• Macros
  • 例

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

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.

Connector Configuration

This section contains all of the configurable connector properties.

Settings Tab

Email Receive Configuration

Settings related to establishing the connection.

• コネクタId コネクタの静的な一意の識別子。
• コネクタの種類 コネクタ名とその機能の説明が表示されます。
• コネクタの説明 コネクタとフローにおけるロールについて自由形式の説明を記載するオプションのフィールド。

IMAP Connection

Settings related to establishing the connection to the IMAP server.

• 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.
• Mailbox The IMAP mailbox to poll for messages.
• TLS Type The method used to negotiate SSL/TLS when connecting to the server:
  STARTTLS: A plain text connection is established. Afterwards, SSL/TLS can be started with an explicit command.
  SSL/TLS: Negotiation occurs immediately without first establishing a plain text connection.
  None (Plain Text): A plain text connection is established, and no SSL/TLS is used.

Authentication

Settings related to authenticating the connection.

• User The username to login to the IMAP server.
• 認証方式 サーバーにログインする際に使用する認証の種類。Basic、OAuth 2.0、NTLM から選択します。オプションは選択した内容に応じて変わります。
• パスワード (Basic およびNTLM) IMAP サーバーのパスワード。
• 認証URL (OAuth 2.0) サービスの認証URL。これは、接続ボタンをクリックしてログインし、アプリケーションに権限を付与するときに表示されるURL です。
• アクセストークンURL (OAuth 2.0) アクセストークンへのURL。
• クライアントId (OAuth 2.0) OAuth 登録時に割り当てられたクライアントId。
• クライアントシークレット (OAuth 2.0) OAuth 登録時に割り当てられたクライアントシークレット。
• スコープ (OAuth 2.0) アプリケーションがアクセス可能なスコープのリスト。
• コールバックURL (OAuth 2.0) 接続するサービスがアクセスを提供するためのトークンを返すURL。サービスでは許可されるURL をホワイトリストに登録する必要があることが多いため、サービスでアプリケーション登録を設定する際にはこの値を使用します。

Download

Settings related to processing messages.

• New Messages Whether 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 Whether to delete successfully downloaded messages from the mailbox.
• Expunge After Delete Whether to permanently remove emails marked for delete. Important: If you choose this option, there is no way to restore expunged emails.

Automation Tab

Automation Settings

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

• Receive Whether the connector should automatically poll the remote mailbox for messages to download.
• Receive Interval The interval between automatic download attempts.
• 毎時何分 時間単位のスケジュールの分オフセット。上記の受信間隔の設定が Hourly に設定されている場合にのみ適用されます。例えば、この値を5 に設定すると、自動的に1:05、2:05、3:05 のようにダウンロードを行います。
• 時 試行が行われる時刻。上記の受信間隔の設定が Daily 、Weekly、または Monthly に設定されている場合にのみ適用されます。
• 曜日/日付 試行が行われる日。上記の受信間隔の設定が Weekly または Monthly に設定されている場合にのみ適用されます。
• 分 ダウンロードを試行するまでの待機時間。上記の受信間隔の設定が Minute に設定されている場合にのみ適用されます。
• Cron 式 いつ試行するかを決定するcron 式を表す5つの欄の文字列。上記の受信間隔の設定が Advanced に設定されている場合にのみ適用されます。

アラートタブ

アラートとサービスレベル（SLA）の設定に関連する設定。

コネクタのE メール設定

サービスレベル（SLA）を実行する前に、通知用のE メールアラートを設定する必要があります。アラートを設定をクリックすると、新しいブラウザウィンドウで設定ページが開き、システム全体のアラートを設定することができます。詳しくは、アラートを参照してください。

サービスレベル（SLA）の設定

サービスレベルでは、フロー内のコネクタが送受信すると予想される処理量を設定し、その量が満たされると予想される時間枠を設定できます。CData Arc は、サービスレベルが満たされていない場合にユーザーに警告するE メールを送信し、SLA を At Risk（危険） としてマークします。これは、サービスレベルがすぐに満たされない場合に Violated（違反） としてマークされることを意味します。これにより、ユーザーはサービスレベルが満たされていない理由を特定し、適切な措置を講じることができます。At Risk の期間内にサービスレベルが満たされなかった場合、SLA はViolated としてマークされ、ユーザーに再度通知されます。

サービスレベルを定義するには、予想処理量の条件を追加をクリックします。

• コネクタに個別の送信アクションと受信アクションがある場合は、ラジオボタンを使用してSLA に関連する方向を指定します。
• 検知基準（最小）を、処理が予想されるトランザクションの最小値（量）に設定し、毎フィールドを使用して期間を指定します。
• デフォルトでは、SLA は毎日有効です。これを変更するには、毎日のチェックをOFF にし、希望する曜日のチェックをON にします。
• 期間終了前にステータスを’At Risk’ に設定するタイミングを使用して、SLA がAt Risk としてマークされるようにします。
• デフォルトでは、通知はSLA が違反のステータスになるまで送信されません。これを変更するには、‘At Risk’ 通知を送信のチェックをON にします。

次の例は、月曜日から金曜日まで毎日1000ファイルを受信すると予想されるコネクタに対して構成されたSLA を示しています。1000ファイルが受信されていない場合、期間終了の1時間前にAt Risk 通知が送信されます。

Advanced Tab

Proxy Settings

These are a collection of settings that identify and authenticate to the proxy through which the Email Receive connection should be routed. By default, this section uses the global settings on the Settings Page. Clear the checkbox to supply settings specific to your Email Receive connector.

• プロキシの種類 プロキシベースのファイアウォールで使用されるプロトコル。
• プロキシホスト プロキシベースのファイアウォールの名前またはIP アドレス。
• プロキシポート プロキシベースのファイアウォールのTCP ポート。
• プロキシユーザー プロキシベースのファイアウォールでの認証に使用するユーザー名。
• プロキシパスワード プロキシベースのファイアウォールに認証するために使われるパスワード。
• 認証スキーム デフォルトのNone のままにするか、以下の認証スキームから1つを選択します：Basic、Digest、Proprietary、NTLM。

Advanced Settings

Settings not included in the previous categories.

• 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 TLS / SSL サーバーのID を検証するために使用される公開鍵証明書。ターゲットサーバーがTLS / SSL を使用する場合は、このフィールドにサーバーを識別する証明書を設定します。サーバーの証明書が利用できない場合は、この設定を空白のままにして基盤となるOS / JVM に証明書の検証を実行させるか、任意の証明書 に設定してサーバーのID を暗黙的に信頼させることができます。
• Command Timeout (seconds) The command execution timeout duration in seconds.
• ローカルファイルスキーム コネクタがアウトプットするメッセージにファイル名を割り当てるスキーム。ファイル名にマクロを動的に使用して、識別子やタイムスタンプなどの情報を含めることができます。詳しくは、マクロ を参照してください。

Message

Message settings determine how the connector searches for messages and manages them after processing. You can save messages to your Sent folder or you can group them based on a Sent folder scheme, as described below.

• Sent フォルダに保存 チェックすると、コネクタで処理されたファイルをコネクタのSent フォルダにコピーします。
• Sent Folder Scheme Instructs the connector to group files in the Sent folder according to the selected interval. For example, the Weekly option instructs the connector to create a new subfolder each week and store all sent files for the week in that folder. The blank setting instructs the connector to save all files directly in the Sent folder. For connectors that process many transactions, using subfolders can help keep files organized and improve performance.

Logging

• Log Level The verbosity of logs generated by the connector. When you request support, set this to Debug.
• Log Subfolder Scheme Instructs the connector to group files in the Logs folder according to the selected interval. For example, the Weekly option instructs the connector to create a new subfolder each week and store all logs for the week in that folder. The blank setting tells the connector to save all logs directly in the Logs folder. For connectors that process many transactions, using subfolders helps keep logs organized and improves performance.
• Log Messages Check this to have the log entry for a processed file include a copy of the file itself. If you disable this, you might not be able to download a copy of the file from the Input or Output tabs.

Miscellaneous

Miscellaneous settings are for specific use cases.

• Other Settings Enables you to configure hidden connector settings in a semicolon-separated list (for example, setting1=value1;setting2=value2). Normal connector use cases and functionality should not require the use of these settings.

Establishing a Connection

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

• Host
• Port
• TLS Type

Use the Test Connection button to verify that the connector can reach the server.

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

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 configuration section to specify the range of messages to download.

Messages can also be manually retrieved by clicking the Receive button on the Output 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.

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:

<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

ファイルの命名規則にマクロを使用することで、組織の効率とデータの文脈的理解を高めることができます。マクロをファイル名に組み込むことで、識別子、タイムスタンプ、ヘッダー情報などの関連情報を動的に含めることができ、各ファイルに有益なコンテキストを付与できます。これにより、組織にとって重要な詳細をファイル名に反映させることができます。

CData Arc はこれらのマクロをサポートしており、すべて次の構文を使用します：%Macro%

Macro	説明
ConnectorID	コネクタのConnectorID を返します。
Ext	コネクタが処理中のファイルの拡張子を返します。
Filename	コネクタが処理中のファイルのファイル名（拡張子を含む）を返します。
FilenameNoExt	コネクタが処理中のファイルのファイル名（拡張子なし）を返します。
MessageId	コネクタがアウトプットするメッセージのMessageId を返します。
RegexFilename:pattern	コネクタで処理中のファイルのファイル名にRegEx パターンを適用します。
Header:headername	コネクタが処理中のメッセージのヘッダー（headername）の値を返します。
LongDate	システムの現在の日時を長い形式（例：Wednesday, January 24, 2024）で返します。
ShortDate	システムの現在の日時をyyyy-MM-dd 形式（例：2024-01-24）で返します。
DateFormat:format	システムの現在の日時を指定されたフォーマット（format）で返します。使用可能な日付フォーマットについては、サンプル日付フォーマット を参照してください。
Vault:vaultitem	指定されたvault 項目の値を返します。
Subject	Evaluates to the subject of the email currently being received by the connector.

例

%Ext% や%ShortDate% などの引数を必要としないマクロもありますが、引数を必要とするマクロもあります。引数を渡すマクロはすべて次の構文を用います：%Macro:argument%

以下は、引数を渡すマクロの例です。

• %Header:headername%：headername はメッセージのヘッダー名です。
• %Header:mycustomheader% は、インプットメッセージで設定されたmycustomheader ヘッダーの値を返します。
• %Header:ponum% は、インプットメッセージで設定されたponum ヘッダーの値に対応します。
• %RegexFilename:pattern%：pattern は正規表現パターンです。例えば、%RegexFilename:^([\w][A-Za-z]+)% はファイル名の最初の単語と照合し、大文字と小文字を区別せずに結果を返します（test_file.xml はtest に変換されます）。
• %Vault:vaultitem%:vaultitem は、vault のアイテム名です。例えば、%Vault:companyname% はVault に保存されているcompanyname アイテムの値を返します。
• %DateFormat:format%：format は使用可能な日付フォーマットです（詳細はサンプル日付フォーマット を参照してください）。例えば、%DateFormat:yyyy-MM-dd-HH-mm-ss-fff% はファイルの日付とタイムスタンプを返します。

以下の例に示すように、より詳細なマクロを作成することもできます。

• 複数のマクロを1つのファイル名にまとめる：%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%%EXT%
• マクロの外側にテキストを含める：MyFile_%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%
• マクロ内にテキストを含める：%DateFormat:'DateProcessed-'yyyy-MM-dd_'TimeProcessed-'HH-mm-ss%