Skip to content

armgit / camel

Public Imported from GitHub
0

🐫 CAMEL: The first and the best multi-agent framework. Finding the Scaling Law of Agents. https://www.camel-ai.org

Auto-update documentation after merge [skip ci]

camel-docs-bot0a2fce251be2
diff --git a/docs/mintlify/reference/camel.toolkits.gmail_toolkit.mdx b/docs/mintlify/reference/camel.toolkits.gmail_toolkit.mdx
index 94262f15e..97e9800c6 100644
--- a/docs/mintlify/reference/camel.toolkits.gmail_toolkit.mdx
+++ b/docs/mintlify/reference/camel.toolkits.gmail_toolkit.mdx
@@ -100,7 +100,7 @@ Reply to an email message.
**Parameters:**
-- **message_id** (str): The ID of the message to reply to (found in send_email/list_drafts results or users.messages.get).
+- **message_id** (str): The unique identifier of the message to reply to. To get a message ID, first use fetch_emails() to list messages, or use the 'message_id' returned from send_email() or create_email_draft().
- **reply_body** (str): The reply message body.
- **reply_all** (bool): Whether to reply to all recipients.
- **is_html** (bool): Whether the body is HTML format. Set to True when sending formatted emails with HTML tags (e.g., bold, links, images). Use False (default) for plain text emails.
@@ -130,9 +130,9 @@ Forward an email message.
**Parameters:**
-- **message_id** (str): The ID of the message to forward (found in send_email/list_drafts results or users.messages.get).
+- **message_id** (str): The unique identifier of the message to forward. To get a message ID, first use fetch_emails() to list messages, or use the 'message_id' returned from send_email() or create_email_draft().
- **to** (Union[str, List[str]]): Recipient email address(es).
-- **forward_body** (Optional[str]): Additional message to include.
+- **forward_body** (Optional[str]): Additional message to include at the top of the forwarded email, before the original message content. If not provided, only the original message will be forwarded.
- **cc** (Optional[Union[str, List[str]]]): CC recipient email address(es).
- **bcc** (Optional[Union[str, List[str]]]): BCC recipient email address(es).
- **include_attachments** (bool): Whether to include original attachments. Defaults to True. Only includes real attachments, not inline images.
@@ -188,7 +188,7 @@ Send a draft email.
**Parameters:**
-- **draft_id** (str): The ID of the draft to send.
+- **draft_id** (str): The unique identifier of the draft to send. To get a draft ID, first use list_drafts() to list drafts, or use the 'draft_id' returned from create_email_draft().
**Returns:**
@@ -214,11 +214,7 @@ Fetch emails with filters and pagination.
**Parameters:**
-- **query** (str): Gmail search query string.
-- **max_results** (int): Maximum number of emails to fetch.
-- **include_spam_trash** (bool): Whether to include spam and trash.
-- **label_ids** (Optional[List[str]]): List of label IDs to filter emails by. Only emails with ALL of the specified labels will be returned. Label IDs can be: - System labels: 'INBOX', 'SENT', 'DRAFT', 'SPAM', 'TRASH', 'UNREAD', 'STARRED', 'IMPORTANT', 'CATEGORY_PERSONAL', etc. - Custom label IDs: Retrieved from list_gmail_labels() method.
-- **page_token** (Optional[str]): Pagination token from a previous response. If provided, fetches the next page of results.
+- **query** (str): Gmail search query string. Use Gmail's search syntax: - 'from:[email protected]' - emails from specific sender - 'subject:meeting' - emails with specific subject text - 'has:attachment' - emails with attachments - 'is:unread' - unread emails - 'in:sent' - emails in sent folder - 'after:2024/01/01 before:2024/12/31' - date range
**Returns:**
@@ -236,7 +232,7 @@ Fetch a thread by ID.
**Parameters:**
-- **thread_id** (str): The ID of the thread to fetch.
+- **thread_id** (str): The unique identifier of the thread to fetch. To get a thread ID, first use list_threads() to list threads, or use the 'thread_id' returned from send_email() or reply_to_email().
**Returns:**
@@ -259,7 +255,7 @@ Modify labels on an email message.
**Parameters:**
-- **message_id** (str): The ID of the message to modify (found in send_email/list_drafts results or users.messages.get).
+- **message_id** (str): The unique identifier of the message to modify. To get a message ID, first use fetch_emails() to list messages, or use the 'message_id' returned from send_email() or create_email_draft().
- **add_labels** (Optional[List[str]]): List of label IDs to add to the message. Label IDs can be: - System labels: 'INBOX', 'STARRED', 'IMPORTANT', 'UNREAD', etc. - Custom label IDs: Retrieved from list_gmail_labels() method.
**Returns:**
@@ -279,7 +275,7 @@ Move a message to trash.
**Parameters:**
-- **message_id** (str): The ID of the message to move to trash (found in send_email/list_drafts results or users.messages.get).
+- **message_id** (str): The unique identifier of the message to move to trash. To get a message ID, first use fetch_emails() to list messages, or use the 'message_id' returned from send_email() or create_email_draft().
**Returns:**
@@ -303,9 +299,9 @@ Get an attachment from a message.
**Parameters:**
-- **message_id** (str): The ID of the message containing the attachment (found in send_email/list_drafts results or users.messages.get).
-- **attachment_id** (str): The ID of the attachment.
-- **save_path** (Optional[str]): Path to save the attachment file.
+- **message_id** (str): The unique identifier of the message containing the attachment. To get a message ID, first use fetch_emails() to list messages, or use the 'message_id' returned from send_email() or create_email_draft().
+- **attachment_id** (str): The unique identifier of the attachment to download. To get an attachment ID, first use fetch_emails() to get message details, then look for 'attachment_id' in the 'attachments' list of each message.
+- **save_path** (Optional[str]): Local file path where the attachment should be saved. If provided, the attachment will be saved to this location and the response will include a success message. If not provided, the attachment data will be returned as base64-encoded content in the response.
**Returns:**
@@ -331,11 +327,7 @@ List email threads.
**Parameters:**
-- **query** (str): Gmail search query string.
-- **max_results** (int): Maximum number of threads to fetch.
-- **include_spam_trash** (bool): Whether to include spam and trash.
-- **label_ids** (Optional[List[str]]): List of label IDs to filter threads by. Only threads with ALL of the specified labels will be returned. Label IDs can be: - System labels: 'INBOX', 'SENT', 'DRAFT', 'SPAM', 'TRASH', 'UNREAD', 'STARRED', 'IMPORTANT', 'CATEGORY_PERSONAL', etc. - Custom label IDs: Retrieved from list_gmail_labels() method.
-- **page_token** (Optional[str]): Pagination token from a previous response. If provided, fetches the next page of results.
+- **query** (str): Gmail search query string. Use Gmail's search syntax: - 'from:[email protected]' - threads from specific sender - 'subject:meeting' - threads with specific subject text - 'has:attachment' - threads with attachments - 'is:unread' - unread threads - 'in:sent' - threads in sent folder - 'after:2024/01/01 before:2024/12/31' - date range
**Returns:**
@@ -390,8 +382,8 @@ Create a new Gmail label.
**Parameters:**
- **name** (str): The name of the label to create.
-- **label_list_visibility** (str): Label visibility in label list.
-- **message_list_visibility** (str): Label visibility in message list.
+- **label_list_visibility** (str): How the label appears in Gmail's label list. - 'labelShow': Label is visible in the label list sidebar (default) - 'labelHide': Label is hidden from the label list sidebar
+- **message_list_visibility** (str): How the label appears in message lists. - 'show': Label is visible on messages in inbox/lists (default) - 'hide': Label is hidden from message displays
**Returns:**
@@ -410,7 +402,7 @@ Delete a Gmail label.
**Parameters:**
-- **label_id** (str): The ID of the user-created label to delete. Retrieve the label ID from `list_gmail_labels()`.
+- **label_id** (str): The unique identifier of the user-created label to delete. To get a label ID, first use list_gmail_labels() to list all labels. Note: System labels (e.g., 'INBOX', 'SENT', 'DRAFT', 'SPAM', 'TRASH', 'UNREAD', 'STARRED', 'IMPORTANT', 'CATEGORY_PERSONAL', etc.) cannot be deleted.
**Returns:**
@@ -434,7 +426,7 @@ Modify labels on a thread.
**Parameters:**
-- **thread_id** (str): The ID of the thread to modify.
+- **thread_id** (str): The unique identifier of the thread to modify. To get a thread ID, first use list_threads() to list threads, or use the 'thread_id' returned from send_email() or reply_to_email().
- **add_labels** (Optional[List[str]]): List of label IDs to add to all messages in the thread. Label IDs can be: - System labels: 'INBOX', 'STARRED', 'IMPORTANT', 'UNREAD', etc. - Custom label IDs: Retrieved from list_gmail_labels().
**Returns:**
@@ -485,8 +477,7 @@ Search for people in contacts.
**Parameters:**
-- **query** (str): Search query for people.
-- **max_results** (int): Maximum number of results to fetch.
+- **query** (str): Search query for people in contacts. Can search by: - Name: 'John Smith' or partial names like 'John' - Email: '[email protected]' - Organization: 'Google' or 'Acme Corp' - Phone number: '+1234567890'
**Returns:**