Mail Alias

Alternative email name for a mailbox.

canSend
boolean

Can this alias send email.

createdAt
string <date-time>

The date the alias was created.

email
string <= 255 characters

The email alias.

emailHash
string <= 255 characters

Hashed email address of the alias.

updatedAt
string <date-time>

The date the alias was last updated.

{
  • "canSend": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "email": "string",
  • "emailHash": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Mail Alias Relationships

data (object) or links (object) (mailbox)

The parent mailbox for this alias. You can use only the attribute id to filter mailAliases by mailbox (e.g. filter[mailbox][id]=X).

{
  • "mailbox": {
    }
}

⌵ Mail Alias Actions

Get a Collection of Mail Aliases

SecuritybearerAuth
Responses
200

OK

422

JSON error message

get/mailAliases
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": [
    ]
}
Get a Mail Alias by ID
SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Responses 
200
OK


404
Not Found


get/mailAliases/{id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}