be Smart.
be Secure.
Phone: 800-441-6612

Application Programming Interface (API)

What is LuxSci's API?

LuxSci's application programming interface allows you, the account administrator, to write programs or scripts, residing anywhere on the Internet, which can perform account administration tasks such as updating, creating, and querying users.

There are two levels of the API: "Account" for performing administrative tasks, and "User" for accessing user-level settings and data. API access is available upon request for no additional charge — simply ask our support staff to enable your account for access if you are interested.

REST: LuxSci's API is REST-based and uses JSON for data transport.

LuxSci API Documentation

Download the following PDFs of the LuxSci API documentation to learn how it works in detail.

What can I do with the Account-Level API?

You can employ the Account API to perform the following functions:

  • Create new users
  • Enable, disable, and delete users
  • Change users' individual disk space limits
  • Copy WebMail preferences from one user to another
  • Add and remove services such as POP, IMAP, SMTP, and Spam/Virus Filtering to/from users
  • Set and remove various "flags" from users which determine things such as if the user must change his/her password on next login.
  • Download user reports including contact information, last login date and time, services accessible, and much more.
  • Create new domains in your account
  • Delete domains from your account
  • Update domain properties and catch-all email aliases.
  • Get a report summarizing the status of all of the domains in your account.
  • Create, update, and delete email aliases in your domains
  • Reporting
    • Request a report summarizing the status of all email aliases, user email forwarding rules, and catchall aliases in your domains.
    • Query messages sent by account users
    • Query delivery status of messages sent
    • Query feed-back loop responses resulting from messages sent
    • Query SMTP email sending failures, login failures, and rejections
  • Manage SecureForm Data
    • Get information about your SecureForm configurations
    • Query and Download rows and files of SecureForm data saved in a database
    • Delete rows and files from SecureForm data saved in a database
    • Synchronize your SecureForm post data database with your external systems.
  • Manage SecureSend NameSpaces
    • List SecureSend users in a NameSpace
    • Create and update users
    • Change user passwords
    • Single Sign-On: Create temporary links to automatic login to SecureSend user accounts.

Uses for LuxSci's Account API

You can employ the API to:

  • Perform bulk domain, user, and/or email alias creation or deletion.
  • Perform bulk or automatic updates to users.
  • Synchronize passwords between LuxSci and your own web site or external database.
  • Create your own web page on your web site that will handle the signup of new users and which will use the API to automatically create these new users in your LuxSci account.
  • Retrieve reports on users, domains, and aliases for arbitrary analysis on your side.

If you have any questions about LuxSci's Account API please contact our support staff.

What can I do with the User-Level API?

The User-Level API enables full access to WebAides (Calendars, Tasks, Address Books, Notes, and Links).

You can employ the User API to perform the following functions:

  • Get Single Sign-On login links
  • Get and update user contact information
  • Change user passwords
  • Retrieve selected user preferences (e.g. preferred time zone)
  • Email
    • Send secure email messages using SecureLine
    • Send SecureText messages
    • Query to see if specific domains properly support TLS for email transport encryption
    • Change user email forwarding settings
    • Query, create, and delete user auto-responders
  • WebAides (Address Books, Calendars, Tasks, Notes)
    • Create and Delete WebAides
    • Retrieve information about entries individually, and in bulk
    • Update entries individually and in bulk
    • Add entries individually and in bulk
    • Delete entries individually and in bulk
    • Download, add, and update SecureLine information for address book recipients -- Escrow questions and answers, PGP certificates, and S/MIME certificates.
  • Reporting
    • Query messages sent by a specific user
    • Query delivery status of messages sent
    • Query feed-back loop responses resulting from messages sent
    • Query SMTP email sending failures, login failures, and rejections
  • Retrieve user-specific Private Labeled Theme information such as:
    • WebMail company name and URL
    • Names of the POP, IMAP, SMTP, and FTP servers the user should use
    • Names and email addresses of the administrative and technical support contacts for WebMail

Access to user-level commands can be enabled to work with or without knowing the passwords for the users in your account -- depending on the needs and trust-level of your API client application.

If you have any questions about LuxSci's User API please contact our support staff.

