feishu.agent.toolkit.mail
¶
邮箱工具工厂:列邮件、读邮件、总结邮件、发邮件。详见 feishu.agent.toolkit。
list_mail_messages
¶
list_mail_messages(*, description: str, name: str = 'list_mail_messages', auth_scopes: Sequence[str] = ()) -> Tool
读类工厂:列出当前用户邮箱中的邮件 ID,返回一个 feishu.agent.tools.Tool。
工具始终以请求用户身份访问固定邮箱 "me",不会让模型指定任意 user_mailbox_id。
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
|
str
|
工具描述(产品本地化文案)。 |
必需 |
|
str
|
工具名。默认为 |
'list_mail_messages'
|
|
Sequence[str]
|
缺少授权时申请的飞书邮箱权限范围。 |
()
|
返回:
| 类型 | 描述 |
|---|---|
Tool
|
示例:
| Python Console Session | |
|---|---|
源代码位于: feishu/agent/toolkit/mail.py
search_mail_messages
¶
search_mail_messages(*, description: str, name: str = 'search_mail_messages', auth_scopes: Sequence[str] = ()) -> Tool
读类工厂:搜索当前用户邮箱中的邮件,返回一个 feishu.agent.tools.Tool。
搜索范围固定为请求用户邮箱 "me";过滤条件直接透传给飞书邮箱 search 接口。
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
|
str
|
工具描述(产品本地化文案)。 |
必需 |
|
str
|
工具名。默认为 |
'search_mail_messages'
|
|
Sequence[str]
|
缺少授权时申请的飞书邮箱权限范围。 |
()
|
返回:
| 类型 | 描述 |
|---|---|
Tool
|
示例:
| Python Console Session | |
|---|---|
源代码位于: feishu/agent/toolkit/mail.py
get_mail_message
¶
get_mail_message(*, description: str, name: str = 'get_mail_message', auth_scopes: Sequence[str] = ()) -> Tool
读类工厂:读取当前用户邮箱中的一封邮件详情,返回一个 feishu.agent.tools.Tool。
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
|
str
|
工具描述(产品本地化文案)。 |
必需 |
|
str
|
工具名。默认为 |
'get_mail_message'
|
|
Sequence[str]
|
缺少授权时申请的飞书邮箱权限范围。 |
()
|
返回:
| 类型 | 描述 |
|---|---|
Tool
|
示例:
| Python Console Session | |
|---|---|
源代码位于: feishu/agent/toolkit/mail.py
summarize_mail_message
¶
summarize_mail_message(*, description: str, text_summarizer: Callable[..., Any] | None, name: str = 'summarize_mail_message', auth_scopes: Sequence[str] = (), max_body_chars: int = 4000, max_summary_chars: int = 2000) -> Tool
读类工厂:读取并总结当前用户邮箱中的一封邮件,返回一个 feishu.agent.tools.Tool。
邮件全文只交给注入的快速文本摘要器,主模型只收到摘要和元数据。
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
|
str
|
工具描述(产品本地化文案)。 |
必需 |
|
Callable[..., Any] | None
|
纯文本摘要器,通常由 fast/flash 模型提供。 |
必需 |
|
str
|
工具名。默认为 |
'summarize_mail_message'
|
|
Sequence[str]
|
缺少授权时申请的飞书邮箱权限范围。 |
()
|
|
int
|
传给摘要器的单封邮件正文最大字符数。 |
4000
|
|
int
|
摘要最大字符数。 |
2000
|
返回:
| 类型 | 描述 |
|---|---|
Tool
|
示例:
| Python Console Session | |
|---|---|
源代码位于: feishu/agent/toolkit/mail.py
| Python | |
|---|---|
237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 | |
summarize_mail_messages
¶
summarize_mail_messages(*, description: str, text_summarizer: Callable[..., Any] | None, name: str = 'summarize_mail_messages', auth_scopes: Sequence[str] = (), default_max_items: int = 10, max_items_limit: int = 20, max_body_chars: int = 4000, max_summary_chars: int = 2000) -> Tool
读类工厂:读取并总结当前用户邮箱中的多封邮件,返回一个 feishu.agent.tools.Tool。
未显式给出 message_ids 时,工具会按筛选条件读取最近邮件再汇总。
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
|
str
|
工具描述(产品本地化文案)。 |
必需 |
|
Callable[..., Any] | None
|
纯文本摘要器,通常由 fast/flash 模型提供。 |
必需 |
|
str
|
工具名。默认为 |
'summarize_mail_messages'
|
|
Sequence[str]
|
缺少授权时申请的飞书邮箱权限范围。 |
()
|
|
int
|
未指定数量时默认总结的邮件数。 |
10
|
|
int
|
单次可总结邮件数上限。 |
20
|
|
int
|
传给摘要器的单封邮件正文最大字符数。 |
4000
|
|
int
|
摘要最大字符数。 |
2000
|
返回:
| 类型 | 描述 |
|---|---|
Tool
|
示例:
| Python Console Session | |
|---|---|
源代码位于: feishu/agent/toolkit/mail.py
| Python | |
|---|---|
329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 | |
list_mail_folders
¶
list_mail_folders(*, description: str, name: str = 'list_mail_folders', auth_scopes: Sequence[str] = ()) -> Tool
读类工厂:列出当前用户邮箱的文件夹,返回一个 feishu.agent.tools.Tool。
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
|
str
|
工具描述(产品本地化文案)。 |
必需 |
|
str
|
工具名。默认为 |
'list_mail_folders'
|
|
Sequence[str]
|
缺少授权时申请的飞书邮箱权限范围。 |
()
|
返回:
| 类型 | 描述 |
|---|---|
Tool
|
示例:
| Python Console Session | |
|---|---|
源代码位于: feishu/agent/toolkit/mail.py
send_mail_message
¶
send_mail_message(*, description: str, name: str = 'send_mail_message', requires_approval: bool = True, auth_scopes: Sequence[str] = ()) -> Tool
写类工厂:以当前用户身份发送一封邮件,返回一个需审批的 feishu.agent.tools.Tool。
requires_approval=True 时,feishu.agent.loop.AgentEngine 会先发确认卡;用户批准后才执行发送。
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
|
str
|
工具描述(产品本地化文案)。 |
必需 |
|
str
|
工具名。默认为 |
'send_mail_message'
|
|
bool
|
是否需用户审批后执行。默认为 |
True
|
|
Sequence[str]
|
缺少授权时申请的飞书邮箱发送权限范围。 |
()
|
返回:
| 类型 | 描述 |
|---|---|
Tool
|
示例:
| Python Console Session | |
|---|---|