メールを取得

UiPath.MicrosoftOffice365.Activities.Mail.GetMail

説明

Microsoft Graph の Get Message および List Messages API を使用して、指定したメールボックス ([メールボックス]) から一致するメッセージを取得します。

検索の実行後、アクティビティは一致する Office365Message オブジェクトの配列 ([結果]) を返します。これは、後続のアクティビティ ([メールを転送]、[メールを移動] など) で入力変数として使用できます。

スコープ

このアクティビティには、次のスコープが必要です。

• Mail.Read AND User.Read

OR

• Mail.ReadWrite AND User.Read

OR

• Mail.Read.Shared AND User.Read

OR

• Mail.ReadWrite.Shared AND User.Read

OR

• Mail.Read AND User.ReadWrite

OR

• Mail.ReadWrite AND User.ReadWrite

OR

• Mail.Read.Shared AND User.ReadWrite

OR

• Mail.ReadWrite.Shared AND User.ReadWrite

プロジェクトの対応 OS

Windows - レガシ |Windows

構成

プロパティ

共通

• 表示名 - アクティビティの表示名です。 このプロパティは、String 型変数と文字列形式の値をサポートします。

入力

• アカウント - (任意) 対話するメール アドレスです。現在のユーザーがアクセス権を持つ任意の共有メールボックスを含みます。設定しない場合、現在のユーザーのアカウントが使用されます。 このプロパティは、String 型変数と文字列形式の値をサポートします。
  注: [アカウント] フィールドは、認証の種類が [ApplicationIdAndSecret] と [ApplicationIdAndCertificate] の場合は必須です。
• メール フォルダー - メッセージの取得元のメール フォルダーです。フォルダー名は、Outlook アプリケーションに表示されるとおりに入力します (例:「受信トレイ」、「送信済みアイテム」、「削除済みアイテム」など)。サブフォルダーには、「親フォルダー/サブフォルダー/さらなるサブフォルダー」の形式を使用します。このプロパティでは、String 型変数と文字列形式の値がサポートされています。

その他

• プライベート - オンにした場合、変数および引数の値が Verbose レベルでログに出力されなくなります。 このフィールドでは、Boolean 値がサポートされています。

オプション

• メール ID - 検索するメールの ID です。指定した場合、[アカウント]、[HTML として取得]、[既読にする] パラメーターは考慮されますが、[未読メッセージのみ]、[日付で並べ替え]、[クエリ]、[上限数] パラメーターは無視されます。指定した ID のメールが見つかった場合、出力配列に含まれる要素は 1 つだけになります。見つからなかった場合、このアクティビティは例外をスローします。このプロパティは、String 型変数と文字列形式の値をサポートします。
• HTML として取得 - 選択した場合、メッセージ本文が HTML 形式で返されます。 このフィールドでは、Boolean 値がサポートされています。
• 既読にする - 選択した場合、返されるメッセージが既読に設定されます。 このフィールドでは、Boolean 値がサポートされています。
• 未読メッセージのみ - 選択した場合、未読のメッセージのみが返されます。このフィールドでは、Boolean 値がサポートされています。既定値は [True] です。
• 日付で並べ替え - 返されたメッセージを日付で並び替えます。利用可能なオプションは [NewestFirst] と [OldestFirst] です。
• クエリ - 返されるメールのフィルター処理に使用するクエリです。クエリが未指定の場合、すべてのメールが返されます。OData クエリ パラメーターの $filter を使用して String を入力します。以下に、いくつかの入力例を示します。
  • "from/emailAddress/address eq '[e-mail]'"
  • "subject eq 'Office365 Quickstart'"
  • "subject eq 'Office365 Quickstart' and from/emailAddress/address eq '[e-mail]'"
  • "categories/any(a:a eq 'Red category')"
• [上限数] - 取得するメールの最大数です。このフィールドでは整数および Int32 型の変数のみがサポートされています。 既定値は 50 通です (表示されません)。

出力

• 結果 - ユーザーの受信トレイにあるすべてのメールを返します。このフィールドでは Office365Message[] 変数のみをサポートします。後続のアクティビティで出力データを使用する予定がある場合は必須です。

  このプロパティ用に作成した変数は、[メールを転送] および [メールを移動] アクティビティでも ([メッセージ] 入力プロパティの値として) 使用されます。この変数を入力プロパティの値として使用する場合、配列内の使用する項目を指定します (例: foundMessages(0))。

  Office365Messageobject には、他のアクティビティで使用できる複数のプロパティが含まれています。
  Body.Content プロパティは、HTML 形式のみで返されます。

動作のしくみ

以下の手順とメッセージ シーケンス ダイアグラムは、設計時 (つまり、アクティビティの依存関係と入/出力プロパティ) から実行時に至るまでの、アクティビティの動作のしくみの例を示したものです。

1. 手順を完了します。
2. プロジェクトに [Microsoft Office 365 スコープ] アクティビティを追加します。
3. [Microsoft Office 365 スコープ] アクティビティ内に [メールを取得] アクティビティを追加します。
4. [入力] セクションのプロパティに値を入力します。
5. [出力] セクションのプロパティのために Office365Message[] 型変数を作成し、入力します。

6. アクティビティを実行します。

   • 入力したプロパティ値は、Get Message および List Messages API に渡されます。
   • API は、[出力] セクションのプロパティ変数に Office365Message[] の値を返します。