Metadata-Version: 2.1
Name: email-api
Version: 0.2
Summary: quickly get the verification code from the temp email
Home-page: https://github.com/xu0329
Author: XuHongsheng
Author-email: xuhongsheng5@outlook.com
License: MIT
Keywords: email temp email verification code
Platform: any
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests

# Email-api

- ### [快速开始](#快速开始)

- ### [注意](#注意)
- ### [支持](#支持)


## 快速开始

```python
pip install email-api
```


***获取邮箱***
```python
email_api.getEmail(arg)
```
***获取验证码***
```python
email_api.getEmailCode()
```

\
\
**自定义邮箱名称**
```python
import email_api


your_email_name='name'  # name@example.com
print(email_api.getEmail(your_email_name))
print(email_api.getEmailCode())

########################################

name@example.com
123456

########################################
```

\
**随机邮箱名称**
```python
import email_api


print(email_api.getEmail(None))
print(email_api.getEmailCode())

########################################

random@example.com
123456

########################################
```


## 注意
### 方法 getEmail() 必须携带参数
随机邮箱参数为None

自定义邮箱只需设置邮箱名称，不能带入后缀

```python
import email_api

# name@example.com

[✓] your_email_name='name' 

[x] your_email_name='name@example.com'
```

### 关于验证码提取
* **支持纯数字的4-6位验证码**
* **暂不支持混合数字字母或纯字母的验证码**

[验证码提取部分 *Line 59* ](email_api/emailapi.py/) 

## 支持
* [mail.cx](https://mail.cx/#/)


