PhabricatorMetaMTAConfigOptions.php

<?php

final class PhabricatorMetaMTAConfigOptions
  extends PhabricatorApplicationConfigOptions {

  public function getName() {
    return pht('Mail');
  }

  public function getDescription() {
    return pht('Configure Mail.');
  }

  public function getIcon() {
    return 'fa-send';
  }

  public function getGroup() {
    return 'core';
  }

  public function getOptions() {
    $send_as_user_desc = $this->deformat(pht(<<<EODOC
When a user takes an action which generates an email notification (like
commenting on a Differential revision), the "From" address can either be set
to the user's email address (like "[email protected]") or the
"metamta.defualt-address" address.

The user experience is generally better if the user's real address is used as
the "From" header value, since the messages are easier to organize when they
appear in mail clients, but this will only work if the server is authorized to
send email on behalf of the "From" domain. Practically, this means:

  - If you are doing an install for Example Corp and all the users will have
    corporate @corp.example.com addresses and any hosts this software is running
    on are authorized to send email from corp.example.com, you can enable this
    to make the user experience a little better.
  - If you are doing an install for an open source project and your users will
    be registering via third-party services and/or using personal email
    addresses, you probably should not enable this or all of your outgoing
    email might vanish into SFP blackholes.
  - If your install is anything else, you're safer leaving this off, at least
    initially, since the risk in turning it on is that your outgoing mail will
    never arrive.
EODOC
  ));

    $one_mail_per_recipient_desc = $this->deformat(pht(<<<EODOC
When a message is sent to multiple recipients (for example, several reviewers on
a code review), it can either be delieverd as one email to everyone (e.g., "To:
alincoln, usgrant, htaft") or separate emails to each user (e.g., "To:
alincoln", "To: usgrant", "To: htaft"). The major advantages and disadvantages
of each approach are:

  - One mail to everyone:
    - This violates policy controls. The body of the mail is generated without
      respect for object policies.
    - Recipients can see To/Cc at a glance.
    - If you use mailing lists, you won't get duplicate mail if you're
      a normal recipient and also Cc'd on a mailing list.
    - Getting threading to work properly is harder, and probably requires
      making mail less useful by turning off options.
    - Sometimes people will "Reply All", which can send mail to too many
      recipients. This software will try not to send mail to users who already
      received a similar message, but can not prevent all stray email arising
      from "Reply All".
    - Not supported with a private reply-to address.
    - Mail messages are sent in the server default translation.
    - Mail that must be delivered over secure channels will leak the recipient
      list in the "To" and "Cc" headers.
  - One mail to each user:
    - Policy controls work correctly and are enforced per-user.
    - Recipients need to look in the mail body to see To/Cc.
    - If you use mailing lists, recipients may sometimes get duplicate
      mail.
    - Getting threading to work properly is easier, and threading settings
      can be customzied by each user.
    - "Reply All" will never send extra mail to other users involved in the
      thread.
    - Required if private reply-to addresses are configured.
    - Mail messages are sent in the language of user preference.

EODOC
));

    $reply_hints_description = $this->deformat(pht(<<<EODOC
You can disable the hints under "REPLY HANDLER ACTIONS" if users prefer
smaller messages. The actions themselves will still work properly.
EODOC
));

    $recipient_hints_description = $this->deformat(pht(<<<EODOC
You can disable the "To:" and "Cc:" footers in mail if users prefer smaller
messages.
EODOC
));

    $email_preferences_description = $this->deformat(pht(<<<EODOC
You can disable the email preference link in emails if users prefer smaller
emails.
EODOC
));

    $re_prefix_description = $this->deformat(pht(<<<EODOC
Mail.app on OS X Lion won't respect threading headers unless the subject is
prefixed with "Re:". If you enable this option, this software will add "Re:" to
the subject line of all mail which is expected to thread. If you've set
'metamta.one-mail-per-recipient', users can override this setting in their
preferences.
EODOC
));

    $vary_subjects_description = $this->deformat(pht(<<<EODOC
If true, allow MetaMTA to change mail subjects to put text like '[Accepted]' and
'[Commented]' in them. This makes subjects more useful, but might break
threading on some clients. If you've set '%s', users can override this setting
in their preferences.
EODOC
  ,
  'metamta.one-mail-per-recipient'));

    $reply_to_description = $this->deformat(pht(<<<EODOC
If you enable `%s`, this software uses "From" to authenticate users. You can
additionally enable this setting to try to authenticate with 'Reply-To'. Note
that this is completely spoofable and insecure (any user can set any 'Reply-To'
address) but depending on the nature of your install or other deliverability
conditions this might be okay. Generally, you can't do much more by spoofing
Reply-To than be annoying (you can write but not read content). But this is
still **COMPLETELY INSECURE**.
EODOC
  ,
  'metamta.public-replies'));

    $adapter_description = $this->deformat(pht(<<<EODOC
Adapter class to use to transmit mail to the MTA. The default uses
PHPMailerLite, which will invoke "sendmail". This is appropriate if sendmail
actually works on your host, but if you haven't configured mail it may not be so
great. A number of other mailers are available (e.g., SES, SendGrid, SMTP,
custom mailers). This option is deprecated in favor of 'cluster.mailers'.
EODOC
));

    $public_replies_description = $this->deformat(pht(<<<EODOC
By default, this software generates unique reply-to addresses and sends a
separate email to each recipient when you enable reply handling. This is more
secure than using "From" to establish user identity, but can mean users may
receive multiple emails when they are on mailing lists. Instead, you can use a
single, non-unique reply to address and authenticate users based on the "From"
address by setting this to 'true'. This trades away a little bit of security
for convenience, but it's reasonable in many installs. Object interactions are
still protected using hashes in the single public email address, so objects
can not be replied to blindly.
EODOC
));

    $single_description = $this->deformat(pht(<<<EODOC
If you want to use a single mailbox for reply mail, you can use this
and set a common prefix for generated reply addresses. It will
make use of the fact that a mail-address such as
`[email protected]` will be delivered to the `devtools`
user's mailbox. Set this to the left part of the email address and it will be
prepended to all generated reply addresses.

For example, if you want to use `[email protected]`, this should be set
to `devtools`.
EODOC
));

    $address_description = $this->deformat(pht(<<<EODOC
When email is sent, what format should the software use for users' email
addresses? Valid values are:

 - `short`: 'gwashington <[email protected]>'
 - `real`:  'George Washington <[email protected]>'
 - `full`: 'gwashington (George Washington) <[email protected]>'

The default is `full`.
EODOC
));

    $mailers_description = $this->deformat(pht(<<<EODOC
Define one or more mail transmission services. For help with configuring
mailers, see **[[ %s | %s ]]** in the documentation.
EODOC
      ,
      PhabricatorEnv::getDoclink('Configuring Outbound Email'),
      pht('Configuring Outbound Email')));

    $default_description = $this->deformat(pht(<<<EODOC
Default address used as a "From" or "To" email address when an address is
required but no meaningful address is available.

If you configure inbound mail, you generally do not need to set this:
the software will automatically generate and use a suitable mailbox on the
inbound mail domain.

Otherwise, this option should be configured to point at a valid mailbox which
discards all mail sent to it. If you point it at an invalid mailbox, mail sent
by the software and some mail sent by users will bounce. If you point it at a
real user mailbox, that user will get a lot of mail they don't want.

For further guidance, see **[[ %s | %s ]]** in the documentation.
EODOC
      ,
      PhabricatorEnv::getDoclink('Configuring Outbound Email'),
      pht('Configuring Outbound Email')));

    return array(
      $this->newOption('cluster.mailers', 'cluster.mailers', array())
        ->setHidden(true)
        ->setDescription($mailers_description),
      $this->newOption('metamta.default-address', 'string', null)
        ->setLocked(true)
        ->setSummary(pht('Default address used when generating mail.'))
        ->setDescription($default_description),
      $this->newOption(
        'metamta.one-mail-per-recipient',
        'bool',
        true)
        ->setLocked(true)
        ->setBoolOptions(
          array(
            pht('Send Mail To Each Recipient'),
            pht('Send Mail To All Recipients'),
          ))
        ->setSummary(
          pht(
            'Controls whether email for multiple recipients is sent by '.
            'creating one message with everyone in the "To:" line, or '.
            'multiple messages that each have a single recipeint in the '.
            '"To:" line.'))
        ->setDescription($one_mail_per_recipient_desc),
      $this->newOption('metamta.can-send-as-user', 'bool', false)
        ->setBoolOptions(
          array(
            pht('Send as User Taking Action'),
            pht(
              'Send as %s',
              PlatformSymbols::getPlatformServerName()),
          ))
        ->setSummary(
          pht(
            'Controls whether email is sent "From" users.'))
        ->setDescription($send_as_user_desc),
      $this->newOption(
        'metamta.reply-handler-domain',
        'string',
        null)
        ->setLocked(true)
        ->setDescription(pht('Domain used for reply email addresses.'))
        ->addExample('devtools.example.com', ''),
      $this->newOption('metamta.recipients.show-hints', 'bool', true)
        ->setBoolOptions(
          array(
            pht('Show Recipient Hints'),
            pht('No Recipient Hints'),
          ))
        ->setSummary(pht('Show "To:" and "Cc:" footer hints in email.'))
        ->setDescription($recipient_hints_description),
      $this->newOption('metamta.email-preferences', 'bool', true)
        ->setBoolOptions(
          array(
            pht('Show Email Preferences Link'),
            pht('No Email Preferences Link'),
          ))
        ->setSummary(pht('Show email preferences link in email.'))
        ->setDescription($email_preferences_description),
      $this->newOption('metamta.public-replies', 'bool', false)
        ->setBoolOptions(
          array(
            pht('Use Public Replies (Less Secure)'),
            pht('Use Private Replies (More Secure)'),
          ))
        ->setSummary(
          pht(
            'Reply addresses can either be private (more secure) or '.
            'public (which works better with mailing lists).'))
        ->setDescription($public_replies_description),
      $this->newOption('metamta.single-reply-handler-prefix', 'string', null)
        ->setSummary(
          pht('Allow a single mailbox to be used for all replies.'))
        ->setDescription($single_description),
      $this->newOption('metamta.user-address-format', 'enum', 'full')
        ->setEnumOptions(
          array(
            'short' => pht('Short'),
            'real' => pht('Real'),
            'full' => pht('Full'),
          ))
        ->setSummary(pht('Control how user names are rendered in mail.'))
        ->setDescription($address_description)
        ->addExample('gwashington <[email protected]>', 'short')
        ->addExample('George Washington <[email protected]>', 'real')
        ->addExample(
          'gwashington (George Washington) <[email protected]>',
          'full'),
      $this->newOption('metamta.email-body-limit', 'int', 524288)
        ->setDescription(
          pht(
            'You can set a limit for the maximum byte size of outbound mail. '.
            'Mail which is larger than this limit will be truncated before '.
            'being sent. This can be useful if your MTA rejects mail which '.
            'exceeds some limit (this is reasonably common). Specify a value '.
            'in bytes.'))
        ->setSummary(pht('Global cap for size of generated emails (bytes).'))
        ->addExample(524288, pht('Truncate at 512KB'))
        ->addExample(1048576, pht('Truncate at 1MB')),
    );
  }

}