xref: /dokuwiki/inc/mail.php (revision 3ec19a6ad26bf02a10a848e2257c9d5a44e6f5e9)
1<?php
2/**
3 * Mail functions
4 *
5 * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
6 * @author     Andreas Gohr <andi@splitbrain.org>
7 */
8
9if(!defined('DOKU_INC')) die('meh.');
10
11// end of line for mail lines - RFC822 says CRLF but postfix (and other MTAs?)
12// think different
13if(!defined('MAILHEADER_EOL')) define('MAILHEADER_EOL',"\n");
14#define('MAILHEADER_ASCIIONLY',1);
15
16/**
17 * Patterns for use in email detection and validation
18 *
19 * NOTE: there is an unquoted '/' in RFC2822_ATEXT, it must remain unquoted to be used in the parser
20 * the pattern uses non-capturing groups as captured groups aren't allowed in the parser
21 * select pattern delimiters with care!
22 *
23 * May not be completly RFC conform!
24 * @link http://www.faqs.org/rfcs/rfc2822.html (paras 3.4.1 & 3.2.4)
25 *
26 * @author Chris Smith <chris@jalakai.co.uk>
27 * Check if a given mail address is valid
28 */
29if (!defined('RFC2822_ATEXT')) define('RFC2822_ATEXT',"0-9a-zA-Z!#$%&'*+/=?^_`{|}~-");
30if (!defined('PREG_PATTERN_VALID_EMAIL')) define('PREG_PATTERN_VALID_EMAIL', '['.RFC2822_ATEXT.']+(?:\.['.RFC2822_ATEXT.']+)*@(?i:[0-9a-z][0-9a-z-]*\.)+(?i:[a-z]{2,4}|museum|travel)');
31
32/**
33 * Prepare mailfrom replacement patterns
34 *
35 * @author Andreas Gohr <andi@splitbrain.org>
36 */
37function mail_setup(){
38    global $conf;
39    global $USERINFO;
40
41    $replace = array();
42
43    if(!empty($USERINFO['mail'])){
44        $replace['@MAIL@'] = $USERINFO['mail'];
45    }else{
46        $host = @parse_url(DOKU_URL,PHP_URL_HOST);
47        if(!$host) $host = 'example.com';
48        $replace['@MAIL@'] = 'noreply@'.$host;
49    }
50
51    if(!empty($_SERVER['REMOTE_USER'])){
52        $replace['@USER@'] = $_SERVER['REMOTE_USER'];
53    }else{
54        $replace['@USER@'] = 'noreply';
55    }
56
57    if(!empty($USERINFO['name'])){
58        $replace['@NAME@'] = $USERINFO['name'];
59    }else{
60        $replace['@NAME@'] = '';
61    }
62
63    $conf['mailfrom'] = str_replace(array_keys($replace),
64                                    array_values($replace),
65                                    $conf['mailfrom']);
66}
67
68/**
69 * UTF-8 autoencoding replacement for PHPs mail function
70 *
71 * Email address fields (To, From, Cc, Bcc can contain a textpart and an address
72 * like this: 'Andreas Gohr <andi@splitbrain.org>' - the text part is encoded
73 * automatically. You can seperate receivers by commas.
74 *
75 * @param string $to      Receiver of the mail (multiple seperated by commas)
76 * @param string $subject Mailsubject
77 * @param string $body    Messagebody
78 * @param string $from    Sender address
79 * @param string $cc      CarbonCopy receiver (multiple seperated by commas)
80 * @param string $bcc     BlindCarbonCopy receiver (multiple seperated by commas)
81 * @param string $headers Additional Headers (seperated by MAILHEADER_EOL
82 * @param string $params  Additonal Sendmail params (passed to mail())
83 *
84 * @author Andreas Gohr <andi@splitbrain.org>
85 * @see    mail()
86 */
87function mail_send($to, $subject, $body, $from='', $cc='', $bcc='', $headers=null, $params=null){
88
89    $message = compact('to','subject','body','from','cc','bcc','headers','params');
90    return trigger_event('MAIL_MESSAGE_SEND',$message,'_mail_send_action');
91}
92
93function _mail_send_action($data) {
94
95    // retrieve parameters from event data, $to, $subject, $body, $from, $cc, $bcc, $headers, $params
96    $to = $data['to'];
97    $subject = $data['subject'];
98    $body = $data['body'];
99
100    // add robustness in case plugin removes any of these optional values
101    $from = isset($data['from']) ? $data['from'] : '';
102    $cc = isset($data['cc']) ? $data['cc'] : '';
103    $bcc = isset($data['bcc']) ? $data['bcc'] : '';
104    $headers = isset($data['headers']) ? $data['headers'] : null;
105    $params = isset($data['params']) ? $data['params'] : null;
106
107    // end additional code to support event ... original mail_send() code from here
108
109    if(defined('MAILHEADER_ASCIIONLY')){
110        $subject = utf8_deaccent($subject);
111        $subject = utf8_strip($subject);
112    }
113
114    if(!utf8_isASCII($subject)) {
115        $subject = '=?UTF-8?Q?'.mail_quotedprintable_encode($subject,0).'?=';
116        // Spaces must be encoded according to rfc2047. Use the "_" shorthand
117        $subject = preg_replace('/ /', '_', $subject);
118    }
119
120    $header  = '';
121
122    // No named recipients for To: in Windows (see FS#652)
123    $usenames = (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') ? false : true;
124
125    $to = mail_encode_address($to,'',$usenames);
126    $header .= mail_encode_address($from,'From');
127    $header .= mail_encode_address($cc,'Cc');
128    $header .= mail_encode_address($bcc,'Bcc');
129    $header .= 'MIME-Version: 1.0'.MAILHEADER_EOL;
130    $header .= 'Content-Type: text/plain; charset=UTF-8'.MAILHEADER_EOL;
131    $header .= 'Content-Transfer-Encoding: quoted-printable'.MAILHEADER_EOL;
132    $header .= $headers;
133    $header  = trim($header);
134
135    $body = mail_quotedprintable_encode($body);
136
137    if($params == null){
138        return @mail($to,$subject,$body,$header);
139    }else{
140        return @mail($to,$subject,$body,$header,$params);
141    }
142}
143
144/**
145 * Encodes an email address header
146 *
147 * Unicode characters will be deaccented and encoded
148 * quoted_printable for headers.
149 * Addresses may not contain Non-ASCII data!
150 *
151 * Example:
152 *   mail_encode_address("föö <foo@bar.com>, me@somewhere.com","TBcc");
153 *
154 * @param string  $string Multiple adresses separated by commas
155 * @param string  $header Name of the header (To,Bcc,Cc,...)
156 * @param boolean $names  Allow named Recipients?
157 */
158function mail_encode_address($string,$header='',$names=true){
159    $headers = '';
160    $parts = explode(',',$string);
161    foreach ($parts as $part){
162        $part = trim($part);
163
164        // parse address
165        if(preg_match('#(.*?)<(.*?)>#',$part,$matches)){
166            $text = trim($matches[1]);
167            $addr = $matches[2];
168        }else{
169            $addr = $part;
170        }
171
172        // skip empty ones
173        if(empty($addr)){
174            continue;
175        }
176
177        // FIXME: is there a way to encode the localpart of a emailaddress?
178        if(!utf8_isASCII($addr)){
179            msg(htmlspecialchars("E-Mail address <$addr> is not ASCII"),-1);
180            continue;
181        }
182
183        if(!mail_isvalid($addr)){
184            msg(htmlspecialchars("E-Mail address <$addr> is not valid"),-1);
185            continue;
186        }
187
188        // text was given
189        if(!empty($text) && $names){
190            // add address quotes
191            $addr = "<$addr>";
192
193            if(defined('MAILHEADER_ASCIIONLY')){
194                $text = utf8_deaccent($text);
195                $text = utf8_strip($text);
196            }
197
198            if(!utf8_isASCII($text)){
199                $text = '=?UTF-8?Q?'.mail_quotedprintable_encode($text,0).'?=';
200            }
201        }else{
202            $text = '';
203        }
204
205        // add to header comma seperated
206        if($headers != ''){
207            $headers .= ',';
208            if($header) $headers .= MAILHEADER_EOL.' '; // avoid overlong mail headers
209        }
210        $headers .= $text.' '.$addr;
211    }
212
213    if(empty($headers)) return null;
214
215    //if headername was given add it and close correctly
216    if($header) $headers = $header.': '.$headers.MAILHEADER_EOL;
217
218    return $headers;
219}
220
221/**
222 * Check if a given mail address is valid
223 *
224 * @param   string $email the address to check
225 * @return  bool          true if address is valid
226 */
227function mail_isvalid($email){
228    $validator = new EmailAddressValidator;
229    $validator->allowLocalAddresses = true;
230    return $validator->check_email_address($email);
231}
232
233/**
234 * Quoted printable encoding
235 *
236 * @author umu <umuAThrz.tu-chemnitz.de>
237 * @link   http://www.php.net/manual/en/function.imap-8bit.php#61216
238 */
239function mail_quotedprintable_encode($sText,$maxlen=74,$bEmulate_imap_8bit=true) {
240    // split text into lines
241    $aLines= preg_split("/(?:\r\n|\r|\n)/", $sText);
242    $cnt = count($aLines);
243
244    for ($i=0;$i<$cnt;$i++) {
245        $sLine =& $aLines[$i];
246        if (strlen($sLine)===0) continue; // do nothing, if empty
247
248        $sRegExp = '/[^\x09\x20\x21-\x3C\x3E-\x7E]/e';
249
250        // imap_8bit encodes x09 everywhere, not only at lineends,
251        // for EBCDIC safeness encode !"#$@[\]^`{|}~,
252        // for complete safeness encode every character :)
253        if ($bEmulate_imap_8bit)
254            $sRegExp = '/[^\x20\x21-\x3C\x3E-\x7E]/e';
255
256        $sReplmt = 'sprintf( "=%02X", ord ( "$0" ) ) ;';
257        $sLine = preg_replace( $sRegExp, $sReplmt, $sLine );
258
259        // encode x09,x20 at lineends
260        {
261            $iLength = strlen($sLine);
262            $iLastChar = ord($sLine{$iLength-1});
263
264            //              !!!!!!!!
265            // imap_8_bit does not encode x20 at the very end of a text,
266            // here is, where I don't agree with imap_8_bit,
267            // please correct me, if I'm wrong,
268            // or comment next line for RFC2045 conformance, if you like
269            if (!($bEmulate_imap_8bit && ($i==count($aLines)-1))){
270                if (($iLastChar==0x09)||($iLastChar==0x20)) {
271                    $sLine{$iLength-1}='=';
272                    $sLine .= ($iLastChar==0x09)?'09':'20';
273                }
274            }
275        }    // imap_8bit encodes x20 before chr(13), too
276        // although IMHO not requested by RFC2045, why not do it safer :)
277        // and why not encode any x20 around chr(10) or chr(13)
278        if ($bEmulate_imap_8bit) {
279            $sLine=str_replace(' =0D','=20=0D',$sLine);
280            //$sLine=str_replace(' =0A','=20=0A',$sLine);
281            //$sLine=str_replace('=0D ','=0D=20',$sLine);
282            //$sLine=str_replace('=0A ','=0A=20',$sLine);
283        }
284
285        // finally split into softlines no longer than $maxlen chars,
286        // for even more safeness one could encode x09,x20
287        // at the very first character of the line
288        // and after soft linebreaks, as well,
289        // but this wouldn't be caught by such an easy RegExp
290        if($maxlen){
291            preg_match_all( '/.{1,'.($maxlen - 2).'}([^=]{0,2})?/', $sLine, $aMatch );
292            $sLine = implode( '=' . MAILHEADER_EOL, $aMatch[0] ); // add soft crlf's
293        }
294    }
295
296    // join lines into text
297    return implode(MAILHEADER_EOL,$aLines);
298}
299
300