Skip to main content

Super simple self-emailing.

Project description

# emailme

A Python module to email myself from Python scripts and the command line.

# installation

```bash
$ pip install emailme
```

# intended usage

`emailme` is intended to be used to quick-fire send an email to oneself from Python scripts and from the command line.

## initial setup

Sending email requires you to login to an SMTP server. This often means a password is required.

To get started, you will need to store your username and password in a file that is read-write only by you. `emailme` provides a convenience way to get setup.

```bash
$ emailme start
```

You will be asked for your email address and passwrod there.

**note about password:** I strongly suggest NOT storing your regular email password. Instead, you should be using an app-specific password that you rotate regularly. Gmail offers such a functionality, and is highly recommended. Check with your email host provider for more detail.

Upon entering your credentials, a file will be written to disk at `~/.credentials/emailme.json`. This email is only read/write-able by you; other users of the computer are unable to read or write it.

Upon this initial setup, you will now be able to use `emailme` to send emails to yourself.


## command line usage

Usage at the command line is super simple.

```bash
$ emailme sendmail --subject "hey" --message "what's up?"
```

(be sure to escape your exclamation marks!)

## script usage

You can also import emailme and use it from a Python script.

```python
from emailme import sendmail

sendmail(subject='hey', message="What's up? How are you doing?")
```


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

emailme-0.1.5.tar.gz (3.3 kB view details)

Uploaded Source

Built Distribution

emailme-0.1.5-py3-none-any.whl (3.5 kB view details)

Uploaded Python 3

File details

Details for the file emailme-0.1.5.tar.gz.

File metadata

  • Download URL: emailme-0.1.5.tar.gz
  • Upload date:
  • Size: 3.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for emailme-0.1.5.tar.gz
Algorithm Hash digest
SHA256 6157d1e0d8c00cc56a6ef5e68510f9edb79e3f559dc709f182c75cb2cad8186d
MD5 17348f186409446eba0405949ac08940
BLAKE2b-256 c4a1c1c59e3bcabaddb5d08fe09828d6bd6320e8e48b64e6b54e0d01be0d350c

See more details on using hashes here.

File details

Details for the file emailme-0.1.5-py3-none-any.whl.

File metadata

File hashes

Hashes for emailme-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 6fb832f277fe0dc9a3198e5ec3a480e63436ded0d4b1ae069d4a4e3190ddbcd6
MD5 db7f38d55ea809b00568ab3ebafb4b7e
BLAKE2b-256 89f933de232764f721ef8c468d8f165275ff07650e81a8d03ea05cb400bea655

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page