Skip to main content

This is a simple package that provides a quick way to send emails through code.

Project description

Dmail

This is a simple package that provides a simple way to send emails through code.

By default, the content of the mail should be written in markdown

Steins;Gate

Installation

A simple pip install will do :

python -m pip install Dmail

If you want support for code highlighting with pygments:

python -m pip install Dmail[CodeHighlight]

How to use:

import os
from Dmail.esp import Gmail

# email info
recipient_email = "xxx@gmail.com"
cc_email = "yyy@hotmail.fr"
sender_email = os.environ.get('email')
password = os.environ.get('password')

# Send Markdown e-mails :
message = """
# Email Content
This is a **test**

![test image](tests/files/another_image.jpg)

| Collumn1 | Collumn2 | Collumn3 |
| :------: | :------- | -------- |
| Content1 | Content2 | Content3 |

this is some other text

[^1]: This is a footnote.
[^2]: This is another footnote.
"""

with Gmail(sender_email, password) as gmail:
    gmail.send(message, recipient_email, subject="[Dmail] Markdown Demo", cc=cc_email,
           attachments=[r"path\to\image.jpg", r'path\to\pdf.pdf', r'path\to\text.txt'])
  • You can send an e-mail loaded from a file:
with Gmail(sender_email, password) as gmail:
    gmail.send_from_file(r"path\to\my_message.md", recipient_email, 
                         subject="[Dmail] Markdown File")
  • You can also send text or html content by specifying the subtype :
from Dmail.esp import Hotmail

message = "Simple e-mail"

with Hotmail(sender_email, password) as hotmail:
    hotmail.add_attachments(r"path\to\image.jpg", "another_name.jpg")
    hotmail.send(message, recipient_email, "[Dmail] Text demo", subtype='text')
  • The usage of a custom CSS stylesheet is possible :

    with Hotmail(sender_email, password, styles=r'path\to\style.css') as mail:
        mail.send(message, recipient_email, subject="[Dmail] Markdown Style")
    

Custom SMTP Server

  • You can use a custom smtp server and port:
from Dmail import Email

with Email(mail_server, mail_port, sender_email, password) as email:
    email.send(message, recipient_email, "[Dmail] Text demo")

APIs

Gmail Api

Installation

To use the Gmail Api you need to install extra packages :

python -m pip install Dmail[GmailApi]
First use

You can also use the Gmail API through a token ! You'll need to download "credentials.json" ( Step 1 of this guide : https://developers.google.com/gmail/api/quickstart/python#step_1_turn_on_the )

Send Email
from Dmail.api import GmailApi

message = """
# Email Content
This is a **test**
"""

with GmailApi(sender_email, 'token.pickle', 'credentials.json') as email:
    email.send(message, recipient_email, subject='[Dmail] Gmail Api - test')

Once you've given the rights, this will create the "token.pickle" that you can use later !

Create draft

Instead of sending the email, you can create it as a draft

from Dmail.api import GmailApi

with GmailApi(sender_email, 'token.pickle') as email:
    email.create_draft(message, recipient_email, '[Dmail] Gmail Api - draft')

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

Dmail-1.2.6.tar.gz (12.1 kB view details)

Uploaded Source

Built Distribution

Dmail-1.2.6-py3-none-any.whl (18.6 kB view details)

Uploaded Python 3

File details

Details for the file Dmail-1.2.6.tar.gz.

File metadata

  • Download URL: Dmail-1.2.6.tar.gz
  • Upload date:
  • Size: 12.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/50.3.1.post20201107 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.6.12

File hashes

Hashes for Dmail-1.2.6.tar.gz
Algorithm Hash digest
SHA256 0615eadf84339b0b61421afb36f8cefab07320456d53c425285f57068e736c43
MD5 fe182b9f930e1b3dea817f981e953504
BLAKE2b-256 53f5b994de7d3808c944a858cf9ef4089495adc748bb356e79a7053b1c15607b

See more details on using hashes here.

File details

Details for the file Dmail-1.2.6-py3-none-any.whl.

File metadata

  • Download URL: Dmail-1.2.6-py3-none-any.whl
  • Upload date:
  • Size: 18.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/50.3.1.post20201107 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.6.12

File hashes

Hashes for Dmail-1.2.6-py3-none-any.whl
Algorithm Hash digest
SHA256 94207c2b42292fa107ad72ce7902fb84d43a467d50b605ffd67554b41ac73c12
MD5 9add7c0732b0caded164c6a7fbda5c6a
BLAKE2b-256 b4f0f06087abe06d1dfa44b36105f4ec669dcb6f4522f3a0922f2402fd8cbd7e

See more details on using hashes here.

Supported by

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