From Wikitech
Jump to navigation Jump to search


This page covers using sending email to users, tools, and from the grid.

Please note that Toolforge emails servers enforce ratelimits per email address.

Mail to users

Mail sent to (where user is a shell account) will be forwarded to the email address that user has set in their Wikitech preferences if it has been verified (the same as the 'Email this user' function on wikitech).

Any existing .forward in the user's home will be ignored.

Mail to a Tool

Mail can also be sent "to a tool" with:

Where "anything" is an arbitrary alphanumeric string. Mail will be forwarded to the first of:

  • The email addresses listed in the tool's $HOME/.forward.anything, if present;
  • The email addresses listed in the tool's $HOME/.forward, if present; or
  • The email addresses of the tool's maintainers.

Additionally, is an alias pointing to mostly useful for automated email generating from within Cloud VPS.

$HOME/.forward and $HOME/.forward.anything need to be readable by the user Debian-exim; to achieve that, you probably need to explicitly make the file world readable with a shell command like chmod o+r $HOME/.forward*.

All of these addresses can also be used via the legacy domain

Prior to early 2019 it was also possible to use a .forward file to configure automatic processing of in-bound email messages by a grid job. This feature was removed as it was not used by many tools and complicated the maintenance of Toolforge. Similar functionality can be achieved by routing inbound emails to an account on an external mail host with IMAP or POP support and polling for new messages from a cron job or long running process.

Mail from Tools

Sending via SMTP

The SMTP protocol can be used to send outbound emails from a tool running on either Kubernetes or the job grid. The service name is used as the public mail exchange (MX) host for inbound SMTP messages to the (and the old domain) domain and points to a server that can process both inbound and outbound email for Toolforge.

Containers running on the Toolforge Kubernetes cluster do not install and configure a local mailer service like the exim service that is installed on grid engine nodes. Tools running in Kubernetes should instead send email using an external SMTP server. The service name should be used as the target SMTP server.

You should use an email address controlled by your tool as the From: address for outgoing email.

Sending via the command line

The job grid hosts in Toolforge install and configure a local mailer service (currently Exim) which can be used to send outgoing email messages. This feature is not available inside Kubernetes containers.

The Toolforge Grid Engine is deprecated and planned to be shut down in early 2024. You should migrate any tools still running on the Grid Engine to newer runtimes. For details, see News/Toolforge Grid Engine deprecation.

See also

Communication and support

Support and administration of the WMCS resources is provided by the Wikimedia Foundation Cloud Services team and Wikimedia movement volunteers. Please reach out with questions and join the conversation:

Discuss and receive general support
Stay aware of critical changes and plans
Track work tasks and report bugs

Use a subproject of the #Cloud-Services Phabricator project to track confirmed bug reports and feature requests about the Cloud Services infrastructure itself

Read stories and WMCS blog posts

Read the Cloud Services Blog (for the broader Wikimedia movement, see the Wikimedia Technical Blog)