AgentMail

Manage email inboxes, threads, and messages with AgentMail

Instructions d'utilisation

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.

Outils

`agentmail_create_draft`

Create a new email draft in AgentMail

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	AgentMail API key
`inboxId`	string	Oui	ID of the inbox to create the draft in
`to`	string	Non	Recipient email addresses (comma-separated)
`subject`	string	Non	Draft subject line
`text`	string	Non	Plain text draft body
`html`	string	Non	HTML draft body
`cc`	string	Non	CC recipient email addresses (comma-separated)
`bcc`	string	Non	BCC recipient email addresses (comma-separated)
`inReplyTo`	string	Non	ID of message being replied to
`sendAt`	string	Non	ISO 8601 timestamp to schedule sending

Sortie

Paramètre	Type	Description
`draftId`	string	Unique identifier for the draft
`inboxId`	string	Inbox the draft belongs to
`subject`	string	Draft subject
`to`	array	Recipient email addresses
`cc`	array	CC email addresses
`bcc`	array	BCC email addresses
`text`	string	Plain text content
`html`	string	HTML content
`preview`	string	Draft preview text
`labels`	array	Labels assigned to the draft
`inReplyTo`	string	Message ID this draft replies to
`sendStatus`	string	Send status (scheduled, sending, failed)
`sendAt`	string	Scheduled send time
`createdAt`	string	Creation timestamp
`updatedAt`	string	Last updated timestamp

`agentmail_create_inbox`

Create a new email inbox with AgentMail

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	AgentMail API key
`username`	string	Non	Username for the inbox email address
`domain`	string	Non	Domain for the inbox email address
`displayName`	string	Non	Display name for the inbox

Sortie

Paramètre	Type	Description
`inboxId`	string	Unique identifier for the inbox
`email`	string	Email address of the inbox
`displayName`	string	Display name of the inbox
`createdAt`	string	Creation timestamp
`updatedAt`	string	Last updated timestamp

`agentmail_delete_draft`

Delete an email draft in AgentMail

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	AgentMail API key
`inboxId`	string	Oui	ID of the inbox containing the draft
`draftId`	string	Oui	ID of the draft to delete

Sortie

Paramètre	Type	Description
`deleted`	boolean	Whether the draft was successfully deleted

`agentmail_delete_inbox`

Delete an email inbox in AgentMail

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	AgentMail API key
`inboxId`	string	Oui	ID of the inbox to delete

Sortie

Paramètre	Type	Description
`deleted`	boolean	Whether the inbox was successfully deleted

`agentmail_delete_thread`

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

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	AgentMail API key
`inboxId`	string	Oui	ID of the inbox containing the thread
`threadId`	string	Oui	ID of the thread to delete
`permanent`	boolean	Non	Force permanent deletion instead of moving to trash

Sortie

Paramètre	Type	Description
`deleted`	boolean	Whether the thread was successfully deleted

`agentmail_forward_message`

Forward an email message to new recipients in AgentMail

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	AgentMail API key
`inboxId`	string	Oui	ID of the inbox containing the message
`messageId`	string	Oui	ID of the message to forward
`to`	string	Oui	Recipient email addresses (comma-separated)
`subject`	string	Non	Override subject line
`text`	string	Non	Additional plain text to prepend
`html`	string	Non	Additional HTML to prepend
`cc`	string	Non	CC recipient email addresses (comma-separated)
`bcc`	string	Non	BCC recipient email addresses (comma-separated)

Sortie

Paramètre	Type	Description
`messageId`	string	ID of the forwarded message
`threadId`	string	ID of the thread

`agentmail_get_draft`

Get details of a specific email draft in AgentMail

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	AgentMail API key
`inboxId`	string	Oui	ID of the inbox the draft belongs to
`draftId`	string	Oui	ID of the draft to retrieve

Sortie

Paramètre	Type	Description
`draftId`	string	Unique identifier for the draft
`inboxId`	string	Inbox the draft belongs to
`subject`	string	Draft subject
`to`	array	Recipient email addresses
`cc`	array	CC email addresses
`bcc`	array	BCC email addresses
`text`	string	Plain text content
`html`	string	HTML content
`preview`	string	Draft preview text
`labels`	array	Labels assigned to the draft
`inReplyTo`	string	Message ID this draft replies to
`sendStatus`	string	Send status (scheduled, sending, failed)
`sendAt`	string	Scheduled send time
`createdAt`	string	Creation timestamp
`updatedAt`	string	Last updated timestamp

`agentmail_get_inbox`

Get details of a specific email inbox in AgentMail

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	AgentMail API key
`inboxId`	string	Oui	ID of the inbox to retrieve

Sortie

Paramètre	Type	Description
`inboxId`	string	Unique identifier for the inbox
`email`	string	Email address of the inbox
`displayName`	string	Display name of the inbox
`createdAt`	string	Creation timestamp
`updatedAt`	string	Last updated timestamp

