VeruMail
Read, organise and send email. Sending is its own permission, separate from writing.
| Method | Endpoint | Permission |
|---|---|---|
| POST |
Create a draft
/v1/drafts
Saves a draft without sending it.
|
mail.messages.write |
| POST |
Create a mail filter
/v1/mail/filters
Adds a rule applied to incoming mail.
|
mail.settings.write |
| POST |
Create a mail folder
/v1/folders
Creates a folder in the mailbox.
|
mail.folders.write |
| DELETE |
Delete a draft
/v1/drafts/:id
Discards a draft.
|
mail.messages.write |
| DELETE |
Delete a mail filter
/v1/mail/filters/:id
Removes a rule.
|
mail.settings.write |
| DELETE |
Delete a mail folder
/v1/folders/:id
Deletes a folder and everything in it.
|
mail.folders.write |
| DELETE |
Delete a message
/v1/messages/:id
Moves a message to Trash, or deletes it permanently.
|
mail.messages.write |
| GET |
Download an attachment
/v1/messages/:id/attachments/:part
Streams one attachment. Subject to the documented proxy size cap.
|
mail.messages.read |
| GET |
Get a message
/v1/messages/:id
Returns one message with its headers, body and attachment metadata.
|
mail.messages.read |
| GET |
Get display preferences
/v1/mail/settings
Returns how dates, times and the calendar are shown: time format, week start, default view and event length.
|
mail.settings.read |
| GET |
List attachments
/v1/messages/:id/attachments
Lists the attachments on a message with their sizes and content types.
|
mail.messages.read |
| GET |
List drafts
/v1/drafts
Lists saved drafts.
|
mail.messages.read |
| GET |
List mail filters
/v1/mail/filters
Lists the rules applied to incoming mail.
|
mail.settings.read |
| GET |
List mail folders
/v1/folders
Lists every folder in the mailbox with its message and unread counts.
|
mail.folders.read |
| GET |
List messages
/v1/messages
Lists message summaries in a folder, newest first, with cursor pagination.
|
mail.messages.read |
| POST |
Move messages
/v1/folders/:folder_id/messages/move
Moves a batch of messages from one folder to another.
|
mail.messages.write |
| PUT |
Replace a draft
/v1/drafts/:id
Replaces a saved draft in full. Drafts are replaced rather than patched: there is no coherent way to merge two versions of a message body.
|
mail.messages.write |
| POST |
Send an email
/v1/messages/send
Sends mail from the workspace user the key acts as. Requires mail.send, which is deliberately separate from mail.messages.write.
|
mail.send |
| POST |
Change flags and labels
/v1/folders/:folder_id/messages/flags
Marks messages read, starred or answered, and adds or removes labels. Takes a batch, so one call can change hundreds of messages.
|
mail.messages.write |
| PATCH |
Rename a mail folder
/v1/folders/:id
Renames or moves a folder.
|
mail.folders.write |
| PATCH |
Update display preferences
/v1/mail/settings
Changes how dates, times and the calendar are shown.
|
mail.settings.write |