「IMAPメールを取得」アクティビティのご紹介をします。
1.アクティビティのプログラム名
RCA.Activities.Mail.GetIMAPMailMessages
2.説明
Studio バージョン 2.0.2.0まで
クイックアクセス： 「ツールボックス」 > 「メール」 > 「IMAPメールメッセージを取得」
Studio バージョン 2.0.3.0から
クイックアクセス： 「ツールボックス」 > 「メール」 > 「IMAP」 > 「IMAPメールを取得」
指定したメールサーバーからメールを取得します。
※動作を確認したコボットStudioのバージョン：2.1.1.2
※バージョンによって文言などが一部異なる場合がございます
3.プロパティ
| プロパティ項目 | プロパティ名 | 入力欄 | 説明 |
|---|---|---|---|
| オプション | セキュア接続 | ドロップダウン選択 | SSL/TLSの暗号化を使用する場合に指定する。選択肢は「None」「Auto」「SslOnConect」「StartTls」「StartTlsWhenAvailable」の5つ。 |
| メッセージを削除 | チェック項目 | チェックを入れた場合、取得したメッセージのうち既読メッセージを削除する。 | |
| 既読にする | チェック項目 | チェックを入れた場合、取得したメッセージを既読にする。 | |
| 取得件数 | 値を入力（Int32型） | 取得する件数の最大数を設定する。 | |
| 未読メッセージのみ | チェック項目 | チェックを入れると未読メッセージのみ取得する。 | |
| その他 | パブリック | チェック項目 | ログにアクティビティ内の変数と引数がログファイルに書き込まれ、Centerにプッシュされる。（詳細は「プロパティ項目「パブリック」について」を参照） |
| 表示名 | 任意の文字列 | デザイナーパネルのアクティビティ名に反映される。 | |
| ホスト | サーバ | 値を入力（String型） | 取得を行うメールサーバーのホストを設定する。 |
| ポート | 値を入力（Int32型） | 取得を行うメールサーバーのポート番号を設定する。 | |
| メールフォルダ | 値を入力（String型） | 取得を行うメールフォルダを設定する。 | |
| ログオン | パスワード | 値を入力（String型） | アカウントのパスワードを設定する。 |
| メールアカウント | 値を入力（String型） | 取得を行うアカウントを設定する。 | |
| 一般 | タイムアウト | 値を入力（Int32型） | エラーが発生する前に指定した時間（ミリ秒）待機する。 |
| 出力 | メッセージ | 値を入力（List<MailMessage>型） | 取得したメッセージを格納する変数を設定する。 |
4.使い方
「IMAPメールを取得」アクティビティの実際の使用例を元に説明します。
【例】IMAPメールサーバーから全メールを取得し、取得したメールの件数をメッセージボックスに表示する。
セキュリティの観点から一部アクティビティに設定する値をあらかじめ以下のように変数を作成して設定しておきます。変数の作成方法につきましては「変数の作成」をご参照ください。
- 「ホスト > サーバ」：String型変数 Server
- 「ホスト > ポート」：Int32型変数 Port
- 「ログオン > パスワード」：String型変数 Password
- 「ログオン > メールアカウント」：String型変数 Account
「メール」 > 「IMAP」 > 「IMAPメールを取得」アクティビティをドラッグ＆ドロップでデザイナーパネルに配置します。
次にサーバーへの接続設定を行います。以下のプロパティをご自身の環境に合わせて設定してください。
- 「オプション > セキュア接続」
- 「ホスト > サーバ」
- 「ホスト > ポート」
- 「ホスト > メールフォルダ」
- 「ログオン > パスワード」
- 「ログオン > メールアカウント」
※以下の画像は設定例になります。
参考に今回の設定例を以下に記載します。
- 「オプション > セキュア接続」：Auto
- 「ホスト > サーバ」：Server
- 「ホスト > ポート」：Port
- 「ホスト > メールフォルダ」："Inbox"
- 「ログオン > パスワード」：Password
- 「ログオン > メールアカウント」：Account
次にサーバー接続情報以外のプロパティについても設定を行います。「オプション > 未読メッセージのみ」プロパティと「出力 > メッセージ」プロパティをそれぞれ以下のように設定します。
- 未読メッセージのみ：チェックを外す
- メッセージ：List<MailMessage>型変数 ※今回は「GetMessage」を設定し、以後「GetMessage」と記載します。
「コア」 > 「ダイアログ」 > 「メッセージボックス」アクティビティをデザイナーパネルにドラッグ＆ドロップで配置し、「入力 > テキスト」プロパティに「GetMessage.Count.ToString + "件取得しました"」と設定します。
「ホーム > スタート」をクリック、または、「F5キー」押下で実行します。実行すると以下の画像のようにメッセージボックスが表示されます。
※コボットStudio/Agent2.1.1.2現在バグがございます。詳細はこちらをご覧ください。