`agentmail_get_message`

Get details of a specific email message in AgentMail

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	AgentMail API key
`inboxId`	string	Oui	ID of the inbox containing the message
`messageId`	string	Oui	ID of the message to retrieve

Sortie

Paramètre	Type	Description
`messageId`	string	Unique identifier for the message
`threadId`	string	ID of the thread this message belongs to
`from`	string	Sender email address
`to`	array	Recipient email addresses
`cc`	array	CC email addresses
`bcc`	array	BCC email addresses
`subject`	string	Message subject
`text`	string	Plain text content
`html`	string	HTML content
`timestamp`	string	Time the message was sent or drafted
`createdAt`	string	Creation timestamp

`agentmail_get_thread`

Get details of a specific email thread including messages in AgentMail

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	AgentMail API key
`inboxId`	string	Oui	ID of the inbox containing the thread
`threadId`	string	Oui	ID of the thread to retrieve

Sortie

Paramètre	Type	Description
`threadId`	string	Unique identifier for the thread
`subject`	string	Thread subject
`senders`	array	List of sender email addresses
`recipients`	array	List of recipient email addresses
`messageCount`	number	Number of messages in the thread
`labels`	array	Labels assigned to the thread
`lastMessageAt`	string	Timestamp of last message
`createdAt`	string	Creation timestamp
`updatedAt`	string	Last updated timestamp
`messages`	array	Messages in the thread
↳ `messageId`	string	Unique identifier for the message
↳ `from`	string	Sender email address
↳ `to`	array	Recipient email addresses
↳ `cc`	array	CC email addresses
↳ `bcc`	array	BCC email addresses
↳ `subject`	string	Message subject
↳ `text`	string	Plain text content
↳ `html`	string	HTML content
↳ `createdAt`	string	Creation timestamp

`agentmail_list_drafts`

List email drafts in an inbox in AgentMail

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	AgentMail API key
`inboxId`	string	Oui	ID of the inbox to list drafts from
`limit`	number	Non	Maximum number of drafts to return
`pageToken`	string	Non	Pagination token for next page of results

Sortie

Paramètre	Type	Description
`drafts`	array	List of drafts
↳ `draftId`	string	Unique identifier for the draft
↳ `inboxId`	string	Inbox the draft belongs to
↳ `subject`	string	Draft subject
↳ `to`	array	Recipient email addresses
↳ `cc`	array	CC email addresses
↳ `bcc`	array	BCC email addresses
↳ `preview`	string	Draft preview text
↳ `sendStatus`	string	Send status (scheduled, sending, failed)
↳ `sendAt`	string	Scheduled send time
↳ `createdAt`	string	Creation timestamp
↳ `updatedAt`	string	Last updated timestamp
`count`	number	Total number of drafts
`nextPageToken`	string	Token for retrieving the next page

`agentmail_list_inboxes`

List all email inboxes in AgentMail

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	AgentMail API key
`limit`	number	Non	Maximum number of inboxes to return
`pageToken`	string	Non	Pagination token for next page of results

Sortie

Paramètre	Type	Description
`inboxes`	array	List of inboxes
↳ `inboxId`	string	Unique identifier for the inbox
↳ `email`	string	Email address of the inbox
↳ `displayName`	string	Display name of the inbox
↳ `createdAt`	string	Creation timestamp
↳ `updatedAt`	string	Last updated timestamp
`count`	number	Total number of inboxes
`nextPageToken`	string	Token for retrieving the next page

`agentmail_list_messages`

List messages in an inbox in AgentMail

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	AgentMail API key
`inboxId`	string	Oui	ID of the inbox to list messages from
`limit`	number	Non	Maximum number of messages to return
`pageToken`	string	Non	Pagination token for next page of results

Sortie

Paramètre	Type	Description
`messages`	array	List of messages in the inbox
↳ `messageId`	string	Unique identifier for the message
↳ `from`	string	Sender email address
↳ `to`	array	Recipient email addresses
↳ `subject`	string	Message subject
↳ `preview`	string	Message preview text
↳ `createdAt`	string	Creation timestamp
`count`	number	Total number of messages
`nextPageToken`	string	Token for retrieving the next page

`agentmail_list_threads`

List email threads in AgentMail

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	AgentMail API key
`inboxId`	string	Oui	ID of the inbox to list threads from
`limit`	number	Non	Maximum number of threads to return
`pageToken`	string	Non	Pagination token for next page of results
`labels`	string	Non	Comma-separated labels to filter threads by
`before`	string	Non	Filter threads before this ISO 8601 timestamp
`after`	string	Non	Filter threads after this ISO 8601 timestamp

Sortie

