#Mailspring config.json location code

The following HTTP codes are available to override: Status Code See the example configuration file for usage examples. The responseOverrides section provides an opportunity to define a custom response when the server would otherwise return an error code. Headers in API responses are preserved and returned to the client. Global headers do not affect API responses. filterĪny other file outside the /images or /css folders

#Mailspring config.json location full

To define an exact route, place the full path of the file in the route property. The route property can be an exact route or a wildcard pattern. Redirect, headers, statusCode (modifies response) Process after a rule is matched and authorized

Individual users are associated to roles through invitations.Įach property has a specific purpose in the request/response pipeline.

If a user is in any of the listed roles, then access is granted.

Users must belong to at least one role.

The built-in role, authenticated, applies to any logged-in user.

The built-in role, anonymous, applies to all users.

Valid characters include a-z, A-Z, 0-9, and _.

To remove a header, set the value to an empty string.ĭefines an array of role names required to access a route.

Route-specific headers override globalHeaders when the route-specific header is the same as the global header is in the response.

Set of HTTP headers added to the response.

Default response code is a 302 (temporary redirect), but you can override with a 301 (permanent redirect).

Redirect rules change the browser's location.

Is mutually exclusive to a rewrite rule.

Values must be relative to the root of the app.ĭefines the file or path redirect destination for a request.

Rewrite rules don't change the browser's location.

Is mutually exclusive to a redirect rule.

Available methods include: GET, HEAD, POST, PUT, DELETE, CONNECT, OPTIONS, TRACE, and PATCH.ĭefines the file or path returned from the request.

For instance, the route /admin* matches any route beginning with /admin.ĭefines an array of request methods which match a route.

Wildcards are supported at the end of route paths.

The route pattern requested by the caller. Only the route and methods (if specified) properties are used to determine whether a rule matches a request. Route rules are defined in the routes array. Defining routesĮach rule is composed of a route pattern, along with one or more of the optional rule properties. Make sure to read the authentication and authorization guide along with this article. The routing concerns significantly overlap with authentication (identifying the user) and authorization (assigning abilities to the user) concepts. A match occurs when the route property and a value in the methods array (if specified) match the request.

Rule evaluation stops at the first match.

Rules are evaluated in the order as they appear in the routes array.

Rules are defined in the routes array, even if you only have one route.

Routes are defined as an array of routing rules. Route rules allow you to restrict access to users in specific roles or perform actions such as redirect or rewrite. You can define rules for one or more routes in your static web app. The deprecated routes.json file is ignored if a exists.