Starting at $10/mo
Sign Up

"Your standard and HIPAA-compliant hosting services are awesome, working exactly like we envisioned. Pricing is very fair and support has been wonderful! Would definitely recommend you."

—Jeff Deitch, President, InfoWerks Data Services, Incorporated, Pharmacy Data Security and Retention

TRUSTe Privacy Certification Refund Policy Thawte Extended Validation SSL Certificate
McAfee Secure TRUSTe Privacy Certification Thawte Extended Validation SSL Certificate Refund Policy
• Access Anywhere
• Fast and Robust
• Super Secure
• Tons of Features
• Customizable
• Mobile Friendly

Send and receive email from your favorite programs, including:

 Microsoft Outlook
 Mozilla Thunderbird
 Apple Mail
 Windows Mail

... Virtually any program that supports POP, IMAP, or SMTP

Keep your email, contacts, and calendars in sync:

 Apple iPhone and iPad
 Android Devices
 Windows Phone

... Any device with Exchange ActiveSync (EAS) support

Relay your server's mail through LuxSci via smarthost:

• Resolve issues with ISP sending limits and restrictions
• Improve deliverability with better IP reputation and IP masking
• Take advantage of Email Archival and HIPAA Compliance
• Even setup smarthosting from Google Apps!

Free web site hosting with any email account:

• Start with up to 10 web sites and MySQL databases
• DNS services for one domain included
• Tons of features and fully HIPAA capable

LuxSci's focus on security and privacy:

• Read The Case for Email Security
• Read Mitigating Security & Privacy Threats
• Review our Privacy Policy

The most accurate, flexible, and trusted filters in the business:

• Premium protection with Intel Security Saas
• Realtime virus database guards against the latest threats
• Seven-day quarantine lets you put eyes on every filtered email
• Supplement with our Basic Spam Filter for even more features

End-to-end secure email encryption — to anyone, from anyone:

• No setup required — encryption is automatic and easy to use
• Secure outbound email with TLS, PGP, S/MIME, or Escrow
• Free inbound encryption via our SecureSend portal
• Independent of your recipient's level of email security
• Widely compatible and fully HIPAA Compliant

Add an extra layer of security with an SSL Certificate:

• Secure your web site
• Debrand LuxSci WebMail with your own secure domain
• Access secure email services via your own secure domain

Encrypt your service traffic via secure tunnel:

• Add another layer of security to your SSL connections
• WebMail, POP, IMAP, SMTP, web/database access
• SecureForm posts, SecureLine Escrow, SecureSend access
• Restrict your account to VPN access only

Secure long-term message archival:

• Immutable, tamperproof email retention with audit trails
• No system requirements — minimal setup, even less upkeep
• Realtime archival of all inbound and outbound messages
• Works anywhere — even with non-LuxSci email hosting

Free data backups included with all email hosting accounts:

• Automatic backups of all email, WebAides, web/database data
• Seven daily backups and up to four weekly backups
• Unlimited restores included at no additional cost
• Custom backup schedules for dedicated servers

Automate your email management:

• Save messages to specific folders or to LuxSci WebAides
• Advanced text scanning with regular expressions
• Tag messages, alter subject lines, or add custom headers
• Filter by message charset, type, TLS status, DKIM status
• Chain filters together for even more complex actions

• Bulk add and edit users, aliases and more
• Control sharing and access globally or on a granular level
• Delegate user roles through permissions
• Configure account-wide taglines, sending restrictions, and more
• Remotely administer account via SOAP API

Share, collaborate, organize, synchronize:

• Calendars, Contacts, Documents, Notes, Widgets, Workspaces
• Fine-grained access control and security
• Access anywhere via secure web portal or smartphone
• Save over solutions like Microsoft Exchange

Free folder sharing for all email hosting accounts:

• Share mail folders with other users in your account
• Subscribe to only the folders you want to see
• Set read-only or read-write access control
• View all personal and shared folders via unified web interface

Color code and label your email messages:

• Define and assign multiple IMAP keywords to each message
• Filter, search, and sort by tags
• Compatible and synchronizes with any IMAP email client
• Also usable with WebAide entries