<?php

[0] Fix | Delete

[1] Fix | Delete

namespace WPForms\Emails;

[2] Fix | Delete

[3] Fix | Delete

use WPForms\Emails\Templates\General;

[4] Fix | Delete

[5] Fix | Delete

/**

[6] Fix | Delete

* Mailer class to wrap wp_mail().

[7] Fix | Delete

*

[8] Fix | Delete

* @since 1.5.4

[9] Fix | Delete

*/

[10] Fix | Delete

class Mailer {

[11] Fix | Delete

[12] Fix | Delete

/**

[13] Fix | Delete

* Array or comma-separated list of email addresses to send a message.

[14] Fix | Delete

*

[15] Fix | Delete

* @since 1.5.4

[16] Fix | Delete

*

[17] Fix | Delete

* @var string|string[]

[18] Fix | Delete

*/

[19] Fix | Delete

private $to_email;

[20] Fix | Delete

[21] Fix | Delete

/**

[22] Fix | Delete

* CC addresses (comma delimited).

[23] Fix | Delete

*

[24] Fix | Delete

* @since 1.5.4

[25] Fix | Delete

*

[26] Fix | Delete

* @var string

[27] Fix | Delete

*/

[28] Fix | Delete

private $cc;

[29] Fix | Delete

[30] Fix | Delete

/**

[31] Fix | Delete

* From address.

[32] Fix | Delete

*

[33] Fix | Delete

* @since 1.5.4

[34] Fix | Delete

*

[35] Fix | Delete

* @var string

[36] Fix | Delete

*/

[37] Fix | Delete

private $from_address;

[38] Fix | Delete

[39] Fix | Delete

/**

[40] Fix | Delete

* From name.

[41] Fix | Delete

*

[42] Fix | Delete

* @since 1.5.4

[43] Fix | Delete

*

[44] Fix | Delete

* @var string

[45] Fix | Delete

*/

[46] Fix | Delete

private $from_name;

[47] Fix | Delete

[48] Fix | Delete

/**

[49] Fix | Delete

* Reply to address.

[50] Fix | Delete

*

[51] Fix | Delete

* @since 1.5.4

[52] Fix | Delete

*

[53] Fix | Delete

* @var string

[54] Fix | Delete

*/

[55] Fix | Delete

private $reply_to;

[56] Fix | Delete

[57] Fix | Delete

/**

[58] Fix | Delete

* Email headers.

[59] Fix | Delete

*

[60] Fix | Delete

* @since 1.5.4

[61] Fix | Delete

*

[62] Fix | Delete

* @var string

[63] Fix | Delete

*/

[64] Fix | Delete

private $headers;

[65] Fix | Delete

[66] Fix | Delete

/**

[67] Fix | Delete

* Email content type.

[68] Fix | Delete

*

[69] Fix | Delete

* @since 1.5.4

[70] Fix | Delete

*

[71] Fix | Delete

* @var string

[72] Fix | Delete

*/

[73] Fix | Delete

private $content_type;

[74] Fix | Delete

[75] Fix | Delete

/**

[76] Fix | Delete

* Email attachments.

[77] Fix | Delete

*

[78] Fix | Delete

* @since 1.5.4

[79] Fix | Delete

*

[80] Fix | Delete

* @var string|string[]

[81] Fix | Delete

*/

[82] Fix | Delete

private $attachments;

[83] Fix | Delete

[84] Fix | Delete

/**

[85] Fix | Delete

* Email subject.

[86] Fix | Delete

*

[87] Fix | Delete

* @since 1.5.4

[88] Fix | Delete

*

[89] Fix | Delete

* @var string

[90] Fix | Delete

*/

[91] Fix | Delete

private $subject;

[92] Fix | Delete

[93] Fix | Delete

/**

[94] Fix | Delete

* Email message.

[95] Fix | Delete

*

[96] Fix | Delete

* @since 1.5.4

[97] Fix | Delete

*

[98] Fix | Delete

* @var string

[99] Fix | Delete

*/

[100] Fix | Delete

private $message;

[101] Fix | Delete

[102] Fix | Delete

/**

[103] Fix | Delete

* Email template.

[104] Fix | Delete

*

[105] Fix | Delete

* @since 1.5.4

[106] Fix | Delete

*

[107] Fix | Delete

* @var General

[108] Fix | Delete

*/

[109] Fix | Delete

private $template;

[110] Fix | Delete

[111] Fix | Delete

/**

[112] Fix | Delete

* Set a property.

[113] Fix | Delete

*

[114] Fix | Delete

* @since 1.5.4

[115] Fix | Delete

*

[116] Fix | Delete

* @param string $key Property name.

[117] Fix | Delete

* @param string|array $value Property value.

[118] Fix | Delete

*/

[119] Fix | Delete

public function __set( string $key, $value ) {

[120] Fix | Delete

[121] Fix | Delete

$this->$key = $value;

[122] Fix | Delete

}

[123] Fix | Delete

[124] Fix | Delete

/**

[125] Fix | Delete

* Get a property.

[126] Fix | Delete

*

[127] Fix | Delete

* @since 1.5.4

[128] Fix | Delete

*

[129] Fix | Delete

* @param string $key Property name.

[130] Fix | Delete

*

[131] Fix | Delete

* @return string

[132] Fix | Delete

*/

[133] Fix | Delete

public function __get( $key ) {

[134] Fix | Delete

[135] Fix | Delete

return $this->$key;

[136] Fix | Delete

}

[137] Fix | Delete

[138] Fix | Delete

/**

[139] Fix | Delete

* Check if a property exists.

[140] Fix | Delete

*

[141] Fix | Delete

* @since 1.5.4

[142] Fix | Delete

*

[143] Fix | Delete

* @param string $key Property name.

[144] Fix | Delete

*

[145] Fix | Delete

* @return bool

[146] Fix | Delete

*/

[147] Fix | Delete

public function __isset( $key ) {

[148] Fix | Delete

[149] Fix | Delete

return isset( $this->key );

[150] Fix | Delete

}

[151] Fix | Delete

[152] Fix | Delete

/**

[153] Fix | Delete

* Unset a property.

[154] Fix | Delete

*

[155] Fix | Delete

* @since 1.5.4

[156] Fix | Delete

*

[157] Fix | Delete

* @param string $key Property name.

[158] Fix | Delete

*/

[159] Fix | Delete

public function __unset( $key ) {

[160] Fix | Delete

[161] Fix | Delete

unset( $this->key );

[162] Fix | Delete

}

[163] Fix | Delete

[164] Fix | Delete

/**

[165] Fix | Delete

* Email kill switch if needed.

[166] Fix | Delete

*

[167] Fix | Delete

* @since 1.5.4

[168] Fix | Delete

*

[169] Fix | Delete

* @return bool

[170] Fix | Delete

*/

[171] Fix | Delete

public function is_email_disabled() {

[172] Fix | Delete

[173] Fix | Delete

// phpcs:ignore WPForms.Comments.PHPDocHooks.RequiredHookDocumentation

[174] Fix | Delete

return (bool) apply_filters( 'wpforms_emails_mailer_is_email_disabled', false, $this );

[175] Fix | Delete

}

[176] Fix | Delete

[177] Fix | Delete

/**

[178] Fix | Delete

* Sanitize the string.

[179] Fix | Delete

*

[180] Fix | Delete

* @since 1.5.4

[181] Fix | Delete

* @since 1.6.0 Deprecated param: $linebreaks. This is handled by wpforms_decode_string().

[182] Fix | Delete

*

[183] Fix | Delete

* @param string $input String that may contain tags.

[184] Fix | Delete

* @param string $context Context of the string.

[185] Fix | Delete

*

[186] Fix | Delete

* @return string

[187] Fix | Delete

* @uses wpforms_decode_string()

[188] Fix | Delete

*/

[189] Fix | Delete

public function sanitize( $input = '', $context = '' ): string { // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.FoundAfterLastUsed

[190] Fix | Delete

[191] Fix | Delete

return wpforms_decode_string( $input );

[192] Fix | Delete

}

[193] Fix | Delete

[194] Fix | Delete

/**

[195] Fix | Delete

* Get the email from the name.

[196] Fix | Delete

*

[197] Fix | Delete

* @since 1.5.4

[198] Fix | Delete

*

[199] Fix | Delete

* @return string

[200] Fix | Delete

*/

[201] Fix | Delete

public function get_from_name() {

[202] Fix | Delete

[203] Fix | Delete

$this->from_name = $this->from_name ? $this->sanitize( $this->from_name ) : get_bloginfo( 'name' );

[204] Fix | Delete

[205] Fix | Delete

// phpcs:ignore WPForms.Comments.PHPDocHooks.RequiredHookDocumentation

[206] Fix | Delete

return apply_filters( 'wpforms_emails_mailer_get_from_name', $this->from_name, $this );

[207] Fix | Delete

}

[208] Fix | Delete

[209] Fix | Delete

/**

[210] Fix | Delete

* Get the email from the address.

[211] Fix | Delete

*

[212] Fix | Delete

* @since 1.5.4

[213] Fix | Delete

*

[214] Fix | Delete

* @return string

[215] Fix | Delete

*/

[216] Fix | Delete

public function get_from_address() {

[217] Fix | Delete

[218] Fix | Delete

$this->from_address = $this->from_address ? $this->sanitize( $this->from_address, 'notification-from' ) : get_option( 'admin_email' );

[219] Fix | Delete

[220] Fix | Delete

// phpcs:ignore WPForms.Comments.PHPDocHooks.RequiredHookDocumentation

[221] Fix | Delete

return apply_filters( 'wpforms_emails_mailer_get_from_address', $this->from_address, $this );

[222] Fix | Delete

}

[223] Fix | Delete

[224] Fix | Delete

/**

[225] Fix | Delete

* Get the email reply to the address.

[226] Fix | Delete

*

[227] Fix | Delete

* @since 1.5.4

[228] Fix | Delete

*

[229] Fix | Delete

* @return string

[230] Fix | Delete

*/

[231] Fix | Delete

public function get_reply_to_address() {

[232] Fix | Delete

[233] Fix | Delete

if ( empty( $this->reply_to ) || ! is_email( $this->reply_to ) ) {

[234] Fix | Delete

$this->reply_to = $this->from_address;

[235] Fix | Delete

}

[236] Fix | Delete

[237] Fix | Delete

$this->reply_to = $this->sanitize( $this->reply_to, 'notification-reply-to' );

[238] Fix | Delete

[239] Fix | Delete

if ( empty( $this->reply_to ) || ! is_email( $this->reply_to ) ) {

[240] Fix | Delete

$this->reply_to = get_option( 'admin_email' );

[241] Fix | Delete

}

[242] Fix | Delete

[243] Fix | Delete

// phpcs:ignore WPForms.Comments.PHPDocHooks.RequiredHookDocumentation

[244] Fix | Delete

return apply_filters( 'wpforms_emails_mailer_get_reply_to_address', $this->reply_to, $this );

[245] Fix | Delete

}

[246] Fix | Delete

[247] Fix | Delete

/**

[248] Fix | Delete

* Get the email carbon copy addresses.

[249] Fix | Delete

*

[250] Fix | Delete

* @since 1.5.4

[251] Fix | Delete

* @since 1.8.9 Allow using CC field as an array.

[252] Fix | Delete

*

[253] Fix | Delete

* @return string The email carbon copy addresses.

[254] Fix | Delete

*/

[255] Fix | Delete

public function get_cc_address() {

[256] Fix | Delete

[257] Fix | Delete

if ( is_array( $this->cc ) ) {

[258] Fix | Delete

$this->cc = implode( ',', $this->cc );

[259] Fix | Delete

}

[260] Fix | Delete

[261] Fix | Delete

if ( empty( $this->cc ) ) {

[262] Fix | Delete

/**

[263] Fix | Delete

* Filters the email carbon copy addresses.

[264] Fix | Delete

*

[265] Fix | Delete

* @since 1.5.4

[266] Fix | Delete

*

[267] Fix | Delete

* @param string $cc Carbon copy addresses.

[268] Fix | Delete

* @param Mailer $this Mailer instance.

[269] Fix | Delete

*/

[270] Fix | Delete

return apply_filters( 'wpforms_emails_mailer_get_cc_address', $this->cc, $this );

[271] Fix | Delete

}

[272] Fix | Delete

[273] Fix | Delete

$this->cc = $this->sanitize( $this->cc );

[274] Fix | Delete

[275] Fix | Delete

$addresses = array_filter( array_map( 'sanitize_email', explode( ',', $this->cc ) ) );

[276] Fix | Delete

[277] Fix | Delete

$this->cc = implode( ',', $addresses );

[278] Fix | Delete

[279] Fix | Delete

/** This filter is documented in src/Emails/Mailer.php. */

[280] Fix | Delete

return apply_filters( 'wpforms_emails_mailer_get_cc_address', $this->cc, $this );

[281] Fix | Delete

}

[282] Fix | Delete

[283] Fix | Delete

/**

[284] Fix | Delete

* Get the email content type.

[285] Fix | Delete

*

[286] Fix | Delete

* @since 1.5.4

[287] Fix | Delete

*

[288] Fix | Delete

* @return string The email content type.

[289] Fix | Delete

*/

[290] Fix | Delete

public function get_content_type() {

[291] Fix | Delete

[292] Fix | Delete

$is_html = ! Helpers::is_plain_text_template();

[293] Fix | Delete

[294] Fix | Delete

if ( ! $this->content_type && $is_html ) {

[295] Fix | Delete

// phpcs:ignore WPForms.Comments.PHPDocHooks.RequiredHookDocumentation

[296] Fix | Delete

$this->content_type = apply_filters( 'wpforms_emails_mailer_get_content_type_default', 'text/html', $this );

[297] Fix | Delete

} elseif ( ! $is_html ) {

[298] Fix | Delete

$this->content_type = 'text/plain';

[299] Fix | Delete

}

[300] Fix | Delete

[301] Fix | Delete

// phpcs:ignore WPForms.Comments.PHPDocHooks.RequiredHookDocumentation

[302] Fix | Delete

return apply_filters( 'wpforms_emails_mailer_get_content_type', $this->content_type, $this );

[303] Fix | Delete

}

[304] Fix | Delete

[305] Fix | Delete

/**

[306] Fix | Delete

* Get the email subject.

[307] Fix | Delete

*

[308] Fix | Delete

* @since 1.8.9

[309] Fix | Delete

*

[310] Fix | Delete

* @return string The email subject.

[311] Fix | Delete

*/

[312] Fix | Delete

private function get_subject() {

[313] Fix | Delete

[314] Fix | Delete

if ( empty( $this->subject ) ) {

[315] Fix | Delete

$this->subject = __( 'New Email Submit', 'wpforms-lite' );

[316] Fix | Delete

}

[317] Fix | Delete

[318] Fix | Delete

/**

[319] Fix | Delete

* Filters the email subject.

[320] Fix | Delete

*

[321] Fix | Delete

* @since 1.8.9

[322] Fix | Delete

*

[323] Fix | Delete

* @param string $subject Email subject.

[324] Fix | Delete

* @param Mailer $this Mailer instance.

[325] Fix | Delete

*/

[326] Fix | Delete

return apply_filters( 'wpforms_emails_mailer_get_subject', $this->subject, $this );

[327] Fix | Delete

}

[328] Fix | Delete

[329] Fix | Delete

/**

[330] Fix | Delete

* Get the email message.

[331] Fix | Delete

*

[332] Fix | Delete

* @since 1.5.4

[333] Fix | Delete

*

[334] Fix | Delete

* @return string The email message.

[335] Fix | Delete

*/

[336] Fix | Delete

public function get_message() {

[337] Fix | Delete

[338] Fix | Delete

if ( empty( $this->message ) && ! empty( $this->template ) ) {

[339] Fix | Delete

$this->message = $this->template->get();

[340] Fix | Delete

}

[341] Fix | Delete

[342] Fix | Delete

/**

[343] Fix | Delete

* Filters the email message.

[344] Fix | Delete

*

[345] Fix | Delete

* @since 1.5.4

[346] Fix | Delete

*

[347] Fix | Delete

* @param string $message Email message.

[348] Fix | Delete

* @param Mailer $this Mailer instance.

[349] Fix | Delete

*/

[350] Fix | Delete

return apply_filters( 'wpforms_emails_mailer_get_message', $this->message, $this );

[351] Fix | Delete

}

[352] Fix | Delete

[353] Fix | Delete

/**

[354] Fix | Delete

* Get the email headers.

[355] Fix | Delete

*

[356] Fix | Delete

* @since 1.5.4

[357] Fix | Delete

*

[358] Fix | Delete

* @return string The email headers.

[359] Fix | Delete

*/

[360] Fix | Delete

public function get_headers() {

[361] Fix | Delete

[362] Fix | Delete

if ( $this->headers ) {

[363] Fix | Delete

// phpcs:ignore WPForms.Comments.PHPDocHooks.RequiredHookDocumentation

[364] Fix | Delete

return apply_filters( 'wpforms_emails_mailer_get_headers', $this->headers, $this );

[365] Fix | Delete

}

[366] Fix | Delete

[367] Fix | Delete

$this->headers = "From: {$this->get_from_name()} <{$this->get_from_address()}>\r\n";

[368] Fix | Delete

[369] Fix | Delete

if ( $this->get_reply_to_address() ) {

[370] Fix | Delete

$this->headers .= "Reply-To: {$this->get_reply_to_address()}\r\n";

[371] Fix | Delete

}

[372] Fix | Delete

[373] Fix | Delete

$cc = $this->get_cc_address();

[374] Fix | Delete

[375] Fix | Delete

if ( $cc ) {

[376] Fix | Delete

$this->headers .= "Cc: {$cc}\r\n";

[377] Fix | Delete

}

[378] Fix | Delete

[379] Fix | Delete

$this->headers .= "Content-Type: {$this->get_content_type()}; charset=utf-8\r\n";

[380] Fix | Delete

[381] Fix | Delete

/**

[382] Fix | Delete

* Filters the email headers.

[383] Fix | Delete

*

[384] Fix | Delete

* @since 1.5.4

[385] Fix | Delete

*

[386] Fix | Delete

* @param string $headers Email headers.

[387] Fix | Delete

* @param Mailer $this Mailer instance.

[388] Fix | Delete

*/

[389] Fix | Delete

return apply_filters( 'wpforms_emails_mailer_get_headers', $this->headers, $this );

[390] Fix | Delete

}

[391] Fix | Delete

[392] Fix | Delete

/**

[393] Fix | Delete

* Get the email attachments.

[394] Fix | Delete

*

[395] Fix | Delete

* @since 1.5.4

[396] Fix | Delete

*

[397] Fix | Delete

* @return string|string[]

[398] Fix | Delete

*/

[399] Fix | Delete

public function get_attachments() {

[400] Fix | Delete

[401] Fix | Delete

if ( $this->attachments === null ) {

[402] Fix | Delete

$this->attachments = [];

[403] Fix | Delete

}

[404] Fix | Delete

[405] Fix | Delete

/**

[406] Fix | Delete

* Filters the email attachments.

[407] Fix | Delete

*

[408] Fix | Delete

* @since 1.5.4

[409] Fix | Delete

*

[410] Fix | Delete

* @param string|string[] $attachments Array or string with attachment paths.

[411] Fix | Delete

* @param Mailer $this Mailer instance.

[412] Fix | Delete

*/

[413] Fix | Delete

return apply_filters( 'wpforms_emails_mailer_get_attachments', $this->attachments, $this );

[414] Fix | Delete

}

[415] Fix | Delete

[416] Fix | Delete

/**

[417] Fix | Delete

* Set an email address to send to.

[418] Fix | Delete

*

[419] Fix | Delete

* @since 1.5.4

[420] Fix | Delete

*

[421] Fix | Delete

* @param string|string[] $email Array or comma-separated list of email addresses to send a message.

[422] Fix | Delete

*

[423] Fix | Delete

* @return Mailer

[424] Fix | Delete

*/

[425] Fix | Delete

public function to_email( $email ) {

[426] Fix | Delete

[427] Fix | Delete

if ( is_string( $email ) ) {

[428] Fix | Delete

$email = explode( ',', $email );

[429] Fix | Delete

}

[430] Fix | Delete

[431] Fix | Delete

// phpcs:ignore WPForms.Comments.PHPDocHooks.RequiredHookDocumentation

[432] Fix | Delete

$this->to_email = apply_filters( 'wpforms_emails_mailer_to_email', $email, $this );

[433] Fix | Delete

[434] Fix | Delete

return $this;

[435] Fix | Delete

}

[436] Fix | Delete

[437] Fix | Delete

/**

[438] Fix | Delete

* Set an email subject.

[439] Fix | Delete

*

[440] Fix | Delete

* @since 1.5.4

[441] Fix | Delete

*

[442] Fix | Delete

* @param string $subject Email subject.

[443] Fix | Delete

*

[444] Fix | Delete

* @return Mailer

[445] Fix | Delete

*/

[446] Fix | Delete

public function subject( $subject ) {

[447] Fix | Delete

[448] Fix | Delete

$subject = $this->sanitize( $subject );

[449] Fix | Delete

[450] Fix | Delete

// phpcs:ignore WPForms.Comments.PHPDocHooks.RequiredHookDocumentation

[451] Fix | Delete

$this->subject = apply_filters( 'wpforms_emails_mailer_subject', $subject, $this );

[452] Fix | Delete

[453] Fix | Delete

return $this;

[454] Fix | Delete

}

[455] Fix | Delete

[456] Fix | Delete

/**

[457] Fix | Delete

* Set an email message (body).

[458] Fix | Delete

*

[459] Fix | Delete

* @since 1.5.4

[460] Fix | Delete

*

[461] Fix | Delete

* @param string $message Email message.

[462] Fix | Delete

*

[463] Fix | Delete

* @return Mailer

[464] Fix | Delete

*/

[465] Fix | Delete

public function message( $message ) {

[466] Fix | Delete

[467] Fix | Delete

// phpcs:ignore WPForms.Comments.PHPDocHooks.RequiredHookDocumentation

[468] Fix | Delete

$this->message = apply_filters( 'wpforms_emails_mailer_message', $message, $this );

[469] Fix | Delete

[470] Fix | Delete

return $this;

[471] Fix | Delete

}

[472] Fix | Delete

[473] Fix | Delete

/**

[474] Fix | Delete

* Set email template.

[475] Fix | Delete

*

[476] Fix | Delete

* @since 1.5.4

[477] Fix | Delete

*

[478] Fix | Delete

* @param General $template Email template.

[479] Fix | Delete

*

[480] Fix | Delete

* @return Mailer

[481] Fix | Delete

*/

[482] Fix | Delete

public function template( General $template ) {

[483] Fix | Delete

[484] Fix | Delete

// phpcs:ignore WPForms.Comments.PHPDocHooks.RequiredHookDocumentation

[485] Fix | Delete

$this->template = apply_filters( 'wpforms_emails_mailer_template', $template, $this );

[486] Fix | Delete

[487] Fix | Delete

return $this;

[488] Fix | Delete

}

[489] Fix | Delete

[490] Fix | Delete

/**

[491] Fix | Delete

* Get email errors.

[492] Fix | Delete

*

[493] Fix | Delete

* @since 1.5.4

[494] Fix | Delete

*

[495] Fix | Delete

* @return array

[496] Fix | Delete

*/

[497] Fix | Delete

protected function get_errors() {

[498] Fix | Delete

[499] Fix | Delete