Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

README update to include API endpoints #50

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

README update to include API endpoints #50

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
2ffffb6
add list of endpoints section in README (addresses)
neverett8fr Jul 25, 2023
3fa9505
README - add mail endpoint
neverett8fr Jul 25, 2023
0909131
README add auth
neverett8fr Jul 25, 2023
1bea927
README add calendar
neverett8fr Jul 25, 2023
9e79e93
README add messages endpoint, etc.
neverett8fr Jul 25, 2023
fd546ef
README add some messages
neverett8fr Jul 25, 2023
da3e830
cleanup of README API section
neverett8fr Jul 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,48 @@ Once we're authenticated and our tokens are valid, we can make api calls to vari
proton_session.api_request(endpoint="custom_api_endpoint")
```

### List of endpoints

- `https://mail.proton.me/api`: the current base URL for APIs _this may change in future_
- `/core/v4`
- `/addresses GET`: Get addresses
- `/addresses/{{address_id}} GET`: Get address
- `/addresses/order PUT`: Order addresses
- `/addresses/{{address_id}}/enable PUT`: Enable address
- `/addresses/{{address_id}}/disable PUT`: Disable address
- `/addresses/{{address_id}} DELETE`: Delete address
- `/mail/v4`
- `/attachments POST`: Upload attachment
- `/attachments/{{attachment_id}} GET`: Get attachment
- `/settings GET`: Get mail settings
- `/messages/import POST`: Import messages
- `/messages POST`: Create draft
- `/messages/{{draft_id}} PUT`: Update draft
- `/messages/{{draft_id}} POST`: Send draft
- `/messages/{{message_id}} GET`: Get message
- `/messages/delete PUT`: Delete message
- `/messages/read PUT`: Mark message as read
- `/messages/unread PUT`: Mark message as unread
- `/messages/ids GET`: Get message IDs
- `/auth/v4`
- `/ POST`: Post auth
- `/info POST`: Post auth info
- `/refresh POST`: Post auth refresh
- `/ DELETE`: Auth delete
- `/sessions GET`: Auth sessions
- `/sessions DELETE`: Auth revoke all
- `/sessions/{{auth_uid}} DELETE`: Auth revoke
- `/calendar/v1`
- `/{{calendar_id}}/events GET`: Calendar events
- `/ GET`: Get calendars
- `/{{calendar_id}} GET`: Get calendar
- `/contacts/v4`
- `/emails GET`: Get contacts emails
- `/data/v1`
- `/stats POST`: Post data stats
- `/stats/multiple POST`: Post multiple data stats


## Error handling
For all of commands presented in the previous chapters, it is recommended to use them within try/except blocks. Some common errors that might come up:
- `401`: Invalid `AccessToken`, client should refresh tokens ([Refresh Session](#refresh-session))
Expand Down