Search
K

Message

メールやメッセージを送受信するアクションの一覧です。

GmailSend

概要

GmailSendは、GmailのAPIによりメールを送信します。この機能により、利用者は、自分のGmailアカウントからメールを送信することができます。

パラメーター

*は、必須パラメーター
名前
概要
provider*
文字列
送信に使うGmail ConnectionのProvider ID
gmail_**
to*
文字列
メールの送信先アドレス
subject*
文字列
送信するメールの件名
Hello! John!
body*
文字列
送信するメールの本文
Hi John, I'm very happy to send this mail to you.
attachments
文字列
メールに添付するファイルのパス
/tmp/sample.txt
from
文字列
メールの送信元アドレス。使用できるアドレスは、Gmail設定からアカウントに追加済みのアドレス(追加方法はこちらを参照してください)。また、下記「fromを指定する際の注意点」も参照してください。
cc
文字列
CCでの送信先アドレス。複数アドレスの指定や名前付きアドレスの指定も可能です。
一つのアドレスを指定: [email protected] 複数アドレスを指定: [email protected],richa[email protected] 名前付きアドレスを指定: ジェーン<[email protected]>
bcc
文字列
BCCでの送信先アドレス。複数アドレスの指定や名前付きアドレスの指定も可能です。
一つのアドレスを指定: [email protected] 複数アドレスを指定: [email protected],richa[email protected] 名前付きアドレスを指定: ジェーン<[email protected]>
fromを指定する際の注意点
fromに指定したアドレスがアカウントに追加済みのアドレスでなかった場合、GmailコネクションとGmail for Google Workspaceコネクションで挙動が異なります。 追加済みのアドレスを問題なく指定できている場合は、どちらのコネクションでも指定したアドレスから送信されます。
コネクション
fromのアドレスが間違っていた際のアクションの挙動
Gmail for Google Workspace
エラー
Gmail
コネクションで紐づくアカウントのデフォルトアドレスから送信

アウトプット

タイプ
概要
Boolean
真理値
APIのリクエストが、200で返却されたときにtrue
true

使用例

+gmail_send:
action>: GmailSend
provider: 'gmail_e7502c3b8b8147410ce2'
subject: 'Hello! John!'
body: 'Hi John, I\'m very happy to send this mail to you.'
attachments: '/tmp/sample.txt'

GmailGet

概要

GmailGetは、Gmail for Google Workspaceのアカウントからメールを取得するアクションです。

パラメーター

*は、必須パラメーター
名前
概要
query*
文字列
検索条件
from:[email protected] (検索条件の詳細についてはこちら参照してください。)
provider*
文字列
送信に使うGmail for Google Workspace ConnectionのProvider ID
gsmail_**
limit
文字列
取得するメールの上限値
10(default)

アウトプット

タイプ
概要
List
配列
取得したメールオブジェクトの配列
※使用例のアウトプット参照

使用例

