[TASK] Deprecate old mail related methods in GeneralUtility 20/33920/2
authorChristian Kuhn <lolli@schwarzbu.ch>
Sun, 9 Nov 2014 14:06:19 +0000 (15:06 +0100)
committerWouter Wolters <typo3@wouterwolters.nl>
Sun, 9 Nov 2014 14:34:40 +0000 (15:34 +0100)
Some mail related methods in GeneralUtility are obsolete and
unused in core and can be deprecated now.

Change-Id: Ie2fe3a841a1f83fc23d11381c083b65fb10b32eb
Resolves: #62794
Releases: master
Reviewed-on: http://review.typo3.org/33920
Reviewed-by: Benjamin Mack <benni@typo3.org>
Tested-by: Benjamin Mack <benni@typo3.org>
Reviewed-by: Wouter Wolters <typo3@wouterwolters.nl>
Tested-by: Wouter Wolters <typo3@wouterwolters.nl>
typo3/sysext/core/Classes/Utility/GeneralUtility.php
typo3/sysext/core/Documentation/Changelog/master/Deprecation-62794-DeprecateOldMailMethodsInGeneralUtility.rst [new file with mode: 0644]

index c6c62ac..c86822c 100644 (file)
@@ -4620,8 +4620,10 @@ Connection: close
         * @param string $string Content to encode
         * @param int $maxlen Length of the lines, default is 76
         * @return string The QP encoded string
+        * @deprecated since TYPO3 CMS 7, will be removed in CMS 8. Use mailer API instead
         */
        static public function quoted_printable($string, $maxlen = 76) {
+               static::logDeprecatedFunction();
                // Make sure the string contains only Unix line breaks
                // Replace Windows breaks (\r\n)
                $string = str_replace(CRLF, LF, $string);
@@ -4678,8 +4680,10 @@ Connection: close
         * @param string $enc Encoding type: "base64" or "quoted-printable". Default value is "quoted-printable".
         * @param string $charset Charset used for encoding
         * @return string The encoded string
+        * @deprecated since TYPO3 CMS 7, will be removed in CMS 8. Use mailer API instead
         */
        static public function encodeHeader($line, $enc = 'quoted-printable', $charset = 'utf-8') {
+               static::logDeprecatedFunction();
                // Avoid problems if "###" is found in $line (would conflict with the placeholder which is used below)
                if (strpos($line, '###') !== FALSE) {
                        return $line;
@@ -4732,8 +4736,10 @@ Connection: close
         * @param string $index_script_url URL of index script (see makeRedirectUrl())
         * @return string Processed message content
         * @see makeRedirectUrl()
+        * @deprecated since TYPO3 CMS 7, will be removed in CMS 8. Use mailer API instead
         */
        static public function substUrlsInPlainText($message, $urlmode = '76', $index_script_url = '') {
+               static::logDeprecatedFunction();
                switch ((string)$urlmode) {
                        case '':
                                $lengthLimit = FALSE;
@@ -4768,8 +4774,10 @@ Connection: close
         * @param int $l URL string length limit
         * @param string $index_script_url URL of "index script" - the prefix of the "?RDCT=..." parameter. If not supplied it will default to \TYPO3\CMS\Core\Utility\GeneralUtility::getIndpEnv('TYPO3_REQUEST_DIR').'index.php'
         * @return string Processed URL
+        * @deprecated since TYPO3 CMS 7, will be removed in CMS 8. Use mailer API instead
         */
        static public function makeRedirectUrl($inUrl, $l = 0, $index_script_url = '') {
+               static::logDeprecatedFunction();
                if (strlen($inUrl) > $l) {
                        $md5 = substr(md5($inUrl), 0, 20);
                        $count = $GLOBALS['TYPO3_DB']->exec_SELECTcountRows('*', 'cache_md5params', 'md5hash=' . $GLOBALS['TYPO3_DB']->fullQuoteStr($md5, 'cache_md5params'));
diff --git a/typo3/sysext/core/Documentation/Changelog/master/Deprecation-62794-DeprecateOldMailMethodsInGeneralUtility.rst b/typo3/sysext/core/Documentation/Changelog/master/Deprecation-62794-DeprecateOldMailMethodsInGeneralUtility.rst
new file mode 100644 (file)
index 0000000..e3b9964
--- /dev/null
@@ -0,0 +1,30 @@
+====================================================
+Deprecation: #62794 - Mail methods in GeneralUtility
+====================================================
+
+Description
+===========
+
+The following methods of the class \TYPO3\CMS\Core\Utility\GeneralUtility are deprecated:
+
+ * quoted_printable()
+ * encodeHeader()
+ * substUrlsInPlainText()
+ * makeRedirectUrl()
+
+Impact
+======
+
+The methods were used together with the old mail API and are obsolete now. Deprecation warnings will be triggered if used.
+
+Affected installations
+======================
+
+Installations that still use those methods will trigger deprecations warnings.
+
+
+Migration
+=========
+
+Code that still uses these methods should be refactored to the mail API using
+TYPO3\CMS\Core\Mail\Mailer class.
\ No newline at end of file