Paramètre	Type	Description
`threads`	array	List of email threads
↳ `threadId`	string	Unique identifier for the thread
↳ `subject`	string	Thread subject
↳ `senders`	array	List of sender email addresses
↳ `recipients`	array	List of recipient email addresses
↳ `messageCount`	number	Number of messages in the thread
↳ `lastMessageAt`	string	Timestamp of last message
↳ `createdAt`	string	Creation timestamp
↳ `updatedAt`	string	Last updated timestamp
`count`	number	Total number of threads
`nextPageToken`	string	Token for retrieving the next page

`agentmail_reply_message`

Reply to an existing email message in AgentMail

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	AgentMail API key
`inboxId`	string	Oui	ID of the inbox to reply from
`messageId`	string	Oui	ID of the message to reply to
`text`	string	Non	Plain text reply body
`html`	string	Non	HTML reply body
`to`	string	Non	Override recipient email addresses (comma-separated)
`cc`	string	Non	CC email addresses (comma-separated)
`bcc`	string	Non	BCC email addresses (comma-separated)
`replyAll`	boolean	Non	Reply to all recipients of the original message

Sortie

Paramètre	Type	Description
`messageId`	string	ID of the sent reply message
`threadId`	string	ID of the thread

`agentmail_send_draft`

Send an existing email draft in AgentMail

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	AgentMail API key
`inboxId`	string	Oui	ID of the inbox containing the draft
`draftId`	string	Oui	ID of the draft to send

Sortie

Paramètre	Type	Description
`messageId`	string	ID of the sent message
`threadId`	string	ID of the thread

`agentmail_send_message`

Send an email message from an AgentMail inbox

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	AgentMail API key
`inboxId`	string	Oui	ID of the inbox to send from
`to`	string	Oui	Recipient email address (comma-separated for multiple)
`subject`	string	Oui	Email subject line
`text`	string	Non	Plain text email body
`html`	string	Non	HTML email body
`cc`	string	Non	CC recipient email addresses (comma-separated)
`bcc`	string	Non	BCC recipient email addresses (comma-separated)

Sortie

Paramètre	Type	Description
`threadId`	string	ID of the created thread
`messageId`	string	ID of the sent message
`subject`	string	Email subject line
`to`	string	Recipient email address

`agentmail_update_draft`

Update an existing email draft in AgentMail

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	AgentMail API key
`inboxId`	string	Oui	ID of the inbox containing the draft
`draftId`	string	Oui	ID of the draft to update
`to`	string	Non	Recipient email addresses (comma-separated)
`subject`	string	Non	Draft subject line
`text`	string	Non	Plain text draft body
`html`	string	Non	HTML draft body
`cc`	string	Non	CC recipient email addresses (comma-separated)
`bcc`	string	Non	BCC recipient email addresses (comma-separated)
`sendAt`	string	Non	ISO 8601 timestamp to schedule sending

Sortie

Paramètre	Type	Description
`draftId`	string	Unique identifier for the draft
`inboxId`	string	Inbox the draft belongs to
`subject`	string	Draft subject
`to`	array	Recipient email addresses
`cc`	array	CC email addresses
`bcc`	array	BCC email addresses
`text`	string	Plain text content
`html`	string	HTML content
`preview`	string	Draft preview text
`labels`	array	Labels assigned to the draft
`inReplyTo`	string	Message ID this draft replies to
`sendStatus`	string	Send status (scheduled, sending, failed)
`sendAt`	string	Scheduled send time
`createdAt`	string	Creation timestamp
`updatedAt`	string	Last updated timestamp

`agentmail_update_inbox`

Update the display name of an email inbox in AgentMail

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	AgentMail API key
`inboxId`	string	Oui	ID of the inbox to update
`displayName`	string	Oui	New display name for the inbox

Sortie

Paramètre	Type	Description
`inboxId`	string	Unique identifier for the inbox
`email`	string	Email address of the inbox
`displayName`	string	Display name of the inbox
`createdAt`	string	Creation timestamp
`updatedAt`	string	Last updated timestamp

`agentmail_update_message`

Add or remove labels on an email message in AgentMail

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	AgentMail API key
`inboxId`	string	Oui	ID of the inbox containing the message
`messageId`	string	Oui	ID of the message to update
`addLabels`	string	Non	Comma-separated labels to add to the message
`removeLabels`	string	Non	Comma-separated labels to remove from the message

Sortie

Paramètre	Type	Description
`messageId`	string	Unique identifier for the message
`labels`	array	Current labels on the message

`agentmail_update_thread`

Add or remove labels on an email thread in AgentMail

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	AgentMail API key
`inboxId`	string	Oui	ID of the inbox containing the thread
`threadId`	string	Oui	ID of the thread to update
`addLabels`	string	Non	Comma-separated labels to add to the thread
`removeLabels`	string	Non	Comma-separated labels to remove from the thread

Sortie

Paramètre	Type	Description
`threadId`	string	Unique identifier for the thread
`labels`	array	Current labels on the thread