Metadata-Version: 2.1
Name: com.dvsnier.email
Version: 0.0.2a1.dev3
Summary: this is dvsnier email.
Home-page: https://github.com/Alinvor/Python-DeMo/
Author: dvsnier
Author-email: dovsnier@qq.com
License: MIT
Project-URL: Bug_Tracker, https://github.com/Alinvor/Python-DeMo/issues/
Project-URL: Documentation, https://packaging.python.org/tutorials/distributing-packages/
Project-URL: Funding, https://donate.pypi.org/
Project-URL: Homepage, https://github.com/Alinvor/Python-DeMo/
Project-URL: Wiki, https://github.com/Alinvor/Python-DeMo/wiki/
Project-URL: Source, https://github.com/Alinvor/Python-DeMo/
Keywords: email,development
Platform: linux: linux
Platform: windows: win32
Platform: macos: darwin
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: License :: Free For Educational Use
Classifier: License :: Free for non-commercial use
Classifier: License :: Freely Distributable
Classifier: License :: Freeware
Classifier: Natural Language :: Chinese (Simplified)
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Cython
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Requires-Python: !=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,<4,>=2.7
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: LICENSE.txt
Provides-Extra: docs
Provides-Extra: test
Provides-Extra: typing
Requires-Dist: mypy (==0.800) ; extra == 'typing'
Requires-Dist: typing-extensions (>=3.7.4.3) ; extra == 'typing'
Provides-Extra: virtualenv
Requires-Dist: virtualenv (>=20.0.35) ; extra == 'virtualenv'

# Tutorial

- [一. Introduce](#一-introduce)
- [二. Configuration](#二-configuration)
- [三. Usage](#三-usage)

## 一. Introduce

this is a simple email execution program, only a single email address can be mailed.

## 二. Configuration

We recommend using the user profile method to define:

```bash
~/.dvsrc
```

the `.dvsrc` configuration items are as follows:

```bash
##################### SERVER REGION ########################
# the setup server
mail_host = smtp.xx.com
# the Server SSL default port
mail_port = 465
##################### SENDER REGION ########################
# the user name
mail_user = xxx
# the secret key with password or token
mail_passwd = passwd_or_token
# the sender
mail_sender = xxx@xx.com
# the sender alias
sender_alias = xxx
################### RECIPIENT REGION #######################
# the recipient
mail_receiver = yyy@yy.com
# the recipient alias
receiver_alias = yyy
```

of course, you can also specify the configuration file, for specific usage, refer to the following section.

## 三. Usage

```bash
usage: dvs-email [-h] [-V] [-v] [-cfg config-file] [-mr mail-receiver] [-ra receiver-alias] [-f] [-s subject]
                 [-msg message [message ...] | -mf message-file]

this is a simple email execution program, only a single email address can be mailed.

optional arguments:
  -h, --help            show this help message and exit
  -V, --version         the show version and exit.
  -v, --verbose         if true, prepare to output detailed journal records, otherwise no.
  -cfg config-file, --config-file config-file
                        the current mail configuration file.
  -mr mail-receiver, --mail-receiver mail-receiver
                        the current mail recipient.
  -ra receiver-alias, --receiver-alias receiver-alias
                        the current mail recipient alias.
  -f, --mode-flag       if flags == true, email program is ssl mode, otherwise no, and the default value is True.
  -s subject, --subject subject
                        the current email subject and the default value is None when It is recommended that users fill in the email
                        subject by themselves.
  -msg message [message ...], --message message [message ...]
                        the current email message and the default value is None.
  -mf message-file, --message-file message-file
                        the current email message file.

the copyright belongs to DovSnier that reserve the right of final interpretation.
```


