Distributed James Server — Mailets

This mailet adds the de-facto standard QMail Delivered-To header.

Upon processing by LocalDelivery, a Delivered-To header matching the recipient mail address will be added before storage.

Example

Takes the message and attaches a footer message to it. Right now, it only supports simple messages. Needs to have additions to make it support messages with alternate content types or with attachments.

Add an prefix (tag) to the subject of a message <br>

Sample Configuration:

This mailet forwards the attributes values to a AMPQ.

It takes 4 parameters:

This mailet will sent the data attached to the mail as an attribute holding a map.

Generates a response to the reverse-path address. Note that this is different than a mail-client’s reply, which would use the Reply-To or From header.

Bounced messages are attached in their entirety (headers and content) and the resulting MIME part type is "message/rfc822".

The reverse-path and the Return-Path header of the response is set to "null" ("<>"), meaning that no reply should be sent.

A sender of the notification message can optionally be specified. If one is not specified, the postmaster’s address will be used.

A notice text can be specified, and in such case will be inserted into the notification inline text.

If the notified message has an "error message" set, it will be inserted into the notification inline text. If the attachError init parameter is set to true, such error message will be attached to the notification message.

Supports the passThrough init parameter (true if missing).

Sample configuration:

The behaviour of this mailet is equivalent to using Resend with the following configuration:

notice and sendingAddress can be used instead of message and sender; such names are kept for backward compatibility.

Collects the sender and the recipients of a message and store them as JSON in a specified message attribute.

Here is the JSON format:

Sample configuration:

Make sure the message stream is 7bit. Every 8bit part is encoded to quoted-printable or base64 and the message is saved.

This mailet sign a message using the DKIM protocol If the privateKey is encoded using a password then you can pass the password as privateKeyPassword parameter.

Sample configuration with inlined private key:

Sample configuration with file-provided private key:

By default the mailet assume that Javamail will convert LF to CRLF when sending so will compute the hash using converted newlines. If you don’t want this behaviour then set forceCRLF attribute to false.

This mailet verify a message using the DKIM protocol

Sample configuration:

By default the mailet assume that Javamail will use LF instead of CRLF so it will verify the hash using converted newlines. If you don’t want this behaviour then set forceCRLF attribute to false.

Generates a Delivery Status Notification (DSN) Note that this is different than a mail-client’s reply, which would use the Reply-To or From header.

Bounced messages are attached in their entirety (headers and content) and the resulting MIME part type is "message/rfc822".

The reverse-path and the Return-Path header of the response is set to "null" ("<>"), meaning that no reply should be sent.

A sender of the notification message can optionally be specified. If one is not specified, the postmaster’s address will be used.

Supports the <code>passThrough</code> init parameter (true if missing).

Sample configuration:

Sanitizes or adds an expiration date to a message, in the form of an Expires header (RFC 4021).

The mailet can force an existing expiration date to be within the bounds given by minAge, maxAge, or both. minAge specifies the minimum time the date must lie in the future, while maxAge specifies a maximum.

If a message has no expiration date, the mailet can add one according to the optional defaultAge parameter.

