Edgewall Software
Modify

Opened 5 years ago

Closed 5 years ago

Last modified 5 years ago

#11658 closed enhancement (fixed)

Merge Trac notification documentation

Reported by: Ryan J Ollos Owned by: Ryan J Ollos
Priority: normal Milestone: 1.1.2
Component: notification Version:
Severity: normal Keywords: documentation
Cc: Branch:
Release Notes:

Updated notification options documentation using content that was previously on the TracNotification page.

API Changes:

Description (last modified by Ryan J Ollos)

The following documentation was removed from the TracNotification page in this change. The Option documentation will be updated using this info.

  • smtp_enabled: Enable email notification.
  • smtp_from: Email address to use for Sender-headers in notification emails.
  • smtp_from_name: Sender name to use for Sender-headers in notification emails.
  • smtp_from_author: (since 1.0) Use the author of a change (the reporter of a new ticket, or the author of a comment) as the From: header value in notification e-mails (default: false). If the author hasn't set an e-mail address, smtp_from and smtp_from_name are used instead.
  • smtp_replyto: Email address to use for Reply-To-headers in notification emails.
  • smtp_default_domain: (since 0.10) Append the specified domain to addresses that do not contain one. Fully qualified addresses are not modified. The default domain is appended to all username/login for which an email address cannot be found from the user settings.
  • smtp_always_cc: List of email addresses to always send notifications to. Typically used to post ticket changes to a dedicated mailing list.
  • smtp_always_bcc: (since 0.10) List of email addresses to always send notifications to, but keeps addresses not visible from other recipients of the notification email
  • smtp_subject_prefix: (since 0.10.1) Text that is inserted before the subject of the email. Set to "__default__" by default, to mean a prefix like [project_name].
  • always_notify_reporter: Always send notifications to any address in the reporter field (default: false).
  • always_notify_owner: (since 0.9) Always send notifications to the address in the owner field (default: false).
  • always_notify_updater: (since 0.10) Always send notifications to the person who causes the ticket property change and to any previous updater of that ticket (default: true).
  • use_public_cc: (since 0.10) Addresses in To: (owner, reporter) and Cc: lists are visible by all recipients (default is Bcc: - hidden copy).
  • use_short_addr: (since 0.10) Enable delivery of notifications to addresses that do not contain a domain (i.e. do not end with @<domain.com>).This option is useful for intranets, where the SMTP server can handle local addresses and map the username/login to a local mailbox. See also smtp_default_domain. Do not use this option with a public SMTP server.
  • ignore_domains: (since 0.11) Comma-separated list of domains that should not be considered part of email addresses (for usernames with Kerberos domains).
  • admit_domains: (since 0.11) Comma-separated list of domains that should be considered as valid for email addresses (such as localdomain).
  • mime_encoding: (since 0.10) This option allows selecting the MIME encoding scheme. Supported values:
    • none: default value, uses 7bit encoding if the text is plain ASCII, or 8bit otherwise.
    • base64: works with any kind of content. May cause some issues with touchy anti-spam/anti-virus engines.
    • qp or quoted-printable: best for european languages (more compact than base64) if 8bit encoding cannot be used.
  • ambiguous_char_width: (since 0.12.2) Which width of ambiguous characters (e.g. 'single' or 'double') should be used in the table of notification mail. If 'single', the same width as characters in US-ASCII. This is expected by most users. If 'double', twice the width of US-ASCII characters. This is expected by CJK users.
  • ticket_subject_template: (since 0.11) A Genshi text template snippet used to get the notification subject.
  • batch_subject_template: (since 1.0) Like ticket_subject_template but for batch modifications.
  • email_sender: (since 0.12) Name of the component implementing IEmailSender. This component is used by the notification system to send emails. Trac currently provides the following components:
    • SmtpEmailSender: connects to an SMTP server (default).
    • SendmailEmailSender: runs a sendmail-compatible executable.

Either smtp_from or smtp_replyto (or both) must be set, otherwise Trac refuses to send notification mails.

The following options are specific to email delivery through SMTP.

  • smtp_server: SMTP server used for notification messages.
  • smtp_port: (since 0.9) Port used to contact the SMTP server.
  • smtp_user: (since 0.9) User name for authentication SMTP account.
  • smtp_password: (since 0.9) Password for authentication SMTP account.
  • use_tls: (since 0.10) Toggle to send notifications via a SMTP server using TLS, such as GMail.

The following option is specific to email delivery through a sendmail-compatible executable.

  • sendmail_path: (since 0.12) Path to the sendmail executable. The sendmail program must accept the -i and -f options.

Attachments (0)

Change History (6)

comment:1 by Ryan J Ollos, 5 years ago

Description: modified (diff)

I was motivated by this edit. I can't see any reason to keep the same documentation in multiple places.

comment:2 by Ryan J Ollos, 5 years ago

Status: newassigned

comment:3 by Ryan J Ollos, 5 years ago

Release Notes: modified (diff)
Summary: Update Trac notification documentUpdate Trac notification documentation

comment:4 by Ryan J Ollos, 5 years ago

Milestone: 1.0.21.1.2
Summary: Update Trac notification documentationMerge Trac notification documentation
Type: defectenhancement

Proposed changes in log:rjollos.git:t11658.

comment:5 by Ryan J Ollos, 5 years ago

Resolution: fixed
Status: assignedclosed

Committed to trunk in [12958].

comment:6 by Ryan J Ollos, 5 years ago

Keywords: documentation added
Release Notes: modified (diff)

Modify Ticket

Change Properties
Set your email in Preferences
Action
as closed The owner will remain Ryan J Ollos.
The resolution will be deleted. Next status will be 'reopened'.
to as closed The owner will be changed from Ryan J Ollos to the specified user.

Add Comment


E-mail address and name can be saved in the Preferences .
 
Note: See TracTickets for help on using tickets.