Skip to content

Commit

Permalink
Fixed some errors in docs and readme file (sabuhish#165)
Browse files Browse the repository at this point in the history
  • Loading branch information
elpacificmb authored Dec 22, 2022
1 parent f7e693b commit edc6622
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

# Fastapi-mail

The fastapi-mail simple lightweight mail system, sending emails and attachments(individual && bulk)
The fastapi-mail is a simple lightweight mail system, for sending emails and attachments(individual && bulk)


[![MIT licensed](https://img.shields.io/github/license/sabuhish/fastapi-mail)](https://raw.githubusercontent.com/sabuhish/fastapi-mail/master/LICENSE)
Expand Down Expand Up @@ -48,7 +48,7 @@ python add 'fastapi-mail[httpx]'

The key features are:

- sending emails with either with FastApi or using asyncio module
- sending emails either with FastApi or using asyncio module
- sending emails using FastApi background task managment
- sending files either from form-data or files from server
- Using Jinja2 HTML Templates
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ The class makes it possible to use redis to save data.

### ```email_utils.WhoIsXmlApi``` class
WhoIsXmlApi class provide working with api [WhoIsXmlApi](https://www.whoisxmlapi.com)
This service gives free 1000 request to checking email address per month.
This service gives free 1000 requests for checking email address per month.

- token : token you can get from this [WhoIsXmlApi](https://www.whoisxmlapi.com) link
- email : email for checking
8 changes: 4 additions & 4 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Fastapi-mail

The fastapi-mail simple lightweight mail system, sending emails and attachments(individual && bulk)
The fastapi-mail is a simple lightweight mail system, for sending emails and attachments(individual && bulk)


[![MIT licensed](https://img.shields.io/github/license/sabuhish/fastapi-mail)](https://raw.githubusercontent.com/sabuhish/fastapi-mail/master/LICENSE)
Expand All @@ -12,9 +12,9 @@ The fastapi-mail simple lightweight mail system, sending emails and attachments(

## Using Jinja2 HTML Templates

In order to use Jinja template langauge, your must specify email folder within your applications working directory.
In order to use Jinja template langauge, you must specify the email folder within your application's working directory.

In sending HTML emails, the CSS expected by mail servers -outlook, google, etc- must be inline CSS. Fastapi mail passes _"body"_ to the rendered template. In creating the template for emails the dynamic objects should be used with the assumption that the variable is named "_body_" and that it is a python dict.
When sending HTML emails, the CSS expected by mail servers -outlook, google, etc- must be inline CSS. Fastapi mail passes _"body"_ to the rendered template. In creating the template for emails the dynamic objects should be used with the assumption that the variable is named "_body_" and that it is a python dict.

check out jinja2 for more details
[jinja2](https://jinja.palletsprojects.com/en/2.11.x/)
Expand All @@ -30,7 +30,7 @@ then the utility will save it in the list or set by default.


## Writing unittests using Fastapi-Mail
Fastapi mails allows you to write unittest for your application without sending emails to
Fastapi-mail allows you to write unittest for your application without sending emails to
non existent email address by mocking the email to be sent. To mock sending out mails, set
the suppress configuration to true. Suppress send defaults to False to prevent mocking within applications.

Expand Down

0 comments on commit edc6622

Please sign in to comment.