hostinger-email-api 0.1.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- hostinger_email_api-0.1.0/PKG-INFO +180 -0
- hostinger_email_api-0.1.0/README.md +156 -0
- hostinger_email_api-0.1.0/hostinger_email_api/__init__.py +76 -0
- hostinger_email_api-0.1.0/hostinger_email_api/api/__init__.py +10 -0
- hostinger_email_api-0.1.0/hostinger_email_api/api/account_api.py +284 -0
- hostinger_email_api-0.1.0/hostinger_email_api/api/folders_api.py +1271 -0
- hostinger_email_api-0.1.0/hostinger_email_api/api/messages_api.py +4237 -0
- hostinger_email_api-0.1.0/hostinger_email_api/api/quota_api.py +304 -0
- hostinger_email_api-0.1.0/hostinger_email_api/api/send_api.py +336 -0
- hostinger_email_api-0.1.0/hostinger_email_api/api/webhooks_api.py +2154 -0
- hostinger_email_api-0.1.0/hostinger_email_api/api_client.py +795 -0
- hostinger_email_api-0.1.0/hostinger_email_api/api_response.py +21 -0
- hostinger_email_api-0.1.0/hostinger_email_api/configuration.py +579 -0
- hostinger_email_api-0.1.0/hostinger_email_api/exceptions.py +214 -0
- hostinger_email_api-0.1.0/hostinger_email_api/models/__init__.py +54 -0
- hostinger_email_api-0.1.0/hostinger_email_api/models/error.py +89 -0
- hostinger_email_api-0.1.0/hostinger_email_api/models/pagination.py +91 -0
- hostinger_email_api-0.1.0/hostinger_email_api/models/v1_folder_messages_collection.py +99 -0
- hostinger_email_api-0.1.0/hostinger_email_api/models/v1_folder_messages_delete_bulk_request.py +86 -0
- hostinger_email_api-0.1.0/hostinger_email_api/models/v1_folder_messages_flags_bulk_request.py +90 -0
- hostinger_email_api-0.1.0/hostinger_email_api/models/v1_folder_messages_flags_request.py +88 -0
- hostinger_email_api-0.1.0/hostinger_email_api/models/v1_folder_messages_message.py +165 -0
- hostinger_email_api-0.1.0/hostinger_email_api/models/v1_folder_messages_message_address.py +87 -0
- hostinger_email_api-0.1.0/hostinger_email_api/models/v1_folder_messages_message_attachment.py +105 -0
- hostinger_email_api-0.1.0/hostinger_email_api/models/v1_folder_messages_message_text.py +87 -0
- hostinger_email_api-0.1.0/hostinger_email_api/models/v1_folder_messages_message_text_resource.py +89 -0
- hostinger_email_api-0.1.0/hostinger_email_api/models/v1_folder_messages_move_bulk_request.py +88 -0
- hostinger_email_api-0.1.0/hostinger_email_api/models/v1_folder_messages_move_request.py +86 -0
- hostinger_email_api-0.1.0/hostinger_email_api/models/v1_folder_messages_resource.py +89 -0
- hostinger_email_api-0.1.0/hostinger_email_api/models/v1_folder_messages_search_request.py +111 -0
- hostinger_email_api-0.1.0/hostinger_email_api/models/v1_folder_messages_update_flags_result.py +89 -0
- hostinger_email_api-0.1.0/hostinger_email_api/models/v1_folder_messages_update_flags_result_data.py +95 -0
- hostinger_email_api-0.1.0/hostinger_email_api/models/v1_folder_messages_update_flags_result_data_failed_inner.py +87 -0
- hostinger_email_api-0.1.0/hostinger_email_api/models/v1_folders_collection.py +99 -0
- hostinger_email_api-0.1.0/hostinger_email_api/models/v1_folders_create_request.py +86 -0
- hostinger_email_api-0.1.0/hostinger_email_api/models/v1_folders_folder.py +100 -0
- hostinger_email_api-0.1.0/hostinger_email_api/models/v1_folders_resource.py +89 -0
- hostinger_email_api-0.1.0/hostinger_email_api/models/v1_folders_update_request.py +86 -0
- hostinger_email_api-0.1.0/hostinger_email_api/models/v1_me_mailbox.py +95 -0
- hostinger_email_api-0.1.0/hostinger_email_api/models/v1_me_resource.py +89 -0
- hostinger_email_api-0.1.0/hostinger_email_api/models/v1_me_resource_data.py +103 -0
- hostinger_email_api-0.1.0/hostinger_email_api/models/v1_quota_quota.py +101 -0
- hostinger_email_api-0.1.0/hostinger_email_api/models/v1_quota_quota_resource.py +91 -0
- hostinger_email_api-0.1.0/hostinger_email_api/models/v1_quota_resource.py +89 -0
- hostinger_email_api-0.1.0/hostinger_email_api/models/v1_send_attachment.py +93 -0
- hostinger_email_api-0.1.0/hostinger_email_api/models/v1_send_request.py +92 -0
- hostinger_email_api-0.1.0/hostinger_email_api/models/v1_webhooks_collection.py +99 -0
- hostinger_email_api-0.1.0/hostinger_email_api/models/v1_webhooks_create_request.py +117 -0
- hostinger_email_api-0.1.0/hostinger_email_api/models/v1_webhooks_resource.py +89 -0
- hostinger_email_api-0.1.0/hostinger_email_api/models/v1_webhooks_resource_with_secret.py +89 -0
- hostinger_email_api-0.1.0/hostinger_email_api/models/v1_webhooks_test_result.py +89 -0
- hostinger_email_api-0.1.0/hostinger_email_api/models/v1_webhooks_test_result_data.py +94 -0
- hostinger_email_api-0.1.0/hostinger_email_api/models/v1_webhooks_update_request.py +120 -0
- hostinger_email_api-0.1.0/hostinger_email_api/models/v1_webhooks_webhook.py +132 -0
- hostinger_email_api-0.1.0/hostinger_email_api/models/v1_webhooks_webhook_with_secret.py +134 -0
- hostinger_email_api-0.1.0/hostinger_email_api/py.typed +0 -0
- hostinger_email_api-0.1.0/hostinger_email_api/rest.py +256 -0
- hostinger_email_api-0.1.0/hostinger_email_api.egg-info/PKG-INFO +180 -0
- hostinger_email_api-0.1.0/hostinger_email_api.egg-info/SOURCES.txt +110 -0
- hostinger_email_api-0.1.0/hostinger_email_api.egg-info/dependency_links.txt +1 -0
- hostinger_email_api-0.1.0/hostinger_email_api.egg-info/requires.txt +4 -0
- hostinger_email_api-0.1.0/hostinger_email_api.egg-info/top_level.txt +1 -0
- hostinger_email_api-0.1.0/pyproject.toml +91 -0
- hostinger_email_api-0.1.0/setup.cfg +7 -0
- hostinger_email_api-0.1.0/setup.py +49 -0
- hostinger_email_api-0.1.0/test/test_account_api.py +36 -0
- hostinger_email_api-0.1.0/test/test_error.py +55 -0
- hostinger_email_api-0.1.0/test/test_folders_api.py +57 -0
- hostinger_email_api-0.1.0/test/test_messages_api.py +120 -0
- hostinger_email_api-0.1.0/test/test_pagination.py +56 -0
- hostinger_email_api-0.1.0/test/test_quota_api.py +36 -0
- hostinger_email_api-0.1.0/test/test_send_api.py +36 -0
- hostinger_email_api-0.1.0/test/test_v1_folder_messages_collection.py +128 -0
- hostinger_email_api-0.1.0/test/test_v1_folder_messages_delete_bulk_request.py +50 -0
- hostinger_email_api-0.1.0/test/test_v1_folder_messages_flags_bulk_request.py +52 -0
- hostinger_email_api-0.1.0/test/test_v1_folder_messages_flags_request.py +50 -0
- hostinger_email_api-0.1.0/test/test_v1_folder_messages_message.py +120 -0
- hostinger_email_api-0.1.0/test/test_v1_folder_messages_message_address.py +52 -0
- hostinger_email_api-0.1.0/test/test_v1_folder_messages_message_attachment.py +60 -0
- hostinger_email_api-0.1.0/test/test_v1_folder_messages_message_text.py +52 -0
- hostinger_email_api-0.1.0/test/test_v1_folder_messages_message_text_resource.py +54 -0
- hostinger_email_api-0.1.0/test/test_v1_folder_messages_move_bulk_request.py +52 -0
- hostinger_email_api-0.1.0/test/test_v1_folder_messages_move_request.py +50 -0
- hostinger_email_api-0.1.0/test/test_v1_folder_messages_resource.py +114 -0
- hostinger_email_api-0.1.0/test/test_v1_folder_messages_search_request.py +61 -0
- hostinger_email_api-0.1.0/test/test_v1_folder_messages_update_flags_result.py +62 -0
- hostinger_email_api-0.1.0/test/test_v1_folder_messages_update_flags_result_data.py +60 -0
- hostinger_email_api-0.1.0/test/test_v1_folder_messages_update_flags_result_data_failed_inner.py +52 -0
- hostinger_email_api-0.1.0/test/test_v1_folders_collection.py +76 -0
- hostinger_email_api-0.1.0/test/test_v1_folders_create_request.py +50 -0
- hostinger_email_api-0.1.0/test/test_v1_folders_folder.py +60 -0
- hostinger_email_api-0.1.0/test/test_v1_folders_resource.py +62 -0
- hostinger_email_api-0.1.0/test/test_v1_folders_update_request.py +50 -0
- hostinger_email_api-0.1.0/test/test_v1_me_mailbox.py +52 -0
- hostinger_email_api-0.1.0/test/test_v1_me_resource.py +62 -0
- hostinger_email_api-0.1.0/test/test_v1_me_resource_data.py +60 -0
- hostinger_email_api-0.1.0/test/test_v1_quota_quota.py +70 -0
- hostinger_email_api-0.1.0/test/test_v1_quota_quota_resource.py +56 -0
- hostinger_email_api-0.1.0/test/test_v1_quota_resource.py +72 -0
- hostinger_email_api-0.1.0/test/test_v1_send_attachment.py +55 -0
- hostinger_email_api-0.1.0/test/test_v1_send_request.py +63 -0
- hostinger_email_api-0.1.0/test/test_v1_webhooks_collection.py +88 -0
- hostinger_email_api-0.1.0/test/test_v1_webhooks_create_request.py +56 -0
- hostinger_email_api-0.1.0/test/test_v1_webhooks_resource.py +74 -0
- hostinger_email_api-0.1.0/test/test_v1_webhooks_resource_with_secret.py +50 -0
- hostinger_email_api-0.1.0/test/test_v1_webhooks_test_result.py +56 -0
- hostinger_email_api-0.1.0/test/test_v1_webhooks_test_result_data.py +52 -0
- hostinger_email_api-0.1.0/test/test_v1_webhooks_update_request.py +53 -0
- hostinger_email_api-0.1.0/test/test_v1_webhooks_webhook.py +72 -0
- hostinger_email_api-0.1.0/test/test_v1_webhooks_webhook_with_secret.py +74 -0
- hostinger_email_api-0.1.0/test/test_webhooks_api.py +78 -0
|
@@ -0,0 +1,180 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: hostinger_email_api
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Hostinger Email API
|
|
5
|
+
Home-page: https://github.com/hostinger/email-api-python-sdk
|
|
6
|
+
Author: Hostinger
|
|
7
|
+
Author-email: devs@hostinger.com
|
|
8
|
+
License: MIT
|
|
9
|
+
Keywords: hostinger,openapi,python,sdk,rest,api
|
|
10
|
+
Description-Content-Type: text/markdown
|
|
11
|
+
Requires-Dist: urllib3<3.0.0,>=2.7.0
|
|
12
|
+
Requires-Dist: python-dateutil>=2.8.2
|
|
13
|
+
Requires-Dist: pydantic>=2
|
|
14
|
+
Requires-Dist: typing-extensions>=4.7.1
|
|
15
|
+
Dynamic: author
|
|
16
|
+
Dynamic: author-email
|
|
17
|
+
Dynamic: description
|
|
18
|
+
Dynamic: description-content-type
|
|
19
|
+
Dynamic: home-page
|
|
20
|
+
Dynamic: keywords
|
|
21
|
+
Dynamic: license
|
|
22
|
+
Dynamic: requires-dist
|
|
23
|
+
Dynamic: summary
|
|
24
|
+
|
|
25
|
+
# Hostinger Email API Python SDK
|
|
26
|
+
|
|
27
|
+
[](https://badge.fury.io/py/hostinger_email_api)
|
|
28
|
+
|
|
29
|
+
## About
|
|
30
|
+
This is a Python SDK for the [Hostinger API](https://developers.hostinger.com).
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
## Requirements.
|
|
34
|
+
|
|
35
|
+
Python 3.9+
|
|
36
|
+
|
|
37
|
+
## Installation & Usage
|
|
38
|
+
### pip install
|
|
39
|
+
|
|
40
|
+
Setup new virtual environment (optional but recommended):
|
|
41
|
+
```sh
|
|
42
|
+
python3 -m venv venv
|
|
43
|
+
source venv/bin/activate
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
Install the package via [pip](https://pypi.org/project/pip/):
|
|
47
|
+
```sh
|
|
48
|
+
pip install hostinger_email_api
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
Then import the package:
|
|
52
|
+
```python
|
|
53
|
+
import hostinger_email_api
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
### Setuptools
|
|
57
|
+
|
|
58
|
+
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
|
|
59
|
+
|
|
60
|
+
```sh
|
|
61
|
+
python setup.py install --user
|
|
62
|
+
```
|
|
63
|
+
(or `sudo python setup.py install` to install the package for all users)
|
|
64
|
+
|
|
65
|
+
Then import the package:
|
|
66
|
+
```python
|
|
67
|
+
import hostinger_email_api
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
## Getting Started
|
|
71
|
+
|
|
72
|
+
Please follow the [installation procedure](#installation--usage) and then run the following:
|
|
73
|
+
|
|
74
|
+
```python
|
|
75
|
+
|
|
76
|
+
import hostinger_email_api
|
|
77
|
+
from hostinger_email_api.rest import ApiException
|
|
78
|
+
from pprint import pprint
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
# Configure Bearer authorization: BearerAuth
|
|
82
|
+
configuration = hostinger_email_api.Configuration(
|
|
83
|
+
access_token = os.environ["BEARER_TOKEN"]
|
|
84
|
+
)
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
# Enter a context with an instance of the API client
|
|
88
|
+
with hostinger_email_api.ApiClient(configuration) as api_client:
|
|
89
|
+
# Create an instance of the API class
|
|
90
|
+
api_instance = hostinger_email_api.AccountApi(api_client)
|
|
91
|
+
|
|
92
|
+
try:
|
|
93
|
+
# Get the authenticated account
|
|
94
|
+
api_response = api_instance.get_current_account()
|
|
95
|
+
print("The response of AccountApi->get_current_account:\n")
|
|
96
|
+
pprint(api_response)
|
|
97
|
+
except ApiException as e:
|
|
98
|
+
print("Exception when calling AccountApi->get_current_account: %s\n" % e)
|
|
99
|
+
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
## Documentation for API Endpoints
|
|
103
|
+
|
|
104
|
+
All URIs are relative to *https://api.mail.hostinger.com*
|
|
105
|
+
|
|
106
|
+
Class | Method | HTTP request | Description
|
|
107
|
+
------------ | ------------- | ------------- | -------------
|
|
108
|
+
*AccountApi* | [**get_current_account**](docs/AccountApi.md#get_current_account) | **GET** /api/v1/me | Get the authenticated account
|
|
109
|
+
*FoldersApi* | [**create_folder**](docs/FoldersApi.md#create_folder) | **POST** /api/v1/mailboxes/{mailboxResourceId}/folders | Create folder
|
|
110
|
+
*FoldersApi* | [**delete_folder**](docs/FoldersApi.md#delete_folder) | **DELETE** /api/v1/mailboxes/{mailboxResourceId}/folders/{folder} | Delete folder
|
|
111
|
+
*FoldersApi* | [**list_folders**](docs/FoldersApi.md#list_folders) | **GET** /api/v1/mailboxes/{mailboxResourceId}/folders | List folders
|
|
112
|
+
*FoldersApi* | [**update_folder**](docs/FoldersApi.md#update_folder) | **PUT** /api/v1/mailboxes/{mailboxResourceId}/folders/{folder} | Update folder
|
|
113
|
+
*MessagesApi* | [**delete_all_messages**](docs/MessagesApi.md#delete_all_messages) | **DELETE** /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages | Delete all messages
|
|
114
|
+
*MessagesApi* | [**delete_message**](docs/MessagesApi.md#delete_message) | **DELETE** /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/{uid} | Delete message
|
|
115
|
+
*MessagesApi* | [**delete_messages**](docs/MessagesApi.md#delete_messages) | **POST** /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/delete | Delete messages
|
|
116
|
+
*MessagesApi* | [**get_message**](docs/MessagesApi.md#get_message) | **GET** /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/{uid} | Get message
|
|
117
|
+
*MessagesApi* | [**get_message_attachment**](docs/MessagesApi.md#get_message_attachment) | **GET** /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/{uid}/attachments/{attachmentId} | Download message attachment
|
|
118
|
+
*MessagesApi* | [**get_message_source**](docs/MessagesApi.md#get_message_source) | **GET** /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/{uid}/source | Get message source
|
|
119
|
+
*MessagesApi* | [**get_message_text**](docs/MessagesApi.md#get_message_text) | **GET** /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/{uid}/text | Get message text content
|
|
120
|
+
*MessagesApi* | [**list_messages**](docs/MessagesApi.md#list_messages) | **GET** /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages | List messages
|
|
121
|
+
*MessagesApi* | [**move_message**](docs/MessagesApi.md#move_message) | **POST** /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/{uid}/move | Move message
|
|
122
|
+
*MessagesApi* | [**move_messages**](docs/MessagesApi.md#move_messages) | **POST** /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/move | Move messages
|
|
123
|
+
*MessagesApi* | [**patch_message**](docs/MessagesApi.md#patch_message) | **PATCH** /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/{uid} | Update message flags
|
|
124
|
+
*MessagesApi* | [**search_messages**](docs/MessagesApi.md#search_messages) | **POST** /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/search | Search messages
|
|
125
|
+
*MessagesApi* | [**update_message_flags**](docs/MessagesApi.md#update_message_flags) | **POST** /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/flags | Update message flags
|
|
126
|
+
*QuotaApi* | [**get_quota**](docs/QuotaApi.md#get_quota) | **GET** /api/v1/mailboxes/{mailboxResourceId}/quota | Get mailbox quota
|
|
127
|
+
*SendApi* | [**send_email**](docs/SendApi.md#send_email) | **POST** /api/v1/mailboxes/{mailboxResourceId}/send | Send email
|
|
128
|
+
*WebhooksApi* | [**create_webhook**](docs/WebhooksApi.md#create_webhook) | **POST** /api/v1/mailboxes/{mailboxResourceId}/webhooks | Create webhook
|
|
129
|
+
*WebhooksApi* | [**delete_webhook**](docs/WebhooksApi.md#delete_webhook) | **DELETE** /api/v1/mailboxes/{mailboxResourceId}/webhooks/{webhook} | Delete webhook
|
|
130
|
+
*WebhooksApi* | [**get_webhook**](docs/WebhooksApi.md#get_webhook) | **GET** /api/v1/mailboxes/{mailboxResourceId}/webhooks/{webhook} | Get webhook
|
|
131
|
+
*WebhooksApi* | [**list_webhooks**](docs/WebhooksApi.md#list_webhooks) | **GET** /api/v1/mailboxes/{mailboxResourceId}/webhooks | List webhooks
|
|
132
|
+
*WebhooksApi* | [**regenerate_webhook_secret**](docs/WebhooksApi.md#regenerate_webhook_secret) | **POST** /api/v1/mailboxes/{mailboxResourceId}/webhooks/{webhook}/regenerate-secret | Regenerate webhook secret
|
|
133
|
+
*WebhooksApi* | [**test_webhook**](docs/WebhooksApi.md#test_webhook) | **POST** /api/v1/mailboxes/{mailboxResourceId}/webhooks/{webhook}/test | Test webhook
|
|
134
|
+
*WebhooksApi* | [**update_webhook**](docs/WebhooksApi.md#update_webhook) | **PATCH** /api/v1/mailboxes/{mailboxResourceId}/webhooks/{webhook} | Update webhook
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
## Documentation For Models
|
|
138
|
+
|
|
139
|
+
- [Error](docs/Error.md)
|
|
140
|
+
- [Pagination](docs/Pagination.md)
|
|
141
|
+
- [V1FolderMessagesCollection](docs/V1FolderMessagesCollection.md)
|
|
142
|
+
- [V1FolderMessagesDeleteBulkRequest](docs/V1FolderMessagesDeleteBulkRequest.md)
|
|
143
|
+
- [V1FolderMessagesFlagsBulkRequest](docs/V1FolderMessagesFlagsBulkRequest.md)
|
|
144
|
+
- [V1FolderMessagesFlagsRequest](docs/V1FolderMessagesFlagsRequest.md)
|
|
145
|
+
- [V1FolderMessagesMessage](docs/V1FolderMessagesMessage.md)
|
|
146
|
+
- [V1FolderMessagesMessageAddress](docs/V1FolderMessagesMessageAddress.md)
|
|
147
|
+
- [V1FolderMessagesMessageAttachment](docs/V1FolderMessagesMessageAttachment.md)
|
|
148
|
+
- [V1FolderMessagesMessageText](docs/V1FolderMessagesMessageText.md)
|
|
149
|
+
- [V1FolderMessagesMessageTextResource](docs/V1FolderMessagesMessageTextResource.md)
|
|
150
|
+
- [V1FolderMessagesMoveBulkRequest](docs/V1FolderMessagesMoveBulkRequest.md)
|
|
151
|
+
- [V1FolderMessagesMoveRequest](docs/V1FolderMessagesMoveRequest.md)
|
|
152
|
+
- [V1FolderMessagesResource](docs/V1FolderMessagesResource.md)
|
|
153
|
+
- [V1FolderMessagesSearchRequest](docs/V1FolderMessagesSearchRequest.md)
|
|
154
|
+
- [V1FolderMessagesUpdateFlagsResult](docs/V1FolderMessagesUpdateFlagsResult.md)
|
|
155
|
+
- [V1FolderMessagesUpdateFlagsResultData](docs/V1FolderMessagesUpdateFlagsResultData.md)
|
|
156
|
+
- [V1FolderMessagesUpdateFlagsResultDataFailedInner](docs/V1FolderMessagesUpdateFlagsResultDataFailedInner.md)
|
|
157
|
+
- [V1FoldersCollection](docs/V1FoldersCollection.md)
|
|
158
|
+
- [V1FoldersCreateRequest](docs/V1FoldersCreateRequest.md)
|
|
159
|
+
- [V1FoldersFolder](docs/V1FoldersFolder.md)
|
|
160
|
+
- [V1FoldersResource](docs/V1FoldersResource.md)
|
|
161
|
+
- [V1FoldersUpdateRequest](docs/V1FoldersUpdateRequest.md)
|
|
162
|
+
- [V1MeMailbox](docs/V1MeMailbox.md)
|
|
163
|
+
- [V1MeResource](docs/V1MeResource.md)
|
|
164
|
+
- [V1MeResourceData](docs/V1MeResourceData.md)
|
|
165
|
+
- [V1QuotaQuota](docs/V1QuotaQuota.md)
|
|
166
|
+
- [V1QuotaQuotaResource](docs/V1QuotaQuotaResource.md)
|
|
167
|
+
- [V1QuotaResource](docs/V1QuotaResource.md)
|
|
168
|
+
- [V1SendAttachment](docs/V1SendAttachment.md)
|
|
169
|
+
- [V1SendRequest](docs/V1SendRequest.md)
|
|
170
|
+
- [V1WebhooksCollection](docs/V1WebhooksCollection.md)
|
|
171
|
+
- [V1WebhooksCreateRequest](docs/V1WebhooksCreateRequest.md)
|
|
172
|
+
- [V1WebhooksResource](docs/V1WebhooksResource.md)
|
|
173
|
+
- [V1WebhooksResourceWithSecret](docs/V1WebhooksResourceWithSecret.md)
|
|
174
|
+
- [V1WebhooksTestResult](docs/V1WebhooksTestResult.md)
|
|
175
|
+
- [V1WebhooksTestResultData](docs/V1WebhooksTestResultData.md)
|
|
176
|
+
- [V1WebhooksUpdateRequest](docs/V1WebhooksUpdateRequest.md)
|
|
177
|
+
- [V1WebhooksWebhook](docs/V1WebhooksWebhook.md)
|
|
178
|
+
- [V1WebhooksWebhookWithSecret](docs/V1WebhooksWebhookWithSecret.md)
|
|
179
|
+
|
|
180
|
+
|
|
@@ -0,0 +1,156 @@
|
|
|
1
|
+
# Hostinger Email API Python SDK
|
|
2
|
+
|
|
3
|
+
[](https://badge.fury.io/py/hostinger_email_api)
|
|
4
|
+
|
|
5
|
+
## About
|
|
6
|
+
This is a Python SDK for the [Hostinger API](https://developers.hostinger.com).
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
## Requirements.
|
|
10
|
+
|
|
11
|
+
Python 3.9+
|
|
12
|
+
|
|
13
|
+
## Installation & Usage
|
|
14
|
+
### pip install
|
|
15
|
+
|
|
16
|
+
Setup new virtual environment (optional but recommended):
|
|
17
|
+
```sh
|
|
18
|
+
python3 -m venv venv
|
|
19
|
+
source venv/bin/activate
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
Install the package via [pip](https://pypi.org/project/pip/):
|
|
23
|
+
```sh
|
|
24
|
+
pip install hostinger_email_api
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Then import the package:
|
|
28
|
+
```python
|
|
29
|
+
import hostinger_email_api
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
### Setuptools
|
|
33
|
+
|
|
34
|
+
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
|
|
35
|
+
|
|
36
|
+
```sh
|
|
37
|
+
python setup.py install --user
|
|
38
|
+
```
|
|
39
|
+
(or `sudo python setup.py install` to install the package for all users)
|
|
40
|
+
|
|
41
|
+
Then import the package:
|
|
42
|
+
```python
|
|
43
|
+
import hostinger_email_api
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
## Getting Started
|
|
47
|
+
|
|
48
|
+
Please follow the [installation procedure](#installation--usage) and then run the following:
|
|
49
|
+
|
|
50
|
+
```python
|
|
51
|
+
|
|
52
|
+
import hostinger_email_api
|
|
53
|
+
from hostinger_email_api.rest import ApiException
|
|
54
|
+
from pprint import pprint
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
# Configure Bearer authorization: BearerAuth
|
|
58
|
+
configuration = hostinger_email_api.Configuration(
|
|
59
|
+
access_token = os.environ["BEARER_TOKEN"]
|
|
60
|
+
)
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
# Enter a context with an instance of the API client
|
|
64
|
+
with hostinger_email_api.ApiClient(configuration) as api_client:
|
|
65
|
+
# Create an instance of the API class
|
|
66
|
+
api_instance = hostinger_email_api.AccountApi(api_client)
|
|
67
|
+
|
|
68
|
+
try:
|
|
69
|
+
# Get the authenticated account
|
|
70
|
+
api_response = api_instance.get_current_account()
|
|
71
|
+
print("The response of AccountApi->get_current_account:\n")
|
|
72
|
+
pprint(api_response)
|
|
73
|
+
except ApiException as e:
|
|
74
|
+
print("Exception when calling AccountApi->get_current_account: %s\n" % e)
|
|
75
|
+
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
## Documentation for API Endpoints
|
|
79
|
+
|
|
80
|
+
All URIs are relative to *https://api.mail.hostinger.com*
|
|
81
|
+
|
|
82
|
+
Class | Method | HTTP request | Description
|
|
83
|
+
------------ | ------------- | ------------- | -------------
|
|
84
|
+
*AccountApi* | [**get_current_account**](docs/AccountApi.md#get_current_account) | **GET** /api/v1/me | Get the authenticated account
|
|
85
|
+
*FoldersApi* | [**create_folder**](docs/FoldersApi.md#create_folder) | **POST** /api/v1/mailboxes/{mailboxResourceId}/folders | Create folder
|
|
86
|
+
*FoldersApi* | [**delete_folder**](docs/FoldersApi.md#delete_folder) | **DELETE** /api/v1/mailboxes/{mailboxResourceId}/folders/{folder} | Delete folder
|
|
87
|
+
*FoldersApi* | [**list_folders**](docs/FoldersApi.md#list_folders) | **GET** /api/v1/mailboxes/{mailboxResourceId}/folders | List folders
|
|
88
|
+
*FoldersApi* | [**update_folder**](docs/FoldersApi.md#update_folder) | **PUT** /api/v1/mailboxes/{mailboxResourceId}/folders/{folder} | Update folder
|
|
89
|
+
*MessagesApi* | [**delete_all_messages**](docs/MessagesApi.md#delete_all_messages) | **DELETE** /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages | Delete all messages
|
|
90
|
+
*MessagesApi* | [**delete_message**](docs/MessagesApi.md#delete_message) | **DELETE** /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/{uid} | Delete message
|
|
91
|
+
*MessagesApi* | [**delete_messages**](docs/MessagesApi.md#delete_messages) | **POST** /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/delete | Delete messages
|
|
92
|
+
*MessagesApi* | [**get_message**](docs/MessagesApi.md#get_message) | **GET** /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/{uid} | Get message
|
|
93
|
+
*MessagesApi* | [**get_message_attachment**](docs/MessagesApi.md#get_message_attachment) | **GET** /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/{uid}/attachments/{attachmentId} | Download message attachment
|
|
94
|
+
*MessagesApi* | [**get_message_source**](docs/MessagesApi.md#get_message_source) | **GET** /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/{uid}/source | Get message source
|
|
95
|
+
*MessagesApi* | [**get_message_text**](docs/MessagesApi.md#get_message_text) | **GET** /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/{uid}/text | Get message text content
|
|
96
|
+
*MessagesApi* | [**list_messages**](docs/MessagesApi.md#list_messages) | **GET** /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages | List messages
|
|
97
|
+
*MessagesApi* | [**move_message**](docs/MessagesApi.md#move_message) | **POST** /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/{uid}/move | Move message
|
|
98
|
+
*MessagesApi* | [**move_messages**](docs/MessagesApi.md#move_messages) | **POST** /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/move | Move messages
|
|
99
|
+
*MessagesApi* | [**patch_message**](docs/MessagesApi.md#patch_message) | **PATCH** /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/{uid} | Update message flags
|
|
100
|
+
*MessagesApi* | [**search_messages**](docs/MessagesApi.md#search_messages) | **POST** /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/search | Search messages
|
|
101
|
+
*MessagesApi* | [**update_message_flags**](docs/MessagesApi.md#update_message_flags) | **POST** /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/flags | Update message flags
|
|
102
|
+
*QuotaApi* | [**get_quota**](docs/QuotaApi.md#get_quota) | **GET** /api/v1/mailboxes/{mailboxResourceId}/quota | Get mailbox quota
|
|
103
|
+
*SendApi* | [**send_email**](docs/SendApi.md#send_email) | **POST** /api/v1/mailboxes/{mailboxResourceId}/send | Send email
|
|
104
|
+
*WebhooksApi* | [**create_webhook**](docs/WebhooksApi.md#create_webhook) | **POST** /api/v1/mailboxes/{mailboxResourceId}/webhooks | Create webhook
|
|
105
|
+
*WebhooksApi* | [**delete_webhook**](docs/WebhooksApi.md#delete_webhook) | **DELETE** /api/v1/mailboxes/{mailboxResourceId}/webhooks/{webhook} | Delete webhook
|
|
106
|
+
*WebhooksApi* | [**get_webhook**](docs/WebhooksApi.md#get_webhook) | **GET** /api/v1/mailboxes/{mailboxResourceId}/webhooks/{webhook} | Get webhook
|
|
107
|
+
*WebhooksApi* | [**list_webhooks**](docs/WebhooksApi.md#list_webhooks) | **GET** /api/v1/mailboxes/{mailboxResourceId}/webhooks | List webhooks
|
|
108
|
+
*WebhooksApi* | [**regenerate_webhook_secret**](docs/WebhooksApi.md#regenerate_webhook_secret) | **POST** /api/v1/mailboxes/{mailboxResourceId}/webhooks/{webhook}/regenerate-secret | Regenerate webhook secret
|
|
109
|
+
*WebhooksApi* | [**test_webhook**](docs/WebhooksApi.md#test_webhook) | **POST** /api/v1/mailboxes/{mailboxResourceId}/webhooks/{webhook}/test | Test webhook
|
|
110
|
+
*WebhooksApi* | [**update_webhook**](docs/WebhooksApi.md#update_webhook) | **PATCH** /api/v1/mailboxes/{mailboxResourceId}/webhooks/{webhook} | Update webhook
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
## Documentation For Models
|
|
114
|
+
|
|
115
|
+
- [Error](docs/Error.md)
|
|
116
|
+
- [Pagination](docs/Pagination.md)
|
|
117
|
+
- [V1FolderMessagesCollection](docs/V1FolderMessagesCollection.md)
|
|
118
|
+
- [V1FolderMessagesDeleteBulkRequest](docs/V1FolderMessagesDeleteBulkRequest.md)
|
|
119
|
+
- [V1FolderMessagesFlagsBulkRequest](docs/V1FolderMessagesFlagsBulkRequest.md)
|
|
120
|
+
- [V1FolderMessagesFlagsRequest](docs/V1FolderMessagesFlagsRequest.md)
|
|
121
|
+
- [V1FolderMessagesMessage](docs/V1FolderMessagesMessage.md)
|
|
122
|
+
- [V1FolderMessagesMessageAddress](docs/V1FolderMessagesMessageAddress.md)
|
|
123
|
+
- [V1FolderMessagesMessageAttachment](docs/V1FolderMessagesMessageAttachment.md)
|
|
124
|
+
- [V1FolderMessagesMessageText](docs/V1FolderMessagesMessageText.md)
|
|
125
|
+
- [V1FolderMessagesMessageTextResource](docs/V1FolderMessagesMessageTextResource.md)
|
|
126
|
+
- [V1FolderMessagesMoveBulkRequest](docs/V1FolderMessagesMoveBulkRequest.md)
|
|
127
|
+
- [V1FolderMessagesMoveRequest](docs/V1FolderMessagesMoveRequest.md)
|
|
128
|
+
- [V1FolderMessagesResource](docs/V1FolderMessagesResource.md)
|
|
129
|
+
- [V1FolderMessagesSearchRequest](docs/V1FolderMessagesSearchRequest.md)
|
|
130
|
+
- [V1FolderMessagesUpdateFlagsResult](docs/V1FolderMessagesUpdateFlagsResult.md)
|
|
131
|
+
- [V1FolderMessagesUpdateFlagsResultData](docs/V1FolderMessagesUpdateFlagsResultData.md)
|
|
132
|
+
- [V1FolderMessagesUpdateFlagsResultDataFailedInner](docs/V1FolderMessagesUpdateFlagsResultDataFailedInner.md)
|
|
133
|
+
- [V1FoldersCollection](docs/V1FoldersCollection.md)
|
|
134
|
+
- [V1FoldersCreateRequest](docs/V1FoldersCreateRequest.md)
|
|
135
|
+
- [V1FoldersFolder](docs/V1FoldersFolder.md)
|
|
136
|
+
- [V1FoldersResource](docs/V1FoldersResource.md)
|
|
137
|
+
- [V1FoldersUpdateRequest](docs/V1FoldersUpdateRequest.md)
|
|
138
|
+
- [V1MeMailbox](docs/V1MeMailbox.md)
|
|
139
|
+
- [V1MeResource](docs/V1MeResource.md)
|
|
140
|
+
- [V1MeResourceData](docs/V1MeResourceData.md)
|
|
141
|
+
- [V1QuotaQuota](docs/V1QuotaQuota.md)
|
|
142
|
+
- [V1QuotaQuotaResource](docs/V1QuotaQuotaResource.md)
|
|
143
|
+
- [V1QuotaResource](docs/V1QuotaResource.md)
|
|
144
|
+
- [V1SendAttachment](docs/V1SendAttachment.md)
|
|
145
|
+
- [V1SendRequest](docs/V1SendRequest.md)
|
|
146
|
+
- [V1WebhooksCollection](docs/V1WebhooksCollection.md)
|
|
147
|
+
- [V1WebhooksCreateRequest](docs/V1WebhooksCreateRequest.md)
|
|
148
|
+
- [V1WebhooksResource](docs/V1WebhooksResource.md)
|
|
149
|
+
- [V1WebhooksResourceWithSecret](docs/V1WebhooksResourceWithSecret.md)
|
|
150
|
+
- [V1WebhooksTestResult](docs/V1WebhooksTestResult.md)
|
|
151
|
+
- [V1WebhooksTestResultData](docs/V1WebhooksTestResultData.md)
|
|
152
|
+
- [V1WebhooksUpdateRequest](docs/V1WebhooksUpdateRequest.md)
|
|
153
|
+
- [V1WebhooksWebhook](docs/V1WebhooksWebhook.md)
|
|
154
|
+
- [V1WebhooksWebhookWithSecret](docs/V1WebhooksWebhookWithSecret.md)
|
|
155
|
+
|
|
156
|
+
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
# coding: utf-8
|
|
2
|
+
|
|
3
|
+
# flake8: noqa
|
|
4
|
+
|
|
5
|
+
"""
|
|
6
|
+
Hostinger Email API Python SDK
|
|
7
|
+
|
|
8
|
+
API Version: 1.0.0
|
|
9
|
+
|
|
10
|
+
NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
|
|
11
|
+
If you want to contribute or request a new feature, please create an issue or pull request on https://github.com/hostinger/api
|
|
12
|
+
""" # noqa: E501
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
__version__ = "0.1.0"
|
|
16
|
+
|
|
17
|
+
# import apis into sdk package
|
|
18
|
+
from hostinger_email_api.api.account_api import AccountApi
|
|
19
|
+
from hostinger_email_api.api.folders_api import FoldersApi
|
|
20
|
+
from hostinger_email_api.api.messages_api import MessagesApi
|
|
21
|
+
from hostinger_email_api.api.quota_api import QuotaApi
|
|
22
|
+
from hostinger_email_api.api.send_api import SendApi
|
|
23
|
+
from hostinger_email_api.api.webhooks_api import WebhooksApi
|
|
24
|
+
|
|
25
|
+
# import ApiClient
|
|
26
|
+
from hostinger_email_api.api_response import ApiResponse
|
|
27
|
+
from hostinger_email_api.api_client import ApiClient
|
|
28
|
+
from hostinger_email_api.configuration import Configuration
|
|
29
|
+
from hostinger_email_api.exceptions import OpenApiException
|
|
30
|
+
from hostinger_email_api.exceptions import ApiTypeError
|
|
31
|
+
from hostinger_email_api.exceptions import ApiValueError
|
|
32
|
+
from hostinger_email_api.exceptions import ApiKeyError
|
|
33
|
+
from hostinger_email_api.exceptions import ApiAttributeError
|
|
34
|
+
from hostinger_email_api.exceptions import ApiException
|
|
35
|
+
|
|
36
|
+
# import models into sdk package
|
|
37
|
+
from hostinger_email_api.models.error import Error
|
|
38
|
+
from hostinger_email_api.models.pagination import Pagination
|
|
39
|
+
from hostinger_email_api.models.v1_folder_messages_collection import V1FolderMessagesCollection
|
|
40
|
+
from hostinger_email_api.models.v1_folder_messages_delete_bulk_request import V1FolderMessagesDeleteBulkRequest
|
|
41
|
+
from hostinger_email_api.models.v1_folder_messages_flags_bulk_request import V1FolderMessagesFlagsBulkRequest
|
|
42
|
+
from hostinger_email_api.models.v1_folder_messages_flags_request import V1FolderMessagesFlagsRequest
|
|
43
|
+
from hostinger_email_api.models.v1_folder_messages_message import V1FolderMessagesMessage
|
|
44
|
+
from hostinger_email_api.models.v1_folder_messages_message_address import V1FolderMessagesMessageAddress
|
|
45
|
+
from hostinger_email_api.models.v1_folder_messages_message_attachment import V1FolderMessagesMessageAttachment
|
|
46
|
+
from hostinger_email_api.models.v1_folder_messages_message_text import V1FolderMessagesMessageText
|
|
47
|
+
from hostinger_email_api.models.v1_folder_messages_message_text_resource import V1FolderMessagesMessageTextResource
|
|
48
|
+
from hostinger_email_api.models.v1_folder_messages_move_bulk_request import V1FolderMessagesMoveBulkRequest
|
|
49
|
+
from hostinger_email_api.models.v1_folder_messages_move_request import V1FolderMessagesMoveRequest
|
|
50
|
+
from hostinger_email_api.models.v1_folder_messages_resource import V1FolderMessagesResource
|
|
51
|
+
from hostinger_email_api.models.v1_folder_messages_search_request import V1FolderMessagesSearchRequest
|
|
52
|
+
from hostinger_email_api.models.v1_folder_messages_update_flags_result import V1FolderMessagesUpdateFlagsResult
|
|
53
|
+
from hostinger_email_api.models.v1_folder_messages_update_flags_result_data import V1FolderMessagesUpdateFlagsResultData
|
|
54
|
+
from hostinger_email_api.models.v1_folder_messages_update_flags_result_data_failed_inner import V1FolderMessagesUpdateFlagsResultDataFailedInner
|
|
55
|
+
from hostinger_email_api.models.v1_folders_collection import V1FoldersCollection
|
|
56
|
+
from hostinger_email_api.models.v1_folders_create_request import V1FoldersCreateRequest
|
|
57
|
+
from hostinger_email_api.models.v1_folders_folder import V1FoldersFolder
|
|
58
|
+
from hostinger_email_api.models.v1_folders_resource import V1FoldersResource
|
|
59
|
+
from hostinger_email_api.models.v1_folders_update_request import V1FoldersUpdateRequest
|
|
60
|
+
from hostinger_email_api.models.v1_me_mailbox import V1MeMailbox
|
|
61
|
+
from hostinger_email_api.models.v1_me_resource import V1MeResource
|
|
62
|
+
from hostinger_email_api.models.v1_me_resource_data import V1MeResourceData
|
|
63
|
+
from hostinger_email_api.models.v1_quota_quota import V1QuotaQuota
|
|
64
|
+
from hostinger_email_api.models.v1_quota_quota_resource import V1QuotaQuotaResource
|
|
65
|
+
from hostinger_email_api.models.v1_quota_resource import V1QuotaResource
|
|
66
|
+
from hostinger_email_api.models.v1_send_attachment import V1SendAttachment
|
|
67
|
+
from hostinger_email_api.models.v1_send_request import V1SendRequest
|
|
68
|
+
from hostinger_email_api.models.v1_webhooks_collection import V1WebhooksCollection
|
|
69
|
+
from hostinger_email_api.models.v1_webhooks_create_request import V1WebhooksCreateRequest
|
|
70
|
+
from hostinger_email_api.models.v1_webhooks_resource import V1WebhooksResource
|
|
71
|
+
from hostinger_email_api.models.v1_webhooks_resource_with_secret import V1WebhooksResourceWithSecret
|
|
72
|
+
from hostinger_email_api.models.v1_webhooks_test_result import V1WebhooksTestResult
|
|
73
|
+
from hostinger_email_api.models.v1_webhooks_test_result_data import V1WebhooksTestResultData
|
|
74
|
+
from hostinger_email_api.models.v1_webhooks_update_request import V1WebhooksUpdateRequest
|
|
75
|
+
from hostinger_email_api.models.v1_webhooks_webhook import V1WebhooksWebhook
|
|
76
|
+
from hostinger_email_api.models.v1_webhooks_webhook_with_secret import V1WebhooksWebhookWithSecret
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# flake8: noqa
|
|
2
|
+
|
|
3
|
+
# import apis into api package
|
|
4
|
+
from hostinger_email_api.api.account_api import AccountApi
|
|
5
|
+
from hostinger_email_api.api.folders_api import FoldersApi
|
|
6
|
+
from hostinger_email_api.api.messages_api import MessagesApi
|
|
7
|
+
from hostinger_email_api.api.quota_api import QuotaApi
|
|
8
|
+
from hostinger_email_api.api.send_api import SendApi
|
|
9
|
+
from hostinger_email_api.api.webhooks_api import WebhooksApi
|
|
10
|
+
|