Skip to content

Latest commit

 

History

History
83 lines (46 loc) · 3.93 KB

README.MD

File metadata and controls

83 lines (46 loc) · 3.93 KB

SuperAGI Email Tool

The robust SuperAGI Email Tool lets users send and read emails while providing a foundation for other fascinating use cases.

💡 Features

1.Read Emails: With SuperAGI's Email Tool, you can effortlessly manage your inbox and ensure that you never overlook a critical detail.

2.Send Emails: SuperAGI's Email Tool uses its comprehensive language model capabilities to create personalised, context-aware emails, sparing you effort and time.

3.Save Emails to Drafts Folder: By allowing SuperAGI to develop email draughts that you can examine and modify before sending, you'll gain greater control and make sure your messages are tailored to your tastes.

4.Send Emails with Attachments: Send attachments in emails with ease to enrich and expand the scope of your message.

5.Custom Email Signature: Create a unique signature for each email you send to add a touch of customization and automation.

6.Auto-Reply and Answer Questions: Allow SuperAGI to read, analyse, and respond to incoming emails with precise answers to streamline your email responses.

⚙️ Installation

🛠 Setting Up of SuperAGI

Set up the SuperAGI by following the instructions given (https://github.com/TransformerOptimus/SuperAGI/blob/main/README.MD)

🔧 Add Email configuration settings in config.yaml

Add the following configuration settings in the file:

  1. Email address and password:
  • Set 'EMAIL_ADDRESS' to sender's email address
  • Set 'EMAIL_PASSWORD' to your Password. If using Gmail, use App Password (Follow the steps given below to obtain your app password.)
  1. Provider-specific settings:
  • If not using Gmail, modify 'EMAIL_SMTP_HOST', 'EMAIL_SMTP_PORT', AND 'EMAIL_IMAP_HOST' according to your email service provider.
  1. Optional Settings:
  • Change the 'EMAIL_SIGNATURE' to your personalise signature.
  • Add the draft folder for your email service provider to prevent it from being sent and instead save it in drafts.
  • Add the path of the directory from where you want to attach files in 'EMAIL_ATTACHMENT_BASE_PATH'.

Obtain your App Password

To obtain App password for your Gmail Account follow the steps:

app_password

  • To get the App Password ensure that you have set up 2-Step Verification for your email address.

  • Generate the password by creating a custom app

password

  • Copy the password generated and use it for 'EMAIL_PASSWORD'

  • Also make sure IMAP Access is enabled for your Gmail Address (Settings > See all settings > Forwarding and POP/IMAP > Enable IMAP)

imap_enable

Running SuperAGI Email Tool

  1. Read an email

By default SuperAGI's email tool reads last 10 emails from your inbox, to change the limit you can modify the default limit in read_email.py

  1. Send an email

To send an email to a particular receiver, mention the receiver id in your goal. Email will be stored in drafts if in case receiver's email address is not mentioned.

send_email

  1. Send an email with attachment

goals

To attach a file with your email from local device, add the path of the directory to config.yaml else you can also mention the full path of the file in the goal.

attachment