version, '2.4.1', '<')) { $this->error(' requires ProcessWire 2.4.1 or newer. Please update.'); } $siteconfig = is_array(wire('config')->wiremailsmtp) ? wire('config')->wiremailsmtp : array(); $modules = wire('modules'); $form = new InputfieldWrapper(); // LOCALHOST $field = $modules->get('InputfieldText'); $field->attr('name', 'localhost'); $field->attr('value', $data['localhost']); $field->label = $this->_('Local Hostname'); $field->description = $this->_('Hostname of this computer'); if(isset($siteconfig['localhost'])) { $field->notes = $this->attentionMessage($siteconfig['localhost']); $field->attr('tabindex', '-1'); } else { $field->required = true; } $field->icon = 'desktop'; $form->add($field); // WRAPPER SMTP SERVER $fieldset = $modules->get('InputfieldFieldset'); $fieldset->label = $this->_('SMTP Server'); $fieldset->attr('name', '_smtp'); $fieldset->collapsed = Inputfield::collapsedNo; $fieldset->icon = 'server'; // SMTP HOST $field = $modules->get('InputfieldText'); $field->attr('name', 'smtp_host'); $field->attr('value', $data['smtp_host']); $field->label = $this->_('SMTP Hostname'); $field->description = $this->_('Set to the host name of the SMTP server to which you want to relay the messages'); $field->columnWidth = 50; if(isset($siteconfig['smtp_host'])) { $field->notes = $this->attentionMessage($siteconfig['smtp_host']); $field->attr('tabindex', '-1'); } else { $field->required = true; } $field->icon = 'server'; $fieldset->add($field); // SMTP PORT $field = $modules->get('InputfieldInteger'); $field->attr('name', 'smtp_port'); $field->attr('value', $data['smtp_port']); $field->label = $this->_('SMTP Port'); $field->description = $this->_('Set to the TCP port of the SMTP server host to connect'); if(isset($siteconfig['smtp_port'])) { $field->notes = $this->attentionMessage($siteconfig['smtp_port']); $field->attr('tabindex', '-1'); } else { $field->notes = $this->_("default: 25\ndefault for TLS / SSL: 587 or 465"); $field->required = true; } $field->columnWidth = 50; $field->icon = 'sign-out'; $fieldset->add($field); // ALLOW WITHOUT ANY AUTHENTICATION $field = $modules->get('InputfieldCheckbox'); $field->attr('name', 'allow_without_authentication'); $field->attr('id', 'allow_without_authentication'); $field->attr('value', 1); $field->attr('checked', $data['allow_without_authentication'] ? 'checked' : ''); $field->label = $this->_('Allow Connection without Authentication'); $field->description = $this->_('Server allows connecting without Authentication Credentials'); if(isset($siteconfig['allow_without_authentication'])) { $field->notes = $this->attentionMessage($siteconfig['allow_without_authentication']); $field->attr('tabindex', '-1'); } else { $field->notes = $this->_('Default: unchecked'); } $field->columnWidth = 33; $field->icon = 'unlock'; $fieldset->add($field); // SMTP USER $field = $modules->get('InputfieldText'); $field->attr('name', 'smtp_user'); $field->attr('value', $data['smtp_user']); $field->label = $this->_('SMTP User'); $field->description = $this->_('Set this variable to the user name when the SMTP server requires authentication'); if(isset($siteconfig['smtp_user'])) { $field->notes = $this->attentionMessage($siteconfig['smtp_user']); $field->attr('tabindex', '-1'); } $field->columnWidth = 34; $field->icon = 'user'; $fieldset->add($field); // SMTP PASSWORD $field = $modules->get('InputfieldText'); $field->attr('name', 'smtp_password'); $field->attr('value', $data['smtp_password']); $field->attr('type', 'password'); $field->label = $this->_('SMTP Password'); $field->description = $this->_('Set this variable to the user password when the SMTP server requires authentication'); if(isset($siteconfig['smtp_password'])) { $field->notes = $this->attentionMessage('*******'); $field->attr('tabindex', '-1'); } else { $field->notes = $this->_('**Note**: Password is stored as plain text in database.'); } $field->columnWidth = 33; $field->icon = 'asterisk'; $fieldset->add($field); // SMTP STARTTLS $field = $modules->get('InputfieldCheckbox'); $field->attr('name', 'smtp_start_tls'); $field->attr('id', 'smtp_start_tls'); $field->attr('value', 1); $field->attr('checked', $data['smtp_start_tls'] ? 'checked' : ''); $field->columnWidth = 50; $field->label = $this->_('Use START-TLS'); $field->description = $this->_('Check if the connection to the SMTP server should use encryption after the connection is established using TLS protocol'); if(isset($siteconfig['smtp_start_tls'])) { $field->notes = $this->attentionMessage($siteconfig['smtp_start_tls']); $field->attr('tabindex', '-1'); } $field->icon = 'lock'; //$field->showIf = 'smtp_ssl=0'; $fieldset->add($field); // TLS crypto method $field = $modules->get('InputfieldSelect'); $field->attr('name', 'smtp_tls_crypto_method'); $field->attr('value', $data['smtp_tls_crypto_method']); $field->label = $this->_('Select a crypto method for TLS'); $availableTLSmethods = WireMailSmtp::getCryptoMethodsTLS(); array_unshift($availableTLSmethods, array('')); $field->addOptions($availableTLSmethods); $field->description = $this->_("Select the crypto method that should be used for TLS connections. If you don't know what to select, try with the highest and strongest entry first!"); if(isset($siteconfig['smtp_tls_crypto_method'])) { $field->notes = $this->attentionMessage($siteconfig['smtp_tls_crypto_method']); $field->attr('tabindex', '-1'); } $field->columnWidth = 50; $field->icon = 'lock'; //$field->showIf = 'smtp_start_tls=1'; $fieldset->add($field); // SMTP SSL $field = $modules->get('InputfieldCheckbox'); $field->attr('name', 'smtp_ssl'); $field->attr('id', 'smtp_ssl'); $field->attr('value', 1); $field->attr('checked', $data['smtp_ssl'] ? 'checked' : ''); $field->columnWidth = 100; $field->label = $this->_('Use SSL'); $field->description = $this->_('Check if the SMTP server requires secure connections using SSL protocol'); if(isset($siteconfig['smtp_ssl'])) { $field->notes = $this->attentionMessage($siteconfig['smtp_ssl']); $field->attr('tabindex', '-1'); } $field->icon = 'lock'; //$field->showIf = 'smtp_start_tls=0'; $fieldset->add($field); // SSL crypto method // $field = $modules->get('InputfieldSelect'); // $field->attr('name', 'smtp_ssl_crypto_method'); // $field->attr('value', $data['smtp_ssl_crypto_method']); // $field->label = $this->_('Select a crypto method for SSL'); // $availableSSLmethods = WireMailSmtp::getCryptoMethodsSSL(); // array_unshift($availableSSLmethods, array('')); // $field->addOptions($availableSSLmethods); // $field->description = $this->_("Select the crypto method that should be used for SSL connections. If you don't know what to select, try with the highest and strongest entry first!"); // if(isset($siteconfig['smtp_ssl_crypto_method'])) { // $field->notes = $this->attentionMessage($siteconfig['smtp_ssl_crypto_method']); // $field->attr('tabindex', '-1'); // } // $field->columnWidth = 50; // $field->icon = 'lock'; // $fieldset->add($field); // SMTP CERTIFICATE // @flydev: https://processwire.com/talk/topic/5704-wiremailsmtp/page-5#entry113290 if(version_compare(phpversion(), '5.6.0', '>=')) { $field = $modules->get('InputfieldCheckbox'); $field->attr('name', 'smtp_certificate'); $field->label = $this->_('PHP >= 5.6 - Allow self signed certificate'); $field->attr('value', $data['smtp_certificate']); $field->attr('checked', $data['smtp_certificate'] ? 'checked' : ''); $field->columnWidth = 100; $field->icon = 'certificate'; $fieldset->add($field); } // WRAPPER ADVANCED SMTP SETTINGS $fieldset2 = $modules->get('InputfieldFieldset'); $fieldset2->label = $this->_('Advanced SMTP'); $fieldset2->attr('name', '_advanced_SMTP'); $fieldset2->collapsed = Inputfield::collapsedYes; $fieldset2->icon = 'cogs'; // AUTHENTICATION MECHANISM $field = $modules->get('InputfieldText'); $field->attr('name', 'authentication_mechanism'); $field->attr('value', $data['authentication_mechanism']); $field->label = $this->_('Authentication Mechanism'); $field->description = $this->_('Force the use of a specific authentication mechanism.'); if(isset($siteconfig['authentication_mechanism'])) { $field->notes = $this->attentionMessage($siteconfig['authentication_mechanism']); $field->attr('tabindex', '-1'); } else { $field->notes = $this->_('Default: empty'); } $field->columnWidth = 33; $field->icon = 'unlock'; $fieldset2->add($field); // REALM $field = $modules->get('InputfieldText'); $field->attr('name', 'realm'); $field->attr('value', $data['realm']); $field->label = $this->_('Realm'); $field->description = $this->_('Set this variable when the SMTP server requires authentication and if more than one authentication realm is supported'); if(isset($siteconfig['realm'])) { $field->notes = $this->attentionMessage($siteconfig['realm']); $field->attr('tabindex', '-1'); } else { $field->notes = $this->_('Default: empty'); } $field->columnWidth = 34; $field->icon = 'map-signs'; $fieldset2->add($field); // WORKSTATION $field = $modules->get('InputfieldText'); $field->attr('name', 'workstation'); $field->attr('value', $data['workstation']); $field->label = $this->_('Workstation'); $field->description = $this->_('Set this variable to the client workstation when the SMTP server requires authentication identifiying the origin workstation name'); if(isset($siteconfig['workstation'])) { $field->notes = $this->attentionMessage($siteconfig['workstation']); $field->attr('tabindex', '-1'); } else { $field->notes = $this->_('Default: empty'); } $field->columnWidth = 33; $field->icon = 'building'; $fieldset2->add($field); $fieldset->add($fieldset2); $form->add($fieldset); // WRAPPER SENDER $fieldset = $modules->get('InputfieldFieldset'); $fieldset->label = $this->_('Sender'); $fieldset->attr('name', '_sender'); $fieldset->collapsed = Inputfield::collapsedNo; $fieldset->icon = 'address-book'; // SENDER EMAIL $field = $modules->get('InputfieldText'); $field->attr('name', 'sender_email'); $field->attr('value', $data['sender_email']); $field->label = $this->_('Sender Email Address'); if(isset($siteconfig['sender_email'])) { $field->notes = $this->attentionMessage($siteconfig['sender_email']); $field->attr('tabindex', '-1'); } $field->columnWidth = 40; $field->icon = 'at'; $fieldset->add($field); // SENDER NAME $field = $modules->get('InputfieldText'); $field->attr('name', 'sender_name'); $field->attr('value', $data['sender_name']); $field->label = $this->_('Sender Name'); if(isset($siteconfig['sender_name'])) { $field->notes = $this->attentionMessage($siteconfig['sender_name']); $field->attr('tabindex', '-1'); } $field->columnWidth = 40; $field->icon = 'user'; $fieldset->add($field); // FORCE USERNAME AS SENDER $field = $modules->get('InputfieldCheckbox'); $field->attr('name', 'force_sender'); $field->attr('id', 'force_sender'); $field->attr('value', 1); $field->attr('checked', isset($data['force_sender']) && $data['force_sender'] ? 'checked' : ''); $field->columnWidth = 20; $field->label = $this->_('Force SMTP User as sender'); $field->description = $this->_('Check if SMTP allows messages only from mailbox user. This will force From-field as set in this configuration.'); if(isset($siteconfig['force_sender'])) { $field->notes = $this->attentionMessage($siteconfig['force_sender']); $field->attr('tabindex', '-1'); } $field->icon = 'user-circle-o'; $fieldset->add($field); // SENDER REPLY EMAIL $field = $modules->get('InputfieldText'); $field->attr('name', 'sender_reply'); $field->attr('value', $data['sender_reply']); $field->label = $this->_('Reply Email Address'); $field->description = $this->_('if is empty, Sender Emailaddress is used'); if(isset($siteconfig['sender_reply'])) { $field->notes = $this->attentionMessage($siteconfig['sender_reply']); $field->attr('tabindex', '-1'); } $field->columnWidth = 50; $field->collapsed = Inputfield::collapsedYes; $field->icon = 'mail-reply'; $fieldset->add($field); // SENDER ERROR EMAIL $field = $modules->get('InputfieldText'); $field->attr('name', 'sender_errors_to'); $field->attr('value', $data['sender_errors_to']); $field->label = $this->_('Errors Email Address'); if(isset($siteconfig['sender_errors_to'])) { $field->notes = $this->attentionMessage($siteconfig['sender_errors_to']); $field->attr('tabindex', '-1'); } else { $field->notes = $this->_('Default: empty'); } $field->columnWidth = 50; $field->collapsed = Inputfield::collapsedYes; $field->icon = 'remove'; $fieldset->add($field); // SENDER SIGNATURE (TEXT) $field = $modules->get('InputfieldTextarea'); $field->attr('name', 'sender_signature'); $field->attr('value', $data['sender_signature']); $field->label = $this->_('Sender Signature (Plain Text)'); $field->description = $this->_('Like Contact Data and / or Confidentiality Notices'); if(isset($siteconfig['sender_signature'])) { $field->notes = $this->attentionMessage('***'); $field->attr('tabindex', '-1'); } $field->columnWidth = 33; $field->icon = 'pencil'; $fieldset->add($field); // SENDER SIGNATURE (HTML) $field = $modules->get('InputfieldTextarea'); $field->attr('name', 'sender_signature_html'); $field->attr('value', $data['sender_signature_html']); $field->label = $this->_('Sender Signature (HTML)'); $field->description = $this->_('Like Contact Data and / or Confidentiality Notices'); if(isset($siteconfig['sender_signature_html'])) { $field->notes = $this->attentionMessage('***'); $field->attr('tabindex', '-1'); } $field->columnWidth = 33; $field->icon = 'code'; $fieldset->add($field); // SENDER SEND SIGNATURE $field = $modules->get('InputfieldSelect'); $field->attr('name', 'send_sender_signature'); $field->attr('value', $data['send_sender_signature']); $field->label = $this->_('Send Sender Signature'); $field->addOptions(array( '1' => 'only when explicitly called via API', '2' => 'automaticaly when FROM = Sender Emailaddress', '3' => 'automaticaly with _every_ Message' )); $field->description = $this->_('When the Signature should be send by default, (could be overriden by the API)'); $field->columnWidth = 34; $field->icon = 'question'; $fieldset->add($field); $form->add($fieldset); // WRAPPER ADVANCED SETTINGS $fieldset = $modules->get('InputfieldFieldset'); $fieldset->label = $this->_('Advanced'); $fieldset->attr('name', '_advanced'); $fieldset->collapsed = Inputfield::collapsedYes; $fieldset->icon = 'gear'; // VALID RECIPIENTS $field = $modules->get('InputfieldTextarea'); $field->attr('name', 'valid_recipients'); $field->attr('value', $data['valid_recipients']); $field->label = $this->_('Valid Recipients'); $field->description = $this->_('List of email addresses that can receive messages.'); if(isset($siteconfig['valid_recipients'])) { $aTemp = array(); foreach($siteconfig['valid_recipients'] as $k => $v) $aTemp[] = "{$k} : {$v}"; $field->notes = $this->attentionMessage("\n" . implode("\n", $aTemp) . "\n"); $field->attr('tabindex', '-1'); unset($k, $v, $aTemp); } else { $field->notes = $this->_('One email per line'); } $field->columnWidth = 50; $field->icon = 'users'; $fieldset->add($field); // EXTRA HEADERS $field = $modules->get('InputfieldTextarea'); $field->attr('name', 'extra_headers'); $field->attr('value', $data['extra_headers']); $field->label = $this->_('Extra Headers'); $field->description = $this->_('Optionally define custom meta headers.'); if(isset($siteconfig['extra_headers'])) { $aTemp = array(); foreach($siteconfig['extra_headers'] as $k => $v) $aTemp[] = "{$k} : {$v}"; $field->notes = $this->attentionMessage("\n" . implode("\n", $aTemp) . "\n"); $field->attr('tabindex', '-1'); unset($k, $v, $aTemp); } else { $field->notes = $this->_('One email per line'); } $field->columnWidth = 50; $field->icon = 'align-left'; $fieldset->add($field); $form->add($fieldset); // DISPLAY FINAL MERGED SETTINGS $field = $modules->get('InputfieldMarkup'); $field->attr('name', '_final_settings'); $field->label = 'Final Merged Settings'; $field->icon = 'filter'; $field->columnWidth = 100; $field->collapsed = Inputfield::collapsedNo; $field->attr('value', $this->finalSettingsMessage($siteconfig)); $form->add($field); // TEST SETTINGS $field = $modules->get('InputfieldCheckbox'); $field->attr('name', '_test_settings'); $field->label = $this->_('Test settings'); $field->description = $this->_('Test settings now.'); $field->attr('value', 1); $field->attr('checked', ''); $field->icon = 'heartbeat'; $form->add($field); // OPTIONAL VERBOSE DEBUGGING $fieldset = $modules->get('InputfieldFieldset'); $fieldset->label = $this->_('Verbose Debug settings'); $fieldset->attr('name', '_verbosedebug'); $fieldset->collapsed = Inputfield::collapsedNo; $fieldset->showIf = '_test_settings=1'; $fieldset->icon = 'heartbeat'; $field = $modules->get('InputfieldText'); $field->attr('name', 'debug_senderemail'); $field->attr('value', $data['sender_email']); $field->label = $this->_('Sender Email Address'); // if(isset($siteconfig['sender_email'])) { // $field->notes = $this->attentionMessage($siteconfig['sender_email']); // $field->attr('tabindex', '-1'); // } $field->columnWidth = 50; $field->icon = 'at'; $fieldset->add($field); $field = $modules->get('InputfieldText'); $field->attr('name', 'debug_recipientemail'); $field->attr('value', ''); $field->label = $this->_('Recipient Email Address'); $field->columnWidth = 50; $field->icon = 'at'; $fieldset->add($field); $field = $modules->get('InputfieldText'); $field->attr('name', 'debug_subjectline'); $field->attr('value', ''); $field->label = $this->_('Subjectline'); $field->columnWidth = 50; $field->icon = 'pencil'; $fieldset->add($field); $field = $modules->get('InputfieldTextarea'); $field->attr('name', 'debug_bodycontent'); $field->attr('value', 'This is a test message. ÄÖÜ äöüß'); $field->label = $this->_('Bodycontent'); $field->columnWidth = 50; $field->icon = 'envelope-o'; $fieldset->add($field); $form->add($fieldset); if(wire('session')->test_settings) { // EXECUTE DEBUG CONNECTION AND DISPLAY LOG $field = $modules->get('InputfieldMarkup'); $field->attr('name', '_debug_log'); $field->label = 'Debug Log'; $field->icon = 'heartbeat'; $field->columnWidth = 100; $field->collapsed = Inputfield::collapsedNo; $field->attr('value', $this->testSettings()); $form->add($field); } else if(wire('input')->post->_test_settings) { // PREPARE SESSION FOR DEBUGGING $session = wire('session'); $session->set('test_settings', 1); $post = wire('input')->post; $session->set('debug_senderemail', $post->debug_senderemail); $session->set('debug_recipientemail', $post->debug_recipientemail); $session->set('debug_subjectline', $post->debug_subjectline); $session->set('debug_bodycontent', $post->debug_bodycontent); } return $form; } public function testSettings() { try { $session = wire('session'); $from = $session->get('debug_senderemail'); $to = array($session->get('debug_recipientemail')); $subject = $session->get('debug_subjectline'); $body = $session->get('debug_bodycontent'); $session->remove('test_settings'); $session->remove('debug_senderemail'); $session->remove('debug_recipientemail'); $session->remove('debug_subjectline'); $session->remove('debug_bodycontent'); if($from && $to) { // do a verbose debugging if(!$subject) $subject = 'Debug Testmail'; if(!$body) $body = 'Debug Testmail, äöüß'; $mail = wireMail(); if($mail->className != 'WireMailSmtp') { $dump = "

