コンテンツへスキップ

メールを読み取る

ノードタイプ browser_getEmail

機能

メールボックスの設定に従って、メールを取得します。

デスクトップクライアントでの設定

デスクトップクライアントでの「メールを読み取る」の設定

MoreLogin デスクトップクライアント V2.73.101 の英語インターフェースで撮影しました。

入力

これらのフィールドは data.browserUi.inputs に置きます。

フィールド型または値スキーマで必須実行時の既定値説明と制約
userstringいいえ—メールアカウント
authType"password" / "oauth2"(変数参照をサポート)いいえ"password"認証方式。エディターの初期値:"password"
passwordstringいいえ—パスワード / 認証コード
imapHoststringいいえ—IMAP サーバー
portWorkflowNumberいいえ993ポート。解決後は 1~65535 の整数。エディターの初期値:993
tlsboolean(変数参照をサポート)いいえtrueTLS を有効にする。エディターの初期値:true
clientIdstringいいえ—クライアント ID
clientSecretstringいいえ—クライアントシークレット
refreshTokenstringいいえ—リフレッシュトークン
status"UNSEEN" / "SEEN" / "ALL"(変数参照をサポート)いいえ"UNSEEN"メールの状態。エディターの初期値:"UNSEEN"
isJunkboolean(変数参照をサポート)いいえfalse迷惑メールも検索。エディターの初期値:false
seenboolean(変数参照をサポート)いいえfalse取得後に既読にする。エディターの初期値:false
fromstringいいえ—送信者のフィルター
mailTostringいいえ—受信者のフィルター
subjectstringいいえ—件名に含む文字列
keywordstringいいえ—本文のキーワード
dateType"all" / "today" / "recent"(変数参照をサポート)いいえ"all"メールの日付。エディターの初期値:"all"
regstringいいえ—抽出用の正規表現

モードごとの要件と制限

  • 必須:user、imapHost、port
  • imapHost はホスト名で、port は 1~65535 の整数です。
  • 検証コード:RPA_NODE_INPUT_INVALID

authType eq "password"

  • 必須:password
  • 値は、パスワードまたはメールボックスの認証コードです。
  • 検証コード:RPA_NODE_INPUT_INVALID

authType eq "oauth2"

  • 必須:clientId、refreshToken
  • このモードは Outlook/Hotmail の IMAP のみをサポートします。Microsoft の refresh_token が access_token と交換され、ローテーションされた refresh_token は暗号化された形式でローカルにキャッシュされます。clientSecret は省略可能です(パブリッククライアントのアプリでは不要です)。
  • 検証コード:RPA_NODE_INPUT_INVALID
  • このノードは実際に IMAP で接続し、フィルターに一致する最新のメールを読み取ります。password モードはパスワードまたは認証コードを使用し、任意の IMAP ホストで動作します。OAuth2 と「迷惑メールも検索」がサポートされるのは Outlook/Hotmail(outlook.office365.com、imap-mail.outlook.com)だけで、ほかのホストでは MAIL_PROVIDER_UNSUPPORTED が返されます。imapHost にはホスト名だけを指定し、ポートやパスは含めません。直近 3 日間とは、実行するマシンのローカル時刻で、今日とその前の 2 日間です。reg を設定した場合は、最初のキャプチャグループ、または一致全体が返されます。最新のメールが一致しない場合は null が返され、それより古いメールへのフォールバックは行われません。reg を設定しない場合、extractedValue は本文です。seen=true では、選択されたメールだけが既読になります。message.receivedAt は、メールを受信した時刻です(デスクトップクライアントのローカル時刻、YYYY-MM-DD HH:mm:ss)。1 つのフォルダー内の候補が 10000 件を超えると MAIL_SEARCH_LIMIT、1 通のメールが 10 MiB を超えると MAIL_MESSAGE_LIMIT、接続/認証に失敗すると MAIL_CONNECTION_FAILED が返されます(サーバーの元のテキストと認証情報は公開されません)。POP3、メールの送信、添付ファイルのダウンロードはサポートされていません。
  • 検証コード:RPA_NODE_INPUT_INVALID

入力の参照

フィールド許可される形式
userliteral, template
authTypeliteral, template
passwordliteral, template
imapHostliteral, template
portliteral, template
tlsliteral, template
clientIdliteral, template
clientSecretliteral, template
refreshTokenliteral, template
statusliteral, template
isJunkliteral, template
seenliteral, template
fromliteral, template
mailToliteral, template
subjectliteral, template
keywordliteral, template
dateTypeliteral, template
regliteral, template

出力

出力フィールド型または値
foundboolean
messageobject / null
extractedValuestring / null

公開されているフィールドは、${nodeId.data.field} として参照します。

JSON の例

ワークフローの nodes 配列、または別のノードの blocks に入れる完全なノードオブジェクトです。mailPassword は、workflow.variables で宣言された非公開の初期パラメーターです。

{
  "id": "read_code_email",
  "type": "browser_getEmail",
  "data": {
    "title": "Read the verification email",
    "browserAction": "getEmail",
    "browserUi": {
      "inputs": {
        "user": "user@example.com",
        "authType": "password",
        "password": "${mailPassword}",
        "imapHost": "imap.example.com",
        "port": 993,
        "tls": true,
        "status": "UNSEEN",
        "from": "no-reply@example.com",
        "dateType": "today",
        "reg": "\\b(\\d{6})\\b"
      },
      "exception": {
        "timeout": 30000,
        "policy": "interrupt"
      }
    }
  }
}

ノードカタログに戻る