The MailArchiva server offers a REST web services API. The API enables programmatic access to many of the product's features; including: conducting searches, retrieving and inserting data, traversing folder structures, sending data, managing tags and legal holds.
Login to the MailArchiva web console as admin. From Configuration->Logins, check Allow Api access, and click the Re-generate button to generate an API key. Take note of the curl command to perform a basic search via the REST API.
Once the server is installed, visit https://localhost:8090/api-docs for further instructions on how to use the API. Alternatively, visit https://demo.mailarchiva.com/api-docs to see the MailArchiva Demo Api docs.
WARNING! To protect against network sniffing, ensure that the console is secured by HTTPS.
When authenticating, if three consecutive password attempts are supplied, the server will reject all authentication attempts for the same user for a long time period.
Furthermore, on each wrong attempt, the server will pause for at least twenty seconds.
Search queries are specified in the same syntax as accepted by the MailArchiva search interface. For example, the query "subject:membership" would return all emails with the value "membership" in the subject field. For a complete description of fields that can be used in a search query, refer to Search Fields. The query syntax is in line with the Lucene Query Parser Syntax.
Search queries filter out the desired set of emails (or blobs) to be included in the search result. XPath queries, however, may be used to traverse actual blob objects and inspect their properties. Internally, MailArchiva uses Commons JXPath to provide the means to traverse the characteristics of a blob.
The REST API parses dates (such as before and after params in search query) in accordance with RFC 2616 Section 3.3.1. The date should be in one of the following formats (the first one being the most relevant).
Sun, 06 Nov 1994 08:49:37 GMT ; RFC 822, updated by RFC 1123 Sunday, 06-Nov-94 08:49:37 GMT ; RFC 850, obsoleted by RFC 1036 Sun Nov 6 08:49:37 1994 ; ANSI C's asctime() format
All blob types share the properties listed below.
The BlobID is used for looking up blobs in the store.
Email Properties (In Addition To Above)
In addition to the common properties above, the email blob type offers the following additional properties:
For convenience, each newly minted MailArchiva distribution includes a Swagger definition for MailArchiva's REST API. The Swagger definition specified in the swagger.json file, may be used to generate a binding in your programming language of choice and is dynamically updated as part of MailArchiva's build process. For example, to generate a Python client stub, upload the JSON file into the Swagger Editor, then click Generate Client and choose Python as the language.
C:\Program Data\MaiLArchiva\server\ws/swagger.json (Windows)
"host""host": : "mailarchiva.company.local""mailarchiva.company.local",,
Found this information useful? Visit mailarchiva.com to learn more about MailArchiva.