Admin Mailboxes
Admin read access to the platform mailboxes (support@, privacy@, abuse@, ...)
4 endpoints
Endpoints
Method Path Description
GET /v1/admin/platform-mailboxesGET /v1/admin/platform-mailboxes GET /v1/admin/platform-mailboxes/{id}/messagesGET /v1/admin/platform-mailboxes/{id}/messages GET /v1/admin/platform-mailboxes/{id}/messages/{msg_id}GET /v1/admin/platform-mailboxes/{id}/messages/{msg_id} POST /v1/admin/platform-mailboxes/{id}/messages/{msg_id}/readPOST /v1/admin/platform-mailboxes/{id}/messages/{msg_id}/read
List the platform mailboxes (support@, privacy@, abuse@, ...) with unread counts. Requires an admin account and the mailbox:read scope.
Responses
Status Description
200 Platform mailboxes with unread counts 401 Unauthorized 403 Caller is not an admin, or the API key lacks mailbox:read
Example
cURL
TypeScript
Python
Rust
Go
curl -X GET https://api.euromail.dev/v1/admin/platform-mailboxes \ -H "X-EuroMail-Api-Key: em_live_..."
import { EuroMail } from "@euromail/sdk" ; const euromail = new EuroMail ({ apiKey: "em_live_..." }); const result = await euromail. getAdmin ();
from euromail import EuroMail client = EuroMail( api_key = "em_live_..." ) result = client.get_admin()
use euromail :: EuroMail ; let client = EuroMail :: new ( "em_live_..." ); let result = client . get_admin () .await? ;
client := euromail. NewClient ( "em_live_..." ) result, err := client. GetAdmin (ctx)
GET /v1/admin/platform-mailboxes/{id}/messages
Parameters
Name In Type Required Description
idpath stringYes Platform mailbox id statusquery `string null` No directionquery `string null` No limitquery `integer null` No offsetquery `integer null` No
Responses
Status Description
200 Messages in the platform mailbox 401 Unauthorized 403 Caller is not an admin, or the API key lacks mailbox:read 404 Not a platform mailbox 422 Invalid status filter
Example
cURL
TypeScript
Python
Rust
Go
curl -X GET https://api.euromail.dev/v1/admin/platform-mailboxes/{id}/messages \ -H "X-EuroMail-Api-Key: em_live_..."
import { EuroMail } from "@euromail/sdk" ; const euromail = new EuroMail ({ apiKey: "em_live_..." }); const result = await euromail. getAdmin ( "id_..." );
from euromail import EuroMail client = EuroMail( api_key = "em_live_..." ) result = client.get_admin( "id_..." )
use euromail :: EuroMail ; let client = EuroMail :: new ( "em_live_..." ); let result = client . get_admin ( "id_..." ) .await? ;
client := euromail. NewClient ( "em_live_..." ) result, err := client. GetAdmin (ctx, "id_..." )
GET /v1/admin/platform-mailboxes/{id}/messages/{msg_id}
Parameters
Name In Type Required Description
idpath stringYes Platform mailbox id msg_idpath stringYes Message id
Responses
Status Description
200 The message 401 Unauthorized 403 Caller is not an admin, or the API key lacks mailbox:read 404 Not a platform mailbox, or message not found
Example
cURL
TypeScript
Python
Rust
Go
curl -X GET https://api.euromail.dev/v1/admin/platform-mailboxes/{id}/messages/{msg_id} \ -H "X-EuroMail-Api-Key: em_live_..."
import { EuroMail } from "@euromail/sdk" ; const euromail = new EuroMail ({ apiKey: "em_live_..." }); const result = await euromail. getAdmin ( "id_..." );
from euromail import EuroMail client = EuroMail( api_key = "em_live_..." ) result = client.get_admin( "id_..." )
use euromail :: EuroMail ; let client = EuroMail :: new ( "em_live_..." ); let result = client . get_admin ( "id_..." ) .await? ;
client := euromail. NewClient ( "em_live_..." ) result, err := client. GetAdmin (ctx, "id_..." )
POST /v1/admin/platform-mailboxes/{id}/messages/{msg_id}/readClears one message from the unread backlog. Without this the
euromail_platform_mailbox_unread_messages gauge can only ever climb, and
the alert built on it would page forever once it first fired.
Idempotent: re-reading an already-read message is a 204, not an error.
Parameters
Name In Type Required Description
idpath stringYes Platform mailbox id msg_idpath stringYes Message id
Responses
Status Description
204 Marked read (or already was) 401 Unauthorized 403 Caller is not an admin, the API key lacks mailbox:read, or the CSRF header is missing 404 Not a platform mailbox, or message not found
Example
cURL
TypeScript
Python
Rust
Go
curl -X POST https://api.euromail.dev/v1/admin/platform-mailboxes/{id}/messages/{msg_id}/read \ -H "X-EuroMail-Api-Key: em_live_..."
import { EuroMail } from "@euromail/sdk" ; const euromail = new EuroMail ({ apiKey: "em_live_..." }); const result = await euromail. createAdmin ( "id_..." );
from euromail import EuroMail client = EuroMail( api_key = "em_live_..." ) result = client.create_admin( "id_..." )
use euromail :: EuroMail ; let client = EuroMail :: new ( "em_live_..." ); let result = client . create_admin ( "id_..." ) .await? ;
client := euromail. NewClient ( "em_live_..." ) result, err := client. CreateAdmin (ctx, "id_..." )