Docs
Open Lodol
DocumentationIntegrationsAPI

Rackspace Email Admin

App · Email · 24 actions · 1 trigger

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.

Triggers

Start a workflow when something happens in Rackspace Email Admin. See how triggers work.

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.

domainRequired

Event fields

What a run starts with. Later steps read each field with an @ reference.

nametext
email_addresstext
domaintext
display_nametext
enabledtrue/false
size_mbnumber
created_datetext
created_attext

Actions

ActionWhat it does
Add to a mailbox's blocked or safe sendersAdd addresses, domains or IP addresses to one of a mailbox's block or safe lists, all in one change.
Block a mailboxStop anyone signing in to a mailbox.
Create a mailboxAdd a mailbox to a domain.
Delete a mailboxDelete a mailbox and its mail.
Find a mailbox by custom IDFind 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.
Get a domainOne 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.
Get a mailboxEverything Rackspace holds on one mailbox: size and use, whether it is blocked, where it forwards, its auto-reply and its contact card.
Get mailbox spam settingsHow 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.
List a mailbox's blocked or safe sendersThe entries on one of a mailbox's four lists: blocked senders, safe senders, blocked IP addresses or safe IP addresses.
List domainsEvery domain on the Rackspace Email account, with how many mailboxes each has paid for, how many are in use and how many are free.
List inactive mailboxesMailboxes nobody has signed in to for a number of days, including ones never signed in to that are older than that.
List mailboxesThe 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.
Offboard a mailboxLock a leaver out of their mailbox in one step: block it and give it a random password nobody is told.
Onboard a new mailboxCreate 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.
Remove from a mailbox's blocked or safe sendersTake addresses, domains or IP addresses off one of a mailbox's block or safe lists, all in one change.
Rename a mailboxGive a mailbox a new address on the same domain, for example after a name change.
Replace a mailbox's blocked or safe sendersMake 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.
Reset a mailbox passwordSet a new password on a mailbox.
Restore a mailboxBring back a mailbox deleted in the last 14 days, with its mail, under the same name.
Set a mailbox auto-replyTurn a mailbox's automatic reply (vacation message) on with a message, or off.
Set mailbox forwardingForward a mailbox's mail to up to 15 addresses, or leave 'Forward to' empty to stop forwarding.
Unblock a mailboxLet the owner of a blocked mailbox sign in again.
Update a mailboxChange a mailbox's size or its contact details.
Update mailbox spam settingsChange a mailbox's spam filter.

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

DomaindomaintextRequired
The domain the mailbox is on, such as example.com.
MailboxmailboxtextRequired
The mailbox, as the part of its address before the @ (jane.doe) or the whole address. It must be on the domain above.
Listlist_typetextRequired
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).
EntriesentrieslistRequired
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

