AptlyStar

AgentMail

Manage email inboxes, threads, and messages with AgentMail

Instrucciones de uso

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.

Herramientas

agentmail_create_draft

Create a new email draft in AgentMail

Entrada

ParámetroTipoObligatorioDescripción
apiKeystringSíAgentMail API key
inboxIdstringSíID of the inbox to create the draft in
tostringNoRecipient email addresses (comma-separated)
subjectstringNoDraft subject line
textstringNoPlain text draft body
htmlstringNoHTML draft body
ccstringNoCC recipient email addresses (comma-separated)
bccstringNoBCC recipient email addresses (comma-separated)
inReplyTostringNoID of message being replied to
sendAtstringNoISO 8601 timestamp to schedule sending

Salida

ParámetroTipoDescripción
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

Entrada

ParámetroTipoObligatorioDescripción
apiKeystringSíAgentMail API key
usernamestringNoUsername for the inbox email address
domainstringNoDomain for the inbox email address
displayNamestringNoDisplay name for the inbox

Salida

ParámetroTipoDescripción
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

Entrada

ParámetroTipoObligatorioDescripción
apiKeystringSíAgentMail API key
inboxIdstringSíID of the inbox containing the draft
draftIdstringSíID of the draft to delete

Salida

ParámetroTipoDescripción
deletedbooleanWhether the draft was successfully deleted

agentmail_delete_inbox

Delete an email inbox in AgentMail

Entrada

ParámetroTipoObligatorioDescripción
apiKeystringSíAgentMail API key
inboxIdstringSíID of the inbox to delete

Salida

ParámetroTipoDescripción
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)

Entrada

ParámetroTipoObligatorioDescripción
apiKeystringSíAgentMail API key
inboxIdstringSíID of the inbox containing the thread
threadIdstringSíID of the thread to delete
permanentbooleanNoForce permanent deletion instead of moving to trash

Salida

ParámetroTipoDescripción
deletedbooleanWhether the thread was successfully deleted

agentmail_forward_message

Forward an email message to new recipients in AgentMail

Entrada

ParámetroTipoObligatorioDescripción
apiKeystringSíAgentMail API key
inboxIdstringSíID of the inbox containing the message
messageIdstringSíID of the message to forward
tostringSíRecipient email addresses (comma-separated)
subjectstringNoOverride subject line
textstringNoAdditional plain text to prepend
htmlstringNoAdditional HTML to prepend
ccstringNoCC recipient email addresses (comma-separated)
bccstringNoBCC recipient email addresses (comma-separated)

Salida

ParámetroTipoDescripción
messageIdstringID of the forwarded message
threadIdstringID of the thread

agentmail_get_draft

Get details of a specific email draft in AgentMail

Entrada

ParámetroTipoObligatorioDescripción
apiKeystringSíAgentMail API key
inboxIdstringSíID of the inbox the draft belongs to
draftIdstringSíID of the draft to retrieve

Salida

ParámetroTipoDescripción
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

Entrada

ParámetroTipoObligatorioDescripción
apiKeystringSíAgentMail API key
inboxIdstringSíID of the inbox to retrieve

Salida

ParámetroTipoDescripción
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

Entrada

ParámetroTipoObligatorioDescripción
apiKeystringSíAgentMail API key
inboxIdstringSíID of the inbox containing the message
messageIdstringSíID of the message to retrieve

Salida

ParámetroTipoDescripción
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

Entrada

ParámetroTipoObligatorioDescripción
apiKeystringSíAgentMail API key
inboxIdstringSíID of the inbox containing the thread
threadIdstringSíID of the thread to retrieve

Salida

ParámetroTipoDescripción
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

Entrada

ParámetroTipoObligatorioDescripción
apiKeystringSíAgentMail API key
inboxIdstringSíID of the inbox to list drafts from
limitnumberNoMaximum number of drafts to return
pageTokenstringNoPagination token for next page of results

Salida

ParámetroTipoDescripción
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

Entrada

ParámetroTipoObligatorioDescripción
apiKeystringSíAgentMail API key
limitnumberNoMaximum number of inboxes to return
pageTokenstringNoPagination token for next page of results

