Skip to main content

List a mailer's Send As aliases

GET 

/v1/oauth/:mailer_id/aliases

Returns the extra addresses a Gmail mailer can send from, read from the mailbox's Gmail "Send mail as" settings. The mailer's own address is the top-level email and is always sendable; aliases lists only the other addresses. Use an alias with sendable: true as from.email on POST /v1/email/send with this mailer_id.

Rules:

  • Only Google OAuth mailers connected for both sending and reading (config_type: smtp_imap). Other mailers, including Microsoft, return 422.
  • sendable is true when Gmail shows the alias as verified (status: accepted); pending aliases are rejected on send until the owner verifies them in Gmail.
  • The list is stored on the mailer, re-read when the mailer connects or reconnects, and re-read from Gmail when it is older than 24 hours. Pass refresh=true to read it now, for example right after adding or verifying an alias. syncedAt is when it was last read.

Request​

Path Parameters

    mailer_id stringrequired

    Mailer ID

Query Parameters

    refresh boolean

    Read Gmail now instead of returning the stored list

Responses​

Send As aliases

Schema

    aliases

    object[]

  • Array [

  • default boolean
    displayName string
    email string
    sendable boolean
    status string
  • ]

  • email string
    mailerId string
    success boolean
    syncedAt string
Loading...