Mail Classes

The name that you wish to assign the Mail Class. This is the value that you’ll be able to use later when including the X-GreenArrow-MailClass header in messages belonging to this Mail Class. The following rules apply to Mail Class names:

• Names may consist of letters and underscores.
• The “a” Mail Class is reserved and may not be created.
• Two or more underscores may not appear next to each other. For example, “server__a__email” is invalid, but “server_a_email” is valid.
• The name length can not exceed 64 characters.
• Please see the Bounce Processor Concepts documentation for caveats regarding long mail class names.

The VirtualMTA to assign mail in this Mail Class to.

The ListID to assign mail in this Mail Class to

Add a BCC to every email sent using this Mail Class.

Add custom headers to emails sent using this Mail Class.

• A maximum of 1024 bytes are allowed.
• The only X-GreenArrow-* headers allowed are (see SimpleMH Headers for usage)
  • X-GreenArrow-DKIM
  • X-GreenArrow-DKIM-Only-Using-Domain
  • X-GreenArrow-Signing-Selector
• The X-Mailer-Info header is prohibited.

If the injected message does not include a Message-ID header, one will be generated automatically.

This option controls how statistics are grouped for this mail class. A thorough explanation of the options and ramifications are discussed in the Statistic Report Grouping documentation.

The default of this option is ordinarily Per Day, but is affected by the legacy_behavior option default_statistic_report_grouping_per_instanceid_legacy (this option was set automatically when upgrading from an older version to v4.333.0 or newer).

This option instructs GreenArrow to modify the email message so that the Bounce Processor is able to process bounces and spam complaints for messages using this Mail Class.

If you are using the Lite Bounce Processor, you will typically want this option to be disabled.

When this option is enabled (which is the default) (or the header X-GreenArrow-HandleBounceAndFbl is enabled), messages sent from this mail class will be affected in the following ways so that GreenArrow’s non-lite bounce and FBL processor can process the messages:

• The 5321.MailFrom (MAIL FROM / Return-Path) address will be overwritten so that GreenArrow receives and processes bounces resulting from these messages.
• An X-Mailer-Info header will be added to these messages to aid in complaint processing and identification.
• An X-Mailer-Info-Extra header will possibly be added to aid in bounce processing.
• The automatically generated List-Unsubscribe header will include a mailto: option (instead of only the HTTP option). This mailto: option is a variant of GreenArrow’s 5321.MailFrom address indicating the message represents an unsubscribe.

This can be overridden on a per-message basis using the X-GreenArrow-HandleBounceAndFbl header.

If you are a GreenArrow cloud customer this field might be forced on and hidden from the UI and API.

The Bounce Address to use for mail in this Mail Class. The list contains:

• Bounce Mailboxes defined in Incoming Email Domains and Aliased Email Domains
• Any bounce addresses configured via the bounce_address_external directive in the main configuration file

Send a copy of each bounce message back to the original Return-Path recipient. Engine will still process the bounce locally when using this feature.

If you enable this feature, make sure that the original Return-Path domains have throttling configurations in place which allows Engine to deliver these bounces as quickly as they come in. Otherwise, the bounce pass through messages could fill up GreenArrow’s queues as they wait to be delivered. That situation has the potential to slow deliveries to a crawl system wide.

Turns click and open tracking on or off for this Mail Class.

This can be overridden on a per-message basis using the X-GreenArrow-Click-Tracking-Do header.

If you are a GreenArrow cloud customer this field might be forced on and hidden from the UI and API.

Turns unsubscribe link processing on or off for this Mail Class.

Choose the URL Domain to use in Click + Open tracking for mail sent via this Mail Class.

Archives sample messages to a table in GreenArrow Engine’s PostgreSQL database.

If the injected message does not include a List-Unsubscribe header, one will be generated automatically.

This can be overridden on a per-message basis using the X-GreenArrow-Disable-Auto-List-Unsubscribe-Header header.

If you are a GreenArrow cloud customer this field might be forced on and hidden from the UI and API.

Converts text only messages to HTML. If this box is checked, additional fields appear, which allow you specify an HTML header, HTML footer, the text that should appear for converted links, and regular expression operations to perform before, and after conversion to HTML.

If this box is checked, additional fields appear which allow you specify how you’d like HTML messages to be modified.

Configure the Event Tracking Metadata Storage for messages processed by this Mail Class.

This can be overridden by the X-GreenArrow-EventTrackingMetadataStorage message header.

The default Event Tracking Metadata Storage is defined by default_event_tracking_metadata_storage.

Statistics are grouped by InstanceID (if set), or by date (if no InstanceID is set), using the legacy SendID format.

If an InstanceID is set, the SendID will look like:

${ mail_class.name }${ LOWERCASE(instance_id) }

If no InstanceID is set, the SendID will look like (note that unlike the other options, this is a 2-digit year):

${ mail_class.name }YYMMDD

When using this mode, we recommend to avoid creating too many unique InstanceID values per day (as one send report will be created for each InstanceID value), nor using the same InstanceID value over the course of more than five months (as beyond five months emails with the same InstanceID may be put into a new statistics group).

This mode effects the same grouping as the per_instanceid mode, but has a few minor differences:

1. The legacy SendID format is used by per_instanceid_legacy, and per_instanceid uses a new format. (Maintaining the old format can be useful for compatibility for users that are directly parsing the SendID value. We no longer recommend parsing the SendID value – instead, please use the mailclass and instanceid fields in events and in the processed logfile.)
2. If no InstanceID is specified, per_instanceid_legacy defaults the InstanceID to YYMMDD. The per_instanceid mode does not do this.
3. The InstanceID is lowercased before it is added to the SendID.
4. Note: Unlike the non-legacy SendID formats, this SendID format may contain uppercase characters if the Mail Class name contains uppercase characters. We don’t recommend that you rely on this behavior, because although most parts of GreenArrow will preserve the case of the SendID (for example, in engine_click and delivery_attempt events), some parts will lowercase the SendID before returning it to you (for example, in bounce_all events). This inconsistency is one reason we recommend only using this grouping option if you are certain you need to.

Statistics are grouped by InstanceID (if set), or by date (if no InstanceID is set).

If an InstanceID is set, the SendID will look like:

${ LOWERCASE(mail_class.name) }==${ LOWERCASE(instance_id) }

If no InstanceID is set, the SendID will look like:

${ LOWERCASE(mail_class.name) }=YYYYMMDD=

When using this mode, we recommend to avoid creating too many unique InstanceID values per day (as one send report will be created for each InstanceID value), nor using the same InstanceID value over the course of more than five months (as beyond five months emails with the same InstanceID may be put into a new statistics group).

If you are running on Postgres 8.3, these SendIDs will be truncated to 100 characters.

Statistics are grouped by InstanceID and per-day (where the day is in accordance with engine_time_zone). In other words: Each statistics group will contain the emails injected on a particular day with a particular InstanceID. If an InstanceID is used over multiple days, then it will have multiple statistics groups, one for each day.

The SendID will look like:

${ LOWERCASE(mail_class.name) }=YYYYMMDD=${ LOWERCASE(instance_id) }

When using this mode, we recommend to avoid creating too many unique InstanceID values per day (as one send report will be created for each InstanceID value).

If you are running on Postgres 8.3, these SendIDs will be truncated to 100 characters.

Statistics are grouped per-day (where the day is in accordance with engine_time_zone).

The SendID will look like:

${ LOWERCASE(mail_class.name) }=YYYYMMDD

Statistics are grouped per-hour (where the day and hour is in accordance with engine_time_zone).

The SendID will look like:

${ LOWERCASE(mail_class.name) }=YYYYMMDDHH