+gmail_get_1:
action>: GmailGet
query: 'from:chan-shiro'
provider: gsmail_********************
limit: 10
#=> [
# {
# "id": "1234567890aaaaaa",
# "subject": "ミーティング日程調整",
# "to": "minna <[email protected]>",
# "cc": "aaa <[email protected]>",
# "from": "bbb <[email protected]>",
# "date": "2019-03-14T10:41:09.000Z",
# "body": "ミーティングはXX月XX日XX時開始にしましょう。",
# "html": "<html xmlns=\"http://www.w3.org/1999/xhtml\">\r\n<head>\r\n<title></title>\r\n</head>\r\n<body>\r\n<div name=\"messageBodySection\">\r\n<div dir=\"auto\">ミーティング日程調整</div>\r\n</div>\r\n</body>\r\n</html>\r\n",
# "attachements": [
# {
# "filename": "combine.pdf",
# "contentType": "application/octet-stream",
# "attachmentId": "ANGjdJ8xf--nLYOiblQaphB0PPmxwiHzqWb189HnjTBSsfYaIEDtgYj2ERCLNrDwMw_okMmC6yPCsip0rHRTvzwH7PbjuEd7TPE1mkYHPANdMCd0K8BU9kNEwR0AEKfw8JFPuHlxcTznvBBVlyjXfdMdjtrRSYRKPKwD-sqRZL0mleYM5TARSDLLKFVl0rhlMNFhvnFwUCLQPx_EmrHByTu2iZOQqDFLwF2gPuAvsvz3qc_ZmrCMs6A825NfRcniz0AzcNvDaCEEAMjbrif6hzOVqnaT1wBeBw-uRX9KxiFLquwuxW3-GI6oRROSG5QdzuzuvCUzcaK4vqxCaGzcDil0OjOOgbYBKCEZMXjKpGfeSq416VpQcj4t3YCaO0c8mfjP7MbwkHxmAS7wT8kGUSMI_0icEtmHKuQNwy3dgQ"
# },
# {
# "filename": "添付画像.png",
# "contentType": "image/png",
# "attachmentId": "ANGjdJ9A5SjcD6C0B3vB-DKy5bt7b8FxTPJpnAVwJ7KmtZ3bPRH8vYyM8XbWqUbNGLvGveHo0f4B0ucUiyTTV1zLRRQigFPTTHtdxE4rZodBQQjvQng3Fnyv82Z8H7rlyA2ST8eXP4sEvaWuJy16Gs8qS_QNVME86VLkSllif19xEwddOK3fM2WXmCG8A8kGdOl1W8xHpJ44wAVgzjxn1ah2VbxKbS-HEjx9n-kZ70rtlIKBlRl-5Nhr2MrifV4LtTvSx6Z-14Iw7RmECkB4PC6fHQk7CseD3z6x3aa4oRDygNeAwakSHbYq-FFajw1elYkCfG6b6t8sIEslCvNHERw8J3JiQfdcWE6QSoXkCSsp56xrkAsS4W__iQQ3hxR1iehbMu_h1rPTw4oANJ3R"
# }
# ]
# },...
# ]

GmailGetAttachments

概要

GmailGetAttachmentsは、GmailGetで取得したメールオブジェクトをインプットにして、メールに添付されているファイルをダウンロードフォルダに保存します。

パラメーター

*は、必須パラメーター
名前
概要
mail*
Gmail
メールオブジェクト
GmailGet で取得したリストから GetItemFromList で取得してください。
ignoreError
真偽値
true の場合、Gmailにメールが添付されていなかった例外を無視します。その他の例外はエラーとなります。
false (default)

アウトプット

タイプ
概要
List
配列
ダウンロードしたファイルの情報
※使用例のアウトプット参照
ダウンロードされたファイルは、ダウンロード一覧を取得アクションで確認できます。

使用例

+gmail_get_1:
action>: GmailGet
query: 'from:chan-shiro'
provider: gmail_********************
limit: 10
+get_item_from_list_1:
action>: GetItemFromList
list: +gmail_get_1
index: 0
+gmail_get_attachments_1:
action>: GmailGetAttachments
mail: +get_item_from_list_1
ignoreError: false
#=> [
# [{
# "size": 12025,
# "filename": "添付画像.png",
# "contentType": "image/png",
# "path": "/path/to/添付画像.png"
# }]
+get_download_files_1:
action>: GetDownloadFiles
#=> [
# "/path/to/添付画像.png"
# ]

GmailCreateDraft

概要

GmailCreateDraftは、Gmail for Google Workspaceのアカウントにメールの下書きを作成するアクションです。

パラメーター

*は、必須パラメーター
名前
概要
provider*
文字列
下書き作成に使うGmail for Google Workspace ConnectionのProvider ID
gsmail_**
to
文字列
メールの送信先アドレス
subject
文字列
メールの件名
Hello! John!
body
文字列
メールの本文
Hi John, I'm very happy to send this mail to you.
attachments
文字列
メールに添付するファイルのパス
/tmp/sample.txt
from
文字列
メールの送信元アドレス。使用できるアドレスは、Gmail設定からアカウントに追加済みのアドレス(追加方法はこちらを参照してください)。また、上記「fromを指定する際の注意点」も参照してください。
cc
文字列
CCでの送信先アドレス。複数アドレスの指定や名前付きアドレスの指定も可能です。
一つのアドレスを指定: [email protected] 複数アドレスを指定: [email protected],richa[email protected] 名前付きアドレスを指定: ジェーン<[email protected]>
bcc
文字列
BCCでの送信先アドレス。複数アドレスの指定や名前付きアドレスの指定も可能です。
一つのアドレスを指定: [email protected] 複数アドレスを指定: [email protected],richa[email protected] 名前付きアドレスを指定: ジェーン<[email protected]>

