Mailbox

A representation of an email mailbox, used within the application for sending and syncing emails.

authId
integer or null

The auth id associated with the mailbox.

createdAt
string or null <date-time>

The date and time the mailbox was created.

editable
boolean or null

A boolean value to indicate if the user has the permission to edit mailbox fields.

email
string or null <= 255 characters

The email address of the mailbox.

emailHash
string or null <= 255 characters

Hashed email address of the mailbox.

emailProvider
string or null <= 255 characters

The mail service provider. While not a required field, it is strongly recommended to use one of 'exchange_online', 'exchange_server', 'gmail', 'gmail_api', 'google_oauth2', 'intermedia', 'office365_oauth2', 'microsoft_hma_oauth2', 'office_365', 'rackspace'. If no value is provided, send and sync will make assumptions based on the ews, imap, and smtp values provided.

emailSignature
string or null <= 65535 characters

The default signature, in HTML, to be appended to sent email messages.

ewsEndpoint
string or null <= 255 characters

The url of the Exchange Web Service.

ewsSslVerifyMode
integer or null

The SSL verify mode, represented as an integer, the EWS connection will used. (verify none=0, verify peer=1, verify client once=4, verify fail if no peer cert=2)

exchangeVersion
string or null <= 255 characters

The version of Exchange. Must be one of 'Exchange2007', 'Exchange2007_SP1', 'Exchange2010', 'Exchange2010_SP1', 'Exchange2010_SP2', 'Exchange2013', 'Exchange2013_SP1'.

imapHost
string or null <= 255 characters

The address of the IMAP host, used for syncing (e.g. 'imap.gmail.com').

imapPort
integer or null

The port number the IMAP server is using (e.g. '993').

imapSsl
boolean or null

A boolean value whether the IMAP connection will use SSL.

maxEmailsPerDay
integer or null

The maximum number of in/out emails per day.

maxMailingsPerDay
integer or null

The maximum number of emails the application can send in a day from this mailbox. Recommended value is 500.

maxMailingsPerWeek
integer or null

The maximum number of emails the application can send within a week from this mailbox. Recommended value is 5000.

optOutMessage
string or null <= 512 characters

The message displayed on the unsubscribe confirmation page, seen after clicking the unsubscribe link in the email (e.g. "To unsubscribe, click the button below.").

optOutSignature
string or null <= 512 characters

The message below the signature, in HTML, when the sequence requires an unsubscribe link (e.g. "If you'd like me to stop sending you emails, please <a href='%unsubscribe_url%'>click here</a>").

password
string or null <= 65535 characters

The password of the mailbox. This attribute can be used to set the password, but is not available for read.

prospectEmailExclusions
string or null <= 65535 characters

A list (provided as a string, newline-delimited) of email address patterns to be excluded from syncing (e.g. "*@outreach.io daniel@example.com").

providerId
integer or null

The id of the provider associated with this calendar.

providerType
string or null <= 255 characters

Email provider type.

sendDisabled
boolean or null

A boolean value whether sending is disabled from this mailbox.

sendErroredAt
string or null <date-time>

The date and time the most recent send error occurred.

sendMaxRetries
integer or null

The maximum number of times to auto-retry a delivery when it fails.

sendMethod
string or null <= 255 characters

The method used for sending email. Must be either 'ews', 'sendgrid', or 'smtp'.

sendPeriod
integer or null

The amount of time in seconds that the number of sendThreshold emails can be sent. Recommended value is two deliveries per minute (sendPeriod is 60).

sendRequiresSync
boolean or null

A boolean value whether the mailbox is required to be recently synced before sending.

sendSuccessAt
string or null <date-time>

The date and time the most recent successful email send occurred.

sendThreshold
integer or null

The maximum number of email sends per the sendPeriod amount of time. Recommended value is two deliveries per minute (sendThreshold is 2).

sendgridApiKey
string or null <= 65535 characters

The api key of the SendGrid account used for sending.

sendgridWebhookUrl
string or null

The endpoint required within the SendGrid account settings to support bounce and spam-report tracking.

smtpHost
string or null <= 255 characters

The address of the SMTP host, used for sending (e.g. 'smtp.gmail.com').

smtpPassword
string or null <= 65535 characters

