Service: Roundcube Webmail - EyevinnOSC/community GitHub Wiki

Roundcube Webmail

Roundcube Webmail (serviceId roundcube-roundcubemail) is a browser-based, multilingual IMAP client that you can connect to any IMAP/SMTP compatible mail service, including your own hosted service. In Eyevinn Open Source Cloud (OSC) it is a long-running service instance with up to 10 GiB of storage per instance. License: GPL-3.0.

What it can do

  • Give users a browser-based mail client (read and compose mail) for an IMAP/SMTP mail service.
  • Work with the mail service provided by OSC or any other IMAP/SMTP service.
  • Be shared by URL with others who have accounts on the configured mail service.
  • Offer customizable skins and plugin support (Roundcube features).

Creating an instance

You need IMAP and SMTP access to a mail service. To use the mail service provided by OSC, create a workspace mailbox, see Team Email. Mailboxes are available on Personal plans and above (Personal, Professional, Business, Enterprise and Reseller). Roundcube has no dependencies on other OSC services.

Create the instance with create-service-instance using serviceId: "roundcube-roundcubemail". The instance name must be alphanumeric and at most 20 characters. Example for the OSC mail service:

{
  "name": "guide",
  "ImapAddress": "ssl://mail.osaas.io",
  "ImapPort": "993",
  "SmtpAddress": "tls://mail.osaas.io",
  "SmtpPort": "587"
}

Wait with wait-for-service-ready or get-instance-status, then read the URL with describe-service-instance.

Options

Option Required Type Meaning
name Yes string Name of the instance. Letters, digits and underscore only; on OSC at most 20 characters.
ImapAddress Yes string IMAP server address, optionally with a protocol prefix for encrypted connections, for example ssl://mail.osaas.io. Maps to Roundcube's IMAP default host setting.
ImapPort Yes string IMAP server port. Default 993; common values are 143 (standard IMAP) and 993 (IMAPS).
SmtpAddress Yes string SMTP server address, optionally with a protocol prefix, for example tls://mail.osaas.io. Maps to Roundcube's SMTP server setting.
SmtpPort Yes string SMTP server port. Default 587; common values are 25 (unencrypted), 587 (STARTTLS submission) and 465 (SSL/TLS).

None of the options are secrets: mail credentials are entered by each user when logging in.

Using the instance

Open the instance URL and log in with the credentials for your email account on the configured mail service.

You can share the instance URL with others that have accounts on the same mail service to give them a browser-based mail client.

Limitations

  • Storage is limited to 10 GiB per instance.

Resources