Retrieve a email account

Parameters

Request

curl -X GET 'https://app.mailyte.com/api/v1/email-accounts/ada@example.com' \
  -H 'Authorization: Bearer mk_live_YOUR_API_KEY'

const response = await fetch('https://app.mailyte.com/api/v1/email-accounts/ada@example.com', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer mk_live_YOUR_API_KEY',
  },
});
const { data } = await response.json();

import requests
response = requests.get(
    "https://app.mailyte.com/api/v1/email-accounts/ada@example.com",
    headers={"Authorization": "Bearer mk_live_YOUR_API_KEY"},
)
data = response.json()["data"]

<?php

$response = Http::withToken('mk_live_YOUR_API_KEY')
    ->get('https://app.mailyte.com/api/v1/email-accounts/ada@example.com');

$data = $response->json('data');

require "net/http"
require "json"
uri = URI("https://app.mailyte.com/api/v1/email-accounts/ada@example.com")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer mk_live_YOUR_API_KEY"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

Response

Success.

• dataobject
  • objectstringmailbox
  • idstring

    Unique identifier for the mailbox.

  • addressstring

    The full email address. This *is* the mailbox publicly: there is no separate username, because the local part is already in here.

  • namestring

    Display name, as it appears to a recipient. null when none was set.

  • domain_idstring

    The domain this mailbox belongs to. Retrieve it with GET /api/v1/domains/{domain}.

  • typestringmail | smtp | both

    What the mailbox was created as, and what you can filter the list by. Recorded rather than enforced: nothing in the product currently branches on it, so it does not by itself restrict what the mailbox can do.

  • statestringactive | provisioning | failed | suspended | deleting

    Where the mailbox stands: deleting first, then suspended, then its setup state. Only an active mailbox sends and receives.

  • provisioningobject

    What the mail server has done with this mailbox. Creation is asynchronous, so a mailbox exists here before it exists there.

    • statestringpending | provisioning | active | failed | suspended | deleting | deleted

      The mailbox's setup state on the mail server. Use the top-level state to decide what the mailbox can do.

    • errorstring

      Why provisioning failed, in the mail server's words. null unless state is failed.

    • retryableboolean

      True only while state is failed, which is the only state POST /retry-provisioning accepts.

  • storageobject

    Bytes, both of them. Never a pre-formatted "3 GB", which cannot be computed with.

    • quota_bytesinteger

      The mailbox's storage limit, in bytes. Always set; the default is 1 GB.

    • used_bytesinteger

      Bytes used. Null means we could not read it yet (for example, the mailbox is not set up on the mail server yet), not that it is empty; show it as unknown.

  • send_limitsobject

    Per-mailbox sending overrides.

    • dailyinteger

      Messages per day for this mailbox. Null means no override, so your plan's limit applies. 0 means it may not send.

    • hourlyinteger

      Messages per hour for this mailbox. Null means no override, as with daily.

  • created_atstring
  • updated_atstring

Returned inside the standard envelope.

Errors

Every status, with what causes it and what to do, is on the error reference.