mirror of
https://github.com/larksuite/cli.git
synced 2026-07-03 14:02:43 +08:00
693e299589
* docs(mail): clarify message read shortcuts Update mail read shortcut help, docs, and triage guidance so single-message and multi-message reads are routed to the right commands. Add focused tests for help text, dry-run copy, triage stderr hints, and batch_get chunking behavior. sprint: S1 * docs(mail): align batch_get limit with gateway config * docs(mail): use shell-safe batch message id examples * docs(mail): trim batch_get pagination wording * docs(mail): use placeholder style for message ids * docs(mail): hide batch_get internals from help
59 lines
2.5 KiB
Go
59 lines
2.5 KiB
Go
// Copyright (c) 2026 Lark Technologies Pte. Ltd.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package mail
|
|
|
|
import (
|
|
"context"
|
|
|
|
"github.com/larksuite/cli/shortcuts/common"
|
|
)
|
|
|
|
// MailMessage is the `+message` shortcut: fetch full content of one email
|
|
// by one message ID (normalized body + attachments / inline metadata).
|
|
var MailMessage = common.Shortcut{
|
|
Service: "mail",
|
|
Command: "+message",
|
|
Description: "Use only when reading full content for one email by one message ID. For multiple message IDs, use mail +messages; do not loop mail +message. Returns normalized body content plus attachments metadata, including inline images.",
|
|
Risk: "read",
|
|
Scopes: []string{"mail:user_mailbox.message:readonly", "mail:user_mailbox.message.address:read", "mail:user_mailbox.message.subject:read", "mail:user_mailbox.message.body:read"},
|
|
AuthTypes: []string{"user", "bot"},
|
|
HasFormat: true,
|
|
Flags: []common.Flag{
|
|
{Name: "mailbox", Default: "me", Desc: "email address (default: me)"},
|
|
{Name: "message-id", Desc: "Required. Single email message ID only. For multiple IDs, use mail +messages --message-ids.", Required: true},
|
|
{Name: "html", Type: "bool", Default: "true", Desc: "Whether to return HTML body (false returns plain text only to save bandwidth)"},
|
|
{Name: "print-output-schema", Type: "bool", Desc: "Print output field reference (run this first to learn field names before parsing output)"},
|
|
},
|
|
Validate: func(ctx context.Context, runtime *common.RuntimeContext) error {
|
|
return validateBotMailboxNotMe(runtime)
|
|
},
|
|
DryRun: func(ctx context.Context, runtime *common.RuntimeContext) *common.DryRunAPI {
|
|
mailboxID := resolveMailboxID(runtime)
|
|
messageID := runtime.Str("message-id")
|
|
return common.NewDryRunAPI().
|
|
Desc("Fetch full email content and attachments metadata, including inline images").
|
|
GET(mailboxPath(mailboxID, "messages", messageID))
|
|
},
|
|
Execute: func(ctx context.Context, runtime *common.RuntimeContext) error {
|
|
if runtime.Bool("print-output-schema") {
|
|
printMessageOutputSchema(runtime)
|
|
return nil
|
|
}
|
|
mailboxID := resolveMailboxID(runtime)
|
|
hintIdentityFirst(runtime, mailboxID)
|
|
messageID := runtime.Str("message-id")
|
|
html := runtime.Bool("html")
|
|
|
|
msg, err := fetchFullMessage(runtime, mailboxID, messageID, html)
|
|
if err != nil {
|
|
return mailDecorateProblemMessage(err, "failed to fetch email")
|
|
}
|
|
|
|
out := buildMessageOutput(msg, html)
|
|
runtime.Out(out, nil)
|
|
maybeHintReadReceiptRequest(runtime, mailboxID, messageID, msg)
|
|
return nil
|
|
},
|
|
}
|