アウトプット

タイプ
概要
Boolean
真理値
APIのリクエストが、200で返却されたときにtrue
true

使用例

+gmail_create_draft:
action>: GmailCreateDraft
provider: 'gsmail_e7502c3b8b8147410ce2'
subject: 'Hello! John!'
body: 'Hi John, I\'m very happy to send this mail to you.'
attachments: '/tmp/sample.txt'

SendSlackMessage

概要

SendSlackMessageは、Slackにメッセージを投稿するアクションです。メッセージにはテキストやファイルやボタン、返信フォームをつけることができます。ボタンにはワークフローを紐づけることができ、Slack上でボタンを押すと紐づけたワークフローが実行されます。また、返信フォームに入力した値をパラメーターとしてワークフローに渡すことができます。

パラメーター

*は、必須パラメーター
名前
概要
provider*
文字列
SlackコネクションのプロバイダーID
slack_**
channel*
文字列
送信先のチャンネル名。プロバイダーIDが入力されている時は、ハンバーガーメニューのSlackのアイコンボタンから選択できます。予めチャンネルにアプリを追加しておく必要があります。
#general
text*
文字列
送信するメッセージ。fileかbuttonsが指定されている場合は、必須ではありません。
Hello,World!
file
文字列
添付ファイル。ファイルは、「ファイルを取得」アクションなどで、ロボット内にダウンロードされている必要があります。
+get_file_1
buttons
配列
ボタン。ボタンにはワークフローを紐づけることができます。Slack上でボタンが押されると、紐づけたワークフローが実行されます。ワークフローを紐付けないことも可能です。その場合にはボタンを押しても、どのワークフローも実行されません。ボタンは複数作成できます。また、色を黒、緑、赤の3色から選択できます。 
[{"type":"button","text":{"type":"plain_text","text":"承認"},"value":"{"workflow_id":3,"response_params":{"val":"〇〇についての承認","response_message":"承認しました"}}","style":"primary"},{"type":"button","text":{"type":"plain_text","text":"否認"},"value":"{"workflow_id":null,"response_params":""}","style":"danger"}]
send_select
真偽値
ボタン送信とセレクト送信の切り替え。trueの場合、Slackにボタンを送信する代わりにセレクトを送信します。
response_message
真偽値
返信メッセージ。trueの場合、Slackに投稿するメッセージに入力フォームが付きます。Slack上でボタンが押された時、そのボタンにワークフローが紐付けられていれば、入力フォームの値をワークフローに渡す事ができます。ただし、 response_message という名前のパラメーターでワークフローに渡されるため、渡したいワークフロー側であらかじめ response_message パラメーターを用意しておく必要があります。押されたボタンにワークフローが紐づいていない場合や、紐づいているワークフローに response_message パラメーターが存在しない場合、入力フォームの値はワークフローに渡りません。 
false (default)

返信メッセージの値をワークフローに渡す方法

ボタンに紐づけるワークフローにあらかじめ パラメーターを用意しておきます。パラメーターの名前は本来は任意ですが、返信メッセージの値をワークフローに渡したい場合には、 response_message という名前にする必要があります。
SendSlackMessage アクションのボタン設定画面では、用意したパラメーターに好きな値を入力することができます。Slack上でボタンが押された時、ここで入力した値がワークフローに渡されます。
response_message パラメーターについては、Slack上で値を書き換える事ができます。
「承認」ボタンを押し、ワークフローを実行した後にログを確認してみると、ボタン作成時に「確認しました」に設定していた response_message パラメーターが、「OKです!」に上書きされてワークフローに渡っていることが確認できます。

アウトプット

タイプ
概要
LIST
配列
JSONレスポンスの配列
※使用例のアウトプット参照

使用例

メッセージのみ送信する場合

