https://github.com/nodejs/email

MX server management for iojs.org (and eventually nodejs.org)
https://github.com/nodejs/email

node nodejs

Last synced: 2 days ago
JSON representation

MX server management for iojs.org (and eventually nodejs.org)

• Host: GitHub
• URL: https://github.com/nodejs/email
• Owner: nodejs
• License: mit
• Created: 2015-06-03T04:51:11.000Z (over 9 years ago)
• Default Branch: main
• Last Pushed: 2024-08-09T13:50:15.000Z (5 months ago)
• Last Synced: 2024-10-29T17:21:41.778Z (2 months ago)
• Topics: node, nodejs
• Language: JavaScript
• Homepage:
• Size: 184 KB
• Stars: 61
• Watchers: 39
• Forks: 78
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome - nodejs/email - MX server management for iojs.org (and eventually nodejs.org) (nodejs)

README

        
# nodejs/email

**MX server management for iojs.org**

## Server

[Mailgun](http://www.mailgun.com/) is used to route email from the `iojs.org` domain to the aliases described in this repo.

## Email aliases

The [iojs.org](./iojs.org) directory contains the [aliases.json](./iojs.org/aliases.json) file which describes the wanted email aliasing. It is structured as a mapping of `"from"` usernames @iojs.org to `"to"` actual email addresses.

## Updating

### Responsibility

Since access to the Mailgun API key is required, only members of the @nodejs/build-infra team have the permission to push code to the `main` branch. That was done in order to minimize the possibility of mismatches between the information in this repo, and the actual email routes that are set up.

### Procedure

The [update](./update) directory contains a node program which will read the aliases mapping file, fetch the list of mail routes from Mailgun and update the routes to make sure they match the required state. The program is run by passing it a domain name as an argument (`update/update.js iojs.org`).

The Mailgun API key for the given domain is required. It can be found in the `admin_logins.md` file in the secrets repo (build/infra/), or directly via the Rackspace API. The key should be stored as a file named `iojs.org/credentials.json` in the form: `{ "api-key": "key-abc..." }` within a code tree.

The programs can be used with `--dry-run` to verify the current status and what will be changed by an update.

## nodejs.org

`@nodejs.org` email addresses are managed by the Linux Foundation. In order to set one up:

* Create an iojs.org alias with associated recipients as described above.

* Send an email to '[email protected]' requesting that the wanted nodejs.org address by directed to the new alias. Please CC an OpenJS Foundation contact person and provide context as to why the alias is needed.

## License & copyright

The contents of this repository are Copyright (c) Node.js Foundation and licensed under the MIT licence. All rights not explicitly granted in the MIT license are reserved. See the included LICENSE.md file for more details.