AptlyStar

AgentMail

Manage email inboxes, threads, and messages with AgentMail

使用说明

Integrate AgentMail into your workflow. Create and manage email inboxes, send and receive messages, reply to threads, manage drafts, and organize threads with labels. Requires API Key.

工具

agentmail_create_draft

Create a new email draft in AgentMail

输入

参数类型必填描述
apiKeystring是AgentMail API key
inboxIdstring是ID of the inbox to create the draft in
tostring否Recipient email addresses (comma-separated)
subjectstring否Draft subject line
textstring否Plain text draft body
htmlstring否HTML draft body
ccstring否CC recipient email addresses (comma-separated)
bccstring否BCC recipient email addresses (comma-separated)
inReplyTostring否ID of message being replied to
sendAtstring否ISO 8601 timestamp to schedule sending

输出

参数类型描述
draftIdstringUnique identifier for the draft
inboxIdstringInbox the draft belongs to
subjectstringDraft subject
toarrayRecipient email addresses
ccarrayCC email addresses
bccarrayBCC email addresses
textstringPlain text content
htmlstringHTML content
previewstringDraft preview text
labelsarrayLabels assigned to the draft
inReplyTostringMessage ID this draft replies to
sendStatusstringSend status (scheduled, sending, failed)
sendAtstringScheduled send time
createdAtstringCreation timestamp
updatedAtstringLast updated timestamp

agentmail_create_inbox

Create a new email inbox with AgentMail

输入

参数类型必填描述
apiKeystring是AgentMail API key
usernamestring否Username for the inbox email address
domainstring否Domain for the inbox email address
displayNamestring否Display name for the inbox

输出

参数类型描述
inboxIdstringUnique identifier for the inbox
emailstringEmail address of the inbox
displayNamestringDisplay name of the inbox
createdAtstringCreation timestamp
updatedAtstringLast updated timestamp

agentmail_delete_draft

Delete an email draft in AgentMail

输入

参数类型必填描述
apiKeystring是AgentMail API key
inboxIdstring是ID of the inbox containing the draft
draftIdstring是ID of the draft to delete

输出

参数类型描述
deletedbooleanWhether the draft was successfully deleted

agentmail_delete_inbox

Delete an email inbox in AgentMail

输入

参数类型必填描述
apiKeystring是AgentMail API key
inboxIdstring是ID of the inbox to delete

输出

参数类型描述
deletedbooleanWhether the inbox was successfully deleted

agentmail_delete_thread

Delete an email thread in AgentMail (moves to trash, or permanently deletes if already in trash)

输入

参数类型必填描述
apiKeystring是AgentMail API key
inboxIdstring是ID of the inbox containing the thread
threadIdstring是ID of the thread to delete
permanentboolean否Force permanent deletion instead of moving to trash

输出

参数类型描述
deletedbooleanWhether the thread was successfully deleted

agentmail_forward_message

Forward an email message to new recipients in AgentMail

输入

参数类型必填描述
apiKeystring是AgentMail API key
inboxIdstring是ID of the inbox containing the message
messageIdstring是ID of the message to forward
tostring是Recipient email addresses (comma-separated)
subjectstring否Override subject line
textstring否Additional plain text to prepend
htmlstring否Additional HTML to prepend
ccstring否CC recipient email addresses (comma-separated)
bccstring否BCC recipient email addresses (comma-separated)

输出

参数类型描述
messageIdstringID of the forwarded message
threadIdstringID of the thread

agentmail_get_draft

Get details of a specific email draft in AgentMail

输入

参数类型必填描述
apiKeystring是AgentMail API key
inboxIdstring是ID of the inbox the draft belongs to
draftIdstring是ID of the draft to retrieve

输出

参数类型描述
draftIdstringUnique identifier for the draft
inboxIdstringInbox the draft belongs to
subjectstringDraft subject
toarrayRecipient email addresses
ccarrayCC email addresses
bccarrayBCC email addresses
textstringPlain text content
htmlstringHTML content
previewstringDraft preview text
labelsarrayLabels assigned to the draft
inReplyTostringMessage ID this draft replies to
sendStatusstringSend status (scheduled, sending, failed)
sendAtstringScheduled send time
createdAtstringCreation timestamp
updatedAtstringLast updated timestamp

agentmail_get_inbox

Get details of a specific email inbox in AgentMail

输入

参数类型必填描述
apiKeystring是AgentMail API key
inboxIdstring是ID of the inbox to retrieve

输出

