merrmail Goto Github PK

MerrMail is an open-source email bot/assistant designed to organize and automate replies to your common emails.

MerrMail utilizes AI to analyze and generate replies to your emails by providing context. Once the program starts, it creates three labels within your email account and begins organizing email threads from your inbox. Importantly, it does not mark your emails as read, allowing you to keep track of which ones you have already reviewed. (Currently, it only supports Gmail).

• MerrMail: High Priority are email threads that did not receive an auto-reply.
• MerrMail: Low Priority are email threads that received a reply from MerrMail. The reply is generated using the email contexts provided by the user of this program.
• MerrMail: Other are email threads initiated by the host or email addresses identified as 'no-reply'.

Before you begin, make sure you have the following. Note that all of these are free.

• Git
• .NET 8
• Docker Compose
• SQLite (optional but recommended)
• Google App Password
• Gmail OAuth 2.0 Client Credentials

We will be building from source, so please follow the steps to install MerrMail on your system.

• First, open your terminal and clone this repository.

$ git clone https://github.com/merrsoft/merrmail.git 
$ cd merrmail

• Take a look at the docker-compose.yml file. Alternatively, can build the Docker image from source.

version: '3'

networks:
  merrnet:
    driver: bridge

services:
  tensorflow:
    build:
      context: src/Infrastructure
      dockerfile: Dockerfile
    ports:
      - "63778:63778"
    networks:
      - merrnet
    volumes:
      - ./secrets/universal_sentence_encoder:/universal_sentence_encoder

• Setup our custom container of TensorFlow's Universal Sentence Encoder.

$ mkdir -p secrets/universal_sentence_encoder 
$ docker-compose up -d

• Navigate to the main entrypoint of the program.

$ cd src/MerrMail 

In order to run the program, you must properly set each configuration of MerrMail. You can also refer to our sample settings.

• EmailReplyOptions:Header sets the header format of the email.
• EmailReplyOptions:Introduction sets the first part of the email. then shows the message from the database.
• EmailReplyOptions:Conclusion sets the last part of the email body.
• EmailReplyOptions:Closing is self-explanatory.
• EmailReplyOptions:Signature is the same.

$ dotnet user-secrets set EmailReplyOptions:Header "Greet the sender"
$ dotnet user-secrets set EmailReplyOptions:Introduction "Explain what's going on"
$ dotnet user-secrets set EmailReplyOptions:Conclusion "Outline next steps"
$ dotnet user-secrets set EmailReplyOptions:Closing "Regards"
$ dotnet user-secrets set EmailReplyOptions:Signature "Provide contact information"

• EmailApiOptions:OAuthClientCrednetialsFilePath is the location of your credentials.json file. Assuming you already downloaded the json credentials from your Gmail API.
• EmailApiOptions:AccessTokenDirectoryPath is the folder where the program will look for your access token. If nothing found, it will open a browser for you to give the program an access to your Gmail API, and then creates the access token.
• EmailApiOptions:HostAddress is your email address.
• EmailApiOptions:HostPassword is the 16-digit app password provided by Google. Assuming you already created an app password for your Google account.

$ dotnet user-secrets set EmailApiOptions:OAuthClientCredentialsFilePath "/path/to/your/credentials.json"
$ dotnet user-secrets set EmailApiOptions:AccessTokenDirectoryPath "/path/to/your/token_folder"
$ dotnet user-secrets set EmailApiOptions:HostAddress "[email protected]"
$ dotnet user-secrets set EmailApiOptions:HostPassword "your_email_account_app_password"

• EmailAnalyzerOptions:AcceptanceScore 0.35 is the "cosine similarity score" that is accepted by your program (we recommend between 0.24 and 0.35). It doesn't allow values that's not between 0.0 and 1.0.

$ dotnet user-secrets set EmailAnalyzerOptions:AcceptanceScore 0.35

• DataStorageOptions:DataStorageType 0 sets the type of your data storage to SQLite.
• DataStorageOptions:DataStorageType 1 sets the data storge type to CSV. Yes, we support CSV! 🎉
• DataStorageOptions:DataStorageAccess is the location of your data storage file. The file type varies depending on what data storage type you chose.

$ dotnet user-secrets set DataStorageOptions:DataStorageType 0
$ dotnet user-secrets set DataStorageOptions:DataStorageAccess "/path/to/your/data/storage/file"

Below is the format of your data storage depending of which type you chose.

• email-context.csv

Subject,Response
"The first row is not","Going to be read."
"Here is my subject","Here is my response, you can use comma."
We recommend wrapping values with quotes,"Wrap ""your quotes"" twice if you want to use quotes."

• email-context.db

-- Note that this is the create statement, not the content of the file.
-- Use SQLite Browser to create tables.
CREATE TABLE "EmailContexts" (
	"Subject"	TEXT NOT NULL,
	"Response"	TEXT NOT NULL
)

Before running our program, please refer to our License.

• You can check if you've properly configured all your app secrets.

$ dotnet user-secrets list

• If everything is configured correctly, you can now run the program!

$ dotnet run

Thank you for choosing MerrMail! We're excited to see how our open-source email bot transforms your inbox. If you have any questions or feedback, feel free to reach out to us. Happy emailing! 🌟