Email

Mailboxes, aliases, forwards and catch-alls of the customer's mail domains.

GET/services/{service_id}/mailboxesList mailboxes
POST/services/{service_id}/mailboxesCreate a mailbox
PATCH/services/{service_id}/mailboxes/{mailbox_id}Change a mailbox
DELETE/services/{service_id}/mailboxes/{mailbox_id}Delete a mailbox
GET/services/{service_id}/mail-forwardingList aliases and forwards
POST/services/{service_id}/mail-aliasesAdd an alias
POST/services/{service_id}/mail-forwardsAdd a forward
POST/services/{service_id}/mail-catchallSet the catch-all
POST/services/{service_id}/mail-domain-aliasesAdd a domain alias
PATCH/services/{service_id}/mail-forwarding/{entry_id}Change an alias or forward
DELETE/services/{service_id}/mail-forwarding/{entry_id}Delete an alias or forward

List mailboxes

GET/services/{service_id}/mailboxes

Needs the permission mailbox:read

The mailboxes of a mail domain.

Path

service_idrequired string (uuid)

Response 200

`id`required	string
`email`required	string
`quota_mb`required	integer \| null
`enabled`required	boolean

curl "https://portal.nimag.net/api/v1/services/{service_id}/mailboxes" \
  -H "Authorization: Bearer nck_…"

[
  {
    "id": "string",
    "email": "string",
    "quota_mb": 0,
    "enabled": true
  }
]

Create a mailbox

POST/services/{service_id}/mailboxes

Needs the permission mailbox:manage

Counted against the package's mailboxes and email storage.

Path

service_idrequired string (uuid)

Body (JSON)

`local_part`required	string
`password`required	string
`quota_mb`	integer	from 1, up to 10000000, default 1024

Response 201

`id`required	string
`email`required	string
`quota_mb`required	integer \| null
`enabled`required	boolean

curl -X POST "https://portal.nimag.net/api/v1/services/{service_id}/mailboxes" \
  -H "Authorization: Bearer nck_…" \
  -H "Content-Type: application/json" \
  -d '{
    "local_part": "string",
    "password": "string",
    "quota_mb": 1024
  }'

{
  "id": "string",
  "email": "string",
  "quota_mb": 0,
  "enabled": true
}

Change a mailbox

PATCH/services/{service_id}/mailboxes/{mailbox_id}

Needs the permission mailbox:manage

Its password, quota, or whether it is active.

Path

`service_id`required	string (uuid)
`mailbox_id`required	string

Body (JSON)

`password`	string \| null
`quota_mb`	integer \| null	from 1, up to 10000000
`enabled`	boolean \| null

Response 200

`id`required	string
`email`required	string
`quota_mb`required	integer \| null
`enabled`required	boolean

curl -X PATCH "https://portal.nimag.net/api/v1/services/{service_id}/mailboxes/{mailbox_id}" \
  -H "Authorization: Bearer nck_…" \
  -H "Content-Type: application/json" \
  -d '{
    "password": "string",
    "quota_mb": 0,
    "enabled": true
  }'

{
  "id": "string",
  "email": "string",
  "quota_mb": 0,
  "enabled": true
}

Delete a mailbox

DELETE/services/{service_id}/mailboxes/{mailbox_id}

Needs the permission mailbox:manage

Its mail is deleted with it.

Path

`service_id`required	string (uuid)
`mailbox_id`required	string

Response 204: no content.

curl -X DELETE "https://portal.nimag.net/api/v1/services/{service_id}/mailboxes/{mailbox_id}" \
  -H "Authorization: Bearer nck_…"

List aliases and forwards

GET/services/{service_id}/mail-forwarding

Needs the permission mailbox:read

Aliases, forwards, the catch-all and domain aliases of a mail domain.

Path

service_idrequired string (uuid)

Response 200

`id`required	string
`kind`required	string
`source`required	string
`destination`required	string
`active`required	boolean

curl "https://portal.nimag.net/api/v1/services/{service_id}/mail-forwarding" \
  -H "Authorization: Bearer nck_…"

[
  {
    "id": "string",
    "kind": "string",
    "source": "string",
    "destination": "string",
    "active": true
  }
]

