# Mailboxes

Mailboxes allow you to organize the conversations you have with your customers in your help center. You can create a mailbox for each department like Billing, IT, General Support, etc. Or you can even create a mailbox for each business or product you manage. How you use them and how you organize the conversations is up to you.

Each mailbox consists of a single email address that's used to send and receive customer inquiries.

Although mailboxes consist of a single email address, they also handle incoming and outgoing conversations of other conversation channels like chat.

All conversations from all channels are conveniently managed from a single interface.

# The mailbox object

  • id integer

    The system-generated ID of the mailbox.

  • account_id string

    The account id where the mailbox belongs to.

  • name string

    The name of the mailbox.

  • email string

    The email associated with the mailbox. This is the email address used to send all outgoing email replies of conversations in the mailbox.

  • from string

    The from name used on outgoing email replies of conversations in the mailbox. For example, when an agent replies to a conversation, the customer receiving the reply will see whatever value this attribute have. Any arbitrary text will work. Possible placeholders are :mailbox.name for the mailbox name, and :user.name for the user name sending the reply.

  • internal_email_address string

    The internal email address for the mailbox. This is the email address where all incoming email addresses should be forwarded to.

  • connection object

    The settings for the email connections. This field will only be included in the response when the user has the appropriate permissions.

    Show child attributes
    • connection.inbound object when type=FWD

      The mailbox's forward inbound connection. This is the default connection when no inbound connection has been configured.

      Show child attributes
      • connection.inbound.type enum: FWD

        The type of the inbound connection.

      • connection.inbound.forward_to string when type=FWD

        Read only config field. The field provides the address you should forward emails to.

    • connection.inbound object when type=IMAP, POP3

      The mailbox's IMAP or POP3 inbound connection settings.

      Show child attributes
      • connection.inbound.type enum: IMAP, POP3

        The type of the inbound connection.

      • connection.inbound.host string

        The IMAP or POP3 server host. For example, imap.gmail.com when using Gmail Imap connection.

      • connection.inbound.port integer

        The IMAP or POP3 port.

      • connection.inbound.username string

        The IMAP or POP3 username, used for authentication. This username typically is the same as the mailbox email address.

      • connection.inbound.password string

        The IMAP or POP3 password, used for authentication. This password typically is the same as the one you use to log in with your email client.

      • connection.inbound.encryption enum: TLS, SSL, NONE

        The encryption type for the connection between Full Help and the IMAP or POP3 server.

      • connection.inbound.validate_certificate boolean

        Whether to validate the SSL certificate provided by the IMAP or POP3 server.

  • created_at string

    The timestamp when the mailbox was created.

  • updated_at string

    The timestamp when the mailbox was last updated.

# The mailbox object

{
  "id": 1,
  "account_id": 1,
  "name": "Full Help Support",
  "email": "support@fullhelp.com",
  "from": ":user.name from Full Help",
  "internal_email_address": "1.1@fullhelp.com",
  "connection": {
    "inbound": {
      "type": "IMAP",
      "host": "imap.example.com",
      "username": "username",
      "password": "secret",
      "encryption": "SSL",
      "validate_certificate": true
    }
  }
}

# Create a mailbox

  • name string

    The name of the mailbox

  • email string

    The email associated with the mailbox. This is the email address used to send all outgoing email replies of conversations in the mailbox.

  • from string

    The from name used on outgoing email replies of conversations in the mailbox.

  • connection object optinal

    The connection configurations.

    Show child attributes
    • connection.inbound object

      Forward inbound connection.

      Show child attributes
      • connection.inbound.type string: FWD

        The inbound forward connection.

    • connection.inbound object

      IMAP or POP3 inbound connection settings.

      Show child attributes
      • connection.inbound.type enum: IMAP, POP3

        The type of the inbound connection.

      • connection.inbound.host string

        The IMAP or POP3 server host. For example, imap.gmail.com when using Gmail Imap connection.

      • connection.inbound.port integer

        The IMAP or POP3 port.

      • connection.inbound.username string

        The IMAP or POP3 username, used for authentication. This username typically is the same as the mailbox email address.

      • connection.inbound.password string

        The IMAP or POP3 password, used for authentication. This password typically is the same as the one you use to log in with your email client.

      • connection.inbound.encryption enum: TLS, SSL, NONE

        The encryption type for the connection between Full Help and the IMAP or POP3 server.

      • connection.inbound.validate_certificate boolean

        Whether to validate the SSL certificate provided by the IMAP or POP3 server.

