From f31f371d539ba8a206aad46b015108b786f23da7 Mon Sep 17 00:00:00 2001
From: Zhou Tuo <45249333+FromCSUZhou@users.noreply.github.com>
Date: Wed, 7 Feb 2024 02:49:47 +0000
Subject: [PATCH] add email_login tool and add email summarization scenario
 example

---
 examples/email_summary.py         | 25 ++++++++++++++
 metagpt/tools/libs/__init__.py    | 10 +++++-
 metagpt/tools/libs/email_login.py | 57 +++++++++++++++++++++++++++++++
 metagpt/tools/tool_type.py        |  4 +++
 4 files changed, 95 insertions(+), 1 deletion(-)
 create mode 100644 examples/email_summary.py
 create mode 100644 metagpt/tools/libs/email_login.py

diff --git a/examples/email_summary.py b/examples/email_summary.py
new file mode 100644
index 000000000..39c6df1c1
--- /dev/null
+++ b/examples/email_summary.py
@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+"""
+@Date    :   2024/02/07 
+@Author  :   Tuo Zhou
+@File    :   email_summary.py
+"""
+
+from metagpt.roles.ci.code_interpreter import CodeInterpreter
+
+
+async def main():
+    # prompt_response = """I will give you your Outlook email account(englishgpt@outlook.com) and password(the outlook_email_password item in the environment variable). You need to find the latest email in my inbox with the sender's suffix @qq.com and reply to him "Thank you! I have received your email~"""""
+    prompt_summary = """I will give you your Outlook email account(englishgpt@outlook.com) and password(outlook_email_password item in the environment variable).
+            Firstly, Please help me present the latest 5 senders and full letter contents.
+            Then, summarize each of the 5 emails into one sentence with Chinese(you can do this by yourself, don't need import other models to do this) and output them in a markdown format."""
+    # ci_response = CodeInterpreter(goal=prompt_response, use_tools=True)
+    ci_summary = CodeInterpreter(goal=prompt_summary, use_tools=True)
+
+    await ci_summary.run(prompt_summary)
+
+
+if __name__ == "__main__":
+    import asyncio
+
+    asyncio.run(main())
diff --git a/metagpt/tools/libs/__init__.py b/metagpt/tools/libs/__init__.py
index c9767c1e5..91596fd3d 100644
--- a/metagpt/tools/libs/__init__.py
+++ b/metagpt/tools/libs/__init__.py
@@ -10,6 +10,14 @@ from metagpt.tools.libs import (
     sd_engine,
     gpt_v_generator,
     web_scraping,
+    email_login,
 )
 
-_ = data_preprocess, feature_engineering, sd_engine, gpt_v_generator, web_scraping  # Avoid pre-commit error
+_ = (
+    data_preprocess,
+    feature_engineering,
+    sd_engine,
+    gpt_v_generator,
+    web_scraping,
+    email_login,
+)  # Avoid pre-commit error
diff --git a/metagpt/tools/libs/email_login.py b/metagpt/tools/libs/email_login.py
new file mode 100644
index 000000000..946e294eb
--- /dev/null
+++ b/metagpt/tools/libs/email_login.py
@@ -0,0 +1,57 @@
+from imap_tools import MailBox
+
+from metagpt.tools.tool_registry import register_tool
+from metagpt.tools.tool_type import ToolType
+
+
+@register_tool(tool_type=ToolType.EMAIL_LOGIN.type_name)
+def email_login_imap(email_address, email_password):
+    """
+    Use imap_tools package to log in to your email (the email that supports IMAP protocol) to verify and return the account object.
+
+    Args:
+        email_address (str): Email address that needs to be logged in and linked.
+        email_password (str): Password for the email address that needs to be logged in and linked.
+
+    Returns:
+        object: The imap_tools's MailBox object returned after successfully connecting to the mailbox through imap_tools, including various information about this account (email, etc.), or None if login fails.
+    """
+
+    # Define a dictionary mapping email domains to their IMAP server addresses
+    imap_servers = {
+        "outlook.com": "imap-mail.outlook.com",  # Outlook
+        "163.com": "imap.163.com",  # 163 Mail
+        "qq.com": "imap.qq.com",  # QQ Mail
+        "gmail.com": "imap.gmail.com",  # Gmail
+        "yahoo.com": "imap.mail.yahoo.com",  # Yahoo Mail
+        "icloud.com": "imap.mail.me.com",  # iCloud Mail
+        "hotmail.com": "imap-mail.outlook.com",  # Hotmail (同 Outlook)
+        "live.com": "imap-mail.outlook.com",  # Live (同 Outlook)
+        "sina.com": "imap.sina.com",  # Sina Mail
+        "sohu.com": "imap.sohu.com",  # Sohu Mail
+        "yahoo.co.jp": "imap.mail.yahoo.co.jp",  # Yahoo Mail Japan
+        "yandex.com": "imap.yandex.com",  # Yandex Mail
+        "mail.ru": "imap.mail.ru",  # Mail.ru
+        "aol.com": "imap.aol.com",  # AOL Mail
+        "gmx.com": "imap.gmx.com",  # GMX Mail
+        "zoho.com": "imap.zoho.com",  # Zoho Mail
+    }
+
+    # Extract the domain from the email address
+    domain = email_address.split("@")[-1]
+
+    # Determine the correct IMAP server
+    imap_server = imap_servers.get(domain)
+
+    if not imap_server:
+        print(f"IMAP server for {domain} not found.")
+        return None
+
+    # Attempt to log in to the email account
+    try:
+        mailbox = MailBox(imap_server).login(email_address, email_password)
+        print("Login successful")
+        return mailbox
+    except Exception as e:
+        print(f"Login failed: {e}")
+        return None
diff --git a/metagpt/tools/tool_type.py b/metagpt/tools/tool_type.py
index 6fa971c56..5a0c66a03 100644
--- a/metagpt/tools/tool_type.py
+++ b/metagpt/tools/tool_type.py
@@ -17,6 +17,10 @@ class ToolType(Enum):
         desc="Only for changing value inplace.",
         usage_prompt=DATA_PREPROCESS_PROMPT,
     )
+    EMAIL_LOGIN = ToolTypeDef(
+        name="email_login",
+        desc="For logging to an email.",
+    )
     FEATURE_ENGINEERING = ToolTypeDef(
         name="feature_engineering",
         desc="Only for creating new columns for input data.",