Mailbox
Get details of email mailboxes.
Select
The add-in will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the add-in.
- Id supports the '=,IN,>=,<=,>,<' operators.
- CreatedAt supports the '=,>=,<=,>,<' operators.
- UpdatedAt supports the '=,>=,<=,>,<' operators.
- UserId supports the '=' operator.
SELECT * FROM Mailbox WHERE Id = 1 SELECT * FROM Mailbox WHERE Id IN (1, 2) SELECT * FROM Mailbox WHERE Id >= 1 SELECT * FROM Mailbox WHERE Id <= 1 SELECT * FROM Mailbox WHERE Id > 1 SELECT * FROM Mailbox WHERE Id < 2 SELECT * FROM Mailbox WHERE CreatedAt <= '2022-02-25 01:02:02.0' SELECT * FROM Mailbox WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND CreatedAt <= '2022-02-25 01:02:02.0' SELECT * FROM Mailbox WHERE CreatedAt >= '2022-02-25 01:02:02.0' SELECT * FROM Mailbox WHERE CreatedAt = '2022-02-25 01:02:02.0' SELECT * FROM Mailbox WHERE CreatedAt < '2022-02-25 01:02:02.0' SELECT * FROM Mailbox WHERE CreatedAt > '2022-02-25 01:02:02.0' SELECT * FROM Mailbox WHERE UpdatedAt <= '2022-02-25 01:02:02.0' SELECT * FROM Mailbox WHERE UserId = 1
Columns
| Name | Type | Description |
| Id [KEY] | Integer | Id of mailbox. |
| AuthId | Integer | The Auth Id associated with the mailbox. |
| CreatedAt | Datetime | The date and time the mailbox was created. |
| Editable | Boolean | A boolean value to indicate if the user has the permission to edit mailbox fields. |
| String | The email address of the mailbox. | |
| EmailProvider | String | The mail service provider. |
| EmailSignature | String | The default signature in HTML to be appended to sent email messages. |
| EwsEndpoint | String | The url of the Exchange Web Service. |
| EwsSslVerifyMode | Integer | The SSL verify mode represented as an integer the EWS connection will used. |
| ExchangeVersion | String | The version of Exchange. |
| ImapHost | String | The address of the IMAP host used for syncing. |
| ImapPort | Integer | The port number the IMAP server is using. |
| ImapSsl | Boolean | A boolean value indicating whether or not the IMAP connection will use SSL. |
| MaxEmailsPerDay | Integer | The maximum number of in and out emails per day. |
| MaxMailingsPerDay | Integer | The maximum number of emails the application can send in a day from this mailbox. |
| MaxMailingsPerWeek | Integer | The maximum number of emails the application can send within a week from this mailbox. |
| OptOutMessage | String | The message displayed on the unsubscribe confirmation page seen after clicking the unsubscribe link in the email. |
| OptOutSignature | String | The message below the signature in HTML. |
| ProspectEmailExclusions | String | A list of email address patterns to be excluded from syncing. |
| ProviderId | Integer | The Id of the provider associated with this calendar. |
| ProviderType | String | Email provider type. |
| SendDisabled | Boolean | A boolean value indicating whether or not sending is disabled from this mailbox. |
| SendErroredAt | Datetime | The date and time the most recent send error occurred. |
| SendMaxRetries | Integer | The maximum number of times to auto-retry a delivery when it fails. |
| SendMethod | String | The method used for sending email. |
| SendPeriod | Integer | The amount of time in seconds that the number of sendThreshold emails can be sent. |
| SendPermanentErrorAt | Datetime | The date and time the most recent send error occurred. |
| SendRequiresSync | Boolean | A boolean value indicating whether or not the mailbox is required to be recently synced before sending. |
| SendSuccessAt | Datetime | The date and time the most recent successful email send occurred. |
| SendThreshold | Integer | The maximum number of email sends per the sendPeriod amount of time. |
| SmtpHost | String | The address of the SMTP host used for sending. |
| SmtpPort | Integer | The port number the SMTP server is using. |
| SmtpSsl | Boolean | A boolean value indicating whether or not the SMTP connection will use SSL. |
| SmtpUsername | String | The username for the SMTP account. |
| SyncActiveFrequency | Integer | The amount of time in seconds between syncing when the user is actively using the application. |
| SyncDisabled | Boolean | A boolean value indicating whether or not syncing is disabled from this mailbox. |
| SyncErroredAt | Datetime | The date and time the most recent sync error occurred. |
| SyncFinishedAt | Datetime | The date and time the most recent sync finished. |
| SyncMethod | String | The method used for syncing email. |
| SyncOutreachFolder | Boolean | A boolean value indicating whether or not the folder for syncing is named Outreach instead of Inbox. |
| SyncPassiveFrequency | Integer | The amount of time in seconds between syncing when the user is not actively using the application. |
| SyncSuccessAt | Datetime | The date and time the most recent successful email sync occurred. |
| UpdatedAt | Datetime | The date and time the mailbox was last updated. |
| CreatorId | Integer | Creator Id. |
| CreatorType | String | Creator type. |
| ownerId | Integer | Owner Id. |
| OwnerType | String | Owner type. |
| UserId | Integer | The Id of the user associated with this mailbox. |
| Username | String | The username of the email account. |
| Type | String | Type. |