mirror of
https://github.com/infiniflow/ragflow.git
synced 2025-12-02 01:46:46 +00:00
daea357940
### What problem does this PR solve? Fix invalid COMPONENT_EXEC_TIMEOUT. #10273 ### Type of change - [x] Bug Fix (non-breaking change which fixes an issue)
216 lines
8.2 KiB
Python
216 lines
8.2 KiB
Python
#
|
|
# Copyright 2024 The InfiniFlow Authors. All Rights Reserved.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
#
|
|
import os
|
|
import time
|
|
from abc import ABC
|
|
import json
|
|
import smtplib
|
|
import logging
|
|
from email.mime.text import MIMEText
|
|
from email.mime.multipart import MIMEMultipart
|
|
from email.header import Header
|
|
from email.utils import formataddr
|
|
|
|
from agent.tools.base import ToolParamBase, ToolBase, ToolMeta
|
|
from api.utils.api_utils import timeout
|
|
|
|
|
|
class EmailParam(ToolParamBase):
|
|
"""
|
|
Define the Email component parameters.
|
|
"""
|
|
def __init__(self):
|
|
self.meta:ToolMeta = {
|
|
"name": "email",
|
|
"description": "The email is a method of electronic communication for sending and receiving information through the Internet. This tool helps users to send emails to one person or to multiple recipients with support for CC, BCC, file attachments, and markdown-to-HTML conversion.",
|
|
"parameters": {
|
|
"to_email": {
|
|
"type": "string",
|
|
"description": "The target email address.",
|
|
"default": "{sys.query}",
|
|
"required": True
|
|
},
|
|
"cc_email": {
|
|
"type": "string",
|
|
"description": "The other email addresses needs to be send to. Comma splited.",
|
|
"default": "",
|
|
"required": False
|
|
},
|
|
"content": {
|
|
"type": "string",
|
|
"description": "The content of the email.",
|
|
"default": "",
|
|
"required": False
|
|
},
|
|
"subject": {
|
|
"type": "string",
|
|
"description": "The subject/title of the email.",
|
|
"default": "",
|
|
"required": False
|
|
}
|
|
}
|
|
}
|
|
super().__init__()
|
|
# Fixed configuration parameters
|
|
self.smtp_server = "" # SMTP server address
|
|
self.smtp_port = 465 # SMTP port
|
|
self.email = "" # Sender email
|
|
self.password = "" # Email authorization code
|
|
self.sender_name = "" # Sender name
|
|
|
|
def check(self):
|
|
# Check required parameters
|
|
self.check_empty(self.smtp_server, "SMTP Server")
|
|
self.check_empty(self.email, "Email")
|
|
self.check_empty(self.password, "Password")
|
|
self.check_empty(self.sender_name, "Sender Name")
|
|
|
|
def get_input_form(self) -> dict[str, dict]:
|
|
return {
|
|
"to_email": {
|
|
"name": "To ",
|
|
"type": "line"
|
|
},
|
|
"subject": {
|
|
"name": "Subject",
|
|
"type": "line",
|
|
"optional": True
|
|
},
|
|
"cc_email": {
|
|
"name": "CC To",
|
|
"type": "line",
|
|
"optional": True
|
|
},
|
|
}
|
|
|
|
class Email(ToolBase, ABC):
|
|
component_name = "Email"
|
|
|
|
@timeout(int(os.environ.get("COMPONENT_EXEC_TIMEOUT", 60)))
|
|
def _invoke(self, **kwargs):
|
|
if not kwargs.get("to_email"):
|
|
self.set_output("success", False)
|
|
return ""
|
|
|
|
last_e = ""
|
|
for _ in range(self._param.max_retries+1):
|
|
try:
|
|
# Parse JSON string passed from upstream
|
|
email_data = kwargs
|
|
|
|
# Validate required fields
|
|
if "to_email" not in email_data:
|
|
return Email.be_output("Missing required field: to_email")
|
|
|
|
# Create email object
|
|
msg = MIMEMultipart('alternative')
|
|
|
|
# Properly handle sender name encoding
|
|
msg['From'] = formataddr((str(Header(self._param.sender_name,'utf-8')), self._param.email))
|
|
msg['To'] = email_data["to_email"]
|
|
if email_data.get("cc_email"):
|
|
msg['Cc'] = email_data["cc_email"]
|
|
msg['Subject'] = Header(email_data.get("subject", "No Subject"), 'utf-8').encode()
|
|
|
|
# Use content from email_data or default content
|
|
email_content = email_data.get("content", "No content provided")
|
|
# msg.attach(MIMEText(email_content, 'plain', 'utf-8'))
|
|
msg.attach(MIMEText(email_content, 'html', 'utf-8'))
|
|
|
|
# Connect to SMTP server and send
|
|
logging.info(f"Connecting to SMTP server {self._param.smtp_server}:{self._param.smtp_port}")
|
|
|
|
context = smtplib.ssl.create_default_context()
|
|
with smtplib.SMTP(self._param.smtp_server, self._param.smtp_port) as server:
|
|
server.ehlo()
|
|
server.starttls(context=context)
|
|
server.ehlo()
|
|
# Login
|
|
logging.info(f"Attempting to login with email: {self._param.email}")
|
|
server.login(self._param.email, self._param.password)
|
|
|
|
# Get all recipient list
|
|
recipients = [email_data["to_email"]]
|
|
if email_data.get("cc_email"):
|
|
recipients.extend(email_data["cc_email"].split(','))
|
|
|
|
# Send email
|
|
logging.info(f"Sending email to recipients: {recipients}")
|
|
try:
|
|
server.send_message(msg, self._param.email, recipients)
|
|
success = True
|
|
except Exception as e:
|
|
logging.error(f"Error during send_message: {str(e)}")
|
|
# Try alternative method
|
|
server.sendmail(self._param.email, recipients, msg.as_string())
|
|
success = True
|
|
|
|
try:
|
|
server.quit()
|
|
except Exception as e:
|
|
# Ignore errors when closing connection
|
|
logging.warning(f"Non-fatal error during connection close: {str(e)}")
|
|
|
|
self.set_output("success", success)
|
|
return success
|
|
|
|
except json.JSONDecodeError:
|
|
error_msg = "Invalid JSON format in input"
|
|
logging.error(error_msg)
|
|
self.set_output("_ERROR", error_msg)
|
|
self.set_output("success", False)
|
|
return False
|
|
|
|
except smtplib.SMTPAuthenticationError:
|
|
error_msg = "SMTP Authentication failed. Please check your email and authorization code."
|
|
logging.error(error_msg)
|
|
self.set_output("_ERROR", error_msg)
|
|
self.set_output("success", False)
|
|
return False
|
|
|
|
except smtplib.SMTPConnectError:
|
|
error_msg = f"Failed to connect to SMTP server {self._param.smtp_server}:{self._param.smtp_port}"
|
|
logging.error(error_msg)
|
|
last_e = error_msg
|
|
time.sleep(self._param.delay_after_error)
|
|
|
|
except smtplib.SMTPException as e:
|
|
error_msg = f"SMTP error occurred: {str(e)}"
|
|
logging.error(error_msg)
|
|
last_e = error_msg
|
|
time.sleep(self._param.delay_after_error)
|
|
|
|
except Exception as e:
|
|
error_msg = f"Unexpected error: {str(e)}"
|
|
logging.error(error_msg)
|
|
self.set_output("_ERROR", error_msg)
|
|
self.set_output("success", False)
|
|
return False
|
|
|
|
if last_e:
|
|
self.set_output("_ERROR", str(last_e))
|
|
return False
|
|
|
|
assert False, self.output()
|
|
|
|
def thoughts(self) -> str:
|
|
inputs = self.get_input()
|
|
return """
|
|
To: {}
|
|
Subject: {}
|
|
Your email is on its way—sit tight!
|
|
""".format(inputs.get("to_email", "-_-!"), inputs.get("subject", "-_-!"))
|