| # Streamlit Email App | |
| This project is a Streamlit web application that allows users to send emails with attachments. It provides a user-friendly interface for entering recipient details, email subject, and body text. | |
| ## Project Structure | |
| ``` | |
| streamlit-email-app | |
| ├── src | |
| │ ├── app.py # Main entry point of the Streamlit application | |
| │ ├── email_sender.py # Contains the email sending functionality | |
| │ └── utils.py # Utility functions for validation and formatting | |
| ├── requirements.txt # Lists the dependencies required for the project | |
| └── README.md # Documentation for the project | |
| ``` | |
| ## Setup Instructions | |
| 1. **Clone the repository**: | |
| ``` | |
| git clone <repository-url> | |
| cd streamlit-email-app | |
| ``` | |
| 2. **Install the required packages**: | |
| Make sure you have Python installed. Then, run: | |
| ``` | |
| pip install -r requirements.txt | |
| ``` | |
| ## Usage Guidelines | |
| 1. **Run the application**: | |
| Navigate to the `src` directory and run: | |
| ``` | |
| streamlit run app.py | |
| ``` | |
| 2. **Using the application**: | |
| - Enter the recipient's email address. | |
| - Fill in the subject and body of the email. | |
| - Optionally, attach a file. | |
| - Click the "Send Email" button to send the email. | |
| ## Contributing | |
| Contributions are welcome! Please feel free to submit a pull request or open an issue for any suggestions or improvements. | |
| ## License | |
| This project is licensed under the MIT License. See the LICENSE file for more details. |