Add an alias

POST/services/{service_id}/mail-aliases

Needs the permission mailbox:manage

Another address of a mailbox of the domain.

Path

service_idrequired string (uuid)

Body (JSON)

`local_part`required	string
`destination`required	string

Response 201

`id`required	string
`kind`required	string
`source`required	string
`destination`required	string
`active`required	boolean

curl -X POST "https://portal.nimag.net/api/v1/services/{service_id}/mail-aliases" \
  -H "Authorization: Bearer nck_…" \
  -H "Content-Type: application/json" \
  -d '{
    "local_part": "string",
    "destination": "string"
  }'

{
  "id": "string",
  "kind": "string",
  "source": "string",
  "destination": "string",
  "active": true
}

Add a forward

POST/services/{service_id}/mail-forwards

Needs the permission mailbox:manage

Mail to an address, sent on to others.

Path

service_idrequired string (uuid)

Body (JSON)

`local_part`required	string
`destinations`required	string[]

Response 201

`id`required	string
`kind`required	string
`source`required	string
`destination`required	string
`active`required	boolean

curl -X POST "https://portal.nimag.net/api/v1/services/{service_id}/mail-forwards" \
  -H "Authorization: Bearer nck_…" \
  -H "Content-Type: application/json" \
  -d '{
    "local_part": "string",
    "destinations": [
      "string"
    ]
  }'

{
  "id": "string",
  "kind": "string",
  "source": "string",
  "destination": "string",
  "active": true
}

Set the catch-all

POST/services/{service_id}/mail-catchall

Needs the permission mailbox:manage

Where mail to addresses that don't exist goes.

Path

service_idrequired string (uuid)

Body (JSON)

destinationrequired string

Response 201

`id`required	string
`kind`required	string
`source`required	string
`destination`required	string
`active`required	boolean

curl -X POST "https://portal.nimag.net/api/v1/services/{service_id}/mail-catchall" \
  -H "Authorization: Bearer nck_…" \
  -H "Content-Type: application/json" \
  -d '{
    "destination": "string"
  }'

{
  "id": "string",
  "kind": "string",
  "source": "string",
  "destination": "string",
  "active": true
}

Add a domain alias

POST/services/{service_id}/mail-domain-aliases

Needs the permission mailbox:manage

Another of the customer's domains, receiving the same mail.

Path

service_idrequired string (uuid)

Body (JSON)

alias_domainrequired string

Response 201

`id`required	string
`kind`required	string
`source`required	string
`destination`required	string
`active`required	boolean

curl -X POST "https://portal.nimag.net/api/v1/services/{service_id}/mail-domain-aliases" \
  -H "Authorization: Bearer nck_…" \
  -H "Content-Type: application/json" \
  -d '{
    "alias_domain": "string"
  }'

{
  "id": "string",
  "kind": "string",
  "source": "string",
  "destination": "string",
  "active": true
}

Change an alias or forward

PATCH/services/{service_id}/mail-forwarding/{entry_id}

Needs the permission mailbox:manage

Path

`service_id`required	string (uuid)
`entry_id`required	string

Body (JSON)

`destination`	string \| null	up to 2048 characters
`active`	boolean	default true

Response 200

`id`required	string
`kind`required	string
`source`required	string
`destination`required	string
`active`required	boolean

curl -X PATCH "https://portal.nimag.net/api/v1/services/{service_id}/mail-forwarding/{entry_id}" \
  -H "Authorization: Bearer nck_…" \
  -H "Content-Type: application/json" \
  -d '{
    "destination": "string",
    "active": true
  }'

{
  "id": "string",
  "kind": "string",
  "source": "string",
  "destination": "string",
  "active": true
}

Delete an alias or forward

DELETE/services/{service_id}/mail-forwarding/{entry_id}

Needs the permission mailbox:manage

Path

`service_id`required	string (uuid)
`entry_id`required	string

Response 204: no content.

curl -X DELETE "https://portal.nimag.net/api/v1/services/{service_id}/mail-forwarding/{entry_id}" \
  -H "Authorization: Bearer nck_…"