| Project | |||
|---|---|---|---|
| category | Form To Email | ||
| package | PHPMailerFE | ||
| author | Andy Prevost |
||
| copyright | 2004-2023 (C) Andy Prevost - All Rights Reserved | ||
| version | 7.2.0 | ||
| license | MIT - Distributed under the MIT License | ||
| namespace | codeworxtech\PHPMailerFE; | ||
| class | Exception extends \Exception | ||
| const | |||
|---|---|---|---|
| scope | property | default value | comments |
| const | CRLF | "\r\n" | |
| const | ERR_CRITICAL | 9; | |
| const | FAILMK | '<span style="color:#FF0000;">✗</span> '; | |
| const | IMG_COMPLETE | "data:image/gif;base64,R0lGODlhyABUAKEAAGRylPR6DAAAAAAAACH5BAEAAAIALAAAAADIAFQAAAL+lI+py+0Po5y02ouz3rz7D4biSJbmiabqyrbuC8fyTNf2jef6zvf+DwwKh8Si8YhMKpfMpvMJjUqn1Kr1is1qt9yu9wsOi8fksvmMTqvX7Lb7DY8PAfIufXGv4wD8e9/wxwf4J+AnWEhIqPeSB3hA5+eYB1n46HhZuejSmFkZ6WkJ2feJqKi5wjmZGalKmaB6GjM6+MmaSPt4aBrbw8kb5fsrPExcbHyMnKy8fBHg/Awd/WwgXR1NbZ2NnV29zX0t8N0dLg4OVA6ODu2Nzl7uLg7/Lc8tpD5Nfk+vna++b/1v3D1n9gYGlHYwncF+7Ri+cxgvyMAACddBnHexXkZdfhMr4ju3sONGgCMFhjypTyJKfyURtlSYUqRIkDFXNpRp8+HMHzhr+mTZE+hCZkSLGj2KNKnSpUybOn0KNarUqVSrWr2KNavWrVy7ev0KNqzYsWTLmj2LNq3aLgUAADs=";= | |
| const | IMG_PROCESS | "data:image/gif,GIF89a%C8%00T%00%91%00%00%F7%7B%08k%7B%A5cs%94%FF%FF%FF!%FF%0BNETSCAPE2.0%03%01%00%00%00!%F9%04%05%19%00%03%00%2C%1F%00%1E%00%8A%00%18%00%00%02%FF%9C%8F%A9%CB%2A%0D%A3%9C%B4%DA%8B%B3%DE%FC%8A%FF%0C`%08%1E%A3Q%A2%E9%F9%9C%EA%D7%C5%B2%14%8A%B6%89%D7h%9E%E8v%DD%C2%CD%86%C4%DDN%07%BC%99%5C)%11%EC%C73%16%A7%9D%242%2A%5C%F8%82%D6%2C%F5%8Ba%F6%9E%CE%E7%EAlV%92VF%1F%F8%ED%85O%DC%F2z%CF%1Ei%E2%F7%FC%BE%FF%0F%18(8HXhx%88%98%A8%B8%98%08%E0%F8%08%19%F9h%10Piy%89iI%99%C9y%B9%D9%D9%F9%09%9A)%3A%EA9`%CA)%B9%1AY%9A%1A%E0%9A%1Ak%3A%3BZ%0Bz%DB%C9%BA%0B%B09%F2%FB%5B%E9%0BL%2C%8C%1A%40%5C%0C%7B%9C%0Cl%5C%D9%1C%BC%0C%1D%0DR%C9%CB%3A%5C%FD1%8D%BC%CD%AD%BD%DD%FD%0D%CEL%3E~%8E%BDJI.%F0%DC%FE~%3E%0D%3F%2F%CF.%AF.%19%1E%FD%EC-%8E%FEo_%B3~%F6%CC%FD%CB%D7%CA`5%82%DF%18%06T%C8%0F%E0B%89%11%11B%128%10c2%8A%1A%FC4%16%F3%E8%0Cd0%8B%93%8E%BD%D2d%F2d7%95%2BU%E6%E2%F42S%01%00!%F9%04%05%19%00%03%00%2C%1F%00-%00%26%00%09%00%00%022%8C%8Fy3%E0%0F%E3S41%89c%10%BC%FBo%5C%D9h%7C%A6%17%88%23%B6%9Dg%D8%ACl%EB%82%AA%0C%D1u%07%E3R%B9C%DD%7C%00%5D%B0G%7C%14%00%00!%F9%04%05%19%00%03%00%2C3%00-%00%26%00%09%00%00%022%8C%8Fy3%E0%0F%E3S41%89c%10%BC%FBo%5C%D9h%7C%A6%17%88%23%B6%9Dg%D8%ACl%EB%82%AA%0C%D1u%07%E3R%B9C%DD%7C%00%5D%B0G%7C%14%00%00!%F9%04%05%19%00%03%00%2CG%00-%00%26%00%09%00%00%022%8C%8Fy3%E0%0F%E3S41%89c%10%BC%FBo%5C%D9h%7C%A6%17%88%23%B6%9Dg%D8%ACl%EB%82%AA%0C%D1u%07%E3R%B9C%DD%7C%00%5D%B0G%7C%14%00%00!%F9%04%05%19%00%03%00%2C%5B%00-%00%26%00%09%00%00%022%8C%8Fy3%E0%0F%E3S41%89c%10%BC%FBo%5C%D9h%7C%A6%17%88%23%B6%9Dg%D8%ACl%EB%82%AA%0C%D1u%07%E3R%B9C%DD%7C%00%5D%B0G%7C%14%00%00!%F9%04%05%19%00%03%00%2Co%00-%00%26%00%09%00%00%022%8C%8Fy3%E0%0F%E3S41%89c%10%BC%FBo%5C%D9h%7C%A6%17%88%23%B6%9Dg%D8%ACl%EB%82%AA%0C%D1u%07%E3R%B9C%DD%7C%00%5D%B0G%7C%14%00%00!%F9%04%09%19%00%03%00%2C%1F%00%1E%00%8A%00%18%00%00%02%7C%9C%8F%A9%CB%ED%0F%A3%9C%B4%DA%8B%B3%DE%BC%FB%0F%86%E2H%96%E6%89%A6%EA%CA%B6%EE%0B%C7%F2L%D7%F6%8D%E7%FA%CE%F7%FE%0F%0C%0A%87%C4b'%80L%2A%97I%03%E0%09%8DJ%A1F%13%F3%BAtN%B7%D1j) %08%8B%C7d%A4%96%CB%F5%92%90%E4%F68pFO%D5%23%B0%DBm%1E%C8%D3%F4%10%FB%DE%06%A7%B77%D7%07b%07%F8%26HXh%E8%F1%97(%B6%C8%D8%E5%F8%18%A9%18GY%00%00%3B" | |
| const | IMG_TAG | '<img id="f2mprocessing" border="0" src="" . self::IMG_PROCESS . "" alt="...processing" title="Processing ..." width="200" height="84" /><br>';= | |
| const | PASSMK | '<span style="color:#008000;">✓</span> '; | |
| const | VERSION | "7.2.0" | |
| private | |||
|---|---|---|---|
| scope | property | default value | comments |
| private | $attachments | [] | |
| private | $bcc | ||
| private | $cc | ||
| private | $contentEnv | [] | |
| private | $contentEnvText | ||
| private | $contentHid | [] | |
| private | $contentHTML | [] | |
| private | $contentRaw | [] | |
| private | $contentText | [] | |
| private | $date | ||
| private | $email_bad | \r|\n|to:|cc:|bcc: | |
| private | $f2m_path | ||
| private | $language | [] | |
| private | $messageBody | [] | |
| private | $missing_fields | ||
| private | $msg_charset | UTF-8 | |
| private | $msg_encoding | 8bit | |
| private | $post | [] | |
| private | $recipients | ||
| private | $replyTo | ||
| private | $reserved_master | [ bcc,cc,host,ip,password,recipient,referer, | |
| private | $sender | ||
| private | $subjectLine | ||
| private | $time | ||
| private | $SendmailOpt | [0=>[pipe,r],1=>[pipe,w],2=>[pipe,w]];= | |
| private | $SendmailPath | ||
| private | $separator | : | |
| private | $useLanguage | ||
| private | $user_ip | ||
| private | $user_host | ||
| public | |||
|---|---|---|---|
| scope | property | default value | comments |
| public | $back_title | #4F81BD | |
| public | $fore_title | #FFFFFF | |
| public | $allowFileType | [ application/msword, | |
| public | $displayProgress | false | |
| public | $env_report | [REMOTE_HOST,REMOTE_USER,REMOTE_ADDR,HTTP_USER_AGENT,HTTP_REFERER] | |
| public | $error_message | [] | |
| public | $plugin_autorespond | ||
| public | $plugin_presend | ||
| public | $plugin_postsend | ||
| public | $redirectOnFail | form_error_fail.html | |
| public | $redirectOnSuccess | form_thankyou.php | |
| public | $required | ||
| public | $reserved_keys | ||
| public | $supressIP | false | |
| public | $useEnvReport | false | |
| public | $useSanitizer | true | |
| public | $SMTP_Account | [] | |
| public | $SMTP_Host | ||
| Methods | |||
|---|---|---|---|
| scope | function | params | comments |
| public | Bcc | $addy | Class Constructor adds to Bcc: field properly RFC formatted @param mixed (can be string or array) @return string |
| public | Cc | $addy | adds to Cc: field properly RFC formatted @param mixed (can be string or array) @return string |
| private | CheckRequired | $posts | Check / Process required fields |
| private | Email_CleanList | $data | accepts string or array containing email addresses (separated by comma) in almost any format - can be single address or multiple with or without correct spacing, quote marks removes items without emails @var string or array @return string |
| private | Email_GetName | $str | accepts string @var string @return string |
| private | ConvertRaw | $raw='' | creates $contents['text'] from $contents['raw'] array @param array @return boolean |
| private | Email_Extract | $str | extracts email address from a string @var string @return string |
| private | Email_FilterEmail | clean (shell safe) email addresses @var string @return string |
|
| private | Email_FilterName | $name | clean (shell safe) name (from email address) @var string @return string |
| private | Email_Format_RFC | $arr,$str='' | structured array containing email address, mailbox, host, name @var array @return string |
| private | Email_Str2Array | $str | accepts string containing email addresses in almost any format @var array @return string |
| private | FormatEnv | adds the structure and formatting to environment variables used with the HTML and TEXT formatting @param n/a @return string |
|
| private | FormatHTML | $data,$data_hidden="",$newdata='' | adds the structure and formatting to environment variables @param n/a @return string |
| private | FormatText | $data,$data_hidden="",$newdata='' | formats $content['text'] for email body |
| public | From | $addy | creates unique From: field properly RFC formatted @param mixed (can be string or array) @return string |
| private | GetAttachments | Upload attachments if there are such (intended for recipient) can handle multiple files with no specific form field naming |
|
| private | GetFile | $file,$num | Create arrays needed for file attachments @param string $file @param integer $num @return boolean |
| protected | Lang | $key | Returns a message in the appropriate language. @return string |
| private | ParseForm | $data | Encodes and wraps long multibyte strings for mail headers without breaking lines within a character validates $str as multibyte @param string $str multi-byte string to encode @return string processes the form and user input @param array @return string |
| private | SafeStr | $str | Filter data (ascii and url-encoded) to prevent header injection @param string $str String @return string (trimmed) |
| private | SanitizeInput | $data | Sanitize forms data @param string @return string |
| public | SendForm | ||
| private | SetLanguage | $langcode = 'en', $lang_path = 'language/' | Sets the language for all class error messages. The default language is English 'en' Based on ISO 639-1 2-character language code (ie. English: 'en') https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes @param string $langcode @param string $lang_path Path to the language file directory array named same as PHPMailer for compatibility |
| public | Subject | $str | creates unique Subject line, cleans, sanitizes @param string @return string |
| public | To | $addy | adds to the To: field properly RFC formatted @param mixed (can be string or array) @return string |
| public | errorMessage | PHPMailer-FE Exception class @see https://sourceforge.net/projects/phpmailer-fe/ @package PHPMailerFE @author Andy Prevost @copyright 2004-2023 (C) Andy Prevost - All Rights Reserved @version 7.2.0 @license MIT - Distributed under the MIT License as shown above |
|
| public | errorMessageRaw | ||