Email

Mantis Manual

Email
Last Modified: August 24, 2004 18:08PM

(Any)

Description

$g_administrator_email	The administrator's e-mail address. This is mainly prompted to the user in case of errors that might require the intervention of the system administrator. For example, SQL errors. sysadmin@example.com
$g_webmaster_email	The webmaster's e-mail address. This address is displayed in the bottom of all Mantis pages. webmaster@example.com
$g_from_email	The email address to be used as the source of all emails sent by Mantis. noreply@example.com
$g_to_email	Dropped in 0.19.0. All emails are going to be sent to this email address. This can be an email list or an archive address to be used to archive all notifications. If this functionality is not needed, then it can be set to nothing ('').
$g_return_path_email	Email address to receive bounced emails.
$g_enable_email_notification	Set to ON to enable e-mail notifications, OFF to disable them. Default is ON. Up to version 0.18.0a4 setting this option to OFF would disable all emails sent by Mantis. However, in 0.18.0a5 this was changed to have no effect on user sign-up notifications.
$g_allow_signup	Allow users to signup for their own accounts. Default is ON. (added in 0.19)
$g_send_reset_password	When set to ON, Mantis will email the users their new passwords when their accounts are reset. If set to OFF, the password will be reset to blank and no e-mail will be sent. Default is ON. (added in 0.19)
$g_validate_email	Set to OFF to disable email checking. Default is ON.
$g_check_mx_record	Set to OFF to disable email checking. Default is OFF.
$g_allow_blank_email	If ON, allows the user to omit an email address field. If you allow users to create their own accounts, they must specify an email at that point, no matter what the value of this option is. Otherwise they wouldn't get their passwords.
$g_limit_email_domain	Only allow and send email to addresses in the given domain. This is useful as a security feature and it is also useful in cases like Sourceforge where its servers are only limited to send emails to SourceForge email addresses in order to avoid spam. $g_limit_email_domain = 'users.sourceforge.net';
$g_show_user_email_threshold	This specifies the access level that is needed to have user names hyperlinked with mailto: links. The default value is NOBODY, hence, even administrators won't have this feature enabled.
$g_use_x_priority	Dropped in 0.19.0.Set to OFF to remove X-Priority header. Default is ON.
$g_mail_priority	If use_x_priority is set to ON, what should the value be? Urgent = 1, Not Urgent = 5, Disable = 0 . Default is 3 Some MTAs interpret X-Priority = 0 to mean 'Very Urgent'
$g_use_bcc	Dropped in 0.19.0.Specifies whether email recipients should be added in the To: field (OFF) or the Bcc: field (ON). The default value is ON. You might need to turn this option OFF on Windows systems, as long as php-mail-function has its bcc-bug (~PHP 4.0.6). However, if you are using PHPMailer for sending emails you probably would not have a problem.
$g_use_phpMailer	Dropped in 0.19.0. This is now the only mailing mechanism.Use PHPMailer instead of standard mail() function. Get the PHPMailer-package from http://phpmailer.sourceforge.net. The installation is very simple you only need 2 plain text php-files: class.smtp.php and class.phpmailer.php. Copy these files to your php-include-dir i.e. 'c:\php\includes' or '/usr/lib/php/includes' and add this path to the 'include_path'-entry in the php.ini file. The installation is described in the readme and there is also a simple example. PHPMailer comes with a detailed documentation in phpdoc format. Default is OFF. Although the default value is OFF. It is recommended to use PHPMailer. It is also planned that in future Mantis releases PHPMailer will be the only supported option for sending emails.
$g_phpMailer_path	Dropped in 0.19.0.Path to PHPMailer directory (default is empty). This directory must include class.phpmailer.hpp and class.smtp.php. The default should work if the PHPMailer directory is in the include_path. If a path is specified, it should be terminated by a directory separator.
$g_phpMailer_method	Select the method to mail by: 0 - mail(), 1 - sendmail 2 - SMTP. Default is 0.
$g_smtp_host	This option allows you to use a remote SMTP host. Must use the phpMailer script. Name of smtp host, needed for phpMailer, taken from php.ini Default is 'localhost'
$g_smtp_username	This option allows the use of SMTP Authentication when using a remote SMTP host with PHPMailer. If smtp_username is not '' then the username and password will be used when logging in to the SMTP server. Default is ''.
$g_smtp_password	This is the password that is used in SMTP Authentication . Default is ''.
$g_email_set_category	Specify whether e-mails should be sent with the category set or not. This is tested with Microsoft Outlook. More testing for this feature + other formats will be added in the future. OFF, EMAIL_CATEGORY_PROJECT_CATEGORY (format: [Project] Category). Default is OFF.
$g_email_separator1	Default is str_pad('', 70, '='); This means 70 equal signs.
$g_email_separator2	Default is str_pad('', 70, '-'); This means 70 minus signs.
$g_email_padding_length	Default is 28.

Mantis uses flags and a threshold system to generate emails on events. For each new event, email is sent to:

the reporter, qualified by the notify flag 'reporter' below
the handler (or Assigned to), qualified by the notify flag 'handler' below
anyone monitoring the bug, qualified by the notify flag 'monitor' below
anyone who has ever added a bugnote the bug, qualified by the notify flag 'bugnotes' below
anyone assigned to the project whose access level is greater than or equal to the notify flag 'threshold_min' and less than or equal to the notify flag 'threshold_max' below

From this list, those recipients who meet the following criteria are eliminated:

the originator of the change, if $g_email_receive_own is OFF
the recipient either no longer exists, or is disabled
the recipient has turned their email_on_<new status> preference OFF
the recipient has no email address extered

$g_email_receive_own	This defines whether users should receive emails for their own actions. This option is defaulted to OFF, hence, users do not receive email notification for their own actions. This can be a source for confusions for users upgrading from Mantis 0.17.x versions, since in these versions users used to get notified of their own actions.
$g_default_notify_flags	Associated with each action a list of flags to control who should be notified. The default will be used if the action is not included in $g_notify_flags or if the flag is not included in the specific action definition. The list of actions include: new, assigned, resolved, bugnote, reopened, closed, deleted, feedback. The default is: $g_default_notify_flags = array('reporter' => ON, 'handler' => ON, 'monitor' => ON, 'bugnotes' => ON, 'threshold_min' => NOBODY, 'threshold_max' => NOBODY); threshold_min and threshold_max are used to send messages to all members of the project whose status is greater than or equal to "threshold_min" and less than or equal to "threshold_max". Sending messages to everyone would set "threshold_min" to ANYBODY and "threshold_max to "NOBODY". To send to all DEVELOPERS and above (as 0.17.5), use DEVELOPER and NOBODY respectively.
$g_notify_flags	Defines the notification flags that are different from the defaults that are defined in $g_default_notify_flags. The following code overrides the default by disabling notifications to bugnote authors and users monitoring the bug on submitting a new bug: $g_notify_flags['new'] = array('bugnotes' => OFF, 'monitor' => OFF); Available actions include: 'new': a new bug has been added 'reopened': the bug has been reopened 'deleted': a bug has been deleted 'owner': the bug has been assigned a new owner (was 'assigned' in 0.18) 'bugnote': a bugnote has been added to a bug 'sponsor': the sponsorship for the bug has changed (added, deleted or updated) (added in 0.19) 'relation': a relationship for the bug has changed (added, deleted or updated) (added in 0.19) In addition, an action can match the bug status in $g_status_enum_string. Note that spaces in the string are replaced with underscores ('_') in creating the action. Thus, using the defaults, 'feedback' would be a valid action. (was 'status_<status>' in 0.18)