E-mail

Actualizado em 05/11/20264 min de leitura

A API gere o e-mail das hospedagens activas da sua conta. Tudo corre na conta do serviço indicado em {id}. Para saber o id, use GET /v1/services.

O que precisa

Uma chave com email:read para ler, e email:write para alterar. Com uma chave sandbox_, ou enquanto a API está em preparação, as alterações são simuladas: a API confere o pedido e não chega ao servidor. Veja Sandbox e Produção. Um serviço que não esteja activo responde 409, como em Hospedagem.

Caixas

GET /v1/services/{id}/email/mailboxes lista as caixas, com o espaço usado e a quota.
POST /v1/services/{id}/email/mailboxes cria uma caixa.
PUT /v1/services/{id}/email/mailboxes/{address}/password muda a senha.
PUT /v1/services/{id}/email/mailboxes/{address}/quota muda a quota.
DELETE /v1/services/{id}/email/mailboxes/{address} apaga uma caixa e as mensagens. Precisa do endereço em confirm.

curl

curl -X POST "https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/mailboxes" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt" \
  -H "Idempotency-Key: 9f1c2d3e-example" \
  -H "Content-Type: application/json" \
  -d '{"address": "[email protected]", "password": "pP7-kX2mQ9vL4tR8wZ3a", "quota_mb": 1024}'

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/mailboxes');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => '{"address": "[email protected]", "password": "pP7-kX2mQ9vL4tR8wZ3a", "quota_mb": 1024}',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
        'Idempotency-Key: 9f1c2d3e-example',
        'Content-Type: application/json',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
    "Idempotency-Key": "9f1c2d3e-example",
}
payload = {"address": "[email protected]", "password": "pP7-kX2mQ9vL4tR8wZ3a", "quota_mb": 1024}
r = requests.post("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/mailboxes", headers=headers, json=payload, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/mailboxes", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
    "Idempotency-Key": "9f1c2d3e-example",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"address": "[email protected]", "password": "pP7-kX2mQ9vL4tR8wZ3a", "quota_mb": 1024}),
});
console.log(response.status);
console.log(await response.text());

A senha tem de 12 a 128 caracteres, com pelo menos 3 tipos entre minúsculas, maiúsculas, números e símbolos, sem o nome da conta nem o da caixa. Os nomes de sistema do servidor, como _mainaccount, não são aceites. A API nunca a guarda nem a devolve. Por isso, nos pedidos com senha, a Idempotency-Key não tem efeito: repetir o pedido volta a executá-lo. A quota vai de 1 MB ao espaço do plano; sem limite não é aceite.

Reencaminhadores

GET /v1/services/{id}/email/forwarders, POST /v1/services/{id}/email/forwarders e DELETE /v1/services/{id}/email/forwarders/{address}/{forward_to} gerem os reencaminhadores. Só se reencaminha para endereços de e-mail, nunca para programas. A lista mostra um domínio de cada vez: indique-o em ?domain=; sem ele, mostra o principal.

O domínio do e-mail da conta

O e-mail com que se entra na conta recebe a reposição da senha e o código de entrada. Quem controla esse correio pode ficar com a conta. Por isso, no domínio desse e-mail e no do e-mail de cada utilizador da conta, a API não cria, não apaga nem altera caixas, não cria nem apaga reencaminhadores e não muda a conta geral.

Estes pedidos respondem 409 com o código account_email_domain, também em Sandbox. Faça estas alterações no My MozOut. As leituras e as respostas automáticas continuam a funcionar. As permissões hosting:login e hosting:code dão acesso à conta do cPanel e não têm esta protecção: dê-as só às chaves que precisam mesmo delas.

Respostas automáticas

GET /v1/services/{id}/email/autoresponders lista, GET /v1/services/{id}/email/autoresponders/{address} mostra uma, PUT /v1/services/{id}/email/autoresponders/{address} cria ou substitui e DELETE /v1/services/{id}/email/autoresponders/{address} apaga.

Conta geral

A conta geral decide o que acontece ao correio para endereços que não existem. GET /v1/services/{id}/email/default-address lê e PUT /v1/services/{id}/email/default-address altera, com action igual a fail (devolve), forward (reencaminha), discard (deita fora) ou main_account (entrega na conta principal da hospedagem, como numa conta nova). Recomendamos fail, para receber menos spam.

SPF, DKIM e DMARC

GET /v1/services/{id}/email/authentication mostra o estado dos três registos de um domínio. Para os alterar, use DNS.

Limites

As alterações têm um limite de 20 por minuto, por hospedagem, e as senhas de 10 por minuto, além do limite geral.

O que ainda não existe

Os filtros de e-mail e o registo de entregas fazem-se no painel.

Ajuda

Para saber mais sobre e-mail, veja a Base de Conhecimento.

Operações

15 operações nesta área. Clique numa operação para ver os parâmetros, os exemplos e as respostas, ou para a experimentar no Playground, sem sair da página.

GET

Listar caixas de e-mail

/v1/services/{id}/email/mailboxes

GEThttps://api.mozout.com/v1/services/{id}/email/mailboxes

Precisa de email:read. quota_mb vem a null quando a caixa não tem limite próprio. Se o serviço não estiver activo, ou não for uma hospedagem suportada, responde 409 com a razão em details.reason.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: email:read.

Parâmetros

Nome	Onde	Tipo	Obrigatório	Descrição
`id`	caminho	string	sim	O `id` do serviço de hospedagem.
`page`	consulta	integer	não	O número da página. A primeira é a 1.
`per_page`	consulta	integer	não	Resultados por página, de 1 a 100. Por omissão, 10.
`X-API-Mode`	cabeçalho	string: sandbox, production	não	Opcional. Se não coincidir com o modo da chave, o pedido é recusado com `invalid_request` e a razão `mode_mismatch`. Serve para garantir que um programa nunca corre com a chave errada.

Exemplos

curl

curl "https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/mailboxes" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt"

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/mailboxes');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
}
r = requests.get("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/mailboxes", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/mailboxes", {
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
  },
});
console.log(response.status);
console.log(await response.text());

Respostas

200

Listar caixas de e-mail.