addedlist
addresseslist
countnumber
domaintext
emailAddresstext
listNametext
listTypetext
nametext
removedlist
Example output
{
  "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

DomaindomaintextRequired
The domain the mailbox is on, such as example.com.
MailboxmailboxtextRequired
The mailbox, as the part of its address before the @ (jane.doe) or the whole address. It must be on the domain above.

Outputs

domaintext
emailAddresstext
enabledtrue/false
nametext
stillBilledtrue/false
Example output
{
  "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

DomaindomaintextRequired
The domain the mailbox is on, such as example.com.
Mailbox namemailbox_nametextRequired
The part of the new address before the @, such as jane.doe for jane.doe@example.com.
PasswordpasswordtextRequired
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_mbnumber
How big the mailbox is, in megabytes. Leave blank for the domain's standard mailbox size.At least 1.
Display namedisplay_nametext
The name people see on mail from this mailbox.
First namefirst_nametext
The owner's first name, for the company directory.
Last namelast_nametext
The owner's last name, for the company directory.
Job titletitletext
The owner's job title, for the company directory.
Departmentdepartmenttext
The owner's department, such as Marketing.
Custom IDcustom_idtext
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 phonebusiness_phonetext
The owner's work phone number, for the company directory.
Mobile phonemobile_phonetext
The owner's mobile number, for the company directory.
Show in company directoryvisible_in_directorytrue/false
Whether the mailbox is listed in the company directory that webmail users see.

Outputs

contactInfoobject
createdAttext
createdDatetext
currentUsagenumber
displayNametext
domaintext
emailAddresstext
emailForwardingAddressListlist
enableVacationMessagetrue/false
enabledtrue/false
lastLogintext
lastLoginAttext
nametext
saveForwardedEmailtrue/false
sizenumber
vacationMessagetext
visibleInExchangeGALtrue/false
visibleInRackspaceEmailCompanyDirectorytrue/false
Example output
{
  "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

DomaindomaintextRequired
The domain the mailbox is on, such as example.com.
MailboxmailboxtextRequired
The mailbox, as the part of its address before the @ (jane.doe) or the whole address. It must be on the domain above.

Outputs

deletedtrue/false
domaintext
emailAddresstext
nametext
restorableForDaysnumber
Example output
{
  "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

DomaindomaintextRequired
The domain the mailbox is on, such as example.com.
Custom IDcustom_idtextRequired
The exact custom ID to look for.

Outputs

checkednumber
customIdtext
domaintext
foundtrue/false
mailboxobject
Example output
{
  "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

DomaindomaintextRequired
The domain the mailbox is on, such as example.com.

Outputs

accountNumbertext
aliaseslist
archivingServiceEnabledtrue/false
baseMailboxSizeMbnumber
freeMailboxesnumber
mailboxLimitnumber
mailboxesInUsenumber
nametext
rsEmailBaseMailboxSizenumber
rsEmailExtraStoragenumber
rsEmailMaxNumberMailboxesnumber
rsEmailUsedStoragenumber
serviceTypetext
Example output
{
  "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

DomaindomaintextRequired
The domain the mailbox is on, such as example.com.
MailboxmailboxtextRequired
The mailbox, as the part of its address before the @ (jane.doe) or the whole address. It must be on the domain above.

Outputs

contactInfoobject
createdAttext
createdDatetext
currentUsagenumber
displayNametext
domaintext
emailAddresstext
emailForwardingAddressListlist
enableVacationMessagetrue/false
enabledtrue/false
lastLogintext
lastLoginAttext
nametext
saveForwardedEmailtrue/false
sizenumber
vacationMessagetext
visibleInExchangeGALtrue/false
visibleInRackspaceEmailCompanyDirectorytrue/false
Example output
{
  "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

DomaindomaintextRequired
The domain the mailbox is on, such as example.com.
MailboxmailboxtextRequired
The mailbox, as the part of its address before the @ (jane.doe) or the whole address. It must be on the domain above.

Outputs

domaintext
emailAddresstext
filterLeveltext
nametext
rsEmailSettingsobject
Example output
{
  "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

DomaindomaintextRequired
The domain the mailbox is on, such as example.com.
MailboxmailboxtextRequired
The mailbox, as the part of its address before the @ (jane.doe) or the whole address. It must be on the domain above.
Listlist_typetextRequired
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

addresseslist
countnumber
domaintext
emailAddresstext
listNametext
listTypetext
nametext
Example output
{
  "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

Searchsearchtext
Only domains whose name contains this text.

Outputs

countnumber
domainslist
totalnumber
Example output
{
  "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

DomaindomaintextRequired
The domain the mailbox is on, such as example.com.
Days without a sign-indaysnumber
How long counts as inactive. Defaults to 90.From 1 to 3650.
Include blocked mailboxesinclude_blockedtrue/false
Also list blocked mailboxes that are inactive.

Outputs

checkednumber
completetrue/false
countnumber
daysnumber
domaintext
mailboxeslist
Example output
{
  "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

DomaindomaintextRequired
The domain the mailbox is on, such as example.com.
Searchsearchtext
Only mailboxes whose name, display name or custom ID contains this text.
Statusstatustext
All mailboxes, only active ones or only blocked ones.One of: all (All mailboxes), active (Active mailboxes only), blocked (Blocked mailboxes only). Default: all.
Limitlimitnumber
The most mailboxes to return. Defaults to 250; up to 5,000.From 1 to 5000.

Outputs

countnumber
domaintext
mailboxeslist
totalnumber
Example output
{
  "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

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

Outputs

autoReplyAppliedtrue/false
autoReplyEnabledtrue/false
blockedtrue/false
domaintext
emailAddresstext
forwardTolist
forwardingAppliedtrue/false
mailboxobject
nametext
passwordResettrue/false
stillBilledtrue/false
Example output
{
  "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

DomaindomaintextRequired
The domain the mailbox is on, such as example.com.
Mailbox namemailbox_nametextRequired
The part of the new address before the @, such as jane.doe for jane.doe@example.com.
Passwordpasswordtext
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_mbnumber
How big the mailbox is, in megabytes. Leave blank for the domain's standard mailbox size.At least 1.
Display namedisplay_nametext
The name people see on mail from this mailbox. Defaults to the first and last name.
First namefirst_nametext
The owner's first name, for the company directory.
Last namelast_nametext
The owner's last name, for the company directory.
Job titletitletext
The owner's job title, for the company directory.
Departmentdepartmenttext
The owner's department, such as Marketing.
Custom IDcustom_idtext
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 phonebusiness_phonetext
The owner's work phone number, for the company directory.
Mobile phonemobile_phonetext
The owner's mobile number, for the company directory.

Outputs

domaintext
emailAddresstext
freeMailboxesLeftnumber
mailboxobject
nametext
passwordGeneratedtrue/false
temporaryPasswordtext
Example output
{
  "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

DomaindomaintextRequired
The domain the mailbox is on, such as example.com.
MailboxmailboxtextRequired
The mailbox, as the part of its address before the @ (jane.doe) or the whole address. It must be on the domain above.
Listlist_typetextRequired
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).
EntriesentrieslistRequired
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

addedlist
addresseslist
countnumber
domaintext
emailAddresstext
listNametext
listTypetext
nametext
removedlist
Example output
{
  "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

DomaindomaintextRequired
The domain the mailbox is on, such as example.com.
MailboxmailboxtextRequired
The mailbox, as the part of its address before the @ (jane.doe) or the whole address. It must be on the domain above.
New namenew_nametextRequired
The new part of the address before the @, such as jane.smith.

Outputs

contactInfoobject
createdAttext
createdDatetext
currentUsagenumber
displayNametext
domaintext
emailAddresstext
emailForwardingAddressListlist
enableVacationMessagetrue/false
enabledtrue/false
lastLogintext
lastLoginAttext
nametext
previousEmailAddresstext
previousNametext
saveForwardedEmailtrue/false
sizenumber
vacationMessagetext
visibleInExchangeGALtrue/false
visibleInRackspaceEmailCompanyDirectorytrue/false
Example output
{
  "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

DomaindomaintextRequired
The domain the mailbox is on, such as example.com.
MailboxmailboxtextRequired
The mailbox, as the part of its address before the @ (jane.doe) or the whole address. It must be on the domain above.
Listlist_typetextRequired
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).
Entriesentrieslist
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

addedlist
addresseslist
countnumber
domaintext
emailAddresstext
listNametext
listTypetext
nametext
removedlist
Example output
{
  "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

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

Outputs

domaintext
emailAddresstext
nametext
passwordChangedtrue/false
Example output
{
  "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

DomaindomaintextRequired
The domain the mailbox is on, such as example.com.
MailboxmailboxtextRequired
The deleted mailbox, as the part of its address before the @ or the whole address.
PasswordpasswordtextRequired
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_mbnumber
How big the mailbox is, in megabytes. Leave blank for the domain's standard mailbox size.At least 1.

Outputs

contactInfoobject
createdAttext
createdDatetext
currentUsagenumber
deletedDatetext
displayNametext
domaintext
emailAddresstext
emailForwardingAddressListlist
enableVacationMessagetrue/false
enabledtrue/false
lastLogintext
lastLoginAttext
nametext
restoredtrue/false
saveForwardedEmailtrue/false
sizenumber
vacationMessagetext
visibleInExchangeGALtrue/false
visibleInRackspaceEmailCompanyDirectorytrue/false
Example output
{
  "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

DomaindomaintextRequired
The domain the mailbox is on, such as example.com.
MailboxmailboxtextRequired
The mailbox, as the part of its address before the @ (jane.doe) or the whole address. It must be on the domain above.
Turn onenabledtrue/falseRequired
On to send the auto-reply, off to stop it.
Messagemessagetext
The reply to send. Required to turn it on.

Outputs

appliedtrue/false
autoReplyEnabledtrue/false
autoReplyMessagetext
domaintext
emailAddresstext
nametext
Example output
{
  "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

DomaindomaintextRequired
The domain the mailbox is on, such as example.com.
MailboxmailboxtextRequired
The mailbox, as the part of its address before the @ (jane.doe) or the whole address. It must be on the domain above.
Forward toforward_tolist
Where to send the mailbox's mail: up to 15 addresses, at most 4 of them outside the mailbox's domain.
Keep a copykeep_copytrue/false
Also keep forwarded mail in this mailbox. On unless you turn it off.

Outputs

appliedtrue/false
domaintext
emailAddresstext
forwardTolist
keepCopytrue/false
nametext
requestedlist
Example output
{
  "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

DomaindomaintextRequired
The domain the mailbox is on, such as example.com.
MailboxmailboxtextRequired
The mailbox, as the part of its address before the @ (jane.doe) or the whole address. It must be on the domain above.

Outputs

domaintext
emailAddresstext
enabledtrue/false
nametext
Example output
{
  "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

DomaindomaintextRequired
The domain the mailbox is on, such as example.com.
MailboxmailboxtextRequired
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_mbnumber
How big the mailbox is, in megabytes. Leave blank for the domain's standard mailbox size.At least 1.
Display namedisplay_nametext
The name people see on mail from this mailbox.
First namefirst_nametext
The owner's first name, for the company directory.
Last namelast_nametext
The owner's last name, for the company directory.
Job titletitletext
The owner's job title, for the company directory.
Departmentdepartmenttext
The owner's department, such as Marketing.
Custom IDcustom_idtext
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 phonebusiness_phonetext
The owner's work phone number, for the company directory.
Mobile phonemobile_phonetext
The owner's mobile number, for the company directory.
Show in company directoryvisible_in_directorytrue/false
Whether the mailbox is listed in the company directory that webmail users see.

Outputs

contactInfoobject
createdAttext
createdDatetext
currentUsagenumber
displayNametext
domaintext
emailAddresstext
emailForwardingAddressListlist
enableVacationMessagetrue/false
enabledtrue/false
lastLogintext
lastLoginAttext
nametext
saveForwardedEmailtrue/false
sizenumber
vacationMessagetext
visibleInExchangeGALtrue/false
visibleInRackspaceEmailCompanyDirectorytrue/false
Example output
{
  "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

DomaindomaintextRequired
The domain the mailbox is on, such as example.com.
MailboxmailboxtextRequired
The mailbox, as the part of its address before the @ (jane.doe) or the whole address. It must be on the domain above.
Spam filterfilter_leveltext
On, off, or exclusive (safe senders only).One of: on, off, exclusive (Exclusive: accept mail only from safe senders).
What to do with spamspam_handlingtext
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 toforward_spam_totext
The address spam goes to, when it is sent to another address.
Empty Spam folder after (days)delete_after_daysnumber
Delete spam from the Spam folder after this many days. 0 keeps it.At least 0.
Keep at most (messages)keep_at_mostnumber
The most messages the Spam folder keeps. 0 means no limit.At least 0.

Outputs

domaintext
emailAddresstext
filterLeveltext
nametext
rsEmailSettingsobject
Example output
{
  "domain": "example.com",
  "emailAddress": "jane.doe@example.com",
  "filterLevel": "on",
  "name": "jane.doe",
  "rsEmailSettings": {
    "hasFolderCleaner": true,
    "spamFolderAgeLimit": 30,
    "spamFolderNumLimit": 0,
    "spamForwardingAddress": "",
    "spamHandling": "toFolder"
  }
}

Rackspace Email

Previous Page

Radio Browser

Next Page

On this page

TriggersNew Rackspace mailboxActionsAdd to a mailbox's blocked or safe sendersBlock a mailboxCreate a mailboxDelete a mailboxFind a mailbox by custom IDGet a domainGet a mailboxGet mailbox spam settingsList a mailbox's blocked or safe sendersList domainsList inactive mailboxesList mailboxesOffboard a mailboxOnboard a new mailboxRemove from a mailbox's blocked or safe sendersRename a mailboxReplace a mailbox's blocked or safe sendersReset a mailbox passwordRestore a mailboxSet a mailbox auto-replySet mailbox forwardingUnblock a mailboxUpdate a mailboxUpdate mailbox spam settings