参数类型描述
inboxIdstringUnique identifier for the inbox
emailstringEmail address of the inbox
displayNamestringDisplay name of the inbox
createdAtstringCreation timestamp
updatedAtstringLast updated timestamp

agentmail_get_message

Get details of a specific email message in AgentMail

输入

参数类型必填描述
apiKeystring是AgentMail API key
inboxIdstring是ID of the inbox containing the message
messageIdstring是ID of the message to retrieve

输出

参数类型描述
messageIdstringUnique identifier for the message
threadIdstringID of the thread this message belongs to
fromstringSender email address
toarrayRecipient email addresses
ccarrayCC email addresses
bccarrayBCC email addresses
subjectstringMessage subject
textstringPlain text content
htmlstringHTML content
timestampstringTime the message was sent or drafted
createdAtstringCreation timestamp

agentmail_get_thread

Get details of a specific email thread including messages in AgentMail

输入

参数类型必填描述
apiKeystring是AgentMail API key
inboxIdstring是ID of the inbox containing the thread
threadIdstring是ID of the thread to retrieve

输出

参数类型描述
threadIdstringUnique identifier for the thread
subjectstringThread subject
sendersarrayList of sender email addresses
recipientsarrayList of recipient email addresses
messageCountnumberNumber of messages in the thread
labelsarrayLabels assigned to the thread
lastMessageAtstringTimestamp of last message
createdAtstringCreation timestamp
updatedAtstringLast updated timestamp
messagesarrayMessages in the thread
↳ messageIdstringUnique identifier for the message
↳ fromstringSender email address
↳ toarrayRecipient email addresses
↳ ccarrayCC email addresses
↳ bccarrayBCC email addresses
↳ subjectstringMessage subject
↳ textstringPlain text content
↳ htmlstringHTML content
↳ createdAtstringCreation timestamp

agentmail_list_drafts

List email drafts in an inbox in AgentMail

输入

参数类型必填描述
apiKeystring是AgentMail API key
inboxIdstring是ID of the inbox to list drafts from
limitnumber否Maximum number of drafts to return
pageTokenstring否Pagination token for next page of results

输出

参数类型描述
draftsarrayList of drafts
↳ draftIdstringUnique identifier for the draft
↳ inboxIdstringInbox the draft belongs to
↳ subjectstringDraft subject
↳ toarrayRecipient email addresses
↳ ccarrayCC email addresses
↳ bccarrayBCC email addresses
↳ previewstringDraft preview text
↳ sendStatusstringSend status (scheduled, sending, failed)
↳ sendAtstringScheduled send time
↳ createdAtstringCreation timestamp
↳ updatedAtstringLast updated timestamp
countnumberTotal number of drafts
nextPageTokenstringToken for retrieving the next page

agentmail_list_inboxes

List all email inboxes in AgentMail

输入

参数类型必填描述
apiKeystring是AgentMail API key
limitnumber否Maximum number of inboxes to return
pageTokenstring否Pagination token for next page of results

输出

参数类型描述
inboxesarrayList of inboxes
↳ inboxIdstringUnique identifier for the inbox
↳ emailstringEmail address of the inbox
↳ displayNamestringDisplay name of the inbox
↳ createdAtstringCreation timestamp
↳ updatedAtstringLast updated timestamp
countnumberTotal number of inboxes
nextPageTokenstringToken for retrieving the next page

agentmail_list_messages

List messages in an inbox in AgentMail

输入

参数类型必填描述
apiKeystring是AgentMail API key
inboxIdstring是ID of the inbox to list messages from
limitnumber否Maximum number of messages to return
pageTokenstring否Pagination token for next page of results

输出

参数类型描述
messagesarrayList of messages in the inbox
↳ messageIdstringUnique identifier for the message
↳ fromstringSender email address
↳ toarrayRecipient email addresses
↳ subjectstringMessage subject
↳ previewstringMessage preview text
↳ createdAtstringCreation timestamp
countnumberTotal number of messages
nextPageTokenstringToken for retrieving the next page

agentmail_list_threads

List email threads in AgentMail

输入

参数类型必填描述
apiKeystring是AgentMail API key
inboxIdstring是ID of the inbox to list threads from
limitnumber否Maximum number of threads to return
pageTokenstring否Pagination token for next page of results
labelsstring否Comma-separated labels to filter threads by
beforestring否Filter threads before this ISO 8601 timestamp
afterstring否Filter threads after this ISO 8601 timestamp

输出