{
  "data": [
    {
      "address": "[email protected]",
      "used_mb": 12.5,
      "quota_mb": 1024
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 10,
    "total": 1,
    "total_pages": 1
  }
}

Cabeçalho	Descrição
`X-Correlation-ID`	Identificador deste pedido. Indique-o ao suporte se comunicar um problema.
`X-RateLimit-Limit`	Pedidos permitidos por minuto.
`X-RateLimit-Remaining`	Pedidos que restam no minuto actual.
`X-RateLimit-Reset`	Quando acaba o minuto, em segundos Unix.
`X-API-Mode`	O modo da chave que fez o pedido: `sandbox` ou `production`.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Não encontrado.

{
  "error": {
    "code": "not_found",
    "message": "Não encontrado.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

A operação não se pode fazer no estado actual. Veja details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Alguns dados não são válidos.

{
  "error": {
    "code": "validation_failed",
    "message": "Alguns dados não são válidos.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}

Cabeçalho	Descrição
`Retry-After`	Segundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

O serviço por trás da API não respondeu como esperado.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

Estado	Código	Significado
401	`unauthorized`	A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403	`forbidden`, `insufficient_scope`, `ip_not_allowed`	A conta não pode usar a API (`forbidden`), a chave não tem a permissão necessária (`insufficient_scope`), ou o endereço IP não está na lista da chave (`ip_not_allowed`).
404	`not_found`	Não encontrado.
409	`conflict`	A operação não se pode fazer no estado actual. Veja `details.reason`.
422	`validation_failed`	Alguns dados não são válidos.
429	`rate_limited`	Demasiados pedidos. Espere o tempo indicado em `Retry-After`.
500	`internal_error`	Ocorreu um erro interno. Indique o `correlation_id` ao suporte.
502	`upstream_error`	O serviço por trás da API não respondeu como esperado.
503	`disabled`	A API está desligada.

O formato dos erros está explicado em Erros.

POST

Criar uma caixa de e-mail

/v1/services/{id}/email/mailboxes

POSThttps://api.mozout.com/v1/services/{id}/email/mailboxes

Precisa de email:write. Os nomes de sistema do servidor, como _mainaccount, não são aceites. O domínio tem de ser desta hospedagem. A API nunca guarda a senha, por isso aqui a Idempotency-Key não tem efeito: repetir o pedido volta a executá-lo. Com uma chave sandbox_, só confere o pedido e não altera nada. No domínio do e-mail da conta, ou do e-mail de um utilizador dela, responde 409 com o código account_email_domain: faça a alteração no portal da conta.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: email:write.

Parâmetros

Nome	Onde	Tipo	Obrigatório	Descrição
`id`	caminho	string	sim	O `id` do serviço de hospedagem.
`X-API-Mode`	cabeçalho	string: sandbox, production	não	Opcional. Se não coincidir com o modo da chave, o pedido é recusado com `invalid_request` e a razão `mode_mismatch`. Serve para garantir que um programa nunca corre com a chave errada.
`Idempotency-Key`	cabeçalho	string	não	Identificador único deste pedido, para o repetir sem o duplicar.

Corpo do pedido

Campo	Tipo	Obrigatório	Descrição
`address`	string	sim	O endereço de e-mail completo.
`password`	string	sim	De 12 a 128 caracteres, com pelo menos 3 tipos entre minúsculas, maiúsculas, números e símbolos, sem o nome da conta, nem o do utilizador ou da caixa. Nunca volta.
`quota_mb`	integer	não	Em MB, de 1 ao espaço do plano. Não se aceita quota ilimitada.

Exemplos

curl

curl -X POST "https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/mailboxes" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt" \
  -H "Idempotency-Key: 9f1c2d3e-example" \
  -H "Content-Type: application/json" \
  -d '{"address": "[email protected]", "password": "pP7-kX2mQ9vL4tR8wZ3a", "quota_mb": 1024}'

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/mailboxes');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => '{"address": "[email protected]", "password": "pP7-kX2mQ9vL4tR8wZ3a", "quota_mb": 1024}',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
        'Idempotency-Key: 9f1c2d3e-example',
        'Content-Type: application/json',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
    "Idempotency-Key": "9f1c2d3e-example",
}
payload = {"address": "[email protected]", "password": "pP7-kX2mQ9vL4tR8wZ3a", "quota_mb": 1024}
r = requests.post("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/mailboxes", headers=headers, json=payload, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/mailboxes", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
    "Idempotency-Key": "9f1c2d3e-example",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"address": "[email protected]", "password": "pP7-kX2mQ9vL4tR8wZ3a", "quota_mb": 1024}),
});
console.log(response.status);
console.log(await response.text());

Respostas

201

Criar uma caixa de e-mail.

{
  "data": {
    "address": "[email protected]",
    "quota_mb": 1024,
    "simulated": false
  },
  "meta": {}
}

Cabeçalho	Descrição
`X-Correlation-ID`	Identificador deste pedido. Indique-o ao suporte se comunicar um problema.
`X-RateLimit-Limit`	Pedidos permitidos por minuto.
`X-RateLimit-Remaining`	Pedidos que restam no minuto actual.
`X-RateLimit-Reset`	Quando acaba o minuto, em segundos Unix.
`X-API-Mode`	O modo da chave que fez o pedido: `sandbox` ou `production`.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Não encontrado.

{
  "error": {
    "code": "not_found",
    "message": "Não encontrado.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

A operação não se pode fazer no estado actual. Veja details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Alguns dados não são válidos.

{
  "error": {
    "code": "validation_failed",
    "message": "Alguns dados não são válidos.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}

Cabeçalho	Descrição
`Retry-After`	Segundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

O serviço por trás da API não respondeu como esperado.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

Estado	Código	Significado
401	`unauthorized`	A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403	`forbidden`, `insufficient_scope`, `ip_not_allowed`	A conta não pode usar a API (`forbidden`), a chave não tem a permissão necessária (`insufficient_scope`), ou o endereço IP não está na lista da chave (`ip_not_allowed`).
404	`not_found`	Não encontrado.
409	`conflict`	A operação não se pode fazer no estado actual. Veja `details.reason`.
422	`validation_failed`	Alguns dados não são válidos.
429	`rate_limited`	Demasiados pedidos. Espere o tempo indicado em `Retry-After`.
500	`internal_error`	Ocorreu um erro interno. Indique o `correlation_id` ao suporte.
502	`upstream_error`	O serviço por trás da API não respondeu como esperado.
503	`disabled`	A API está desligada.

O formato dos erros está explicado em Erros.

DELETE

Apagar uma caixa de e-mail

/v1/services/{id}/email/mailboxes/{address}

DELETEhttps://api.mozout.com/v1/services/{id}/email/mailboxes/{address}

Precisa de email:write. Precisa do endereço em confirm. As mensagens perdem-se. Com uma chave sandbox_, só confere o pedido e não altera nada. No domínio do e-mail da conta, ou do e-mail de um utilizador dela, responde 409 com o código account_email_domain: faça a alteração no portal da conta.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: email:write.

Parâmetros

Nome	Onde	Tipo	Obrigatório	Descrição
`id`	caminho	string	sim	O `id` do serviço de hospedagem.
`address`	caminho	string	sim	O endereço de e-mail completo.
`X-API-Mode`	cabeçalho	string: sandbox, production	não	Opcional. Se não coincidir com o modo da chave, o pedido é recusado com `invalid_request` e a razão `mode_mismatch`. Serve para garantir que um programa nunca corre com a chave errada.

Corpo do pedido

Campo	Tipo	Obrigatório	Descrição
`confirm`	string	sim	O nome exacto do que vai apagar, para confirmar.

Exemplos

curl

curl -X DELETE "https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/mailboxes/VALUE" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt" \
  -H "Content-Type: application/json" \
  -d '{"confirm": "[email protected]"}'

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/mailboxes/VALUE');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'DELETE',
    CURLOPT_POSTFIELDS => '{"confirm": "[email protected]"}',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
        'Content-Type: application/json',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
}
payload = {"confirm": "[email protected]"}
r = requests.delete("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/mailboxes/VALUE", headers=headers, json=payload, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/mailboxes/VALUE", {
  method: "DELETE",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"confirm": "[email protected]"}),
});
console.log(response.status);
console.log(await response.text());

Respostas

200

Apagar uma caixa de e-mail.

{
  "data": {
    "address": "[email protected]",
    "deleted": true,
    "simulated": false
  },
  "meta": {}
}

Cabeçalho	Descrição
`X-Correlation-ID`	Identificador deste pedido. Indique-o ao suporte se comunicar um problema.
`X-RateLimit-Limit`	Pedidos permitidos por minuto.
`X-RateLimit-Remaining`	Pedidos que restam no minuto actual.
`X-RateLimit-Reset`	Quando acaba o minuto, em segundos Unix.
`X-API-Mode`	O modo da chave que fez o pedido: `sandbox` ou `production`.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Não encontrado.

{
  "error": {
    "code": "not_found",
    "message": "Não encontrado.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

A operação não se pode fazer no estado actual. Veja details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Alguns dados não são válidos.

{
  "error": {
    "code": "validation_failed",
    "message": "Alguns dados não são válidos.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}

Cabeçalho	Descrição
`Retry-After`	Segundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

O serviço por trás da API não respondeu como esperado.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

Estado	Código	Significado
401	`unauthorized`	A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403	`forbidden`, `insufficient_scope`, `ip_not_allowed`	A conta não pode usar a API (`forbidden`), a chave não tem a permissão necessária (`insufficient_scope`), ou o endereço IP não está na lista da chave (`ip_not_allowed`).
404	`not_found`	Não encontrado.
409	`conflict`	A operação não se pode fazer no estado actual. Veja `details.reason`.
422	`validation_failed`	Alguns dados não são válidos.
429	`rate_limited`	Demasiados pedidos. Espere o tempo indicado em `Retry-After`.
500	`internal_error`	Ocorreu um erro interno. Indique o `correlation_id` ao suporte.
502	`upstream_error`	O serviço por trás da API não respondeu como esperado.
503	`disabled`	A API está desligada.

O formato dos erros está explicado em Erros.

PUT

Mudar a senha de uma caixa

/v1/services/{id}/email/mailboxes/{address}/password

PUThttps://api.mozout.com/v1/services/{id}/email/mailboxes/{address}/password

Precisa de email:write. Os nomes de sistema do servidor, como _mainaccount, não são aceites. A senha nunca volta. Limite: 10 por minuto por hospedagem. Com uma chave sandbox_, só confere o pedido e não altera nada. No domínio do e-mail da conta, ou do e-mail de um utilizador dela, responde 409 com o código account_email_domain: faça a alteração no portal da conta.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: email:write.

Parâmetros

Nome	Onde	Tipo	Obrigatório	Descrição
`id`	caminho	string	sim	O `id` do serviço de hospedagem.
`address`	caminho	string	sim	O endereço de e-mail completo.
`X-API-Mode`	cabeçalho	string: sandbox, production	não	Opcional. Se não coincidir com o modo da chave, o pedido é recusado com `invalid_request` e a razão `mode_mismatch`. Serve para garantir que um programa nunca corre com a chave errada.

Corpo do pedido

Campo	Tipo	Obrigatório	Descrição
`password`	string	sim	De 12 a 128 caracteres, com pelo menos 3 tipos entre minúsculas, maiúsculas, números e símbolos, sem o nome da conta, nem o do utilizador ou da caixa. Nunca volta.

Exemplos

curl

curl -X PUT "https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/mailboxes/VALUE/password" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt" \
  -H "Content-Type: application/json" \
  -d '{"password": "pP7-kX2mQ9vL4tR8wZ3a"}'

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/mailboxes/VALUE/password');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'PUT',
    CURLOPT_POSTFIELDS => '{"password": "pP7-kX2mQ9vL4tR8wZ3a"}',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
        'Content-Type: application/json',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
}
payload = {"password": "pP7-kX2mQ9vL4tR8wZ3a"}
r = requests.put("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/mailboxes/VALUE/password", headers=headers, json=payload, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/mailboxes/VALUE/password", {
  method: "PUT",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"password": "pP7-kX2mQ9vL4tR8wZ3a"}),
});
console.log(response.status);
console.log(await response.text());

Respostas

200

Mudar a senha de uma caixa.

{
  "data": {
    "address": "[email protected]",
    "password_changed": true,
    "simulated": false
  },
  "meta": {}
}

Cabeçalho	Descrição
`X-Correlation-ID`	Identificador deste pedido. Indique-o ao suporte se comunicar um problema.
`X-RateLimit-Limit`	Pedidos permitidos por minuto.
`X-RateLimit-Remaining`	Pedidos que restam no minuto actual.
`X-RateLimit-Reset`	Quando acaba o minuto, em segundos Unix.
`X-API-Mode`	O modo da chave que fez o pedido: `sandbox` ou `production`.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Não encontrado.

{
  "error": {
    "code": "not_found",
    "message": "Não encontrado.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

A operação não se pode fazer no estado actual. Veja details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Alguns dados não são válidos.

{
  "error": {
    "code": "validation_failed",
    "message": "Alguns dados não são válidos.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}

Cabeçalho	Descrição
`Retry-After`	Segundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

O serviço por trás da API não respondeu como esperado.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

Estado	Código	Significado
401	`unauthorized`	A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403	`forbidden`, `insufficient_scope`, `ip_not_allowed`	A conta não pode usar a API (`forbidden`), a chave não tem a permissão necessária (`insufficient_scope`), ou o endereço IP não está na lista da chave (`ip_not_allowed`).
404	`not_found`	Não encontrado.
409	`conflict`	A operação não se pode fazer no estado actual. Veja `details.reason`.
422	`validation_failed`	Alguns dados não são válidos.
429	`rate_limited`	Demasiados pedidos. Espere o tempo indicado em `Retry-After`.
500	`internal_error`	Ocorreu um erro interno. Indique o `correlation_id` ao suporte.
502	`upstream_error`	O serviço por trás da API não respondeu como esperado.
503	`disabled`	A API está desligada.

O formato dos erros está explicado em Erros.

PUT

Mudar a quota de uma caixa

/v1/services/{id}/email/mailboxes/{address}/quota

PUThttps://api.mozout.com/v1/services/{id}/email/mailboxes/{address}/quota

Precisa de email:write. A quota nunca passa do espaço do plano. Com uma chave sandbox_, só confere o pedido e não altera nada. No domínio do e-mail da conta, ou do e-mail de um utilizador dela, responde 409 com o código account_email_domain: faça a alteração no portal da conta.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: email:write.

Parâmetros

Nome	Onde	Tipo	Obrigatório	Descrição
`id`	caminho	string	sim	O `id` do serviço de hospedagem.
`address`	caminho	string	sim	O endereço de e-mail completo.
`X-API-Mode`	cabeçalho	string: sandbox, production	não	Opcional. Se não coincidir com o modo da chave, o pedido é recusado com `invalid_request` e a razão `mode_mismatch`. Serve para garantir que um programa nunca corre com a chave errada.

Corpo do pedido

Campo	Tipo	Obrigatório	Descrição
`quota_mb`	integer	sim	Em MB, de 1 ao espaço do plano. Não se aceita quota ilimitada.

Exemplos

curl

curl -X PUT "https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/mailboxes/VALUE/quota" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt" \
  -H "Content-Type: application/json" \
  -d '{"quota_mb": 2048}'

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/mailboxes/VALUE/quota');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'PUT',
    CURLOPT_POSTFIELDS => '{"quota_mb": 2048}',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
        'Content-Type: application/json',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
}
payload = {"quota_mb": 2048}
r = requests.put("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/mailboxes/VALUE/quota", headers=headers, json=payload, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/mailboxes/VALUE/quota", {
  method: "PUT",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"quota_mb": 2048}),
});
console.log(response.status);
console.log(await response.text());

Respostas

200

Mudar a quota de uma caixa.

{
  "data": {
    "address": "[email protected]",
    "quota_mb": 2048,
    "simulated": false
  },
  "meta": {}
}

Cabeçalho	Descrição
`X-Correlation-ID`	Identificador deste pedido. Indique-o ao suporte se comunicar um problema.
`X-RateLimit-Limit`	Pedidos permitidos por minuto.
`X-RateLimit-Remaining`	Pedidos que restam no minuto actual.
`X-RateLimit-Reset`	Quando acaba o minuto, em segundos Unix.
`X-API-Mode`	O modo da chave que fez o pedido: `sandbox` ou `production`.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Não encontrado.

{
  "error": {
    "code": "not_found",
    "message": "Não encontrado.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

A operação não se pode fazer no estado actual. Veja details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Alguns dados não são válidos.

{
  "error": {
    "code": "validation_failed",
    "message": "Alguns dados não são válidos.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}

Cabeçalho	Descrição
`Retry-After`	Segundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

O serviço por trás da API não respondeu como esperado.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

Estado	Código	Significado
401	`unauthorized`	A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403	`forbidden`, `insufficient_scope`, `ip_not_allowed`	A conta não pode usar a API (`forbidden`), a chave não tem a permissão necessária (`insufficient_scope`), ou o endereço IP não está na lista da chave (`ip_not_allowed`).
404	`not_found`	Não encontrado.
409	`conflict`	A operação não se pode fazer no estado actual. Veja `details.reason`.
422	`validation_failed`	Alguns dados não são válidos.
429	`rate_limited`	Demasiados pedidos. Espere o tempo indicado em `Retry-After`.
500	`internal_error`	Ocorreu um erro interno. Indique o `correlation_id` ao suporte.
502	`upstream_error`	O serviço por trás da API não respondeu como esperado.
503	`disabled`	A API está desligada.

O formato dos erros está explicado em Erros.

GET

Listar reencaminhadores

/v1/services/{id}/email/forwarders

GEThttps://api.mozout.com/v1/services/{id}/email/forwarders

Precisa de email:read. forward_to vem a null se o reencaminhador for para um programa, definido no painel. Se o serviço não estiver activo, ou não for uma hospedagem suportada, responde 409 com a razão em details.reason.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: email:read.

Parâmetros

Nome	Onde	Tipo	Obrigatório	Descrição
`id`	caminho	string	sim	O `id` do serviço de hospedagem.
`domain`	consulta	string	não	Um domínio desta hospedagem. Sem ele, o domínio principal.
`page`	consulta	integer	não	O número da página. A primeira é a 1.
`per_page`	consulta	integer	não	Resultados por página, de 1 a 100. Por omissão, 10.
`X-API-Mode`	cabeçalho	string: sandbox, production	não	Opcional. Se não coincidir com o modo da chave, o pedido é recusado com `invalid_request` e a razão `mode_mismatch`. Serve para garantir que um programa nunca corre com a chave errada.

Exemplos

curl

curl "https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/forwarders" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt"

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/forwarders');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
}
r = requests.get("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/forwarders", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/forwarders", {
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
  },
});
console.log(response.status);
console.log(await response.text());

Respostas

200

Listar reencaminhadores.

{
  "data": [
    {
      "address": "[email protected]",
      "forward_to": "[email protected]"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 10,
    "total": 1,
    "total_pages": 1
  }
}

Cabeçalho	Descrição
`X-Correlation-ID`	Identificador deste pedido. Indique-o ao suporte se comunicar um problema.
`X-RateLimit-Limit`	Pedidos permitidos por minuto.
`X-RateLimit-Remaining`	Pedidos que restam no minuto actual.
`X-RateLimit-Reset`	Quando acaba o minuto, em segundos Unix.
`X-API-Mode`	O modo da chave que fez o pedido: `sandbox` ou `production`.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Não encontrado.

{
  "error": {
    "code": "not_found",
    "message": "Não encontrado.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

A operação não se pode fazer no estado actual. Veja details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Alguns dados não são válidos.

{
  "error": {
    "code": "validation_failed",
    "message": "Alguns dados não são válidos.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}

Cabeçalho	Descrição
`Retry-After`	Segundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

O serviço por trás da API não respondeu como esperado.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

Estado	Código	Significado
401	`unauthorized`	A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403	`forbidden`, `insufficient_scope`, `ip_not_allowed`	A conta não pode usar a API (`forbidden`), a chave não tem a permissão necessária (`insufficient_scope`), ou o endereço IP não está na lista da chave (`ip_not_allowed`).
404	`not_found`	Não encontrado.
409	`conflict`	A operação não se pode fazer no estado actual. Veja `details.reason`.
422	`validation_failed`	Alguns dados não são válidos.
429	`rate_limited`	Demasiados pedidos. Espere o tempo indicado em `Retry-After`.
500	`internal_error`	Ocorreu um erro interno. Indique o `correlation_id` ao suporte.
502	`upstream_error`	O serviço por trás da API não respondeu como esperado.
503	`disabled`	A API está desligada.

O formato dos erros está explicado em Erros.

POST

Criar um reencaminhador

/v1/services/{id}/email/forwarders

POSThttps://api.mozout.com/v1/services/{id}/email/forwarders

Precisa de email:write. Só para endereços de e-mail, nunca para programas. Com uma chave sandbox_, só confere o pedido e não altera nada. No domínio do e-mail da conta, ou do e-mail de um utilizador dela, responde 409 com o código account_email_domain: faça a alteração no portal da conta.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: email:write.

Parâmetros

Nome	Onde	Tipo	Obrigatório	Descrição
`id`	caminho	string	sim	O `id` do serviço de hospedagem.
`Idempotency-Key`	cabeçalho	string	não	Um valor único qualquer, até 255 caracteres visíveis. Vale 24 horas por chave. Repetir o mesmo pedido devolve a resposta guardada; outro corpo, ou um primeiro pedido ainda em curso, devolve 409.
`X-API-Mode`	cabeçalho	string: sandbox, production	não	Opcional. Se não coincidir com o modo da chave, o pedido é recusado com `invalid_request` e a razão `mode_mismatch`. Serve para garantir que um programa nunca corre com a chave errada.

Corpo do pedido

Campo	Tipo	Obrigatório	Descrição
`address`	string	sim	O endereço de e-mail completo.
`forward_to`	string	sim	O endereço para onde reencaminha.

Exemplos

curl

curl -X POST "https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/forwarders" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt" \
  -H "Idempotency-Key: 9f1c2d3e-example" \
  -H "Content-Type: application/json" \
  -d '{"address": "[email protected]", "forward_to": "[email protected]"}'

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/forwarders');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => '{"address": "[email protected]", "forward_to": "[email protected]"}',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
        'Idempotency-Key: 9f1c2d3e-example',
        'Content-Type: application/json',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
    "Idempotency-Key": "9f1c2d3e-example",
}
payload = {"address": "[email protected]", "forward_to": "[email protected]"}
r = requests.post("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/forwarders", headers=headers, json=payload, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/forwarders", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
    "Idempotency-Key": "9f1c2d3e-example",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"address": "[email protected]", "forward_to": "[email protected]"}),
});
console.log(response.status);
console.log(await response.text());

Respostas

201

Criar um reencaminhador.

{
  "data": {
    "address": "[email protected]",
    "forward_to": "[email protected]",
    "simulated": false
  },
  "meta": {}
}

Cabeçalho	Descrição
`X-Correlation-ID`	Identificador deste pedido. Indique-o ao suporte se comunicar um problema.
`X-RateLimit-Limit`	Pedidos permitidos por minuto.
`X-RateLimit-Remaining`	Pedidos que restam no minuto actual.
`X-RateLimit-Reset`	Quando acaba o minuto, em segundos Unix.
`X-API-Mode`	O modo da chave que fez o pedido: `sandbox` ou `production`.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Não encontrado.

{
  "error": {
    "code": "not_found",
    "message": "Não encontrado.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

A operação não se pode fazer no estado actual. Veja details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Alguns dados não são válidos.

{
  "error": {
    "code": "validation_failed",
    "message": "Alguns dados não são válidos.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}

Cabeçalho	Descrição
`Retry-After`	Segundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

O serviço por trás da API não respondeu como esperado.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

Estado	Código	Significado
401	`unauthorized`	A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403	`forbidden`, `insufficient_scope`, `ip_not_allowed`	A conta não pode usar a API (`forbidden`), a chave não tem a permissão necessária (`insufficient_scope`), ou o endereço IP não está na lista da chave (`ip_not_allowed`).
404	`not_found`	Não encontrado.
409	`conflict`	A operação não se pode fazer no estado actual. Veja `details.reason`.
422	`validation_failed`	Alguns dados não são válidos.
429	`rate_limited`	Demasiados pedidos. Espere o tempo indicado em `Retry-After`.
500	`internal_error`	Ocorreu um erro interno. Indique o `correlation_id` ao suporte.
502	`upstream_error`	O serviço por trás da API não respondeu como esperado.
503	`disabled`	A API está desligada.

O formato dos erros está explicado em Erros.

DELETE

Apagar um reencaminhador

/v1/services/{id}/email/forwarders/{address}/{forward_to}

DELETEhttps://api.mozout.com/v1/services/{id}/email/forwarders/{address}/{forward_to}

Precisa de email:write. Indique os dois endereços no caminho. Com uma chave sandbox_, só confere o pedido e não altera nada. No domínio do e-mail da conta, ou do e-mail de um utilizador dela, responde 409 com o código account_email_domain: faça a alteração no portal da conta.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: email:write.

Parâmetros

Nome	Onde	Tipo	Obrigatório	Descrição
`id`	caminho	string	sim	O `id` do serviço de hospedagem.
`address`	caminho	string	sim	O endereço de e-mail completo.
`forward_to`	caminho	string	sim	O endereço para onde reencaminha.
`X-API-Mode`	cabeçalho	string: sandbox, production	não	Opcional. Se não coincidir com o modo da chave, o pedido é recusado com `invalid_request` e a razão `mode_mismatch`. Serve para garantir que um programa nunca corre com a chave errada.

Exemplos

curl

curl -X DELETE "https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/forwarders/VALUE/VALUE" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt"

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/forwarders/VALUE/VALUE');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'DELETE',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
}
r = requests.delete("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/forwarders/VALUE/VALUE", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/forwarders/VALUE/VALUE", {
  method: "DELETE",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
  },
});
console.log(response.status);
console.log(await response.text());

Respostas

200

Apagar um reencaminhador.

{
  "data": {
    "address": "[email protected]",
    "forward_to": "[email protected]",
    "deleted": true,
    "simulated": false
  },
  "meta": {}
}

Cabeçalho	Descrição
`X-Correlation-ID`	Identificador deste pedido. Indique-o ao suporte se comunicar um problema.
`X-RateLimit-Limit`	Pedidos permitidos por minuto.
`X-RateLimit-Remaining`	Pedidos que restam no minuto actual.
`X-RateLimit-Reset`	Quando acaba o minuto, em segundos Unix.
`X-API-Mode`	O modo da chave que fez o pedido: `sandbox` ou `production`.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Não encontrado.

{
  "error": {
    "code": "not_found",
    "message": "Não encontrado.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

A operação não se pode fazer no estado actual. Veja details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Alguns dados não são válidos.

{
  "error": {
    "code": "validation_failed",
    "message": "Alguns dados não são válidos.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}

Cabeçalho	Descrição
`Retry-After`	Segundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

O serviço por trás da API não respondeu como esperado.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

Estado	Código	Significado
401	`unauthorized`	A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403	`forbidden`, `insufficient_scope`, `ip_not_allowed`	A conta não pode usar a API (`forbidden`), a chave não tem a permissão necessária (`insufficient_scope`), ou o endereço IP não está na lista da chave (`ip_not_allowed`).
404	`not_found`	Não encontrado.
409	`conflict`	A operação não se pode fazer no estado actual. Veja `details.reason`.
422	`validation_failed`	Alguns dados não são válidos.
429	`rate_limited`	Demasiados pedidos. Espere o tempo indicado em `Retry-After`.
500	`internal_error`	Ocorreu um erro interno. Indique o `correlation_id` ao suporte.
502	`upstream_error`	O serviço por trás da API não respondeu como esperado.
503	`disabled`	A API está desligada.

O formato dos erros está explicado em Erros.

GET

Listar respostas automáticas

/v1/services/{id}/email/autoresponders

GEThttps://api.mozout.com/v1/services/{id}/email/autoresponders

Precisa de email:read. As respostas automáticas de um domínio. Se o serviço não estiver activo, ou não for uma hospedagem suportada, responde 409 com a razão em details.reason.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: email:read.

Parâmetros

Nome	Onde	Tipo	Obrigatório	Descrição
`id`	caminho	string	sim	O `id` do serviço de hospedagem.
`domain`	consulta	string	não	Um domínio desta hospedagem. Sem ele, o domínio principal.
`page`	consulta	integer	não	O número da página. A primeira é a 1.
`per_page`	consulta	integer	não	Resultados por página, de 1 a 100. Por omissão, 10.
`X-API-Mode`	cabeçalho	string: sandbox, production	não	Opcional. Se não coincidir com o modo da chave, o pedido é recusado com `invalid_request` e a razão `mode_mismatch`. Serve para garantir que um programa nunca corre com a chave errada.

Exemplos

curl

curl "https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/autoresponders" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt"

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/autoresponders');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
}
r = requests.get("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/autoresponders", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/autoresponders", {
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
  },
});
console.log(response.status);
console.log(await response.text());

Respostas

200

Listar respostas automáticas.

{
  "data": [
    {
      "address": "[email protected]",
      "subject": "Fora do escritório"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 10,
    "total": 1,
    "total_pages": 1
  }
}

Cabeçalho	Descrição
`X-Correlation-ID`	Identificador deste pedido. Indique-o ao suporte se comunicar um problema.
`X-RateLimit-Limit`	Pedidos permitidos por minuto.
`X-RateLimit-Remaining`	Pedidos que restam no minuto actual.
`X-RateLimit-Reset`	Quando acaba o minuto, em segundos Unix.
`X-API-Mode`	O modo da chave que fez o pedido: `sandbox` ou `production`.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Não encontrado.

{
  "error": {
    "code": "not_found",
    "message": "Não encontrado.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

A operação não se pode fazer no estado actual. Veja details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Alguns dados não são válidos.

{
  "error": {
    "code": "validation_failed",
    "message": "Alguns dados não são válidos.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}

Cabeçalho	Descrição
`Retry-After`	Segundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

O serviço por trás da API não respondeu como esperado.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

Estado	Código	Significado
401	`unauthorized`	A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403	`forbidden`, `insufficient_scope`, `ip_not_allowed`	A conta não pode usar a API (`forbidden`), a chave não tem a permissão necessária (`insufficient_scope`), ou o endereço IP não está na lista da chave (`ip_not_allowed`).
404	`not_found`	Não encontrado.
409	`conflict`	A operação não se pode fazer no estado actual. Veja `details.reason`.
422	`validation_failed`	Alguns dados não são válidos.
429	`rate_limited`	Demasiados pedidos. Espere o tempo indicado em `Retry-After`.
500	`internal_error`	Ocorreu um erro interno. Indique o `correlation_id` ao suporte.
502	`upstream_error`	O serviço por trás da API não respondeu como esperado.
503	`disabled`	A API está desligada.

O formato dos erros está explicado em Erros.

GET

Ver uma resposta automática

/v1/services/{id}/email/autoresponders/{address}

GEThttps://api.mozout.com/v1/services/{id}/email/autoresponders/{address}

Precisa de email:read. Com o texto e as datas. Se o serviço não estiver activo, ou não for uma hospedagem suportada, responde 409 com a razão em details.reason.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: email:read.

Parâmetros

Nome	Onde	Tipo	Obrigatório	Descrição
`id`	caminho	string	sim	O `id` do serviço de hospedagem.
`address`	caminho	string	sim	O endereço de e-mail completo.
`X-API-Mode`	cabeçalho	string: sandbox, production	não	Opcional. Se não coincidir com o modo da chave, o pedido é recusado com `invalid_request` e a razão `mode_mismatch`. Serve para garantir que um programa nunca corre com a chave errada.

Exemplos

curl

curl "https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/autoresponders/VALUE" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt"

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/autoresponders/VALUE');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
}
r = requests.get("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/autoresponders/VALUE", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/autoresponders/VALUE", {
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
  },
});
console.log(response.status);
console.log(await response.text());

Respostas

200

Ver uma resposta automática.

{
  "data": {
    "address": "[email protected]",
    "from": "Info",
    "subject": "Fora do escritório",
    "body": "Volto na segunda.",
    "html": false,
    "interval_hours": 8,
    "start_at": null,
    "stop_at": null
  },
  "meta": {}
}

Cabeçalho	Descrição
`X-Correlation-ID`	Identificador deste pedido. Indique-o ao suporte se comunicar um problema.
`X-RateLimit-Limit`	Pedidos permitidos por minuto.
`X-RateLimit-Remaining`	Pedidos que restam no minuto actual.
`X-RateLimit-Reset`	Quando acaba o minuto, em segundos Unix.
`X-API-Mode`	O modo da chave que fez o pedido: `sandbox` ou `production`.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Não encontrado.

{
  "error": {
    "code": "not_found",
    "message": "Não encontrado.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

A operação não se pode fazer no estado actual. Veja details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}

Cabeçalho	Descrição
`Retry-After`	Segundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

O serviço por trás da API não respondeu como esperado.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

Estado	Código	Significado
401	`unauthorized`	A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403	`forbidden`, `insufficient_scope`, `ip_not_allowed`	A conta não pode usar a API (`forbidden`), a chave não tem a permissão necessária (`insufficient_scope`), ou o endereço IP não está na lista da chave (`ip_not_allowed`).
404	`not_found`	Não encontrado.
409	`conflict`	A operação não se pode fazer no estado actual. Veja `details.reason`.
429	`rate_limited`	Demasiados pedidos. Espere o tempo indicado em `Retry-After`.
500	`internal_error`	Ocorreu um erro interno. Indique o `correlation_id` ao suporte.
502	`upstream_error`	O serviço por trás da API não respondeu como esperado.
503	`disabled`	A API está desligada.

O formato dos erros está explicado em Erros.

PUT

Gravar uma resposta automática

/v1/services/{id}/email/autoresponders/{address}

PUThttps://api.mozout.com/v1/services/{id}/email/autoresponders/{address}

Precisa de email:write. Cria ou substitui a resposta automática deste endereço. Com uma chave sandbox_, só confere o pedido e não altera nada.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: email:write.

Parâmetros

Nome	Onde	Tipo	Obrigatório	Descrição
`id`	caminho	string	sim	O `id` do serviço de hospedagem.
`address`	caminho	string	sim	O endereço de e-mail completo.
`X-API-Mode`	cabeçalho	string: sandbox, production	não	Opcional. Se não coincidir com o modo da chave, o pedido é recusado com `invalid_request` e a razão `mode_mismatch`. Serve para garantir que um programa nunca corre com a chave errada.

Corpo do pedido

Campo	Tipo	Obrigatório	Descrição
`from`	string	sim	O nome do remetente, até 100 caracteres.
`subject`	string	sim	Até 200 caracteres.
`body`	string	sim	Até 20000 caracteres.
`html`	boolean	não	Se o texto é HTML.
`interval_hours`	integer	não	Horas entre respostas ao mesmo remetente, de 0 a 720. Sem ele, 8.
`start_at`	string	não	Início, em ISO 8601.
`stop_at`	string	não	Fim, em ISO 8601.

Exemplos

curl

curl -X PUT "https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/autoresponders/VALUE" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt" \
  -H "Content-Type: application/json" \
  -d '{"from": "Info", "subject": "Fora do escritório", "body": "Volto na segunda."}'

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/autoresponders/VALUE');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'PUT',
    CURLOPT_POSTFIELDS => '{"from": "Info", "subject": "Fora do escritório", "body": "Volto na segunda."}',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
        'Content-Type: application/json',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
}
payload = {"from": "Info", "subject": "Fora do escritório", "body": "Volto na segunda."}
r = requests.put("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/autoresponders/VALUE", headers=headers, json=payload, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/autoresponders/VALUE", {
  method: "PUT",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"from": "Info", "subject": "Fora do escritório", "body": "Volto na segunda."}),
});
console.log(response.status);
console.log(await response.text());

Respostas

200

Gravar uma resposta automática.

{
  "data": {
    "address": "[email protected]",
    "subject": "Fora do escritório",
    "simulated": false
  },
  "meta": {}
}

Cabeçalho	Descrição
`X-Correlation-ID`	Identificador deste pedido. Indique-o ao suporte se comunicar um problema.
`X-RateLimit-Limit`	Pedidos permitidos por minuto.
`X-RateLimit-Remaining`	Pedidos que restam no minuto actual.
`X-RateLimit-Reset`	Quando acaba o minuto, em segundos Unix.
`X-API-Mode`	O modo da chave que fez o pedido: `sandbox` ou `production`.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Não encontrado.

{
  "error": {
    "code": "not_found",
    "message": "Não encontrado.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

A operação não se pode fazer no estado actual. Veja details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Alguns dados não são válidos.

{
  "error": {
    "code": "validation_failed",
    "message": "Alguns dados não são válidos.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}

Cabeçalho	Descrição
`Retry-After`	Segundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

O serviço por trás da API não respondeu como esperado.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

Estado	Código	Significado
401	`unauthorized`	A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403	`forbidden`, `insufficient_scope`, `ip_not_allowed`	A conta não pode usar a API (`forbidden`), a chave não tem a permissão necessária (`insufficient_scope`), ou o endereço IP não está na lista da chave (`ip_not_allowed`).
404	`not_found`	Não encontrado.
409	`conflict`	A operação não se pode fazer no estado actual. Veja `details.reason`.
422	`validation_failed`	Alguns dados não são válidos.
429	`rate_limited`	Demasiados pedidos. Espere o tempo indicado em `Retry-After`.
500	`internal_error`	Ocorreu um erro interno. Indique o `correlation_id` ao suporte.
502	`upstream_error`	O serviço por trás da API não respondeu como esperado.
503	`disabled`	A API está desligada.

O formato dos erros está explicado em Erros.

DELETE

Apagar uma resposta automática

/v1/services/{id}/email/autoresponders/{address}

DELETEhttps://api.mozout.com/v1/services/{id}/email/autoresponders/{address}

Precisa de email:write. A caixa fica. Com uma chave sandbox_, só confere o pedido e não altera nada.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: email:write.

Parâmetros

Nome	Onde	Tipo	Obrigatório	Descrição
`id`	caminho	string	sim	O `id` do serviço de hospedagem.
`address`	caminho	string	sim	O endereço de e-mail completo.
`X-API-Mode`	cabeçalho	string: sandbox, production	não	Opcional. Se não coincidir com o modo da chave, o pedido é recusado com `invalid_request` e a razão `mode_mismatch`. Serve para garantir que um programa nunca corre com a chave errada.

Exemplos

curl

curl -X DELETE "https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/autoresponders/VALUE" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt"

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/autoresponders/VALUE');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'DELETE',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
}
r = requests.delete("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/autoresponders/VALUE", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/autoresponders/VALUE", {
  method: "DELETE",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
  },
});
console.log(response.status);
console.log(await response.text());

Respostas

200

Apagar uma resposta automática.

{
  "data": {
    "address": "[email protected]",
    "deleted": true,
    "simulated": false
  },
  "meta": {}
}

Cabeçalho	Descrição
`X-Correlation-ID`	Identificador deste pedido. Indique-o ao suporte se comunicar um problema.
`X-RateLimit-Limit`	Pedidos permitidos por minuto.
`X-RateLimit-Remaining`	Pedidos que restam no minuto actual.
`X-RateLimit-Reset`	Quando acaba o minuto, em segundos Unix.
`X-API-Mode`	O modo da chave que fez o pedido: `sandbox` ou `production`.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Não encontrado.

{
  "error": {
    "code": "not_found",
    "message": "Não encontrado.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

A operação não se pode fazer no estado actual. Veja details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Alguns dados não são válidos.

{
  "error": {
    "code": "validation_failed",
    "message": "Alguns dados não são válidos.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}

Cabeçalho	Descrição
`Retry-After`	Segundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

O serviço por trás da API não respondeu como esperado.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

Estado	Código	Significado
401	`unauthorized`	A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403	`forbidden`, `insufficient_scope`, `ip_not_allowed`	A conta não pode usar a API (`forbidden`), a chave não tem a permissão necessária (`insufficient_scope`), ou o endereço IP não está na lista da chave (`ip_not_allowed`).
404	`not_found`	Não encontrado.
409	`conflict`	A operação não se pode fazer no estado actual. Veja `details.reason`.
422	`validation_failed`	Alguns dados não são válidos.
429	`rate_limited`	Demasiados pedidos. Espere o tempo indicado em `Retry-After`.
500	`internal_error`	Ocorreu um erro interno. Indique o `correlation_id` ao suporte.
502	`upstream_error`	O serviço por trás da API não respondeu como esperado.
503	`disabled`	A API está desligada.

O formato dos erros está explicado em Erros.

GET

Ver a conta geral

/v1/services/{id}/email/default-address

GEThttps://api.mozout.com/v1/services/{id}/email/default-address

Precisa de email:read. O que acontece ao correio para endereços que não existem. action é fail, forward, discard, main_account ou other. Se o serviço não estiver activo, ou não for uma hospedagem suportada, responde 409 com a razão em details.reason.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: email:read.

Parâmetros

Nome	Onde	Tipo	Obrigatório	Descrição
`id`	caminho	string	sim	O `id` do serviço de hospedagem.
`domain`	consulta	string	não	Um domínio desta hospedagem. Sem ele, o domínio principal.
`X-API-Mode`	cabeçalho	string: sandbox, production	não	Opcional. Se não coincidir com o modo da chave, o pedido é recusado com `invalid_request` e a razão `mode_mismatch`. Serve para garantir que um programa nunca corre com a chave errada.

Exemplos

curl

curl "https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/default-address" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt"

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/default-address');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
}
r = requests.get("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/default-address", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/default-address", {
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
  },
});
console.log(response.status);
console.log(await response.text());

Respostas

200

Ver a conta geral.

{
  "data": {
    "domain": "example.co.mz",
    "action": "fail",
    "forward_to": null,
    "message": "No such person at this address."
  },
  "meta": {}
}

Cabeçalho	Descrição
`X-Correlation-ID`	Identificador deste pedido. Indique-o ao suporte se comunicar um problema.
`X-RateLimit-Limit`	Pedidos permitidos por minuto.
`X-RateLimit-Remaining`	Pedidos que restam no minuto actual.
`X-RateLimit-Reset`	Quando acaba o minuto, em segundos Unix.
`X-API-Mode`	O modo da chave que fez o pedido: `sandbox` ou `production`.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Não encontrado.

{
  "error": {
    "code": "not_found",
    "message": "Não encontrado.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

A operação não se pode fazer no estado actual. Veja details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}

Cabeçalho	Descrição
`Retry-After`	Segundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

O serviço por trás da API não respondeu como esperado.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

Estado	Código	Significado
401	`unauthorized`	A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403	`forbidden`, `insufficient_scope`, `ip_not_allowed`	A conta não pode usar a API (`forbidden`), a chave não tem a permissão necessária (`insufficient_scope`), ou o endereço IP não está na lista da chave (`ip_not_allowed`).
404	`not_found`	Não encontrado.
409	`conflict`	A operação não se pode fazer no estado actual. Veja `details.reason`.
429	`rate_limited`	Demasiados pedidos. Espere o tempo indicado em `Retry-After`.
500	`internal_error`	Ocorreu um erro interno. Indique o `correlation_id` ao suporte.
502	`upstream_error`	O serviço por trás da API não respondeu como esperado.
503	`disabled`	A API está desligada.

O formato dos erros está explicado em Erros.

PUT

Alterar a conta geral

/v1/services/{id}/email/default-address

PUThttps://api.mozout.com/v1/services/{id}/email/default-address

Precisa de email:write. Acções aceites: fail, forward, discard e main_account. Com uma chave sandbox_, só confere o pedido e não altera nada. No domínio do e-mail da conta, ou do e-mail de um utilizador dela, responde 409 com o código account_email_domain: faça a alteração no portal da conta.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: email:write.

Parâmetros

Nome	Onde	Tipo	Obrigatório	Descrição
`id`	caminho	string	sim	O `id` do serviço de hospedagem.
`X-API-Mode`	cabeçalho	string: sandbox, production	não	Opcional. Se não coincidir com o modo da chave, o pedido é recusado com `invalid_request` e a razão `mode_mismatch`. Serve para garantir que um programa nunca corre com a chave errada.

Corpo do pedido

Campo	Tipo	Obrigatório	Descrição
`domain`	string	sim	Um domínio desta hospedagem.
`action`	string	sim	`fail`, `forward`, `discard` ou `main_account`.
`forward_to`	string	não	Necessário com `forward`.
`message`	string	não	A mensagem com `fail`, até 200 caracteres.

Exemplos

curl

curl -X PUT "https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/default-address" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt" \
  -H "Content-Type: application/json" \
  -d '{"domain": "example.co.mz", "action": "fail", "message": "No such person at this address."}'

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/default-address');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'PUT',
    CURLOPT_POSTFIELDS => '{"domain": "example.co.mz", "action": "fail", "message": "No such person at this address."}',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
        'Content-Type: application/json',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
}
payload = {"domain": "example.co.mz", "action": "fail", "message": "No such person at this address."}
r = requests.put("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/default-address", headers=headers, json=payload, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/default-address", {
  method: "PUT",
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"domain": "example.co.mz", "action": "fail", "message": "No such person at this address."}),
});
console.log(response.status);
console.log(await response.text());

Respostas

200

Alterar a conta geral.

{
  "data": {
    "domain": "example.co.mz",
    "action": "fail",
    "forward_to": null,
    "message": "No such person at this address.",
    "simulated": false
  },
  "meta": {}
}

Cabeçalho	Descrição
`X-Correlation-ID`	Identificador deste pedido. Indique-o ao suporte se comunicar um problema.
`X-RateLimit-Limit`	Pedidos permitidos por minuto.
`X-RateLimit-Remaining`	Pedidos que restam no minuto actual.
`X-RateLimit-Reset`	Quando acaba o minuto, em segundos Unix.
`X-API-Mode`	O modo da chave que fez o pedido: `sandbox` ou `production`.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Não encontrado.

{
  "error": {
    "code": "not_found",
    "message": "Não encontrado.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

A operação não se pode fazer no estado actual. Veja details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

422

Alguns dados não são válidos.

{
  "error": {
    "code": "validation_failed",
    "message": "Alguns dados não são válidos.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}

Cabeçalho	Descrição
`Retry-After`	Segundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

O serviço por trás da API não respondeu como esperado.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

Estado	Código	Significado
401	`unauthorized`	A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403	`forbidden`, `insufficient_scope`, `ip_not_allowed`	A conta não pode usar a API (`forbidden`), a chave não tem a permissão necessária (`insufficient_scope`), ou o endereço IP não está na lista da chave (`ip_not_allowed`).
404	`not_found`	Não encontrado.
409	`conflict`	A operação não se pode fazer no estado actual. Veja `details.reason`.
422	`validation_failed`	Alguns dados não são válidos.
429	`rate_limited`	Demasiados pedidos. Espere o tempo indicado em `Retry-After`.
500	`internal_error`	Ocorreu um erro interno. Indique o `correlation_id` ao suporte.
502	`upstream_error`	O serviço por trás da API não respondeu como esperado.
503	`disabled`	A API está desligada.

O formato dos erros está explicado em Erros.

GET

Ver SPF, DKIM e DMARC

/v1/services/{id}/email/authentication

GEThttps://api.mozout.com/v1/services/{id}/email/authentication

Precisa de email:read. O estado dos três registos de um domínio, como estão publicados no DNS. Se o serviço não estiver activo, ou não for uma hospedagem suportada, responde 409 com a razão em details.reason.

Autenticação

Precisa de uma chave válida no cabeçalho Authorization: Bearer. Permissão necessária: email:read.

Parâmetros

Nome	Onde	Tipo	Obrigatório	Descrição
`id`	caminho	string	sim	O `id` do serviço de hospedagem.
`domain`	consulta	string	não	Um domínio desta hospedagem. Sem ele, o domínio principal.
`X-API-Mode`	cabeçalho	string: sandbox, production	não	Opcional. Se não coincidir com o modo da chave, o pedido é recusado com `invalid_request` e a razão `mode_mismatch`. Serve para garantir que um programa nunca corre com a chave errada.

Exemplos

curl

curl "https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/authentication" \
  -H "Authorization: Bearer $RLX_API_KEY" \
  -H "Accept-Language: pt"

PHP

<?php
$ch = curl_init('https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/authentication');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('RLX_API_KEY'),
        'Accept-Language: pt',
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $body, PHP_EOL;

Python

import os
import requests

headers = {
    "Authorization": "Bearer " + os.environ["RLX_API_KEY"],
    "Accept-Language": "pt",
}
r = requests.get("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/authentication", headers=headers, timeout=30)
print(r.status_code)
print(r.text)

JavaScript

const response = await fetch("https://api.mozout.com/v1/services/00000000-0000-4000-8000-000000000000/email/authentication", {
  headers: {
    Authorization: `Bearer ${process.env.RLX_API_KEY}`,
    "Accept-Language": "pt",
  },
});
console.log(response.status);
console.log(await response.text());

Respostas

200

Ver SPF, DKIM e DMARC.

{
  "data": {
    "domain": "example.co.mz",
    "spf": {
      "state": "pass"
    },
    "dkim": {
      "state": "valid"
    },
    "dmarc": {
      "state": "missing"
    }
  },
  "meta": {}
}

Cabeçalho	Descrição
`X-Correlation-ID`	Identificador deste pedido. Indique-o ao suporte se comunicar um problema.
`X-RateLimit-Limit`	Pedidos permitidos por minuto.
`X-RateLimit-Remaining`	Pedidos que restam no minuto actual.
`X-RateLimit-Reset`	Quando acaba o minuto, em segundos Unix.
`X-API-Mode`	O modo da chave que fez o pedido: `sandbox` ou `production`.

401

A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.

{
  "error": {
    "code": "unauthorized",
    "message": "Chave da API em falta ou inválida.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

403

A conta não pode usar a API (forbidden), a chave não tem a permissão necessária (insufficient_scope), ou o endereço IP não está na lista da chave (ip_not_allowed).

{
  "error": {
    "code": "insufficient_scope",
    "message": "Esta chave não tem a permissão necessária.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "required": "dns:read"
    }
  }
}

404

Não encontrado.

{
  "error": {
    "code": "not_found",
    "message": "Não encontrado.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

409

A operação não se pode fazer no estado actual. Veja details.reason.

{
  "error": {
    "code": "conflict",
    "message": "This operation only works on an active domain.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "reason": "domain_not_active"
    }
  }
}

429

Demasiados pedidos. Espere o tempo indicado em Retry-After.

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiados pedidos. Tente de novo daqui a pouco.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {
      "retry_after": 42
    }
  }
}

Cabeçalho	Descrição
`Retry-After`	Segundos a esperar antes de tentar de novo.

500

Ocorreu um erro interno. Indique o correlation_id ao suporte.

{
  "error": {
    "code": "internal_error",
    "message": "Ocorreu um erro interno. Indique o correlation_id ao suporte.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

502

O serviço por trás da API não respondeu como esperado.

{
  "error": {
    "code": "upstream_error",
    "message": "The service did not respond as expected. Please try again later.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

503

A API está desligada.

{
  "error": {
    "code": "disabled",
    "message": "A API está desligada de momento.",
    "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "details": {}
  }
}

Erros

Estado	Código	Significado
401	`unauthorized`	A chave está em falta, não é válida, foi revogada ou passou da validade, ou quem a criou já não tem acesso à conta.
403	`forbidden`, `insufficient_scope`, `ip_not_allowed`	A conta não pode usar a API (`forbidden`), a chave não tem a permissão necessária (`insufficient_scope`), ou o endereço IP não está na lista da chave (`ip_not_allowed`).
404	`not_found`	Não encontrado.
409	`conflict`	A operação não se pode fazer no estado actual. Veja `details.reason`.
429	`rate_limited`	Demasiados pedidos. Espere o tempo indicado em `Retry-After`.
500	`internal_error`	Ocorreu um erro interno. Indique o `correlation_id` ao suporte.
502	`upstream_error`	O serviço por trás da API não respondeu como esperado.
503	`disabled`	A API está desligada.

O formato dos erros está explicado em Erros.