Skip to content

Latest commit

 

History

History
28 lines (22 loc) · 986 Bytes

GLOSSARY.md

File metadata and controls

28 lines (22 loc) · 986 Bytes

mail-parser-api

Stateless HTTP service that turns a raw email into the JSON produced by mail-parser, without storing anything.

Language

Raw email: The bytes of an email exactly as received, in RFC 822 / RFC 5322 format, sent as the request body with Content-Type: message/rfc822. Avoid: EML, message body, input

Parsed message: The mail_json that mail-parser produces for one raw email, returned under message with the payload key removed from every attachment. Avoid: Result, report, analysis

Parse service: This API: it receives a raw email, runs the mail-parser CLI on it in a subprocess, and returns the parsed message. It keeps no state except the rate limiter's counters. Avoid: Backend, parser server, worker

Client key: The identity the rate limiter counts requests against: the first X-Forwarded-For value or the peer address, an IPv4 address whole or an IPv6 address collapsed to its /64 network. Avoid: Client IP, user, session