list_emails
メール · macOS
効果: 読み取り. 状態: 条件付き提供.
「条件付き提供」は、バージョン、プラットフォーム、権限、アカウント、設定に依存する可能性を示し、すべての環境で有効という意味ではありません。
macOS
目的
ユーザーがこの Mac の受信トレイ(Apple Mail、つまり Mail.app に追加された iCloud、Gmail、IMAP、Exchange の各アカウント)を表示または整理したい場合に使用します。メールのヘッダー(件名、送信者、日付、未読状態)を一覧表示し、本文全体には read_email(message_id) を呼び出します。Mail.app に追加されていない Microsoft 365 メールボックスには m365_list_emails を使用します。重要: アカウントが2つ以上あるマシンでは、list_email_accounts で得た account=<name> を指定してください。指定せず、高速インデックスで回答できない場合、list_emails は全アカウントを走査せずアカウント一覧を返します。1回で全アカウントを走査すると時間制限がなく、他の要求でも Mail をブロックする可能性があるためです(#2268)。アカウントが1つだけなら影響しません。ページネーションに対応し、offset で結果をページ送りできます(例: limit=20 で2ページ目は offset=20)。limit は1回あたり最大50(既定値20)なので、さらに読む場合は大きな limit を要求せず offset を使ってください。
必須入力
このプラットフォームのスキーマには必須入力が宣言されていません。任意の選択項目や実行要件が存在する場合があります。
権限と確認
スキーマには明示的な確認パラメータがありません。これは無許可の操作を認めるものではありません。効果を確認し、承認を得てください。
- このプラットフォームでは、ユーザーが許可したアプリ、アカウント、リソースだけを使用してください。接続と権限の要件については、このツールのプラットフォーム固有の説明を参照してください。このカタログは、追加の OAuth スコープや OS 権限があるとは主張しません。
英語の正規技術スキーマ — macOS
{
"properties": {
"account": {
"description": "Mail.app account name (from list_email_accounts). On a Mac with 2+ accounts, passing it is much faster than letting the walk cover all of them.",
"type": "string"
},
"limit": {
"default": "20",
"description": "How many messages to return, 0-50 (0 returns none). Defaults to 20.",
"maximum": 50,
"minimum": 0,
"type": "integer"
},
"mailbox": {
"description": "Folder to list, by name (see list_email_folders). Defaults to the Inbox.",
"type": "string"
},
"offset": {
"default": "0",
"description": "How many messages to skip before returning, for paging through a folder. Defaults to 0.",
"minimum": 0,
"type": "integer"
},
"unread_only": {
"default": "false",
"description": "Return only unread messages. Defaults to false.",
"type": "boolean"
}
},
"type": "object"
}ドキュメント例
list_emails のドキュメント例です。この例は実行しないでください。表示される引数は架空のデータセットに属します。実際に呼び出す前に実在する識別子を確認し、承認を得てください。
{
"limit": 5
}