https://github.com/usmanmusa1920/kyaah

Kyaah abstract away cognitive over-head of sending SMTP mail, together with other mailing operations things like, mail with file, tokens etc.
https://github.com/usmanmusa1920/kyaah

email python

Last synced: 8 days ago
JSON representation

Kyaah abstract away cognitive over-head of sending SMTP mail, together with other mailing operations things like, mail with file, tokens etc.

• Host: GitHub
• URL: https://github.com/usmanmusa1920/kyaah
• Owner: usmanmusa1920
• License: mit
• Created: 2022-11-19T09:36:23.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2024-09-22T06:56:51.000Z (about 2 months ago)
• Last Synced: 2024-09-22T07:18:47.054Z (about 2 months ago)
• Topics: email, python
• Language: Python
• Homepage: https://kyaah.readthedocs.io
• Size: 302 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG
  • License: LICENSE

Awesome Lists containing this project

README

        
# Kyaah

Kyaah abstract away cognitive over-head of sending SMTP, POP3, and IMAP mail, together with other mailing operations things like, mail with file, tokens etc.

[![Downloads Month Badge](https://static.pepy.tech/badge/kyaah/month)](https://pypi.org/project/kyaah)

[![License Badge](https://img.shields.io/pypi/l/kyaah.svg)](https://pypi.org/project/kyaah)

[![Supported Wheel Badge](https://img.shields.io/pypi/wheel/kyaah.svg)](https://pypi.org/project/kyaah)

[![Supported Versions Badge](https://img.shields.io/pypi/pyversions/kyaah.svg)](https://pypi.org/project/kyaah)

# Installation & Usage

First, you are recommended to create a virtual environment `python -m venv venv` and then activate it `source venv/bin/activate`, next install the library using:

```sh

    pip install kyaah

```

Wait for the installation to finish, basically the library was uploaded using `sdist` (Source Distribution) and `bdist_wheel` (Built Distribution).

After that, simply import the library and set payload, which include `sender`, `receiver`, `subject`, `body`, and `password` and lastly call the `send` method and pass the `payload` as a keyword just like the sample below:

```python

    import kyaah

        

    payload = dict(

        sender = "[email protected]",

        receiver = ["[email protected]"],

        subject = "Hellow world!",

        body = "Lorem ipsum dolor sit amet adipisicing elit, rerum voluptate ipsum volupt.",

        password = "*********",

    )

    kyaah.send(credentials=payload)

```

> **Note**

> The password to use, is app password, take note that if you use your traditional mail password that you use to login, it won't give access to!

## Useful links

-   Documentations: https://kyaah.readthedocs.io

-   Repository: https://github.com/usmanmusa1920/kyaah

-   PYPI Release: https://pypi.org/project/kyaah