# Sample request

curl https://www.yourdomain.com/api/v1/accounts/1/mailboxes \
  --request POST \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <access-token>" \
  -d name="Full Help Support" \
  -d email="support@fullhelp.com" \
  -d from=":user.name"

# Sample successful response

{
  "data": {
    "id": 1,
    "account_id": 1,
    "name": "Full Help Support",
    "email": "support@fullhelp.com",
    "from": ":user.name",
    "internal_email_address": "1.1@fullhelp.com",
    "connection": {
      "inbound": {
        "type": "FWD",
        "forward_to": "1.1@fullhelp.com"
      }
    }
  }
}

# Retrieve a mailbox

# Sample request

curl https://www.yourdomain.com/api/v1/accounts/1/mailboxes/1 \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <access-token>" \
  -G

# Sample successful response

{
  "data": {
    "id": 1,
    "account_id": 1,
    "name": "Full Help Support",
    "email": "support@fullhelp.com",
    "from": ":user.name",
    "internal_email_address": "1.1@fullhelp.com",
    "connection": {
      "inbound": {
        "type": "FWD",
        "forward_to": "1.1@fullhelp.com"
      }
    }
  }
}

# Update a mailbox

  • name string

    The name of the mailbox

  • email string

    The email associated with the mailbox. This is the email address used to send all outgoing email replies of conversations in the mailbox.

  • from string

    The from name used on outgoing email replies of conversations in the mailbox.

  • connection object optinal

    The connection configurations.

    Show child attributes
    • connection.inbound object

      Forward inbound connection.

      Show child attributes
      • connection.inbound.type string: FWD

        The inbound forward connection.

    • connection.inbound object

      IMAP or POP3 inbound connection settings.

      Show child attributes
      • connection.inbound.type enum: IMAP, POP3

        The type of the inbound connection.

      • connection.inbound.host string

        The IMAP or POP3 server host. For example, imap.gmail.com when using Gmail Imap connection.

      • connection.inbound.port integer

        The IMAP or POP3 port.

      • connection.inbound.username string

        The IMAP or POP3 username, used for authentication. This username typically is the same as the mailbox email address.

      • connection.inbound.password string

        The IMAP or POP3 password, used for authentication. This password typically is the same as the one you use to log in with your email client.

      • connection.inbound.encryption enum: TLS, SSL, NONE

        The encryption type for the connection between Full Help and the IMAP or POP3 server.

      • connection.inbound.validate_certificate boolean

        Whether to validate the SSL certificate provided by the IMAP or POP3 server.

# Sample request

curl https://www.yourdomain.com/api/v1/accounts/1/mailboxes/1 \
  --request PUT \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <access-token>" \
  -d name="Full Help Support" \
  -d email="support@fullhelp.com" \
  -d from=":user.name from Full Help"

# Sample successful response

{
  "data": {
    "id": 1,
    "account_id": 1,
    "name": "Full Help Support",
    "email": "support@fullhelp.com",
    "from": ":user.name from Full Help",
    "internal_email_address": "1.1@fullhelp.com",
    "connection": {
      "inbound": {
        "type": "IMAP",
        "host": "imap.example.com",
        "username": "username",
        "password": "secret",
        "encryption": "SSL",
        "validate_certificate": true
      }
    }
  }
}

# Delete a mailbox

# Sample request

curl https://www.yourdomain.com/api/v1/accounts/1/mailboxes/1 \
  --request DELETE \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <access-token>" 

If successful, the above request will return an empty response with 204 HTTP status code.

# List all mailboxes

# Sample request

curl https://www.yourdomain.com/api/v1/accounts/1/mailboxes \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <access-token>" \
  -G

# Sample successful response

{
  "data": [
    {
      "id": 1,
      "account_id": 1,
      "name": "Full Help Support",
      "email": "support@fullhelp.com",
      "from": ":user.name from Full Help",
      "internal_email_address": "1.1@fullhelp.com",
      "connection": {
        "inbound": {
          "type": "IMAP",
          "host": "imap.example.com",
          "username": "username",
          "password": "secret",
          "encryption": "SSL",
          "validate_certificate": true
        }
      }
    },
    {...}
  ]
}