# Rackspace Email Admin

> Manage Rackspace Email mailboxes from a workflow: create, update, rename, block, delete and restore them, reset passwords, set forwarding and auto-replies, manage spam filters and block lists, and onboard or offboard people in one step.

App · Email · 24 actions · 1 trigger. Web page: https://docs.lodol.com/docs/integrations/rackspace-email-admin

## Triggers

Start a workflow when something happens in Rackspace Email Admin. See [how triggers work](https://docs.lodol.com/docs/concepts/triggers.md).

### New Rackspace mailbox

Triggers when a mailbox is added to a Rackspace Email domain. Checks the domain's mailbox list on a schedule; renamed mailboxes do not trigger it.

**Filters**: Narrow which events start a run.

- `domain` (required)

**Event fields**: What a run starts with. Later steps read each field with an @ reference.

- `name` (text)
- `email_address` (text)
- `domain` (text)
- `display_name` (text)
- `enabled` (true/false)
- `size_mb` (number)
- `created_date` (text)
- `created_at` (text)

## Actions

### Add to a mailbox's blocked or safe senders

Add addresses, domains or IP addresses to one of a mailbox's block or safe lists, all in one change. Rackspace refuses to block the mailbox's own domain.

**Inputs**

- Domain (`domain`, text, required): The domain the mailbox is on, such as example.com.
- Mailbox (`mailbox`, text, required): The mailbox, as the part of its address before the @ (jane.doe) or the whole address. It must be on the domain above.
- List (`list_type`, text, required): Which list: blocked or safe senders (addresses and domains), or blocked or safe IP addresses. One of: `blocklist` (Blocked senders), `safelist` (Safe senders), `ipblocklist` (Blocked IP addresses), `ipsafelist` (Safe IP addresses).
- Entries (`entries`, list, required): Addresses or domains for the sender lists, such as name@example.com or @example.com, with % as a wildcard in the domain but not the ending (@%.example.com). IP addresses for the IP lists, with % for the last parts (216.12.34.%).

**Outputs**

- `added` (list)
- `addresses` (list)
- `count` (number)
- `domain` (text)
- `emailAddress` (text)
- `listName` (text)
- `listType` (text)
- `name` (text)
- `removed` (list)

**Example output**

```json
{
  "added": [
    "offers@spam.example"
  ],
  "addresses": [
    "offers@spam.example",
    "@%.junk.example"
  ],
  "count": 2,
  "domain": "example.com",
  "emailAddress": "jane.doe@example.com",
  "listName": "Blocked senders",
  "listType": "blocklist",
  "name": "jane.doe",
  "removed": []
}
```

### Block a mailbox

Stop anyone signing in to a mailbox. Blocking does not cancel it: the mailbox keeps receiving mail and Rackspace keeps billing for it. Delete it to stop the billing.

**Inputs**

- Domain (`domain`, text, required): The domain the mailbox is on, such as example.com.
- Mailbox (`mailbox`, text, required): The mailbox, as the part of its address before the @ (jane.doe) or the whole address. It must be on the domain above.

**Outputs**

- `domain` (text)
- `emailAddress` (text)
- `enabled` (true/false)
- `name` (text)
- `stillBilled` (true/false)

**Example output**

```json
{
  "domain": "example.com",
  "emailAddress": "jane.doe@example.com",
  "enabled": false,
  "name": "jane.doe",
  "stillBilled": true
}
```

### Create a mailbox

Add a mailbox to a domain. The domain needs a free mailbox - use 'Onboard a new mailbox' to have that checked first, and to have a password made for you. Rackspace says a new mailbox can take up to 15 minutes before it can be signed in to.

**Inputs**

- Domain (`domain`, text, required): The domain the mailbox is on, such as example.com.
- Mailbox name (`mailbox_name`, text, required): The part of the new address before the @, such as jane.doe for jane.doe@example.com.
- Password (`password`, text, required): At least 8 characters, using at least three of: upper-case letters, lower-case letters, numbers and symbols. It is never included in the step's output.
- Size (MB) (`size_mb`, number): How big the mailbox is, in megabytes. Leave blank for the domain's standard mailbox size. At least 1.
- Display name (`display_name`, text): The name people see on mail from this mailbox.
- First name (`first_name`, text): The owner's first name, for the company directory.
- Last name (`last_name`, text): The owner's last name, for the company directory.
- Job title (`title`, text): The owner's job title, for the company directory.
- Department (`department`, text): The owner's department, such as Marketing.
- Custom ID (`custom_id`, text): An ID from another system, such as an employee number from your HR software. 'Find a mailbox by custom ID' can look the mailbox up by it later.
- Business phone (`business_phone`, text): The owner's work phone number, for the company directory.
- Mobile phone (`mobile_phone`, text): The owner's mobile number, for the company directory.
- Show in company directory (`visible_in_directory`, true/false): Whether the mailbox is listed in the company directory that webmail users see.

**Outputs**

- `contactInfo` (object)
- `createdAt` (text)
- `createdDate` (text)
- `currentUsage` (number)
- `displayName` (text)
- `domain` (text)
- `emailAddress` (text)
- `emailForwardingAddressList` (list)
- `enableVacationMessage` (true/false)
- `enabled` (true/false)
- `lastLogin` (text)
- `lastLoginAt` (text)
- `name` (text)
- `saveForwardedEmail` (true/false)
- `size` (number)
- `vacationMessage` (text)
- `visibleInExchangeGAL` (true/false)
- `visibleInRackspaceEmailCompanyDirectory` (true/false)

**Example output**

```json
{
  "contactInfo": {
    "customID": "E-1024",
    "firstName": "Jane",
    "lastName": "Doe",
    "organizationUnit": "Sales",
    "title": "Account Manager"
  },
  "createdAt": "2026-03-02T14:15:00Z",
  "createdDate": "3/2/2026 9:15:00 AM",
  "currentUsage": 1024,
  "displayName": "Jane Doe",
  "domain": "example.com",
  "emailAddress": "jane.doe@example.com",
  "emailForwardingAddressList": [],
  "enableVacationMessage": false,
  "enabled": true,
  "lastLogin": "9/21/2026 4:02:11 PM",
  "lastLoginAt": "2026-09-21T20:02:11Z",
  "name": "jane.doe",
  "saveForwardedEmail": true,
  "size": 25600,
  "vacationMessage": "",
  "visibleInExchangeGAL": false,
  "visibleInRackspaceEmailCompanyDirectory": true
}
```

### Delete a mailbox

Delete a mailbox and its mail. This is what stops Rackspace billing for it. For 14 days afterwards it can be brought back with its mail using 'Restore a mailbox'; after that it is gone for good.

**Inputs**

- Domain (`domain`, text, required): The domain the mailbox is on, such as example.com.
- Mailbox (`mailbox`, text, required): The mailbox, as the part of its address before the @ (jane.doe) or the whole address. It must be on the domain above.

**Outputs**

- `deleted` (true/false)
- `domain` (text)
- `emailAddress` (text)
- `name` (text)
- `restorableForDays` (number)

**Example output**

```json
{
  "deleted": true,
  "domain": "example.com",
  "emailAddress": "jane.doe@example.com",
  "name": "jane.doe",
  "restorableForDays": 14
}
```

### Find a mailbox by custom ID

Find the mailbox whose custom ID is exactly this value - such as an employee number from your HR software - so a workflow started by another system can act on the right mailbox. 'found' is false when no mailbox has it.

**Inputs**

- Domain (`domain`, text, required): The domain the mailbox is on, such as example.com.
- Custom ID (`custom_id`, text, required): The exact custom ID to look for.

**Outputs**

- `checked` (number)
- `customId` (text)
- `domain` (text)
- `found` (true/false)
- `mailbox` (object)

**Example output**

```json
{
  "checked": 1,
  "customId": "E-1024",
  "domain": "example.com",
  "found": true,
  "mailbox": {
    "contactInfo": {
      "customID": "E-1024",
      "firstName": "Jane",
      "lastName": "Doe",
      "organizationUnit": "Sales",
      "title": "Account Manager"
    },
    "createdAt": "2026-03-02T14:15:00Z",
    "createdDate": "3/2/2026 9:15:00 AM",
    "currentUsage": 1024,
    "displayName": "Jane Doe",
    "domain": "example.com",
    "emailAddress": "jane.doe@example.com",
    "emailForwardingAddressList": [],
    "enableVacationMessage": false,
    "enabled": true,
    "lastLogin": "9/21/2026 4:02:11 PM",
    "lastLoginAt": "2026-09-21T20:02:11Z",
    "name": "jane.doe",
    "saveForwardedEmail": true,
    "size": 25600,
    "vacationMessage": "",
    "visibleInExchangeGAL": false,
    "visibleInRackspaceEmailCompanyDirectory": true
  }
}
```

### Get a domain

One domain's mailbox allowance: how many mailboxes it has paid for (mailboxLimit), how many are in use (mailboxesInUse), how many are free, and the standard size a new mailbox gets. Check it before creating a mailbox - Rackspace refuses to create one on a full domain.

**Inputs**

- Domain (`domain`, text, required): The domain the mailbox is on, such as example.com.

**Outputs**

- `accountNumber` (text)
- `aliases` (list)
- `archivingServiceEnabled` (true/false)
- `baseMailboxSizeMb` (number)
- `freeMailboxes` (number)
- `mailboxLimit` (number)
- `mailboxesInUse` (number)
- `name` (text)
- `rsEmailBaseMailboxSize` (number)
- `rsEmailExtraStorage` (number)
- `rsEmailMaxNumberMailboxes` (number)
- `rsEmailUsedStorage` (number)
- `serviceType` (text)

**Example output**

```json
{
  "accountNumber": "123456",
  "aliases": [],
  "archivingServiceEnabled": false,
  "baseMailboxSizeMb": 25600,
  "freeMailboxes": 6,
  "mailboxLimit": 10,
  "mailboxesInUse": 4,
  "name": "example.com",
  "rsEmailBaseMailboxSize": 25600,
  "rsEmailExtraStorage": 0,
  "rsEmailMaxNumberMailboxes": 10,
  "rsEmailUsedStorage": 4,
  "serviceType": "rsemail"
}
```

### Get a mailbox

Everything Rackspace holds on one mailbox: size and use, whether it is blocked, where it forwards, its auto-reply and its contact card. If the mailbox was deleted in the last 14 days, the step fails with the date it was deleted and says it can still be restored.

**Inputs**

- Domain (`domain`, text, required): The domain the mailbox is on, such as example.com.
- Mailbox (`mailbox`, text, required): The mailbox, as the part of its address before the @ (jane.doe) or the whole address. It must be on the domain above.

**Outputs**

- `contactInfo` (object)
- `createdAt` (text)
- `createdDate` (text)
- `currentUsage` (number)
- `displayName` (text)
- `domain` (text)
- `emailAddress` (text)
- `emailForwardingAddressList` (list)
- `enableVacationMessage` (true/false)
- `enabled` (true/false)
- `lastLogin` (text)
- `lastLoginAt` (text)
- `name` (text)
- `saveForwardedEmail` (true/false)
- `size` (number)
- `vacationMessage` (text)
- `visibleInExchangeGAL` (true/false)
- `visibleInRackspaceEmailCompanyDirectory` (true/false)

**Example output**

```json
{
  "contactInfo": {
    "customID": "E-1024",
    "firstName": "Jane",
    "lastName": "Doe",
    "organizationUnit": "Sales",
    "title": "Account Manager"
  },
  "createdAt": "2026-03-02T14:15:00Z",
  "createdDate": "3/2/2026 9:15:00 AM",
  "currentUsage": 1024,
  "displayName": "Jane Doe",
  "domain": "example.com",
  "emailAddress": "jane.doe@example.com",
  "emailForwardingAddressList": [],
  "enableVacationMessage": false,
  "enabled": true,
  "lastLogin": "9/21/2026 4:02:11 PM",
  "lastLoginAt": "2026-09-21T20:02:11Z",
  "name": "jane.doe",
  "saveForwardedEmail": true,
  "size": 25600,
  "vacationMessage": "",
  "visibleInExchangeGAL": false,
  "visibleInRackspaceEmailCompanyDirectory": true
}
```

### Get mailbox spam settings

How a mailbox's spam filter is set (on, off or exclusive) and what happens to spam: delivered to the Spam folder, deleted, marked [SPAM] or sent to another address.

**Inputs**

- Domain (`domain`, text, required): The domain the mailbox is on, such as example.com.
- Mailbox (`mailbox`, text, required): The mailbox, as the part of its address before the @ (jane.doe) or the whole address. It must be on the domain above.

**Outputs**

- `domain` (text)
- `emailAddress` (text)
- `filterLevel` (text)
- `name` (text)
- `rsEmailSettings` (object)

**Example output**

```json
{
  "domain": "example.com",
  "emailAddress": "jane.doe@example.com",
  "filterLevel": "on",
  "name": "jane.doe",
  "rsEmailSettings": {
    "hasFolderCleaner": true,
    "spamFolderAgeLimit": 30,
    "spamFolderNumLimit": 0,
    "spamForwardingAddress": "",
    "spamHandling": "toFolder"
  }
}
```

### List a mailbox's blocked or safe senders

The entries on one of a mailbox's four lists: blocked senders, safe senders, blocked IP addresses or safe IP addresses.

**Inputs**

- Domain (`domain`, text, required): The domain the mailbox is on, such as example.com.
- Mailbox (`mailbox`, text, required): The mailbox, as the part of its address before the @ (jane.doe) or the whole address. It must be on the domain above.
- List (`list_type`, text, required): Which list: blocked or safe senders (addresses and domains), or blocked or safe IP addresses. One of: `blocklist` (Blocked senders), `safelist` (Safe senders), `ipblocklist` (Blocked IP addresses), `ipsafelist` (Safe IP addresses).

**Outputs**

- `addresses` (list)
- `count` (number)
- `domain` (text)
- `emailAddress` (text)
- `listName` (text)
- `listType` (text)
- `name` (text)

**Example output**

```json
{
  "addresses": [
    "offers@spam.example",
    "@%.junk.example"
  ],
  "count": 2,
  "domain": "example.com",
  "emailAddress": "jane.doe@example.com",
  "listName": "Blocked senders",
  "listType": "blocklist",
  "name": "jane.doe"
}
```

### List domains

Every domain on the Rackspace Email account, with how many mailboxes each has paid for, how many are in use and how many are free.

**Inputs**

- Search (`search`, text): Only domains whose name contains this text.

**Outputs**

- `count` (number)
- `domains` (list)
- `total` (number)

**Example output**

```json
{
  "count": 1,
  "domains": [
    {
      "accountNumber": "123456",
      "aliases": [],
      "archivingServiceEnabled": false,
      "baseMailboxSizeMb": 25600,
      "freeMailboxes": 6,
      "mailboxLimit": 10,
      "mailboxesInUse": 4,
      "name": "example.com",
      "rsEmailBaseMailboxSize": 25600,
      "rsEmailExtraStorage": 0,
      "rsEmailMaxNumberMailboxes": 10,
      "rsEmailUsedStorage": 4,
      "serviceType": "rsemail"
    }
  ],
  "total": 1
}
```

### List inactive mailboxes

Mailboxes nobody has signed in to for a number of days, including ones never signed in to that are older than that. Useful for finding mailboxes you pay for and no longer use. Blocked mailboxes are left out unless you include them, though they are billed too.

**Inputs**

- Domain (`domain`, text, required): The domain the mailbox is on, such as example.com.
- Days without a sign-in (`days`, number): How long counts as inactive. Defaults to 90. From 1 to 3650.
- Include blocked mailboxes (`include_blocked`, true/false): Also list blocked mailboxes that are inactive.

**Outputs**

- `checked` (number)
- `complete` (true/false)
- `count` (number)
- `days` (number)
- `domain` (text)
- `mailboxes` (list)

**Example output**

```json
{
  "checked": 4,
  "complete": true,
  "count": 1,
  "days": 90,
  "domain": "example.com",
  "mailboxes": [
    {
      "createdAt": "2026-03-02T14:15:00Z",
      "createdDate": "3/2/2026 9:15:00 AM",
      "currentUsage": 1024,
      "daysSinceLastLogin": 176,
      "displayName": "Jane Doe",
      "domain": "example.com",
      "emailAddress": "jane.doe@example.com",
      "enabled": true,
      "lastLogin": "3/30/2026 8:00:00 AM",
      "lastLoginAt": "2026-03-30T12:00:00Z",
      "name": "jane.doe",
      "neverSignedIn": false,
      "size": 25600
    }
  ]
}
```

### List mailboxes

The mailboxes on a domain, with each one's size, how much of it is used, whether it is blocked, when it was created and when someone last signed in. Rackspace writes those dates in US Eastern time; createdAt and lastLoginAt give the same moments in UTC.

**Inputs**

- Domain (`domain`, text, required): The domain the mailbox is on, such as example.com.
- Search (`search`, text): Only mailboxes whose name, display name or custom ID contains this text.
- Status (`status`, text): All mailboxes, only active ones or only blocked ones. One of: `all` (All mailboxes), `active` (Active mailboxes only), `blocked` (Blocked mailboxes only). Default: `all`.
- Limit (`limit`, number): The most mailboxes to return. Defaults to 250; up to 5,000. From 1 to 5000.

**Outputs**

- `count` (number)
- `domain` (text)
- `mailboxes` (list)
- `total` (number)

**Example output**

```json
{
  "count": 1,
  "domain": "example.com",
  "mailboxes": [
    {
      "createdAt": "2026-03-02T14:15:00Z",
      "createdDate": "3/2/2026 9:15:00 AM",
      "currentUsage": 1024,
      "displayName": "Jane Doe",
      "domain": "example.com",
      "emailAddress": "jane.doe@example.com",
      "enabled": true,
      "lastLogin": "9/21/2026 4:02:11 PM",
      "lastLoginAt": "2026-09-21T20:02:11Z",
      "name": "jane.doe",
      "size": 25600
    }
  ],
  "total": 1
}
```

### Offboard a mailbox

Lock a leaver out of their mailbox in one step: block it and give it a random password nobody is told. Optionally forward their mail and set an auto-reply at the same time. The mailbox keeps receiving mail and Rackspace keeps billing for it until it is deleted. Alias memberships are not changed.

**Inputs**

- Domain (`domain`, text, required): The domain the mailbox is on, such as example.com.
- Mailbox (`mailbox`, text, required): The mailbox, as the part of its address before the @ (jane.doe) or the whole address. It must be on the domain above.
- Forward to (`forward_to`, list): Where to send the mailbox's mail: up to 15 addresses, at most 4 of them outside the mailbox's domain.
- Keep a copy (`keep_copy`, true/false): Also keep forwarded mail in this mailbox. On unless you turn it off.
- Auto-reply message (`auto_reply_message`, text): A reply to send to everyone who writes to the mailbox, such as who to contact instead.

**Outputs**

- `autoReplyApplied` (true/false)
- `autoReplyEnabled` (true/false)
- `blocked` (true/false)
- `domain` (text)
- `emailAddress` (text)
- `forwardTo` (list)
- `forwardingApplied` (true/false)
- `mailbox` (object)
- `name` (text)
- `passwordReset` (true/false)
- `stillBilled` (true/false)

**Example output**

```json
{
  "autoReplyApplied": true,
  "autoReplyEnabled": true,
  "blocked": true,
  "domain": "example.com",
  "emailAddress": "jane.doe@example.com",
  "forwardTo": [
    "manager@example.com"
  ],
  "forwardingApplied": true,
  "mailbox": {
    "contactInfo": {
      "customID": "E-1024",
      "firstName": "Jane",
      "lastName": "Doe",
      "organizationUnit": "Sales",
      "title": "Account Manager"
    },
    "createdAt": "2026-03-02T14:15:00Z",
    "createdDate": "3/2/2026 9:15:00 AM",
    "currentUsage": 1024,
    "displayName": "Jane Doe",
    "domain": "example.com",
    "emailAddress": "jane.doe@example.com",
    "emailForwardingAddressList": [
      "manager@example.com"
    ],
    "enableVacationMessage": true,
    "enabled": false,
    "lastLogin": "9/21/2026 4:02:11 PM",
    "lastLoginAt": "2026-09-21T20:02:11Z",
    "name": "jane.doe",
    "saveForwardedEmail": true,
    "size": 25600,
    "vacationMessage": "",
    "visibleInExchangeGAL": false,
    "visibleInRackspaceEmailCompanyDirectory": true
  },
  "name": "jane.doe",
  "passwordReset": true,
  "stillBilled": true
}
```

### Onboard a new mailbox

Create a new starter's mailbox, checking first that the domain has a free mailbox and that the name is not taken - or deleted recently enough that it should be restored instead. Leave the password blank to have a strong one made; it is returned once as temporaryPassword for a later step to pass on, and is kept with this run's history, so ask the starter to change it.

**Inputs**

- Domain (`domain`, text, required): The domain the mailbox is on, such as example.com.
- Mailbox name (`mailbox_name`, text, required): The part of the new address before the @, such as jane.doe for jane.doe@example.com.
- Password (`password`, text): Leave blank to have a random password made. At least 8 characters, using at least three of: upper-case letters, lower-case letters, numbers and symbols.
- Size (MB) (`size_mb`, number): How big the mailbox is, in megabytes. Leave blank for the domain's standard mailbox size. At least 1.
- Display name (`display_name`, text): The name people see on mail from this mailbox. Defaults to the first and last name.
- First name (`first_name`, text): The owner's first name, for the company directory.
- Last name (`last_name`, text): The owner's last name, for the company directory.
- Job title (`title`, text): The owner's job title, for the company directory.
- Department (`department`, text): The owner's department, such as Marketing.
- Custom ID (`custom_id`, text): An ID from another system, such as an employee number from your HR software. 'Find a mailbox by custom ID' can look the mailbox up by it later.
- Business phone (`business_phone`, text): The owner's work phone number, for the company directory.
- Mobile phone (`mobile_phone`, text): The owner's mobile number, for the company directory.

**Outputs**

- `domain` (text)
- `emailAddress` (text)
- `freeMailboxesLeft` (number)
- `mailbox` (object)
- `name` (text)
- `passwordGenerated` (true/false)
- `temporaryPassword` (text)

**Example output**

```json
{
  "domain": "example.com",
  "emailAddress": "jane.doe@example.com",
  "freeMailboxesLeft": 5,
  "mailbox": {
    "contactInfo": {
      "customID": "E-1024",
      "firstName": "Jane",
      "lastName": "Doe",
      "organizationUnit": "Sales",
      "title": "Account Manager"
    },
    "createdAt": "2026-03-02T14:15:00Z",
    "createdDate": "3/2/2026 9:15:00 AM",
    "currentUsage": 1024,
    "displayName": "Jane Doe",
    "domain": "example.com",
    "emailAddress": "jane.doe@example.com",
    "emailForwardingAddressList": [],
    "enableVacationMessage": false,
    "enabled": true,
    "lastLogin": "9/21/2026 4:02:11 PM",
    "lastLoginAt": "2026-09-21T20:02:11Z",
    "name": "jane.doe",
    "saveForwardedEmail": true,
    "size": 25600,
    "vacationMessage": "",
    "visibleInExchangeGAL": false,
    "visibleInRackspaceEmailCompanyDirectory": true
  },
  "name": "jane.doe",
  "passwordGenerated": true,
  "temporaryPassword": "Xq7!pR2#vL9mK4$tW8zB"
}
```

### Remove from a mailbox's blocked or safe senders

Take addresses, domains or IP addresses off one of a mailbox's block or safe lists, all in one change.

**Inputs**

- Domain (`domain`, text, required): The domain the mailbox is on, such as example.com.
- Mailbox (`mailbox`, text, required): The mailbox, as the part of its address before the @ (jane.doe) or the whole address. It must be on the domain above.
- List (`list_type`, text, required): Which list: blocked or safe senders (addresses and domains), or blocked or safe IP addresses. One of: `blocklist` (Blocked senders), `safelist` (Safe senders), `ipblocklist` (Blocked IP addresses), `ipsafelist` (Safe IP addresses).
- Entries (`entries`, list, required): Addresses or domains for the sender lists, such as name@example.com or @example.com, with % as a wildcard in the domain but not the ending (@%.example.com). IP addresses for the IP lists, with % for the last parts (216.12.34.%).

**Outputs**

- `added` (list)
- `addresses` (list)
- `count` (number)
- `domain` (text)
- `emailAddress` (text)
- `listName` (text)
- `listType` (text)
- `name` (text)
- `removed` (list)

**Example output**

```json
{
  "added": [],
  "addresses": [
    "@%.junk.example"
  ],
  "count": 1,
  "domain": "example.com",
  "emailAddress": "jane.doe@example.com",
  "listName": "Blocked senders",
  "listType": "blocklist",
  "name": "jane.doe",
  "removed": [
    "offers@spam.example"
  ]
}
```

### Rename a mailbox

Give a mailbox a new address on the same domain, for example after a name change. Rackspace keeps the old address as an alias, so mail sent to it still arrives.

**Inputs**

- Domain (`domain`, text, required): The domain the mailbox is on, such as example.com.
- Mailbox (`mailbox`, text, required): The mailbox, as the part of its address before the @ (jane.doe) or the whole address. It must be on the domain above.
- New name (`new_name`, text, required): The new part of the address before the @, such as jane.smith.

**Outputs**

- `contactInfo` (object)
- `createdAt` (text)
- `createdDate` (text)
- `currentUsage` (number)
- `displayName` (text)
- `domain` (text)
- `emailAddress` (text)
- `emailForwardingAddressList` (list)
- `enableVacationMessage` (true/false)
- `enabled` (true/false)
- `lastLogin` (text)
- `lastLoginAt` (text)
- `name` (text)
- `previousEmailAddress` (text)
- `previousName` (text)
- `saveForwardedEmail` (true/false)
- `size` (number)
- `vacationMessage` (text)
- `visibleInExchangeGAL` (true/false)
- `visibleInRackspaceEmailCompanyDirectory` (true/false)

**Example output**

```json
{
  "contactInfo": {
    "customID": "E-1024",
    "firstName": "Jane",
    "lastName": "Doe",
    "organizationUnit": "Sales",
    "title": "Account Manager"
  },
  "createdAt": "2026-03-02T14:15:00Z",
  "createdDate": "3/2/2026 9:15:00 AM",
  "currentUsage": 1024,
  "displayName": "Jane Doe",
  "domain": "example.com",
  "emailAddress": "jane.smith@example.com",
  "emailForwardingAddressList": [],
  "enableVacationMessage": false,
  "enabled": true,
  "lastLogin": "9/21/2026 4:02:11 PM",
  "lastLoginAt": "2026-09-21T20:02:11Z",
  "name": "jane.smith",
  "previousEmailAddress": "jane.doe@example.com",
  "previousName": "jane.doe",
  "saveForwardedEmail": true,
  "size": 25600,
  "vacationMessage": "",
  "visibleInExchangeGAL": false,
  "visibleInRackspaceEmailCompanyDirectory": true
}
```

### Replace a mailbox's blocked or safe senders

Make one of a mailbox's block or safe lists exactly the entries given: anything missing is added and anything extra is removed, in one change. Leave 'Entries' empty to clear the list.

**Inputs**

- Domain (`domain`, text, required): The domain the mailbox is on, such as example.com.
- Mailbox (`mailbox`, text, required): The mailbox, as the part of its address before the @ (jane.doe) or the whole address. It must be on the domain above.
- List (`list_type`, text, required): Which list: blocked or safe senders (addresses and domains), or blocked or safe IP addresses. One of: `blocklist` (Blocked senders), `safelist` (Safe senders), `ipblocklist` (Blocked IP addresses), `ipsafelist` (Safe IP addresses).
- Entries (`entries`, list): The complete list. Empty clears it. Addresses or domains for the sender lists, IP addresses for the IP lists, with % as a wildcard as described in 'Add to a mailbox's blocked or safe senders'.

**Outputs**

- `added` (list)
- `addresses` (list)
- `count` (number)
- `domain` (text)
- `emailAddress` (text)
- `listName` (text)
- `listType` (text)
- `name` (text)
- `removed` (list)

**Example output**

```json
{
  "added": [
    "@%.junk.example"
  ],
  "addresses": [
    "offers@spam.example",
    "@%.junk.example"
  ],
  "count": 2,
  "domain": "example.com",
  "emailAddress": "jane.doe@example.com",
  "listName": "Blocked senders",
  "listType": "blocklist",
  "name": "jane.doe",
  "removed": [
    "old@spam.example"
  ]
}
```

### Reset a mailbox password

Set a new password on a mailbox. Anyone signed in with the old one - including mail apps and phones - has to sign in again. The password is never included in the output.

**Inputs**

- Domain (`domain`, text, required): The domain the mailbox is on, such as example.com.
- Mailbox (`mailbox`, text, required): The mailbox, as the part of its address before the @ (jane.doe) or the whole address. It must be on the domain above.
- New password (`new_password`, text, required): At least 8 characters, using at least three of: upper-case letters, lower-case letters, numbers and symbols.

**Outputs**

- `domain` (text)
- `emailAddress` (text)
- `name` (text)
- `passwordChanged` (true/false)

**Example output**

```json
{
  "domain": "example.com",
  "emailAddress": "jane.doe@example.com",
  "name": "jane.doe",
  "passwordChanged": true
}
```

### Restore a mailbox

Bring back a mailbox deleted in the last 14 days, with its mail, under the same name. It needs a new password, and a free mailbox on the domain.

**Inputs**

- Domain (`domain`, text, required): The domain the mailbox is on, such as example.com.
- Mailbox (`mailbox`, text, required): The deleted mailbox, as the part of its address before the @ or the whole address.
- Password (`password`, text, required): At least 8 characters, using at least three of: upper-case letters, lower-case letters, numbers and symbols. It is never included in the step's output.
- Size (MB) (`size_mb`, number): How big the mailbox is, in megabytes. Leave blank for the domain's standard mailbox size. At least 1.

**Outputs**

- `contactInfo` (object)
- `createdAt` (text)
- `createdDate` (text)
- `currentUsage` (number)
- `deletedDate` (text)
- `displayName` (text)
- `domain` (text)
- `emailAddress` (text)
- `emailForwardingAddressList` (list)
- `enableVacationMessage` (true/false)
- `enabled` (true/false)
- `lastLogin` (text)
- `lastLoginAt` (text)
- `name` (text)
- `restored` (true/false)
- `saveForwardedEmail` (true/false)
- `size` (number)
- `vacationMessage` (text)
- `visibleInExchangeGAL` (true/false)
- `visibleInRackspaceEmailCompanyDirectory` (true/false)

**Example output**

```json
{
  "contactInfo": {
    "customID": "E-1024",
    "firstName": "Jane",
    "lastName": "Doe",
    "organizationUnit": "Sales",
    "title": "Account Manager"
  },
  "createdAt": "2026-03-02T14:15:00Z",
  "createdDate": "3/2/2026 9:15:00 AM",
  "currentUsage": 1024,
  "deletedDate": "2026-09-20T15:04:05Z",
  "displayName": "Jane Doe",
  "domain": "example.com",
  "emailAddress": "jane.doe@example.com",
  "emailForwardingAddressList": [],
  "enableVacationMessage": false,
  "enabled": true,
  "lastLogin": "9/21/2026 4:02:11 PM",
  "lastLoginAt": "2026-09-21T20:02:11Z",
  "name": "jane.doe",
  "restored": true,
  "saveForwardedEmail": true,
  "size": 25600,
  "vacationMessage": "",
  "visibleInExchangeGAL": false,
  "visibleInRackspaceEmailCompanyDirectory": true
}
```

### Set a mailbox auto-reply

Turn a mailbox's automatic reply (vacation message) on with a message, or off. Rackspace removed auto-replies from its own control panel in 2022 while the API still offers them, so the step reads the mailbox back and reports whether the change took ('applied').

**Inputs**

- Domain (`domain`, text, required): The domain the mailbox is on, such as example.com.
- Mailbox (`mailbox`, text, required): The mailbox, as the part of its address before the @ (jane.doe) or the whole address. It must be on the domain above.
- Turn on (`enabled`, true/false, required): On to send the auto-reply, off to stop it.
- Message (`message`, text): The reply to send. Required to turn it on.

**Outputs**

- `applied` (true/false)
- `autoReplyEnabled` (true/false)
- `autoReplyMessage` (text)
- `domain` (text)
- `emailAddress` (text)
- `name` (text)

**Example output**

```json
{
  "applied": true,
  "autoReplyEnabled": true,
  "autoReplyMessage": "I'm away until Monday.",
  "domain": "example.com",
  "emailAddress": "jane.doe@example.com",
  "name": "jane.doe"
}
```

### Set mailbox forwarding

Forward a mailbox's mail to up to 15 addresses, or leave 'Forward to' empty to stop forwarding. Rackspace removed forwarding from its own control panel in 2022 while the API still offers it, so the step reads the mailbox back and reports whether the change took ('applied'). Rackspace says to allow at least 15 minutes before forwarding starts.

**Inputs**

- Domain (`domain`, text, required): The domain the mailbox is on, such as example.com.
- Mailbox (`mailbox`, text, required): The mailbox, as the part of its address before the @ (jane.doe) or the whole address. It must be on the domain above.
- Forward to (`forward_to`, list): Where to send the mailbox's mail: up to 15 addresses, at most 4 of them outside the mailbox's domain.
- Keep a copy (`keep_copy`, true/false): Also keep forwarded mail in this mailbox. On unless you turn it off.

**Outputs**

- `applied` (true/false)
- `domain` (text)
- `emailAddress` (text)
- `forwardTo` (list)
- `keepCopy` (true/false)
- `name` (text)
- `requested` (list)

**Example output**

```json
{
  "applied": true,
  "domain": "example.com",
  "emailAddress": "jane.doe@example.com",
  "forwardTo": [
    "manager@example.com"
  ],
  "keepCopy": true,
  "name": "jane.doe",
  "requested": [
    "manager@example.com"
  ]
}
```

### Unblock a mailbox

Let the owner of a blocked mailbox sign in again.

**Inputs**

- Domain (`domain`, text, required): The domain the mailbox is on, such as example.com.
- Mailbox (`mailbox`, text, required): The mailbox, as the part of its address before the @ (jane.doe) or the whole address. It must be on the domain above.

**Outputs**

- `domain` (text)
- `emailAddress` (text)
- `enabled` (true/false)
- `name` (text)

**Example output**

```json
{
  "domain": "example.com",
  "emailAddress": "jane.doe@example.com",
  "enabled": true,
  "name": "jane.doe"
}
```

### Update a mailbox

Change a mailbox's size or its contact details. Only the fields you fill in change; the rest stay as they are.

**Inputs**

- Domain (`domain`, text, required): The domain the mailbox is on, such as example.com.
- Mailbox (`mailbox`, text, required): The mailbox, as the part of its address before the @ (jane.doe) or the whole address. It must be on the domain above.
- Size (MB) (`size_mb`, number): How big the mailbox is, in megabytes. Leave blank for the domain's standard mailbox size. At least 1.
- Display name (`display_name`, text): The name people see on mail from this mailbox.
- First name (`first_name`, text): The owner's first name, for the company directory.
- Last name (`last_name`, text): The owner's last name, for the company directory.
- Job title (`title`, text): The owner's job title, for the company directory.
- Department (`department`, text): The owner's department, such as Marketing.
- Custom ID (`custom_id`, text): An ID from another system, such as an employee number from your HR software. 'Find a mailbox by custom ID' can look the mailbox up by it later.
- Business phone (`business_phone`, text): The owner's work phone number, for the company directory.
- Mobile phone (`mobile_phone`, text): The owner's mobile number, for the company directory.
- Show in company directory (`visible_in_directory`, true/false): Whether the mailbox is listed in the company directory that webmail users see.

**Outputs**

- `contactInfo` (object)
- `createdAt` (text)
- `createdDate` (text)
- `currentUsage` (number)
- `displayName` (text)
- `domain` (text)
- `emailAddress` (text)
- `emailForwardingAddressList` (list)
- `enableVacationMessage` (true/false)
- `enabled` (true/false)
- `lastLogin` (text)
- `lastLoginAt` (text)
- `name` (text)
- `saveForwardedEmail` (true/false)
- `size` (number)
- `vacationMessage` (text)
- `visibleInExchangeGAL` (true/false)
- `visibleInRackspaceEmailCompanyDirectory` (true/false)

**Example output**

```json
{
  "contactInfo": {
    "customID": "E-1024",
    "firstName": "Jane",
    "lastName": "Doe",
    "organizationUnit": "Sales",
    "title": "Account Manager"
  },
  "createdAt": "2026-03-02T14:15:00Z",
  "createdDate": "3/2/2026 9:15:00 AM",
  "currentUsage": 1024,
  "displayName": "Jane Doe",
  "domain": "example.com",
  "emailAddress": "jane.doe@example.com",
  "emailForwardingAddressList": [],
  "enableVacationMessage": false,
  "enabled": true,
  "lastLogin": "9/21/2026 4:02:11 PM",
  "lastLoginAt": "2026-09-21T20:02:11Z",
  "name": "jane.doe",
  "saveForwardedEmail": true,
  "size": 25600,
  "vacationMessage": "",
  "visibleInExchangeGAL": false,
  "visibleInRackspaceEmailCompanyDirectory": true
}
```

### Update mailbox spam settings

Change a mailbox's spam filter. Fields left blank keep their current setting. 'Exclusive' accepts mail only from the safe senders list. The Spam folder limits apply only when spam goes to the Spam folder, and a forwarding address only when it goes to another address.

**Inputs**

- Domain (`domain`, text, required): The domain the mailbox is on, such as example.com.
- Mailbox (`mailbox`, text, required): The mailbox, as the part of its address before the @ (jane.doe) or the whole address. It must be on the domain above.
- Spam filter (`filter_level`, text): On, off, or exclusive (safe senders only). One of: `on`, `off`, `exclusive` (Exclusive: accept mail only from safe senders).
- What to do with spam (`spam_handling`, text): Where mail the filter marks as spam goes. One of: `toFolder` (Deliver it to the Spam folder), `delete` (Delete it), `labelSubject` (Deliver it with [SPAM] in the subject), `toAddress` (Send it to another address).
- Send spam to (`forward_spam_to`, text): The address spam goes to, when it is sent to another address.
- Empty Spam folder after (days) (`delete_after_days`, number): Delete spam from the Spam folder after this many days. 0 keeps it. At least 0.
- Keep at most (messages) (`keep_at_most`, number): The most messages the Spam folder keeps. 0 means no limit. At least 0.

**Outputs**

- `domain` (text)
- `emailAddress` (text)
- `filterLevel` (text)
- `name` (text)
- `rsEmailSettings` (object)

**Example output**

```json
{
  "domain": "example.com",
  "emailAddress": "jane.doe@example.com",
  "filterLevel": "on",
  "name": "jane.doe",
  "rsEmailSettings": {
    "hasFolderCleaner": true,
    "spamFolderAgeLimit": 30,
    "spamFolderNumLimit": 0,
    "spamForwardingAddress": "",
    "spamHandling": "toFolder"
  }
}
```