# Slackでメッセージを送信
+send_slack_message:
action>: SendSlackMessage
provider: slack_**
channel: '#test'
text: 'Hello, World!'
buttons: []
response_message: false
# =>
# [
# {
# "ok": true,
# "channel": "123456",
# "ts": "1627850307.000100",
# "message": {
# "bot_id": "123456",
# "type": "message",
# "text": "Hello, World!",
# "user": "123456",
# "ts": "1627850307.000100",
# "team": "123456",
# "bot_profile": {
# "id": "123456",
# "deleted": false,
# "name": "AUTORO",
# "updated": 1625819637,
# "app_id": "123456",
# "icons": {
# "image_36": "https://avatars.slack-edge.com/hogehoge.png",
# "image_48": "https://avatars.slack-edge.com/hogehoge.png",
# "image_72": "https://avatars.slack-edge.com/hogehoge.png"
# },
# "team_id": "123456"
# }
# },
# "response_metadata": {
# "scopes": [
# "chat:write",
# "files:write",
# "channels:read"
# ],
# "acceptedScopes": [
# "chat:write"
# ]
# }
# }
# ]

ファイルを添付する場合

# ファイルを取得
+get_file_1:
action>: GetFile
filename: 'rc_hogehoge'
provider: local
# Slackでメッセージを送信
+send_slack_message_1:
action>: SendSlackMessage
provider: slack_**
channel: '#test'
text: 'ファイルを送信する'
file: +get_file_1
buttons: []
response_message: false
# =>
# [
# {
# "ok": true,
# "file": {
# "id": "123456",
# "created": 1627850962,
# "timestamp": 1627850962,
# "name": "test.pdf",
# "title": "test.pdf",
# "mimetype": "application/pdf",
# "filetype": "pdf",
# "pretty_type": "PDF",
# "user": "123456",
# "editable": false,
# "size": 34974,
# "mode": "hosted",
# "is_external": false,
# "external_type": "",
# "is_public": true,
# "public_url_shared": false,
# "display_as_bot": false,
# "username": "",
# "url_private": "https://files.slack.com/files-pri/hoge.pdf",
# "url_private_download": "https://files.slack.com/files-pri/hoge.pdf",
# "media_display_type": "unknown",
# "thumb_pdf": "https://files.slack.com/files-tmb/hoge.png",
# "thumb_pdf_w": 1100,
# "thumb_pdf_h": 619,
# "permalink": "https://autoro-123456.slack.com/files/hoge.pdf",
# "permalink_public": "https://slack-files.com/hoge",
# "comments_count": 0,
# "is_starred": false,
# "shares": {
# "public": {
# "123456": [
# {
# "reply_users": [],
# "reply_users_count": 0,
# "reply_count": 0,
# "ts": "1627850963.000400",
# "channel_name": "test",
# "team_id": "123456",
# "share_user_id": "123456"
# }
# ]
# }
# },
# "channels": [
# "123456"
# ],
# "groups": [],
# "ims": [],
# "has_rich_preview": false
# },
# "response_metadata": {
# "scopes": [
# "chat:write",
# "files:write",
# "channels:read"
# ],
# "acceptedScopes": [
# "files:write"
# ]
# }
# }
# ]

ファイルとボタンと返信メッセージを付与する場合