Salida

ParámetroTipoDescripción
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

Entrada

ParámetroTipoObligatorioDescripción
apiKeystringSíAgentMail API key
inboxIdstringSíID of the inbox to list messages from
limitnumberNoMaximum number of messages to return
pageTokenstringNoPagination token for next page of results

Salida

ParámetroTipoDescripción
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

Entrada

ParámetroTipoObligatorioDescripción
apiKeystringSíAgentMail API key
inboxIdstringSíID of the inbox to list threads from
limitnumberNoMaximum number of threads to return
pageTokenstringNoPagination token for next page of results
labelsstringNoComma-separated labels to filter threads by
beforestringNoFilter threads before this ISO 8601 timestamp
afterstringNoFilter threads after this ISO 8601 timestamp

Salida

ParámetroTipoDescripción
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

Entrada

ParámetroTipoObligatorioDescripción
apiKeystringSíAgentMail API key
inboxIdstringSíID of the inbox to reply from
messageIdstringSíID of the message to reply to
textstringNoPlain text reply body
htmlstringNoHTML reply body
tostringNoOverride recipient email addresses (comma-separated)
ccstringNoCC email addresses (comma-separated)
bccstringNoBCC email addresses (comma-separated)
replyAllbooleanNoReply to all recipients of the original message

Salida

ParámetroTipoDescripción
messageIdstringID of the sent reply message
threadIdstringID of the thread

agentmail_send_draft

Send an existing email draft in AgentMail

Entrada

ParámetroTipoObligatorioDescripción
apiKeystringSíAgentMail API key
inboxIdstringSíID of the inbox containing the draft
draftIdstringSíID of the draft to send

Salida

ParámetroTipoDescripción
messageIdstringID of the sent message
threadIdstringID of the thread

agentmail_send_message

Send an email message from an AgentMail inbox

Entrada

ParámetroTipoObligatorioDescripción
apiKeystringSíAgentMail API key
inboxIdstringSíID of the inbox to send from
tostringSíRecipient email address (comma-separated for multiple)
subjectstringSíEmail subject line
textstringNoPlain text email body
htmlstringNoHTML email body
ccstringNoCC recipient email addresses (comma-separated)
bccstringNoBCC recipient email addresses (comma-separated)

Salida

ParámetroTipoDescripción
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

Entrada

ParámetroTipoObligatorioDescripción
apiKeystringSíAgentMail API key
inboxIdstringSíID of the inbox containing the draft
draftIdstringSíID of the draft to update
tostringNoRecipient email addresses (comma-separated)
subjectstringNoDraft subject line
textstringNoPlain text draft body
htmlstringNoHTML draft body
ccstringNoCC recipient email addresses (comma-separated)
bccstringNoBCC recipient email addresses (comma-separated)
sendAtstringNoISO 8601 timestamp to schedule sending

Salida

ParámetroTipoDescripción
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

Entrada

ParámetroTipoObligatorioDescripción
apiKeystringSíAgentMail API key
inboxIdstringSíID of the inbox to update
displayNamestringSíNew display name for the inbox

Salida

ParámetroTipoDescripción
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

Entrada

ParámetroTipoObligatorioDescripción
apiKeystringSíAgentMail API key
inboxIdstringSíID of the inbox containing the message
messageIdstringSíID of the message to update
addLabelsstringNoComma-separated labels to add to the message
removeLabelsstringNoComma-separated labels to remove from the message

Salida

ParámetroTipoDescripción
messageIdstringUnique identifier for the message
labelsarrayCurrent labels on the message

agentmail_update_thread

Add or remove labels on an email thread in AgentMail

Entrada

ParámetroTipoObligatorioDescripción
apiKeystringSíAgentMail API key
inboxIdstringSíID of the inbox containing the thread
threadIdstringSíID of the thread to update
addLabelsstringNoComma-separated labels to add to the thread
removeLabelsstringNoComma-separated labels to remove from the thread

Salida

ParámetroTipoDescripción
threadIdstringUnique identifier for the thread
labelsarrayCurrent labels on the thread

On this page