Couldn't get the right WireMail-Module (WireMailSmtp). found: {$mail->className}

"; } else { $mail->from = $from; $mail->to($to); $mail->subject($subject); $mail->sendSingle(true); $mail->body($body); $dump = $mail->debugSend(3); } } else { // only try a testconnection $module = wire('modules')->get('WireMailSmtp'); $a = $module->getAdaptor(); if($a->testConnection()) { $dump = $this->_("SUCCESS! SMTP settings appear to work correctly."); } else { $dump = $this->_("FAILURE! SMTP settings doesn't appear to work."); } } } catch(Exception $e) { $dump = $e->getMessage(); } $outputTemplate = "
".str_replace(array('
', '
', '
'), '', $dump) ."
"; return $outputTemplate; } private function attentionMessage($value) { return sprintf($this->_("ATTENTION: Value is overwritten by an entry in your site/config.php:\n -[ %s ]- "), $value); } private function finalSettingsMessage($siteconfig) { $outputTemplate = "
[__CONTENT__]
"; if(!count($siteconfig)) { $content = 'There are no overriding settings defined in your site/config.php'; return str_replace('[__CONTENT__]', $content, $outputTemplate); } $validKeys = array( 'localhost', 'smtp_host', 'smtp_port', 'smtp_ssl', 'smtp_ssl_crypto_method', 'smtp_start_tls', 'smtp_tls_crypto_method', 'smtp_user', 'smtp_password', 'allow_without_authentication', 'smtp_certificate', 'realm', 'workstation', 'authentication_mechanism', 'sender_name', 'sender_email', 'sender_reply', 'sender_errors_to', 'sender_signature', 'sender_signature_html', 'extra_headers', 'valid_recipients', #'smtp_debug', #'smtp_html_debug', ); $module = wire('modules')->get('WireMailSmtp'); $dump = $module->getSettings(); $v = array(); foreach($validKeys as $k) { if(isset($dump[$k])) { $v[$k] = 'smtp_password' == $k ? '********' : $dump[$k]; } } ob_start(); var_dump($v); $content = ob_get_contents(); ob_end_clean(); $m = 0; preg_match_all('#^(.*)=>#mU', $content, $stack); $lines = $stack[1]; $indents = array_map('strlen', $lines); if($indents) $m = max($indents) + 1; $content = preg_replace_callback( '#^(.*)=>\\n\s+(\S)#Um', function($match) use ($m) { return $match[1] . str_repeat(' ', ($m - strlen($match[1]) > 1 ? $m - strlen($match[1]) : 1)) . $match[2]; }, $content ); $content = preg_replace('#^((\s*).*){$#m', "\\1\n\\2{", $content); $content = str_replace(array('
', '
'), '', $content); return str_replace('[__CONTENT__]', $content, $outputTemplate); } }