# ファイルを取得
+get_file_1:
action>: GetFile
filename: 'rc_hogehoge'
provider: local
# Slackでメッセージを送信
+send_slack_message_1:
action>: SendSlackMessage
provider: slack_**
channel: '#動作確認'
text: 'ボタンと返信メッセージ付き'
file: +get_file_1
buttons: [{"type":"button","text":{"type":"plain_text","text":"承認"},"value":"{\"workflow_id\":3,\"response_params\":{\"val\":\"あなた\",\"response_message\":\"確認しました\"}}","style":"primary"},{"type":"button","text":{"type":"plain_text","text":"否認"},"value":"{\"workflow_id\":null,\"response_params\":\"\"}","style":"danger"}]
response_message: true
# =>
# [
# {
# "ok": true,
# "file": {
# "id": "123456",
# "created": 1627852017,
# "timestamp": 1627852017,
# "name": "text.pdf",
# "title": "test.pdf",
# "mimetype": "application/pdf",
# "filetype": "pdf",
# "pretty_type": "PDF",
# "user": "123456",
# "editable": false,
# "size": 34974,
# "mode": "hosted",
# "is_external": false,
# "external_type": "",
# "is_public": true,
# "public_url_shared": false,
# "display_as_bot": false,
# "username": "",
# "url_private": "https://files.slack.com/files-pri/hoge.pdf",
# "url_private_download": "https://files.slack.com/files-pri/hoge.pdf",
# "media_display_type": "unknown",
# "thumb_pdf": "https://files.slack.com/files-tmb/hoge.png",
# "thumb_pdf_w": 1100,
# "thumb_pdf_h": 619,
# "permalink": "https://autoro-123456.slack.com/files/hoge.pdf",
# "permalink_public": "https://slack-files.com/hoge",
# "comments_count": 0,
# "is_starred": false,
# "shares": {
# "public": {
# "123456": [
# {
# "reply_users": [],
# "reply_users_count": 0,
# "reply_count": 0,
# "ts": "1627852018.001200",
# "channel_name": "test",
# "team_id": "123456",
# "share_user_id": "123456"
# }
# ]
# }
# },
# "channels": [
# "123456"
# ],
# "groups": [],
# "ims": [],
# "has_rich_preview": false
# },
# "response_metadata": {
# "scopes": [
# "chat:write",
# "files:write",
# "channels:read"
# ],
# "acceptedScopes": [
# "files:write"
# ]
# }
# },
# {
# "ok": true,
# "channel": "123456",
# "ts": "1627852018.001500",
# "message": {
# "bot_id": "123456",
# "type": "message",
# "text": "slack_**",
# "user": "123456",
# "ts": "1627852018.001500",
# "team": "123456",
# "bot_profile": {
# "id": "123456",
# "deleted": false,
# "name": "AUTORO",
# "updated": 1625819637,
# "app_id": "123456",
# "icons": {
# "image_36": "https://avatars.slack-edge.com/hoge.png",
# "image_48": "https://avatars.slack-edge.com/hoge.png",
# "image_72": "https://avatars.slack-edge.com/hoge.png"
# },
# "team_id": "hoge"
# },
# "blocks": [
# {
# "type": "section",
# "block_id": "abc",
# "text": {
# "type": "mrkdwn",
# "text": "ボタンと返信メッセージ付き",
# "verbatim": false
# }
# },
# {
# "type": "input",
# "block_id": "def",
# "label": {
# "type": "plain_text",
# "text": " ",
# "emoji": true
# },
# "optional": false,
# "dispatch_action": false,
# "element": {
# "type": "plain_text_input",
# "action_id": "plain_text_input-action",
# "dispatch_action_config": {
# "trigger_actions_on": [
# "on_enter_pressed"
# ]
# }
# }
# },
# {
# "type": "actions",
# "block_id": "ghi",
# "elements": [
# {
# "type": "button",
# "action_id": "jkl",
# "text": {
# "type": "plain_text",
# "text": "承認",
# "emoji": true
# },
# "style": "primary",
# "value": "\"{\\\"workflow_id\\\":3,\\\"response_params\\\":{\\\"val\\\":\\\"あなた\\\",\\\"response_message\\\":\\\"確認しました\\\"}}\""
# },
# {
# "type": "button",
# "action_id": "mno",
# "text": {
# "type": "plain_text",
# "text": "否認",
# "emoji": true
# },
# "style": "danger",
# "value": "\"{\\\"workflow_id\\\":null,\\\"response_params\\\":\\\"\\\"}\""
# }
# ]
# }
# ]
# },
# "response_metadata": {
# "scopes": [
# "chat:write",
# "files:write",
# "channels:read"
# ],
# "acceptedScopes": [
# "chat:write"
# ]
# }
# }
# ]

GetChatworkMessages

概要

GetChatworkMessages は、Chatwork のルームからメッセージを取得するアクションです。 force パラメータを設定することで、メッセージの取得方法を指定することができます。

パラメーター

*は、必須パラメーター
名前
概要
provider*
文字列
プロバイダーID
chatwork_**
room_id*
文字列
メッセージを取得するルームID。プロバイダーIDが入力されている時は、chatworkのアイコンボタンから選択できます。
1234567890
force
真偽値
未取得にかかわらず最新の100件を取得するか。trueの場合、未取得にかかわらず最新の100件を取得します。falseの場合、未読のメッセージのみ取得します。未読のメッセージがない場合は、空文字が返却されます。デフォルトは false です。
false