参数类型描述
threadsarrayList of email threads
↳ threadIdstringUnique identifier for the thread
↳ subjectstringThread subject
↳ sendersarrayList of sender email addresses
↳ recipientsarrayList of recipient email addresses
↳ messageCountnumberNumber of messages in the thread
↳ lastMessageAtstringTimestamp of last message
↳ createdAtstringCreation timestamp
↳ updatedAtstringLast updated timestamp
countnumberTotal number of threads
nextPageTokenstringToken for retrieving the next page

agentmail_reply_message

Reply to an existing email message in AgentMail

输入

参数类型必填描述
apiKeystring是AgentMail API key
inboxIdstring是ID of the inbox to reply from
messageIdstring是ID of the message to reply to
textstring否Plain text reply body
htmlstring否HTML reply body
tostring否Override recipient email addresses (comma-separated)
ccstring否CC email addresses (comma-separated)
bccstring否BCC email addresses (comma-separated)
replyAllboolean否Reply to all recipients of the original message

输出

参数类型描述
messageIdstringID of the sent reply message
threadIdstringID of the thread

agentmail_send_draft

Send an existing email draft in AgentMail

输入

参数类型必填描述
apiKeystring是AgentMail API key
inboxIdstring是ID of the inbox containing the draft
draftIdstring是ID of the draft to send

输出

参数类型描述
messageIdstringID of the sent message
threadIdstringID of the thread

agentmail_send_message

Send an email message from an AgentMail inbox

输入

参数类型必填描述
apiKeystring是AgentMail API key
inboxIdstring是ID of the inbox to send from
tostring是Recipient email address (comma-separated for multiple)
subjectstring是Email subject line
textstring否Plain text email body
htmlstring否HTML email body
ccstring否CC recipient email addresses (comma-separated)
bccstring否BCC recipient email addresses (comma-separated)

输出

参数类型描述
threadIdstringID of the created thread
messageIdstringID of the sent message
subjectstringEmail subject line
tostringRecipient email address

agentmail_update_draft

Update an existing email draft in AgentMail

输入

参数类型必填描述
apiKeystring是AgentMail API key
inboxIdstring是ID of the inbox containing the draft
draftIdstring是ID of the draft to update
tostring否Recipient email addresses (comma-separated)
subjectstring否Draft subject line
textstring否Plain text draft body
htmlstring否HTML draft body
ccstring否CC recipient email addresses (comma-separated)
bccstring否BCC recipient email addresses (comma-separated)
sendAtstring否ISO 8601 timestamp to schedule sending

输出

参数类型描述
draftIdstringUnique identifier for the draft
inboxIdstringInbox the draft belongs to
subjectstringDraft subject
toarrayRecipient email addresses
ccarrayCC email addresses
bccarrayBCC email addresses
textstringPlain text content
htmlstringHTML content
previewstringDraft preview text
labelsarrayLabels assigned to the draft
inReplyTostringMessage ID this draft replies to
sendStatusstringSend status (scheduled, sending, failed)
sendAtstringScheduled send time
createdAtstringCreation timestamp
updatedAtstringLast updated timestamp

agentmail_update_inbox

Update the display name of an email inbox in AgentMail

输入

参数类型必填描述
apiKeystring是AgentMail API key
inboxIdstring是ID of the inbox to update
displayNamestring是New display name for the inbox

输出

参数类型描述
inboxIdstringUnique identifier for the inbox
emailstringEmail address of the inbox
displayNamestringDisplay name of the inbox
createdAtstringCreation timestamp
updatedAtstringLast updated timestamp

agentmail_update_message

Add or remove labels on an email message in AgentMail

输入

参数类型必填描述
apiKeystring是AgentMail API key
inboxIdstring是ID of the inbox containing the message
messageIdstring是ID of the message to update
addLabelsstring否Comma-separated labels to add to the message
removeLabelsstring否Comma-separated labels to remove from the message

输出

参数类型描述
messageIdstringUnique identifier for the message
labelsarrayCurrent labels on the message

agentmail_update_thread

Add or remove labels on an email thread in AgentMail

输入

参数类型必填描述
apiKeystring是AgentMail API key
inboxIdstring是ID of the inbox containing the thread
threadIdstring是ID of the thread to update
addLabelsstring否Comma-separated labels to add to the thread
removeLabelsstring否Comma-separated labels to remove from the thread

输出

参数类型描述
threadIdstringUnique identifier for the thread
labelsarrayCurrent labels on the thread

On this page