chore: import upstream snapshot with attribution

browser_use/integrations/gmail/actions.py

@@ -0,0 +1,115 @@
+"""
+Gmail Actions for Browser Use
+Defines agent actions for Gmail integration including 2FA code retrieval,
+email reading, and authentication management.
+"""
+
+import logging
+
+from pydantic import BaseModel, Field
+
+from browser_use.agent.views import ActionResult
+from browser_use.tools.service import Tools
+
+from .service import GmailService
+
+logger = logging.getLogger(__name__)
+
+# Global Gmail service instance - initialized when actions are registered
+_gmail_service: GmailService | None = None
+
+
+class GetRecentEmailsParams(BaseModel):
+	"""Parameters for getting recent emails"""
+
+	keyword: str = Field(default='', description='A single keyword for search, e.g. github, airbnb, etc.')
+	max_results: int = Field(default=3, ge=1, le=50, description='Maximum number of emails to retrieve (1-50, default: 3)')
+
+
+def register_gmail_actions(tools: Tools, gmail_service: GmailService | None = None, access_token: str | None = None) -> Tools:
+	"""
+	Register Gmail actions with the provided tools
+	Args:
+	    tools: The browser-use tools to register actions with
+	    gmail_service: Optional pre-configured Gmail service instance
+	    access_token: Optional direct access token (alternative to file-based auth)
+	"""
+	global _gmail_service
+
+	# Use provided service or create a new one with access token if provided
+	if gmail_service:
+		_gmail_service = gmail_service
+	elif access_token:
+		_gmail_service = GmailService(access_token=access_token)
+	else:
+		_gmail_service = GmailService()
+
+	@tools.registry.action(
+		description='Get recent emails from the mailbox with a keyword to retrieve verification codes, OTP, 2FA tokens, magic links, or any recent email content. Keep your query a single keyword.',
+		param_model=GetRecentEmailsParams,
+	)
+	async def get_recent_emails(params: GetRecentEmailsParams) -> ActionResult:
+		"""Get recent emails from the last 5 minutes with full content"""
+		try:
+			if _gmail_service is None:
+				raise RuntimeError('Gmail service not initialized')
+
+			# Ensure authentication
+			if not _gmail_service.is_authenticated():
+				logger.info('📧 Gmail not authenticated, attempting authentication...')
+				authenticated = await _gmail_service.authenticate()
+				if not authenticated:
+					return ActionResult(
+						extracted_content='Failed to authenticate with Gmail. Please ensure Gmail credentials are set up properly.',
+						long_term_memory='Gmail authentication failed',
+					)
+
+			# Use specified max_results (1-50, default 10), last 5 minutes
+			max_results = params.max_results
+			time_filter = '5m'
+
+			# Build query with time filter and optional user query
+			query_parts = [f'newer_than:{time_filter}']
+			if params.keyword.strip():
+				query_parts.append(params.keyword.strip())
+
+			query = ' '.join(query_parts)
+			logger.info(f'🔍 Gmail search query: {query}')
+
+			# Get emails
+			emails = await _gmail_service.get_recent_emails(max_results=max_results, query=query, time_filter=time_filter)
+
+			if not emails:
+				query_info = f" matching '{params.keyword}'" if params.keyword.strip() else ''
+				memory = f'No recent emails found from last {time_filter}{query_info}'
+				return ActionResult(
+					extracted_content=memory,
+					long_term_memory=memory,
+				)
+
+			# Format with full email content for large display
+			content = f'Found {len(emails)} recent email{"s" if len(emails) > 1 else ""} from the last {time_filter}:\n\n'
+
+			for i, email in enumerate(emails, 1):
+				content += f'Email {i}:\n'
+				content += f'From: {email["from"]}\n'
+				content += f'Subject: {email["subject"]}\n'
+				content += f'Date: {email["date"]}\n'
+				content += f'Content:\n{email["body"]}\n'
+				content += '-' * 50 + '\n\n'
+
+			logger.info(f'📧 Retrieved {len(emails)} recent emails')
+			return ActionResult(
+				extracted_content=content,
+				include_extracted_content_only_once=True,
+				long_term_memory=f'Retrieved {len(emails)} recent emails from last {time_filter} for query {query}.',
+			)
+
+		except Exception as e:
+			logger.error(f'Error getting recent emails: {e}')
+			return ActionResult(
+				error=f'Error getting recent emails: {str(e)}',
+				long_term_memory='Failed to get recent emails due to error',
+			)
+
+	return tools