Documentation
ARX

Comprendre vos adresses, connecter vos outils et garder le contrôle.

Une adresse, un usage.

Depuis « Mes alias », choisissez un nom et un domaine disponible, puis indiquez votre adresse de destination. Les emails envoyés à l’alias seront redirigés vers cette adresse.

Vous pouvez mettre un alias en pause, changer sa destination, ou autoriser et bloquer certains expéditeurs. La suppression d’un alias est définitive.

Gérer mes alias

Le temps d’un échange.

Créez une boîte avec une durée comprise entre 10 minutes et 7 jours. Ouvrez-la pour consulter les messages reçus. La liste s’actualise toutes les 15 secondes lorsque la page est visible.

Vous pouvez prolonger une boîte de 24 heures depuis son écran de lecture. Le contenu HTML des messages est isolé et les images distantes ne sont pas chargées.

Votre domaine, votre point d’entrée.

Ajoutez votre domaine et publiez le jeton TXT fourni sous le nom _agy-challenge. Lancez ensuite la vérification depuis l’interface. Configurez également le MX vers le serveur email de votre installation.

Une fois vérifié, le domaine peut accueillir vos adresses et une règle catch-all. Cette règle redirige les adresses non attribuées vers votre destination.

Connecter ce qui compte.

L’accès développeur dépend de votre offre. Créez une clé avec les permissions minimales nécessaires et copiez-la immédiatement : elle n’est affichée qu’une seule fois.

Envoyer des emails depuis un autre SaaS

Avec la permission mail:send, vous pouvez émettre des emails transactionnels, notifications et reçus directement depuis votre plateforme tierce. L’expéditeur ("from") doit correspondre à l’un de vos domaines vérifiés ou à une adresse active de votre compte.

curl -X POST "https://arx-mail.com/api/v1/developer/send" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "from": "[email protected]",
    "to": "[email protected]",
    "subject": "Votre facture est disponible",
    "html": "<h1>Bonjour</h1><p>Votre facture #4092 est prête.</p>",
    "text": "Bonjour, votre facture #4092 est prête."
  }'

Consultez vos expéditeurs autorisés via GET /api/v1/developer/send/senders et suivez l’état de vos envois via GET /api/v1/developer/sent.

Recevoir et consulter les emails par API

Avec la permission messages:read ou mail:read, interrogez les emails reçus sur vos adresses ou boîtes temporaires, inspectez le contenu HTML ou texte brut et téléchargez les pièces jointes de manière sécurisée.

# 1. Lister les emails reçus pour une adresse
curl -s "https://arx-mail.com/api/v1/developer/[email protected]" \
  -H "Authorization: Bearer $API_KEY"

# 2. Récupérer le contenu complet d'un email
curl -s "https://arx-mail.com/api/v1/developer/messages/msg_01j7abc..." \
  -H "Authorization: Bearer $API_KEY"

# 3. Télécharger une pièce jointe
curl -s "https://arx-mail.com/api/v1/developer/messages/msg_01j7abc.../attachments/att_01" \
  -H "Authorization: Bearer $API_KEY" -o "facture.pdf"

Vous pouvez également interroger directement une boîte via son identifiant : GET /api/v1/developer/temp-inboxes/{inbox_id}/messages.

Intégration accélérée avec une IA

Un prompt d’intégration complet est disponible dans l’espace Développeur. Copiez-le en un clic et collez-le dans ChatGPT, Claude ou Cursor pour générer immédiatement votre code d’intégration.

Consulter les quotas et webhooks

GET /api/v1/developer/temp-inboxes
Authorization: Bearer $API_KEY

GET /api/v1/developer/usage
Authorization: Bearer $API_KEY

Les webhooks permettent de notifier une URL publique de vos événements. Consultez les livraisons pour connaître le code HTTP, le succès et la durée de chaque appel.

Ouvrir l’espace développeur

Un accès qui reste le vôtre.

Activez la double authentification depuis les paramètres et sauvegardez vos codes de secours. Consultez vos sessions et révoquez les appareils que vous ne reconnaissez pas.

Un changement de mot de passe révoque toutes les sessions existantes.