All parameter values should be expressed in the following format: Nunit. N should be positive. unit could be either in the short form (h, d, w, y etc.), or in the long form (hours, days`, weeks, months, years). The default unit is days.

Sample configuration:

By itself the Expires header is informational only. But some variants of James will let you delete expired messages through the WebAdmin interface:

This mailet handles MDN messages and define a header X-JAMES-MDN-JMAP-MESSAGE-ID referencing the original message (by its Jmap Id) asking for the recipient to send an MDN.

Replaces incoming recipients with those specified, and resends the message unaltered.

Can be totally replaced by an equivalent usage of {@link Resend} (see below), simply replacing <forwardto> with <recipients>.

Sample configuration:

The behaviour of this mailet is equivalent to using Resend with the following configuration:

forwardto can be used instead of forwardTo; such name is kept for backward compatibility.

This mailet can be combined with the Strip attachment mailet.

The ICS body part byte array is arranged as map then this mailet should look for ICS and parse it with Ical4J then store it as a mail attribute

Configuration: The mailet contains 2 mandatory attributes

ICALToHeader takes a Map of filenames to ICAL4J calendars, will pick the first Calendar, and add it to the headers of the e-mail.

The following headers will be added : X_MEETING_UID, X_MEETING_METHOD, X_MEETING_RECURRENCE_ID, X_MEETING_SEQUENCE, X_MEETING_DTSTAMP

The only configuration parameter for this mailet is the attribute the ICAL4J Calendar map should be attached to, named attribute.

Configuration example :

ICALToJsonAttribute takes a map of ICAL4J objects attached as attribute, and output the map of corresponding json bytes as an other attribute, with unique String keys.

The JSON contains the following fields :

Example are included in test call ICalToJsonAttributeTest.

Configuration example :

Some senders embed 'text/calendar' content as part of Mime bodypart headers with an empty body.

This mailet duplicate the 'text/calendar' content to the Mime body part.

Example configuration:

Receives a Mail from the Queue and takes care of delivery of the message to local inboxes.

Logs Message Headers and/or Body. If the "passThrough" in confs is true the mail will be left untouched in the pipe. If false will be destroyed. Default is true.

Convert attributes of type Collection<String> to headers

Sample configuration:

Convert attributes of type Collection<String> to headers

Sample configuration:

This Metrics mailet increments a counter on every incoming emails.

This counter is accessible via JMX, or grafana. Read more about metrics.

Example :

Will increment a counter relayDenied

This mailet replace the mail attribute map of key to MimePart by a map of key to the MimePart content (as bytes).

It takes only one parameter:

Then all this map attribute values will be replaced by their content.

Sends a notification message to the Postmaster.

A sender of the notification message can optionally be specified. If one is not specified, the postmaster’s address will be used.

The "To:" header of the notification message can be set to "unaltered"; if missing will be set to the postmaster.

A notice text can be specified, and in such case will be inserted into the notification inline text.

If the notified message has an "error message" set, it will be inserted into the notification inline text. If the attachError init parameter is set to true, such error message will be attached to the notification message.

The notified messages are attached in their entirety (headers and content) and the resulting MIME part type is "message/rfc822".

Supports the passThrough init parameter (true if missing).

Sample configuration:

The behaviour of this mailet is equivalent to using Resend with the following configuration:

notice, sendingAddress and attachError can be used instead of message, sender and attachError; such names are kept for backward compatibility.

Sends a notification message to the sender of a message.

A sender of the notification message can optionally be specified. If one is not specified, the postmaster’s address will be used.

The "To:" header of the notification message can be set to "unaltered"; if missing will be set to the sender of the notified message.

A notice text can be specified, and in such case will be inserted into the notification inline text.

If the notified message has an "error message" set, it will be inserted into the notification inline text. If the attachError init parameter is set to true, such error message will be attached to the notification message.

The notified messages are attached in their entirety (headers and content) and the resulting MIME part type is "message/rfc822".

Supports the passThrough init parameter (true if missing).

Sample configuration:

The behaviour of this mailet is equivalent to using Resend with the following configuration:

notice, sendingAddress and attachError can be used instead of message, sender and attachError; such names are kept for backward compatibility.

Simplest Mailet which destroys any incoming messages by setting their state to GHOST.

This effectively stops all processing of this mail.

Rewrites recipient addresses to make sure email for the postmaster is always handled. This mailet is silently inserted at the top of the root spool processor. All recipients mapped to postmaster@<servernames> are changed to the postmaster account as specified in the server conf.

Process messages and randomly assign them to 4 to 8 mailboxes.

Mailet which should get used when using RecipientRewriteTable-Store to implementations for mappings of forwards and aliases.

By specifying an 'errorProcessor' you can specify your logic upon RecipientRewriteTable failures.

Example:

The rewriteSenderUponForward option (default to true) can be used to prevent senders to be rewritten upon forwards in the transport envelope (JAMES 3.8.0 default behaviour). WARNING: Please note that not rewriting the sender will cause issues forwarding emails from external senders to external addresses as the DKIM and SPF records will not be matching the ones of the sending domain.

The forwardAutoSubmittedEmails option (default to false) can be used to prevent forwarding bounces as such a scenario can lead to an infinite loop if the forward recipient bounces the email.

GenericMailet which convert all Recipients to lowercase.

A mailet providing configurable redirection services.

Can produce listserver, forward and notify behaviour, with the original message intact, attached, appended or left out altogether.

It differs from Resend because (i) some defaults are different, notably for the following parameters: <recipients>, <to>, <reversePath> and <inline>; (ii) because it allows the use of the <static> parameter;.

Use <code>Resend</code> if you need full control, <code>Redirect</code> if the more automatic behaviour of some parameters is appropriate.

This built in functionality is controlled by the configuration as laid out below. In the table please note that the parameters controlling message headers accept the <b>"unaltered"</b> value, whose meaning is to keep the associated header unchanged and, unless stated differently, corresponds to the assumed default if the parameter is missing.

The configuration parameters are:

Example:

and:

replyto can be used instead of replyTo; such name is kept for backward compatibility.

The RemoteDelivery mailet delivers messages to a remote SMTP server able to deliver or forward messages to their final destination.

The remote SMTP server through which each mail is delivered is resolved using MX lookup for each message destination unless the <gateway/> parameter is set. The <gateway/> parameter enables the definition of one or more gateway servers through which all messages are sent.

If an attempt to deliver a message fails, a redelivery attempt is scheduled according to the scheme defined by the <delayTime/> parameter, retrying up to the limit defined by the <maxRetries/> parameter. When the retry limit is exceeded, delivery failure is processed according to the setting of the <bounceProcessor/> parameter.

These are the parameters that control the operation of the RemoteDelivery mailet:

Default is one attempt after 6 hours, which if explicitly declared would be written as <delayTime>1 6 hour</delayTime>

When using bounceProcessor or onSuccess processors, take special care of error handling (see onMailetException and onMatcherException) to avoid confusing situations. Also remember that on partial delivery, both processors will be used: onSuccess with successfull recipients, and bounceProcessor with failed recipients.

This mailet sets removes all attributes set on the Mail instance

Sample configuration:

This mailet sets attributes on the Mail.

Sample configuration:

Remove mime headers from the message (global) and per recipient (specific).

Sample configuration:

This mailet removes all of the headers starting with a given prefix in the message (global) and per recipient (specific).

Sample configuration:

Replace text contents

This mailet allow to specific regular expression to replace text in subject and content.

Each expression is defined as: /REGEX_PATTERN/SUBSTITUTION_PATTERN/FLAGS/

To identify subject and body pattern we use the tags <subjectPattern> and <bodyPattern>

Rules can be specified in external files. Lines must be CRLF terminated and lines starting with # are considered comments. Tags used to include external files are <subjectPatternFile> and <bodyPatternFile> If file path starts with # then the file is loaded as a resource.

Use of both files and direct patterns at the same time is allowed.

This mailet allow also to enforce the resulting charset for messages processed, when a replacement has been done. To do that the tag <charset> must be specified.

NOTE: Regexp rules must be escaped by regexp escaping rules and applying this 2 additional rules:

A mailet providing configurable redirection services.

Can produce listserver, forward and notify behaviour, with the original message intact, attached, appended or left out altogether. Can be used as a replacement to {@link Redirect}, having more consistent defaults, and new options available.

Use <code>Resend</code> if you need full control, <code>Redirect</code> if the more automatic behaviour of some parameters is appropriate.

This built in functionality is controlled by the configuration as laid out below. In the table please note that the parameters controlling message headers accept the <b>"unaltered"</b> value, whose meaning is to keep the associated header unchanged and, unless stated differently, corresponds to the assumed default if the parameter is missing.

The configuration parameters are:

Example:

and:

The following example forwards the message without any modification, based on the defaults:

replyto can be used instead of replyTo; such name is kept for backward compatibility.

This mailet sets attributes on the Mail.

Sample configuration:

Adds a specified header and value to the message.

Sample configuration:

Execute Sieve scripts for incoming emails, and set the result of the execution as attributes of the mail

Puts a server-side SMIME signature on a message.

It is a concrete subclass of Sign, with very few modifications to it, to specialize for SMIME.

Handles the following init parameters:

Verifies the s/mime signature of a message. The s/mime signing ensure that the private key owner is the real sender of the message. To be checked by this mailet the s/mime signature must contain the actual signature, the signer’s certificate and optionally a set of certificate that can be used to create a chain of trust that starts from the signer’s certificate and leads to a known trusted certificate.

This check is composed by two steps: firstly it’s ensured that the signature is valid, then it’s checked if a chain of trust starting from the signer certificate and that leads to a trusted certificate can be created. The first check verifies that the message has not been modified after the signature was put and that the signer’s certificate was valid at the time of the signing. The latter should ensure that the signer is who he declare to be.

The results of the checks perfomed by this mailet are wrote as a mail attribute which default name is org.apache.james.SMIMECheckSignature (it can be changed using the mailet parameter mailAttribute). After the check this attribute will contain a list of SMIMESignerInfo object, one for each message’s signer. These objects contain the signer’s certificate and the trust path.

Optionally, specifying the parameter strip, the signature of the message can be stripped after the check. The message will become a standard message without an attached s/mime signature.

The configuration parameter of this mailet are summerized below. The firsts defines the location, the format and the password of the keystore containing the certificates that are considered trusted. Note: only the trusted certificate entries are read, the key ones are not.

If fileType is "keystore". The following configuration parameters would be used:

If fileType is "pem". The following configuration parameters would be used:

Other parameters configure the behavior of the mailet:

This mailet decrypts a s/mime encrypted message. It takes as input an encrypted message and it tries to dechiper it using the key specified in its configuration. If the decryption is successful the mail will be changed and it will contain the decrypted message. The mail attribute org.apache.james.SMIMEDecrypt will contain the public certificate of the key used in the process.

The configuration parameters of this mailet are summarized below. The firsts define the keystore where the key that will be used to decrypt messages is saved.

The other parameters define which private key have to be used. (if the store contains more than one key).

Puts a server-side signature on a message.

It is a concrete subclass of AbstractSign, with very few modifications to it.

A text file with an explanation text is attached to the original message, and the resulting message with all its attachments is signed.

The kind of signature depends on the value of the <keyHolderClass> init parameter.

Handles the following init parameters:

Sends the message through daemonized SpamAssassin (spamd), visit spamassassin.apache.org for info on configuration. The header X-Spam-Status is added to every message, this contains the score and the threshold score for spam (usually 5.0). If the message exceeds the threshold, the header X-Spam-Flag will be added with the value of YES. The default host for spamd is localhost and the default port is 783.

Sample Configuration:

Remove attachments from a Message. Supports simple removal, storing to file, or storing to mail attributes.

Configuration:

At least one of pattern, notpattern and mimeType is required.

This mailet converts Content-Type of MimeMessage from text/calendar to mulitpart/mixed

The BodyPart should be retrieved from content of text/calendar with all the same "Content-*" headers from original message and those "Content-" header are removed from original message

It does not takes any parameter

Sample configuration:

This mailet redirects the mail to the named processor

Sample configuration:

Stores incoming Mail in the specified Repository.

If the "passThrough" in conf is true the mail will be returned untouched in the pipe and may be processed by additional mailets. If false will be destroyed.

Stores incoming Mail in a repository defined by the sender’s domain.<br>

Supported configuration parameters:

Example:

This mailet uses JMAP VacationResponse and sends back a vacation notice to the sender if needed.

This mailet sets the priority of the incoming mail.

Example configuration:

WithStorageDirective position storage directive for the recipients of this email.

These directives are used by <strong>LocalDelivery</strong> mailet when adding the email to the recipients mailboxes.

The following storage directives can be set:

Example:

Alternatively, several target folders can be specified:

Does an antivirus scan check using a ClamAV daemon (CLAMD)

Interacts directly with the daemon using the "stream" method, which should have the lowest possible overhead.

The CLAMD daemon will typically reside on localhost, but could reside on a different host. It may also consist on a set of multiple daemons, each residing on a different server and on different IP number. In such case a DNS host name with multiple IP addresses (round-robin load sharing) is supported by the mailet (but on the same port number).

Handles the following init parameters:

The actions performed are as follows:

Some notes regarding clamav.conf :

Here follows an example of config.xml definitions deploying CLAMD on localhost, and handling the infected messages:

Assesses the message to determine if it was a hard or soft bounce, and if it was a soft bounce, something of its nature..

Sample configuration:

Re-spools Mail found in the specified Repository.

Serialise the email and pass it to an HTTP call

Sample configuration:

Keep only the text part of a message.

If the message is text only then it doesn’t touch it, if it is a multipart it transform it a in plain text message with the first text part found.

Each user can manage his SIEVE scripts through the ManageSieveMailet mailet.

To use the manage SIEVE mailet :

To activate a script for a user, you need the following combination :

This mailet takes an attachment stored in an attribute and attach it back to the message

This may be used to place back attachment stripped by StripAttachment and stored in the attribute org.apache.james.mailet.standard.mailets.StripAttachment.saved

Serialise the email and pass it to an HTTP call

Sample configuration:

Returns the current time for the mail server.

Sample configuration:

Check the ip, sender, helo against SPF. Add the following attributes to the mail object:

Sample configuration:

This mailet converts HTML parts of a message into Plain text.

It starts looking for multipart/alternative containing a text/plain and a text/html part and only keep the text/plain part. Then in a second pass replaces remaining text/html by their textual content, infered by parsing the HTML content and handling common tags.

Eg:

You have to define the folder name of the sender.

The flag 'consume' will tell is the mail will be further

processed by the upcoming processor mailets, or not.

Remove (best effort to) the hardcoded wrapping from a message.

If the text is "format=flowed" then deflows the text. Otherwise it forces a dewrap of the text.

Parameters:

The value should be "WIDTH+X" if the original length is known, "-X" otherwise.

In the latter case the length of the longer line will be used.

X is the tollerance needed for the quoting chars: if the original width is known the suggested value for X is 2 (because of "> " prefix), otherwise it is suggested to increase it to a value like 10 (-10)

In summary, if the original wrap is known (for example 76, for flowed messages) quotewidth = 78

Otherwise quotewidth = -10

Mailet designed to process the recipients from the mail headers rather than the recipients specified in the SMTP message header. This can be useful if your mail is redirected on-route by a mail server that substitutes a fixed recipient address for the original.

To use this, match against the redirection address using the RecipientIs matcher and set the mailet 'class' to UseHeaderRecipients. This will cause the email to be re-injected into the root process with the recipient substituted by all the recipients in the Mail-For, To and Cc headers of the message.

e.g.

Convert a message to format=flowed

SubAddressing positions a storage directive for the folder this email will be delivered in if the following criteria are met:

These directives are used by <strong>LocalDelivery</strong> mailet when adding the email to the recipients mailboxes.

The storage directive is recognized when a specific character or character sequence is present in the local part of the recipient address. <strong>By default, it is "+"</strong>.

If the sender is not allowed to send a mail to the specified folder, then the mail is delivered in the recipient’s inbox. Likewise, if the storage directive is empty or absent, the mail will simply be delivered in the recipient’s inbox.

Thus,

Any user can position rights for other users and for its different folders. They may create whitelists or blacklists, for one or several folders. In the case where the sender is unknown, the mail will be delivered in the specified folder only if the recipient has allowed everyone for that folder.