ルームIDの取得方法

Chatwork にて送信先のルームを開きます。URLの「#!rid」より後の数字がルームIDです。

取得数について

Chatwork の契約プランがフリープランの場合、取得できるメッセージ数には制限があります。詳細はこちら

アウトプット

タイプ
概要
JSON
オブジェクト
JSONレスポンス
※使用例のアウトプット参照

使用例

# Chatworkからメッセージを取得
# +get_chatwork_messages_1:
# action>: GetChatworkMessages
# provider: chatwork_**
# room_id: 1234567890
# force: false
# =>
# [ { message_id: '1234567890',
# account:
# { account_id: 123456,
# name: '山田 太郎',
# avatar_image_url: 'https://appdata.chatwork.com/avatar/ico_default_green.png' },
# body: 'Hello Charwork! read',
# send_time: 1576740683,
# update_time: 0
# },
# ....
# ]

SendChatworkMessage

概要

SendChatworkMessage は、Chatwork アカウントからメッセージを送信するアクションです。指定したルームにメッセージを送信します。self_unread パラメータを設定することで、追加したメッセージを自分から見て未読とするか既読とするかを選択できます。

パラメーター

*は、必須パラメーター
名前
概要
provider*
文字列
プロバイダーID
chatwork_**
room_id*
文字列
送信先のルームID。プロバイダーIDが入力されている時は、chatworkのアイコンボタンから選択できます。
1234567890
body*
文字列
メッセージ本文
Hello Chatwork!
file
文字列
添付ファイル。ファイルは、「ファイルを取得」アクションなどで、ロボット内にダウンロードされている必要があります。添付ファイルを送る場合、メッセージ本文は任意となります。
+get_file_1
self_unread
真偽値
追加したメッセージを自分から見て未読とするか。true の場合は未読、false の場合は既読となります。デフォルトは false(既読)です。添付ファイルを送る場合、自動的にfalseとなります。
false

ルームIDの取得方法

Chatwork にて送信先のルームを開きます。URLの「#!rid」より後の数字がルームIDです。

アウトプット

タイプ
概要
JSON
オブジェクト
JSONレスポンス
※使用例のアウトプット参照

使用例

メッセージのみ送信する場合

# Chatworkにメッセージを送信
+send_chatwork_message_1:
action>: SendChatworkMessage
provider: chatwork_**
room_id: 1234567890
body: 'Hello Chatwork!'
self_unread: false
# =>
# {
# "message_id": "1234567890"
# }

添付ファイルを送信する場合

# Chatworkにメッセージを送信
+send_chatwork_message_1:
action>: SendChatworkMessage
provider: chatwork_**
room_id: 1234567890
body: 'Hello Chatwork!'
file: +get_file_1
# =>
# {
# "message_id": "1234567890"
# }

OutlookSend

概要

OutlookSendは、Outlookアカウントからメールを送信するアクションです。

パラメーター

*は、必須パラメーター
名前
概要
provider*
文字列
OutlookコネクションのProvider ID
outlook_**
to*
文字列
メールの送信先アドレス
subject*
文字列
送信するメールの件名
Hello! John!
body*
文字列
送信するメールの本文
Hi John, I'm very happy to send this mail to you.
attachment
文字列
メールに添付するファイルのパス
一つのファイルを指定: +get_file_1 複数のファイルを指定: ["+get_file_1","+get_file_2"]
cc
文字列
CC での送信先アドレス。複数アドレスの指定も可能です。
一つのアドレスを指定: [email protected] 複数アドレスを指定: [email protected], [email protected]
bcc
文字列
BCC での送信先アドレス。複数アドレスの指定も可能です。
一つのアドレスを指定: [email protected] 複数アドレスを指定: [email protected], [email protected]

アウトプット

タイプ
概要
Boolean
真理値
メール送信に成功したときにtrue
true

使用例

+outlook_send:
action>: OutlookSend
provider: 'outlook_e7502c3b8b8147410ce2'
subject: 'Hello! John!'
body: 'Hi John, I\'m very happy to send this mail to you.'
attachment: '/tmp/sample.txt'

OutlookGet

概要

OutlookGetは、Outlookアカウントからメールを取得するアクションです。

パラメーター

*は、必須パラメーター