The password for the SMTP account. This value should be left blank unless a separate SMTP account is being used for sending (i.e. not the mailbox's main username/password).

smtpPort
integer or null

The port number the SMTP server is using (e.g. '587').

smtpSsl
boolean or null

A boolean value whether the SMTP connection will use SSL.

smtpUsername
string or null <= 255 characters

The username for the SMTP account. This value should be left blank unless a separate SMTP account is being used for sending (i.e. not the mailbox's main username/password).

syncActiveFrequency
integer or null

The amount of time in seconds between syncing when the user is actively using the application.

syncDisabled
boolean or null

A boolean value whether syncing is disabled from this mailbox.

syncErroredAt
string or null <date-time>

The date and time the most recent sync error occurred.

syncFinishedAt
string or null <date-time>

The date and time the most recent sync finished.

syncMethod
string or null <= 255 characters

The method used for syncing email. Must be either 'ews', 'gmail_api', or 'imap'.

syncOutreachFolder
boolean or null

A boolean value whether the folder for syncing is named 'Outreach' instead of 'Inbox'. Only available for Exchange version 'Exchange2007_SP1'.

syncPassiveFrequency
integer or null

The amount of time in seconds between syncing when the user is not actively using the application.

syncSuccessAt
string or null <date-time>

The date and time the most recent successful email sync occurred.

updatedAt
string or null <date-time>

The date and time the mailbox was last updated.

userId
integer or null

The id of the user associated with this mailbox.

username
string or null <= 255 characters

The username of the email account. While not a required field, a username is necessary for most email providers outside of OAuth. This value is normally the same as the email address.

validateSend
boolean or null

If this is set to true then the record will only save successfully if the mailbox is properly configured to send emails.

validateSync
boolean or null

If this is set to true then the record will only save successfully if the mailbox is properly configured to sync emails.

{
  • "authId": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "editable": true,
  • "email": "string",
  • "emailHash": "string",
  • "emailProvider": "string",
  • "emailSignature": "string",
  • "ewsEndpoint": "string",
  • "ewsSslVerifyMode": 0,
  • "exchangeVersion": "string",
  • "imapHost": "string",
  • "imapPort": 0,
  • "imapSsl": true,
  • "maxEmailsPerDay": 0,
  • "maxMailingsPerDay": 0,
  • "maxMailingsPerWeek": 0,
  • "optOutMessage": "string",
  • "optOutSignature": "string",
  • "password": "string",
  • "prospectEmailExclusions": "string",
  • "providerId": 0,
  • "providerType": "string",
  • "sendDisabled": true,
  • "sendErroredAt": "2019-08-24T14:15:22Z",
  • "sendMaxRetries": 0,
  • "sendMethod": "string",
  • "sendPeriod": 0,
  • "sendRequiresSync": true,
  • "sendSuccessAt": "2019-08-24T14:15:22Z",
  • "sendThreshold": 0,
  • "sendgridApiKey": "string",
  • "sendgridWebhookUrl": "string",
  • "smtpHost": "string",
  • "smtpPassword": "string",
  • "smtpPort": 0,
  • "smtpSsl": true,
  • "smtpUsername": "string",
  • "syncActiveFrequency": 0,
  • "syncDisabled": true,
  • "syncErroredAt": "2019-08-24T14:15:22Z",
  • "syncFinishedAt": "2019-08-24T14:15:22Z",
  • "syncMethod": "string",
  • "syncOutreachFolder": true,
  • "syncPassiveFrequency": 0,
  • "syncSuccessAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "userId": 0,
  • "username": "string",
  • "validateSend": true,
  • "validateSync": true
}

Mailbox Relationships

object

The creator of the mailbox. Relationship creator cannot be used as a filter.

object

The email aliases associated with this mailbox Relationship mailAliases cannot be used as a filter.

object

The mailings sent via this mailbox. Relationship mailings cannot be used as a filter.

object

The most recent updater of the mailbox. Relationship updater cannot be used as a filter.

object

The user owning this mailbox. You can use only the attribute id to filter mailboxes by user (e.g. filter[user][id]=X).

{}

Mailbox Resource Metadata

METADATA NAME DESCRIPTION QUERY PARAM
canWrite A boolean value indicating whether the current API user has write access to this resource. provideAuthorizationMeta
canDelete A boolean value indicating whether the current API user has delete access to this resource. provideAuthorizationMeta

⌵ Mailbox Actions

Get a Collection of Mailboxes

SecuritybearerAuth
Responses
200

OK

422

JSON error message

get/mailboxes
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": [
    ]
}
Create a New Mailbox
SecuritybearerAuth 
Request 
Request Body schema: application/vnd.api+json
required
object
 
Responses 
201
Created


422
JSON error message


post/mailboxes
Request samples 
application/vnd.api+json
{
  • "data": {
    }
}
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}
Delete an Existing Mailbox by ID
SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Responses 
204
Deleted


422
JSON error message


delete/mailboxes/{id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "errors": [
    ]
}
Get a Mailbox by ID
SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Responses 
200
OK


404
Not Found


get/mailboxes/{id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}
Update a Mailbox
SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Request Body schema: application/vnd.api+json
required
object
 
Responses 
200
OK


422
JSON error message


patch/mailboxes/{id}
Request samples 
application/vnd.api+json
{
  • "data": {
    }
}
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}
Link Ews Master Account
Member Action


Link mailbox with EWS master account


SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Responses 
200
OK


422
JSON error message


post/mailboxes/{id}/actions/linkEwsMasterAccount
Request samples 
Response samples 
application/vnd.api+json
{ }
Test Send
Member Action


Test if sending emails works from this mailbox.


SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Responses 
200
OK


422
JSON error message


post/mailboxes/{id}/actions/testSend
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}
Test Sync
Member Action


Test if syncing emails works from this mailbox.


SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Responses 
200
OK


422
JSON error message


post/mailboxes/{id}/actions/testSync
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}
Unlink Ews Master Account
Member Action


Unlink EWS master account from mailbox


SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Responses 
200
OK


422
JSON error message


post/mailboxes/{id}/actions/unlinkEwsMasterAccount
Request samples 
Response samples 
application/vnd.api+json
{ }