Camel.toolkits.gmail toolkit

​

GmailToolkit

class GmailToolkit(BaseToolkit):

​

init

def __init__(self, timeout: Optional[float] = None):

• timeout (Optional[float]): The timeout value for API requests in seconds. If None, no timeout is applied. (default: :obj:None)

​

people_service

def people_service(self):

​

people_service

def people_service(self, service: Any):

​

send_email

def send_email(
    self,
    to: Union[str, List[str]],
    subject: str,
    body: str,
    cc: Optional[Union[str, List[str]]] = None,
    bcc: Optional[Union[str, List[str]]] = None,
    attachments: Optional[List[str]] = None,
    is_html: bool = False
):

• to (Union[str, List[str]]): Recipient email address(es).
• subject (str): Email subject.
• body (str): Email body content.
• cc (Optional[Union[str, List[str]]]): CC recipient email address(es).
• bcc (Optional[Union[str, List[str]]]): BCC recipient email address(es).
• attachments (Optional[List[str]]): List of file paths to attach.
• 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.

​

reply_to_email

def reply_to_email(
    self,
    message_id: str,
    reply_body: str,
    reply_all: bool = False,
    is_html: bool = False
):

• 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.

​

forward_email

def forward_email(
    self,
    message_id: str,
    to: Union[str, List[str]],
    forward_body: Optional[str] = None,
    cc: Optional[Union[str, List[str]]] = None,
    bcc: Optional[Union[str, List[str]]] = None,
    include_attachments: bool = True
):

• 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 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.

​

create_email_draft

def create_email_draft(
    self,
    to: Union[str, List[str]],
    subject: str,
    body: str,
    cc: Optional[Union[str, List[str]]] = None,
    bcc: Optional[Union[str, List[str]]] = None,
    attachments: Optional[List[str]] = None,
    is_html: bool = False
):

• to (Union[str, List[str]]): Recipient email address(es).
• subject (str): Email subject.
• body (str): Email body content.
• cc (Optional[Union[str, List[str]]]): CC recipient email address(es).
• bcc (Optional[Union[str, List[str]]]): BCC recipient email address(es).
• attachments (Optional[List[str]]): List of file paths to attach.
• 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.

​

send_draft

def send_draft(self, draft_id: str):

• 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().

​

fetch_emails

def fetch_emails(
    self,
    query: str = '',
    max_results: int = 10,
    include_spam_trash: bool = False,
    label_ids: Optional[List[str]] = None,
    page_token: Optional[str] = None
):

• 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

​

fetch_thread_by_id

def fetch_thread_by_id(self, thread_id: str):

• 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().

​

modify_email_labels

def modify_email_labels(
    self,
    message_id: str,
    add_labels: Optional[List[str]] = None,
    remove_labels: Optional[List[str]] = None
):

• 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.

​

move_to_trash

def move_to_trash(self, message_id: str):

• 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().

​

get_attachment

def get_attachment(
    self,
    message_id: str,
    attachment_id: str,
    save_path: Optional[str] = None
):

• 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.

​

list_threads

def list_threads(
    self,
    query: str = '',
    max_results: int = 10,
    include_spam_trash: bool = False,
    label_ids: Optional[List[str]] = None,
    page_token: Optional[str] = None
):

• 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

​

list_drafts

def list_drafts(self, max_results: int = 10, page_token: Optional[str] = None):

• max_results (int): Maximum number of drafts to fetch.
• page_token (Optional[str]): Pagination token from a previous response. If provided, fetches the next page of results.

​

list_gmail_labels

def list_gmail_labels(self):

​

create_label

def create_label(
    self,
    name: str,
    label_list_visibility: Literal['labelShow', 'labelHide'] = 'labelShow',
    message_list_visibility: Literal['show', 'hide'] = 'show'
):

• name (str): The name of the label to create.
• 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

​

delete_label

def delete_label(self, label_id: str):

• 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.

​

modify_thread_labels

def modify_thread_labels(
    self,
    thread_id: str,
    add_labels: Optional[List[str]] = None,
    remove_labels: Optional[List[str]] = None
):

• 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().

​

get_profile

def get_profile(self):

​

get_contacts

def get_contacts(self, max_results: int = 100, page_token: Optional[str] = None):

• max_results (int): Maximum number of contacts to fetch.
• page_token (Optional[str]): Pagination token from a previous response. If provided, fetches the next page of results.

​

search_people

def search_people(self, query: str, max_results: int = 10):

• 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’

​

_get_gmail_service

def _get_gmail_service(self):

​

_get_people_service

def _get_people_service(self):

​

_authenticate

def _authenticate(self):

​

_create_message

def _create_message(
    self,
    to_list: List[str],
    subject: str,
    body: str,
    cc_list: Optional[List[str]] = None,
    bcc_list: Optional[List[str]] = None,
    attachments: Optional[List[str]] = None,
    is_html: bool = False,
    in_reply_to: Optional[str] = None,
    references: Optional[List[str]] = None
):

​

_get_message_details

def _get_message_details(self, message_id: str):

​

_get_header_value

def _get_header_value(self, headers: List[Dict[str, str]], name: str):

​

_extract_message_body

def _extract_message_body(self, message: Dict[str, Any]):

• message (Dict[str, Any]): The Gmail message dictionary containing the payload to extract text from.

​

_extract_attachments

def _extract_attachments(self, message: Dict[str, Any], include_inline: bool = False):

• message (Dict[str, Any]): The Gmail message dictionary containing the payload to extract attachments from.

• attachment_id: Gmail’s unique identifier for the attachment
• filename: Name of the attached file
• mime_type: MIME type of the attachment
• size: Size of the attachment in bytes
• is_inline: Whether this is an inline image (embedded in HTML)

​

_is_valid_email

def _is_valid_email(self, email: str):

• Plain email: [email protected]
• Named email: John Doe <[email protected]>

​

get_tools

def get_tools(self):