Skip to main content

Documentation Index

Fetch the complete documentation index at: https://hybridbox.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

How do I connect to a mailbox?

Use the mailbox domain as the mail host:
mail.{domain}
For example, if the mailbox is billing@example.com, use:
mail.example.com
Use either the full mailbox email address or one of its aliases as the username. Use the mailbox password or a master password as the password.
ProtocolDefault portSecure portNotes
SMTP587465Use SMTP to send mail. Port 587 is commonly used for authenticated submission.
IMAP143993Use IMAP to read and sync mailbox messages.
When configuring a mail client, prefer the secure ports when possible:
  • SMTP over TLS/SSL: 465
  • SMTP with STARTTLS: 587
  • IMAPS: 993

What is a mailbox alias?

A mailbox alias is a secondary email address on an existing mailbox. Aliases are free of charge and let you send and receive from additional email addresses without paying for another mailbox. Email sent to an alias is delivered into the mailbox. You can also send using the alias by logging in to the mailbox with either the full mailbox email address or the alias as the username. For example, billing@example.com could have aliases such as:
accounts@example.com
invoices@example.com
Mail sent to any of those aliases is delivered to the same mailbox.

What are master passwords?

A master password is an alternate password that can be used to log in to SMTP mailboxes within its scope. Master passwords can be created at the domain, workspace, or account level and are valid for any SMTP mailbox inside that scope. Master passwords work for both SMTP and IMAP. Use them when you want to log in to mailboxes without repeatedly retrieving each mailbox’s own password.

What happens when a mailbox is paused?

A paused mailbox cannot be used to log in or send email, but incoming email is still delivered to it. Pausing is useful when you want to stop mailbox access before taking a backup, moving messages, or eventually deleting the mailbox. After you no longer need the mailbox, you can delete it to stop incurring charges. Before deleting a mailbox, consider one of these options if you still need to receive future email for the address:
  • Add the address as an alias on another mailbox in the same domain.
  • Configure a catch-all mailbox for the domain.

What are backup, restore, and move/copy?

Backup, restore, and move/copy are mailbox data jobs.
FeatureWhat it does
BackupCreates an export of one or more mailboxes in maildir, mbox, or eml format.
RestoreTakes a backup and repopulates messages inside a mailbox.
MoveMoves messages from one or more mailboxes to a destination mailbox.
CopyCopies messages from one or more mailboxes to a destination mailbox while keeping the originals.
Backups are useful when you want to keep mailbox contents but delete a mailbox after you are done using it.

What happens when I delete a mailbox?

Deleting a mailbox removes the mailbox, its aliases, and its SMTP credentials. If you need to keep messages, create a backup before deleting the mailbox. If the address should continue receiving email, add the address as an alias on another mailbox or configure a catch-all mailbox before deletion.

What roles are required?

Hybridbox roles can be granted on different scopes, such as account, workspace, or domain. The scope controls which mailboxes the role applies to.
ActionTypical role
View mailboxesViewer, Editor, Domain Manager, or Manager on a scope that includes the mailbox
Create mailboxesDomain Manager or Manager on a scope that includes the domain, or Account owner
Pause or update mailboxesEditor, Domain Manager, Manager, or Account owner on a scope that includes the mailbox
Delete mailboxesDomain Manager, Manager, or Account owner on a scope that includes the mailbox
View mailbox credentialsEditor, Domain Manager, Manager, or Account owner on a scope that includes the mailbox
Manage aliasesEditor, Domain Manager, Manager, or Account owner on a scope that includes the mailbox
Run backup, restore, move, or copy jobsEditor, Domain Manager, Manager, or Account owner on a scope that includes the selected mailboxes
If an action is hidden, the selected account, workspace, domain, mailbox, or role may not allow that action.