You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/mintlify/reference/camel.toolkits.gmail_toolkit.mdx
+17-26Lines changed: 17 additions & 26 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -100,7 +100,7 @@ Reply to an email message.
100
100
101
101
**Parameters:**
102
102
103
-
-**message_id** (str): The ID of the message to reply to (found in send_email/list_drafts results or users.messages.get).
103
+
-**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().
104
104
-**reply_body** (str): The reply message body.
105
105
-**reply_all** (bool): Whether to reply to all recipients.
106
106
-**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.
130
130
131
131
**Parameters:**
132
132
133
-
-**message_id** (str): The ID of the message to forward (found in send_email/list_drafts results or users.messages.get).
133
+
-**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().
-**forward_body** (Optional[str]): Additional message to include.
135
+
-**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.
136
136
-**cc** (Optional[Union[str, List[str]]]): CC 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.
188
188
189
189
**Parameters:**
190
190
191
-
-**draft_id** (str): The ID of the draft to send.
191
+
-**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().
192
192
193
193
**Returns:**
194
194
@@ -214,11 +214,7 @@ Fetch emails with filters and pagination.
214
214
215
215
**Parameters:**
216
216
217
-
-**query** (str): Gmail search query string.
218
-
-**max_results** (int): Maximum number of emails to fetch.
219
-
-**include_spam_trash** (bool): Whether to include spam and trash.
220
-
-**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.
221
-
-**page_token** (Optional[str]): Pagination token from a previous response. If provided, fetches the next page of results.
217
+
-**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
222
218
223
219
**Returns:**
224
220
@@ -236,7 +232,7 @@ Fetch a thread by ID.
236
232
237
233
**Parameters:**
238
234
239
-
-**thread_id** (str): The ID of the thread to fetch.
235
+
-**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().
240
236
241
237
**Returns:**
242
238
@@ -259,7 +255,7 @@ Modify labels on an email message.
259
255
260
256
**Parameters:**
261
257
262
-
-**message_id** (str): The ID of the message to modify (found in send_email/list_drafts results or users.messages.get).
258
+
-**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().
263
259
-**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.
264
260
265
261
**Returns:**
@@ -279,7 +275,7 @@ Move a message to trash.
279
275
280
276
**Parameters:**
281
277
282
-
-**message_id** (str): The ID of the message to move to trash (found in send_email/list_drafts results or users.messages.get).
278
+
-**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().
283
279
284
280
**Returns:**
285
281
@@ -303,9 +299,9 @@ Get an attachment from a message.
303
299
304
300
**Parameters:**
305
301
306
-
-**message_id** (str): The ID of the message containing the attachment (found in send_email/list_drafts results or users.messages.get).
307
-
-**attachment_id** (str): The ID of the attachment.
308
-
-**save_path** (Optional[str]): Path to save the attachment file.
302
+
-**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().
303
+
-**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.
304
+
-**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.
309
305
310
306
**Returns:**
311
307
@@ -331,11 +327,7 @@ List email threads.
331
327
332
328
**Parameters:**
333
329
334
-
-**query** (str): Gmail search query string.
335
-
-**max_results** (int): Maximum number of threads to fetch.
336
-
-**include_spam_trash** (bool): Whether to include spam and trash.
337
-
-**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.
338
-
-**page_token** (Optional[str]): Pagination token from a previous response. If provided, fetches the next page of results.
330
+
-**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
339
331
340
332
**Returns:**
341
333
@@ -390,8 +382,8 @@ Create a new Gmail label.
390
382
**Parameters:**
391
383
392
384
-**name** (str): The name of the label to create.
393
-
-**label_list_visibility** (str): Label visibility in label list.
394
-
-**message_list_visibility** (str): Label visibility in message list.
385
+
-**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
386
+
-**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
395
387
396
388
**Returns:**
397
389
@@ -410,7 +402,7 @@ Delete a Gmail label.
410
402
411
403
**Parameters:**
412
404
413
-
-**label_id** (str): The ID of the user-created label to delete. Retrieve the label ID from `list_gmail_labels()`.
405
+
-**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.
414
406
415
407
**Returns:**
416
408
@@ -434,7 +426,7 @@ Modify labels on a thread.
434
426
435
427
**Parameters:**
436
428
437
-
-**thread_id** (str): The ID of the thread to modify.
429
+
-**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().
438
430
-**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().
439
431
440
432
**Returns:**
@@ -485,8 +477,7 @@ Search for people in contacts.
485
477
486
478
**Parameters:**
487
479
488
-
-**query** (str): Search query for people.
489
-
-**max_results** (int): Maximum number of results to fetch.
480
+
-**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'
0 commit comments