Mailboxes
Columns
Name | Type | ReadOnly | Description |
Id [KEY] | Bigint | False | Unique ID of the email mailbox. |
AccessType | String | False | Denotes if the mailbox is to be used for incoming, outgoing or both.Takes the values |
Active | Boolean | True | True if the mailbox is verified and activated. |
Authentication | String | False | Denotes the type of authentication that should be used authenticate the mailbox. It can be plain/login/CRAM-MD5. |
CustomMailbox | String | False | Mandatory if the mailbox is of the type custom mailbox. This field contains the incoming and/or outgoing configurations of the mailbox based on what access type is set. |
DefaultReplyEmail | Boolean | False | True if the email associated to a product, is the primary email. |
DeleteFromServer | Boolean | False | If set to true, Freshdesk is given the permission to delete the email from the mailbox after the ticket is created. |
FailureCode | String | True | Denotes the failure message if any in the custom incoming mailbox. |
ForwardEmail | String | True | Denotes the email address to which your support emails gets forwarded. |
FreshdeskMailbox | String | True | If the mailbox is of the type Freshdesk mailbox this field contains the forward email to which your support emails gets forwarded. |
GroupId | Bigint | False | Denotes the group ID to which the email is associated. |
Incoming | String | False | Contains the incoming configuration of the custom mailbox. |
MailServer | String | False | Denotes the server used by incoming and/or outgoing configurations of the mailbox. |
MailboxType | String | False | Denotes if the mailbox uses a Freshdesk mailbox or a custom mailbox setup by the customer. It takes the values |
Name | String | False | Name of the email mailbox. |
Outgoing | String | True | Contains the outgoing configuration of the custom mailbox. |
Password | String | False | Denotes the password that will be used to authenticate the custom mailbox. |
Port | Int | False | Denotes the port used by incoming and/or outgoing configurations of the mailbox. |
ProductId | Int | False | Denotes the product ID to which the email is associated. |
SupportEmail | String | False | Denotes your support email address. |
UseSSL | Boolean | False | Denotes if the incoming and/or outgoing configuration should use ssl while authenticating the mailbox. |
Username | String | False | username. |
CreatedAt | Datetime | True | Mailbox creation timestamp. |
UpdatedAt | Datetime | True | Mailbox updated timestamp. |
Last updated