Skip to content

User Guide: Team Email

Jump to bottom
Claude Agent edited this page Nov 10, 2026 · 5 revisions

Team Email

Teams on Personal plans and above (Personal, Professional, Business, Enterprise and Reseller) can provision a dedicated workspace mailbox with IMAP/SMTP access. This gives your team a {tenantId}@users.osaas.io email address that can be used with any standard email client.

Prerequisites

  • An account on Personal plans and above (Personal, Professional, Business, Enterprise and Reseller)
  • Tenant admin role (to manage the mailbox)

Creating Your Team Mailbox

Step 1: Navigate to Team Settings

From the dashboard, click on your team name in the top navigation, then select Team Settings.

Step 2: Go to the Mail Tab

In the left sidebar of Workspace Settings, click on Mail.

Step 3: Create Mailbox

On the Mail page, you'll see a form to create your workspace mailbox.

  1. Enter a password (minimum 12 characters)
  2. Confirm the password
  3. Click Create Mailbox

The mailbox will be created with the email address {tenantId}@users.osaas.io, where {tenantId} is your unique tenant identifier.

Step 4: Configure Your Email Client

Once created, you'll see the connection details for SMTP and IMAP:

SMTP (Outgoing Mail)

  • Server: mail.osaas.io
  • Port: 587
  • Encryption: STARTTLS

IMAP (Incoming Mail)

  • Server: mail.osaas.io
  • Port: 993
  • Encryption: SSL/TLS

Use your team's email address ({tenantId}@users.osaas.io) and the password you set to configure your email client (Thunderbird, Apple Mail, Outlook, etc.).

Managing Your Mailbox

Changing the Password

You can change your mailbox password at any time:

  1. Go to Workspace Settings > Mail
  2. Click Change Password
  3. Enter your new password (minimum 12 characters)
  4. Confirm the password
  5. Click Update Password

Note: Password changes are rate-limited to 5 changes per hour.

Deleting Your Mailbox

To remove your workspace mailbox:

  1. Go to Workspace Settings > Mail
  2. Click Delete Mailbox
  3. Confirm the deletion

Warning: This action is permanent and cannot be undone. All emails and data will be lost.

Using the API

The OSC CLI has no mail command. You can do the same things in Workspace Settings > Mail (described above) or through an AI agent (described below). If you want to script it, deploy-manager has four calls. Each one needs a personal access token, which you can create by following User-Guide:-Access-Tokens. The examples assume the token is stored in OSC_ACCESS_TOKEN.

Check mailbox status

curl -X GET https://deploy.svc.prod.osaas.io/mymail \
  -H "x-pat-jwt: Bearer $OSC_ACCESS_TOKEN"

Create a mailbox

curl -X POST https://deploy.svc.prod.osaas.io/mymail \
  -H "x-pat-jwt: Bearer $OSC_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"password": "your-secure-password"}'

The password must be at least 12 characters.

Change password

curl -X POST https://deploy.svc.prod.osaas.io/mymail/password \
  -H "x-pat-jwt: Bearer $OSC_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"password": "new-secure-password"}'

Delete mailbox

curl -X DELETE https://deploy.svc.prod.osaas.io/mymail \
  -H "x-pat-jwt: Bearer $OSC_ACCESS_TOKEN"

Using with AI Agents

If you have OSC connected to AI agents via MCP, you can ask your AI assistant to manage your mailbox using natural language:

  • "Check if I have a workspace mailbox"
  • "Create a workspace mailbox with a secure password"
  • "Change my mailbox password to something more secure"
  • "Delete my workspace mailbox"
  • "Show me my SMTP and IMAP connection details"

The AI agent will use the following MCP tools to interact with the mail provisioning API on your behalf:

  • get-mail-status - Check mailbox status and get connection details
  • create-mailbox - Create a new workspace mailbox (requires paid plan)
  • change-mail-password - Update mailbox password
  • delete-mailbox - Remove workspace mailbox

Note: Creating a mailbox requires Personal plans and above (Personal, Professional, Business, Enterprise and Reseller). If you're on the free tier, the AI agent will suggest upgrading your plan.

Troubleshooting

Cannot create mailbox

  • Verify you're on Personal plans and above (Personal, Professional, Business, Enterprise and Reseller)
  • Ensure you have tenant admin permissions
  • Check that you don't already have a mailbox (only one per team)

Email client connection issues

  • Verify you're using the correct server addresses and ports
  • SMTP uses STARTTLS on port 587 and IMAP uses SSL/TLS on port 993, so check that your email client has the matching encryption selected for each
  • Double-check your password is correct

Password change rate limit

  • You can change your password up to 5 times per hour
  • If you hit the limit, wait an hour before trying again

Need Help?

If you need assistance with team email provisioning, contact support at contact@support.osaas.io

Clone this wiki locally