Microsoft Outlook コネクタのメソッド

  • リリースバージョン: Xanadu
  • 更新日 2024年08月01日
  • 所要時間:13分
  • Microsoft Outlook コネクタのメソッドは、Microsoft Outlook に対してさまざまなアクションを自動化します。自動化フローでは、メソッドは他のメソッドやコンポーネントに接続されます。メソッドを使用するには、まずメソッドを公開する必要があります。

    Microsoft Outlook コネクタを使用すると、Microsoft Outlook アプリケーション内の日常的なタスクを自動化し、これらの機能をより広範な自動ワークフローに統合できます。

    メールの送信や返信などのプロセスを手動介入なしで自動化できます。このコネクタは、 Microsoft Outlook 内のアクションの自動化を促進するためのさまざまな方法を提供します。これらのメソッドは、自動化フレームワーク内の他のメソッドやコンポーネントとシームレスに組み合わせることができるため、より複雑で効率的なワークフロー設計が可能になります。

    AddFolder

    指定した階層内に新しいフォルダーを追加し、必要に応じてサブフォルダーを Outlook アカウントセットに追加します。

    表 : 1. AddFolder メソッドのパラメーター
    パラメーター 説明 データポートタイプ データタイプ
    MainFolder メソッドが Outlook アカウントに追加するフォルダの名前です。

    このパラメータは、新しいフォルダが追加されるメインフォルダを指定します。

    データ入力 文字列
    SubFolderName メソッドがメインフォルダの下に追加するサブフォルダの名前です。

    このパラメーターは、作成する新しいフォルダーの名前を指定します。

    このパラメーターを使用する場合は、IsSubFolder パラメーターを使用する必要があります。

    データ入力 文字列
    IsSubFolder SubFolderName パラメーターで作成されたフォルダがメインフォルダの下にあるサブフォルダであることを示すオプションです。

    このパラメーターは、SubFolderName をメインフォルダー内のサブフォルダーとして追加する必要があるかどうかを示します。既定値は False で、SubFolderName はメイン フォルダーの直下に追加されます。

    データ入力 ブーリアン

    クローズ

    プロファイル名を指定して、 Microsoft Outlook エクスプローラーを閉じます。

    このメソッドは、すべての自動化タスクが完了した後のクリーンアップアクティビティとして使用できます。

    表 : 2. Close メソッドのパラメーター
    パラメーター 説明 データポートタイプ データタイプ
    プロファイル名 このパラメーターは、閉じる Outlook プロファイル名を指定します。 データ入力 文字列

    DeleteFolder

    指定されたフォルダとその下にあるすべてのサブフォルダを削除します。

    表 : 3. DeleteFolder メソッドのパラメーター
    パラメーター 説明 データポートタイプ データタイプ
    FolderName メソッドが削除するフォルダの名前。 データ入力 文字列

    DeleteMail

    1 件または複数件のメールを削除します。一意のエントリー ID に基づいてメールを削除します。
    ヒント:
    GetMails メソッドを使用して、DeleteMail メソッドで削除するメールを指定します。
    表 : 4. DeleteMail メソッドのパラメーター
    パラメーター 説明 データポートタイプ データタイプ
    MailId メソッドがメールを削除するメールを取得します。

    このパラメーターは、削除する必要があるメールの一意のエントリー ID を指定します。

    データ入力 文字列

    ForwardMail

    一意のエントリー ID に基づいて、指定されたメールアドレス (EmailID) にメールを転送します。

    表 : 5. ForwardMail メソッドのパラメーター
    パラメーター 説明 データポートタイプ データタイプ
    MailId このパラメーターは、転送する必要があるメールの一意のエントリー ID を指定します。 データ入力 文字列
    メール ID このパラメーターは、メールの転送先メールアドレスを指定します。 データ入力 文字列
    CC このパラメーターは、転送されたメールのカーボンコピー (CC) を送信するメールアドレスを指定します。 データ入力 文字列
    BCC このパラメーターは、転送されたメールのブラインドカーボンコピー (BCC) を送信するメールアドレスを指定します。 データ入力 文字列
    [件名] このパラメーターは、転送されるメールの件名を指定します。 データ入力 文字列
    Return このメソッドは、メールが正常に転送されたかどうかを示すブール値を返します。

    戻り値 true は、操作が成功したことを示します。

    データ出力 ブーリアン

    GetAttachmentName

    一意のエントリー ID で指定されたメールに関連付けられている添付ファイル名のリストを取得します。

    表 : 6. GetAttachmentNames メソッドのパラメーター
    パラメーター 説明 データポートタイプ データタイプ
    MailId このパラメーターは、添付ファイル名を取得するメールの一意のエントリー ID を指定します。 データ入力 文字列

    既存アカウントの取得

    設定されたアカウントとその数のリストなど、設定されたアカウントに関する情報を取得します。

    これは、Outlook で複数のアカウントが構成されている場合に役立ちます。

    表 : 7. GetExistingAccounts メソッドのパラメーター
    パラメーター 説明 データポートタイプ データタイプ
    アカウント このパラメーターは参照によって渡され、List (Of String) であることが想定されます。このメソッドを呼び出すと、構成されたアカウント名のリストが入力されます。 データ出力 リスト 1
    カウント このパラメーターは参照によって渡されます。このメソッドを呼び出すと、このパラメーターに構成されたアカウントの数が入力されます。 データ出力 Int32

    GetFolderName

    アクティブな Outlook アカウントからフォルダー名のリストを取得して返します。

    表 : 8. GetFolderNames メソッドのパラメーター
    パラメーター 説明 データポートタイプ データタイプ
    Return アクティブな Outlook アカウントからフォルダー名のリストを返します。 データ出力 リスト 1

    メールを取得

    一意のエントリー ID (MailId) で指定されたメールのすべての詳細を取得します。

    メールのすべての詳細を取得するための追加の条件を指定するには、GetMail メソッドバーでメソッド設定アイコン ( メソッド設定アイコン)をクリックし、CC、BCC、件名、本文、送信者、宛先、AttachmentsCount、ReceivedTime、EntryId などの必要なメールアイテムを選択します。

    表 : 9. GetMail メソッドのパラメーター
    パラメーター 説明 データポートタイプ データタイプ
    MailId このパラメーターは、詳細を取得するメールの一意のエントリー ID を指定します。 データ入力 文字列

    GetMails

    メールシステム内の指定されたフォルダーからメールエントリー ID のリストを取得します。

    GetMails メソッドは、電子メール システム内の指定されたフォルダーからメール エントリ ID の一覧を取得します。

    表 : 10. GetMails メソッドのパラメーター
    パラメーター 説明 データポートタイプ データタイプ
    FolderName このパラメータは、メールエントリ ID を取得するフォルダの名前を指定します。

    デフォルト値は「受信トレイ」です。

    データ入力 文字列
    フィルター このパラメーターは、メールエントリー ID を取得するときに適用するフィルター条件を指定します。 データ入力 文字列
    メールの数 このパラメーターは、取得するメールエントリ ID の最大数を指定します。デフォルト値は 10 です。 データ入力 Int32
    未読のみ このパラメータは、未読メールのみを取得するか (True)、すべてのメールを取得するか (False) を示します。既定値は True です。 データ入力 ブーリアン
    AvoidMeetingItem このパラメーターは、取得したメールエントリ ID から会議アイテムを除外するかどうかを指定します。既定値は True です。 データ入力 ブーリアン
    FetchingOrder このパラメータは、メールがフェッチされる順序を指定します。たとえば、FIFO、LIFO などです。デフォルトはFIFOです。 データ入力 FetchingOrder
    Return このパラメーターは、指定されたフォルダーからのメールのリストを返します。 データ出力 リスト 1
    カウント このパラメーターは、取得されるメールエントリ ID の合計数を指定します。 データ出力 Int32

    GetSenderName

    一意のエントリー ID で指定されたメールに関連付けられている送信者のメールアドレスを取得します。

    表 : 11. GetSenderName メソッドのパラメーター
    パラメーター 説明 データポートタイプ データタイプ
    MailId このパラメーターは、送信者のメールアドレスを取得するメールの一意のエントリー ID を指定します。 データ入力 文字列
    Return このメソッドは、送信者名を示す文字列値を返します。 データ出力 文字列

    MarkAsRead

    一意のエントリー ID に基づいてメールを既読としてマークします。

    表 : 12. MarkAsRead メソッドのパラメーター
    パラメーター 説明 データポートタイプ データタイプ
    MailId このパラメーターは、送信者のメールアドレスを取得するメールの一意のエントリー ID を指定します。 データ入力 文字列
    Return このメソッドは、メールが既読として正常にマークされたかどうかを示すブール値を返します。

    戻り値 true は、操作が成功したことを示します。

    データ出力 ブーリアン

    MarkAsUnread

    一意のエントリー ID に基づいてメールを未読としてマークします。

    表 : 13. MarkAsUnread メソッドのパラメーター
    パラメーター 説明 データポートタイプ データタイプ
    MailId このパラメーターは、未読としてマークする必要があるメールの一意のエントリー ID を指定します。 データ入力 文字列
    Return このメソッドは、メールが正常に未読としてマークされたかどうかを示すブール値を返します。

    戻り値 true は、操作が成功したことを示します。

    データ出力 ブーリアン

    ムーブメール

    一意のエントリー ID に基づいて、メールシステム内のフォルダー間でメールを移動します。

    表 : 14. MoveMail メソッドのパラメーター
    パラメーター 説明 データポートタイプ データタイプ
    MailId このパラメーターは、移動する必要があるメールの一意のエントリー ID を指定します。 データ入力 文字列
    宛先フォルダー このパラメーターは、メールの移動先フォルダーの名前またはパスを指定します。 データ入力 文字列

    ReadMsgFile

    ファイルシステムから .msg ファイルの内容を読み取ります。

    表 : 15. ReadMsgFile メソッドのパラメーター
    パラメーター 説明 データポートタイプ データタイプ
    Filepath このパラメーターは、読み込む必要がある.msgファイルへのパスを指定します。 データ入力 文字列
    本文 このパラメーターは参照 (ByRef) によって渡され、メソッド呼び出し後に .msg ファイルの本文の内容が設定されます。 データ出力 文字列

    返信

    一意のエントリー ID で指定されたメールに返信して送信します。

    表 : 16. Reply メソッドのパラメーター
    パラメーター 説明 データポートタイプ データタイプ
    IsHtmlBody このパラメーターは、返信メールの本文コンテンツが HTML 形式であるかどうかを示します。

    デフォルトは False です。

    データ入力 ブーリアン
    Return このメソッドは、応答が正常に送信されたかどうかを示すブール値を返します。

    戻り値 true は、操作が成功したことを示します。

    データ出力 ブーリアン

    SaveAllAttachments

    一意のエントリー ID で指定されたメールのすべての添付ファイルを、指定したフォルダーパスに保存します。

    表 : 17. SaveAllAttachments メソッドのパラメーター
    パラメーター 説明 データポートタイプ データタイプ
    MailId このパラメーターは、添付ファイルを保存する必要があるメールの一意のエントリ ID を指定します。 データ入力 文字列
    FolderPath このパラメーターは、添付ファイルを保存する必要があるフォルダーのパスを指定します。 データ入力 文字列

    添付ファイルの保存

    指定されたエントリー ID を持つメールの指定された添付ファイルを指定されたファイルに保存します。

    表 : 18. SaveAttachment メソッドのパラメーター
    パラメーター 説明 データポートタイプ データタイプ
    MailId このパラメーターは、添付ファイルの保存元となるメールの一意のエントリー ID を指定します。 データ入力 文字列
    添付ファイル名 このパラメーターは、保存する必要がある添付ファイルの名前を指定します。 データ入力 文字列
    Filepath このパラメーターは、添付ファイルを保存する必要があるファイルのパスを指定します。 データ入力 文字列

    メールを保存

    一意のエントリー ID (MailId) で指定されたメールを、指定されたファイル パスのファイルに保存します。

    表 : 19. SaveMail メソッドのパラメーター
    パラメーター 説明 データポートタイプ データタイプ
    MailId このパラメーターは、保存するメールの一意のエントリー ID を指定します。 データ入力 文字列
    Filepath このパラメーターは、メールをファイルとして保存する必要があるパスを指定します データ入力 文字列
    保存タイプ このパラメーターは、メールを保存する際の形式を指定します。

    既定値は MsgSaveType.olMSG で、Microsoft Outlook MSG 形式を示します。

    データ入力 MsgSaveType

    SendMail

    受信者にメールを送信します。画像の追加、送信者のアドレスの設定、CCおよびBCC受信者の指定など、メールをカスタマイズするためのさまざまなオプションのパラメーターを提供します。

    表 : 20. SendMail メソッドのパラメーター
    パラメーター 説明 データポートタイプ データタイプ
    ToEmailId このパラメーターは、受信者のメールアドレスを指定します。 データ入力 文字列
    画像 このパラメーターは、メールに含めるオプションの画像を指定します。 データ入力 Drawing.Bitmap
    送信元 このパラメーターは、送信者のメールアドレスを指定します。指定しない場合は、デフォルトの送信者のアドレスが使用されます。 データ入力 文字列
    CC このパラメーターは、カーボンコピー (CC) の送信先のメールアドレスを指定します。 データ入力 文字列
    BCC このパラメーターは、ブラインドカーボンコピー (BCC) の送信先のメールアドレスを指定します。 データ入力 文字列
    [件名] このパラメーターは、メールの件名を指定します。 データ入力 文字列
    本文 このパラメーターは、メールの本文の内容を指定します。 データ入力 文字列
    添付ファイル このパラメーターは、メールに含める添付ファイルのファイルパスを指定します。複数のファイルはセミコロンで区切ることができます。 データ入力 文字列
    IsHtmlBody このパラメーターは、メールの本文が HTML 形式であるかどうかを示します。デフォルトは False です。 データ入力 ブーリアン
    Return このメソッドは、メールが正常に送信されたかどうかを示すブール値を返します。

    戻り値 true は、操作が成功したことを示します。

    データ出力 ブーリアン

    送信側

    別のメールアカウントの代わりにメールを送信します。

    表 : 21. SentAs メソッドのパラメーター
    パラメーター 説明 データポートタイプ データタイプ
    ToEmailId このパラメーターは、受信者のメールアドレスを指定します。 データ入力 文字列
    SentOnBehalfEmailID このパラメーターは、代わりにメールが送信されるメールアドレスを指定します。 データ入力 文字列
    [件名] このパラメーターは、メールの件名を指定します。 データ入力 文字列
    本文 このパラメーターは、メールの本文の内容を指定します。 データ入力 文字列
    添付ファイル このパラメーターは、メールに含める添付ファイルのファイルパスを指定します。 データ入力 文字列
    IsHtmlBody このパラメーターは、メールの本文が HTML 形式であるかどうかを示します。デフォルトは False です。 データ入力 ブーリアン

    SetAccount

    自動化タスクの操作を実行する Outlook アカウントを指定します。

    SetAccount メソッドは、このコネクタの他のメソッドの前に、最初に使用して、後続のメソッドを実行するコンテキストまたは電子メールアカウントを指定または設定する必要があります。

    表 : 22. SetAccount メソッドのパラメーター
    パラメーター 説明 データポートタイプ データタイプ
    AccountName このパラメーターは、操作を実行する Outlook メールアカウント ID を指定します。 データ入力 文字列