E-mail senders

Endpoints

• GETList e-mail senders/v1/email_senders
• GETRetrieve an e-mail sender/v1/email_senders/{id}
• POSTCheck an e-mail sender's DNS now/v1/email_senders/{id}/check
• GETList the addresses Parasend sends from/v1/email_senders/egress_ips

The EmailSender object

• idstringrequired

  The sender's ID, es_ followed by 26 characters.

• objectstringrequired

  Always email_sender.

• modestringrequired
  One of parasend_domain smtp
• from_addressstring · emailrequired
• domainstringrequired
• mail_from_domainstringrequired
• statestringrequired
  One of pending_dns verifying active degraded failed removed
• reasonstring · nullablerequired

  Why it waits, is degraded or failed, as a code; null when it is active. Setting up: ownership_not_found, lookup_failed, dkim_pending, mail_from_pending, dmarc_missing, retrying. Not possible: claimed_elsewhere (another organisation has the domain), identity_elsewhere (Parasend's e-mail service has the domain from elsewhere: contact Parasend), senders_off. Failed: dkim_failed, mail_from_failed, verification_timeout (records not seen within 72 hours), dkim_not_verified, mail_from_not_verified, paused_by_ses, identity_missing, identity_not_verified, tenant_not_ready. A sender that sends through your own mail server (mode smtp) also has smtp_not_configured, awaiting_test, awaiting_confirmation and smtp_secrets_off while it is set up, and when degraded the server's failure: smtp_auth_failed, smtp_app_password_required, smtp_tls_failed, smtp_rejected, smtp_oauth_failed, smtp_host_not_public, smtp_secret_missing, or, for a server that stayed down, smtp_unreachable, smtp_busy, smtp_host_unresolvable (checked again every 15 minutes).

• recordsarray of objectrequired

  Ownership, DKIM ×3 (once known), the MAIL FROM's MX and SPF, DMARC — expected and seen.

  9 fields of records

  • records[].recordstringrequired

    Which record this is. spf is the domain's own SPF record, for a sender that sends through your own mail server.

    One of ownership dkim mail_from_mx mail_from_spf spf dmarc
  • records[].typestringrequired
    One of TXT CNAME MX
  • records[].namestringrequired

    The DNS name to publish at.

  • records[].valuestringrequired

    What it should hold (for dmarc a suggestion: any DMARC policy counts).

  • records[].seenarray of stringrequired

    What the last check found there.

  • records[].okbooleanrequired
  • records[].viastring

    Ownership proved by a parent domain this organisation verified.

    One of parent_domain
  • records[].advisoryboolean

    Advice for the chosen mail service (an SMTP sender's spf and dmarc rows): shown to help, never required.

  • records[].guidestring

    How to word an SMTP sender's spf or dkim row: spf_add (value is the entry to add to the domain's one SPF record), spf_provider (value empty: the mail service has it), dkim_google or dkim_microsoft (value empty: the mail service makes the key).

    One of spf_add spf_provider dkim_google dkim_microsoft
• dkim_pendingbooleanrequired

  The DKIM records are not known yet (they come once ownership is seen).

• used_byobjectrequired
  1 field of used_by

  • used_by.brand_profilesintegerrequired

    Profiles in use whose current version names it (a count).

    at least 0
• verified_atstring · date-time · nullablerequired

  When ownership was first seen: from then the domain is this organisation's sender.

• active_sincestring · date-time · nullablerequired
• degraded_sincestring · date-time · nullablerequired
• failed_atstring · date-time · nullablerequired
• last_checked_atstring · date-time · nullablerequired
• created_atstring · date-timerequired
• removed_atstring · date-time · nullablerequired
• smtpobject · nullable

  Mode smtp only: the mail server Parasend sends through; null until it is saved. Never includes the secret.

• last_testobject · nullable

  Mode smtp only: the last test e-mail and how the server answered it.

• test_sent_atstring · date-time · nullable

  Mode smtp only: when the test e-mail with the confirmation link went out.

• confirmed_atstring · date-time · nullable

  Mode smtp only: when a person confirmed the sender from the test e-mail's link.

• on_failurestring

  While the sender cannot send, notifications go from Parasend's address under the brand's name (fallback, the default), or wait for it, a day at most (hold).

  One of fallback hold
• heldobject · nullable

  The notifications waiting for this sender while it cannot send (on_failure hold); null when none is waiting.

  3 fields of held

  • held.countintegerrequired
    at least 1
  • held.sincestring · date-time · nullablerequired

    When the oldest began to wait.

  • held.untilstring · date-time · nullablerequired

    When the oldest goes from Parasend's address at the latest (since + 24 h).