WordPress/wp-includes/class-wp-phpmailer.php
Pascal Birchler c90837121a I18N: Mail: Make PHPMailer messages translatable.
Adds a new `WP_PHPMailer` class to leverage the WordPress i18n system with PHPMailer, so that any user-visible error messages can be properly translated.

Props sukhendu2002, swissspidy, audrasjb, iandunn, nacin, mark-k.
Fixes #23311.
Built from https://develop.svn.wordpress.org/trunk@59592


git-svn-id: http://core.svn.wordpress.org/trunk@58978 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2025-01-08 12:54:18 +00:00

94 lines
3.7 KiB
PHP

<?php
/**
* WordPress PHPMailer class.
*
* @package WordPress
* @since 6.8.0
*/
/**
* WordPress PHPMailer class.
*
* Overrides the internationalization method in order to use WordPress' instead.
*
* @since 6.8.0
*/
class WP_PHPMailer extends PHPMailer\PHPMailer\PHPMailer {
/**
* Constructor.
*
* @since 6.8.0
*
* @param bool $exceptions Optional. Whether to throw exceptions for errors. Default false.
*/
public function __construct( $exceptions = false ) {
parent::__construct( $exceptions );
$this->SetLanguage();
}
/**
* Defines the error messages using WordPress' internationalization method.
*
* @since 6.8.0
*
* @return true Always returns true.
*/
public function SetLanguage( $langcode = 'en', $lang_path = '' ) {
$error_strings = array(
'authenticate' => __( 'SMTP Error: Could not authenticate.' ),
'buggy_php' => sprintf(
/* translators: 1: mail.add_x_header. 2: php.ini */
__(
'Your version of PHP is affected by a bug that may result in corrupted messages. To fix it, switch to sending using SMTP, disable the %1$s option in your %2$s, or switch to MacOS or Linux, or upgrade your PHP version.'
),
'mail.add_x_header',
'php.ini'
),
'connect_host' => __( 'SMTP Error: Could not connect to SMTP host.' ),
'data_not_accepted' => __( 'SMTP Error: data not accepted.' ),
'empty_message' => __( 'Message body empty' ),
/* translators: There is a space after the colon. */
'encoding' => __( 'Unknown encoding: ' ),
/* translators: There is a space after the colon. */
'execute' => __( 'Could not execute: ' ),
/* translators: There is a space after the colon. */
'extension_missing' => __( 'Extension missing: ' ),
/* translators: There is a space after the colon. */
'file_access' => __( 'Could not access file: ' ),
/* translators: There is a space after the colon. */
'file_open' => __( 'File Error: Could not open file: ' ),
/* translators: There is a space after the colon. */
'from_failed' => __( 'The following From address failed: ' ),
'instantiate' => __( 'Could not instantiate mail function.' ),
/* translators: There is a space after the colon. */
'invalid_address' => __( 'Invalid address: ' ),
'invalid_header' => __( 'Invalid header name or value' ),
/* translators: There is a space after the colon. */
'invalid_hostentry' => __( 'Invalid hostentry: ' ),
/* translators: There is a space after the colon. */
'invalid_host' => __( 'Invalid host: ' ),
/* translators: There is a space at the beginning. */
'mailer_not_supported' => __( ' mailer is not supported.' ),
'provide_address' => __( 'You must provide at least one recipient email address.' ),
/* translators: There is a space after the colon. */
'recipients_failed' => __( 'SMTP Error: The following recipients failed: ' ),
/* translators: There is a space after the colon. */
'signing' => __( 'Signing Error: ' ),
/* translators: There is a space after the colon. */
'smtp_code' => __( 'SMTP code: ' ),
/* translators: There is a space after the colon. */
'smtp_code_ex' => __( 'Additional SMTP info: ' ),
'smtp_connect_failed' => __( 'SMTP connect() failed.' ),
/* translators: There is a space after the colon. */
'smtp_detail' => __( 'Detail: ' ),
/* translators: There is a space after the colon. */
'smtp_error' => __( 'SMTP server error: ' ),
/* translators: There is a space after the colon. */
'variable_set' => __( 'Cannot set or reset variable: ' ),
);
$this->language = $error_strings;
return true;
}
}