5 * Copyright (c) 2004 The SquirrelMail Project Team
6 * Licensed under the GNU GPL. For full terms see the file COPYING.
8 * Contains rfc822 email address function parsing functions.
12 * @package squirrelmail
15 if (!defined('SQM_ADDR_PERSONAL')) define('SQM_ADDR_PERSONAL', 0);
16 if (!defined('SQM_ADDR_ADLL')) define('SQM_ADDR_ADL', 1);
17 if (!defined('SQM_ADDR_MAILBOX')) define('SQM_ADDR_MAILBOX', 2);
18 if (!defined('SQM_ADDR_HOST')) define('SQM_ADDR_HOST', 3);
21 * parseRFC822Address: function for parsing RFC822 email address strings and store
22 * them in an address array
24 * @param string $address The email address string to parse
25 * @param array $aProps associative array with properties
27 * @author Marc Groot Koerkamp
31 function parseRFC822Address($sAddress,$aProps) {
32 $aPropsDefault = array (
34 'limit' => 0, // limits returned addresses
35 'abooklookup' => false); // callback function for addressbook lookup
37 $aProps = is_array($aProps) ?
array_merge($aPropsDefault,$aProps) : $aPropsDefault;
39 $cbLookup = $aProps['abooklookup'];
40 $sDomain = $aProps['domain'];
41 $iLimit = $aProps['limit'];
43 $aTokens = _getAddressTokens($sAddress);
44 $sPersonal = $sEmail = $sComment = $sGroup = '';
45 $aStack = $aComment = $aAddress = array();
46 foreach ($aTokens as $sToken) {
47 if ($iLimit && $iLimit == count($aAddress)) {
59 $aComment[] = substr($sToken,1,-1);
63 $aAddress[] = _createAddressElement($aStack,$aComment,$sEmail);
64 $oAddr = end($aAddress);
65 if(!$oAddr ||
((isset($oAddr)) && !$oAddr->mailbox
&& !$oAddr->personal
)) {
66 $sEmail = $sGroup . ':;';
68 $aAddress[] = _createAddressElement($aStack,$aComment,$sEmail);
70 $aStack = $aComment = array();
74 $aAddress[] = _createAddressElement($aStack,$aComment,$sEmail);
77 $sGroup = trim(implode(' ',$aStack));
78 $sGroup = preg_replace('/\s+/',' ',$sGroup);
82 $sEmail = trim(substr($sToken,1,-1));
87 default: $aStack[] = $sToken; break;
90 /* now do the action again for the last address */
91 $aAddress[] = _createAddressElement($aStack,$aComment,$sEmail);
96 * Do the address array to string translation
98 * @param array $aAddressList list with email address arrays
99 * @param array $aProps associative array with properties
102 * @see parseRFC822Address
103 * @author Marc Groot Koerkamp
106 function getAddressString($aAddressList,$aProps) {
107 $aPropsDefault = array (
108 'separator' => ',', // address separator
109 'limit' => 0, // limits returned addresses
110 'personal' => true, // show persnal part
111 'email' => true, // show email part
112 'best' => false, // show personal if available
113 'encode' => false, // encode the personal part
114 'unique' => false, // make email addresses unique.
115 'exclude' => array() // array with exclude addresses
116 // format of address: mailbox@host
119 $aProps = is_array($aProps) ?
array_merge($aPropsDefault,$aProps) : $aPropsDefault;
121 $aNewAddressList = array();
122 $aEmailUnique = array();
123 foreach ($aAddressList as $aAddr) {
124 if ($aProps['limit'] && count($aNewAddressList) == $aProps['limit']) {
127 $sPersonal = (isset($aAddr[SQM_ADDR_PERSONAL
])) ?
$aAddr[SQM_ADDR_PERSONAL
] : '';
128 $sMailbox = (isset($aAddr[SQM_ADDR_MAILBOX
])) ?
$aAddr[SQM_ADDR_MAILBOX
] : '';
129 $sHost = (isset($aAddr[SQM_ADDR_HOST
])) ?
$aAddr[SQM_ADDR_HOST
] : '';
131 $sEmail = ($sHost) ?
"$sMailbox@$sHost": $sMailbox;
133 if (in_array($sEmail,$aProps['exclude'],true)) {
137 if ($aProps['unique']) {
138 if (in_array($sEmail,$aEmailUnique,true)) {
141 $aEmailUnique[] = $sEmail;
146 if ($aProps['best']) {
147 $s .= ($sPersonal) ?
$sPersonal : $sEmail;
149 if ($aProps['personal'] && $sPersonal) {
150 if ($aProps['encode']) {
151 $sPersonal = encodeHeader($sPersonal);
155 if ($aProps['email'] && $sEmail) {
156 $s.= ($s) ?
' <'.$sEmail.'>': '<'.$sEmail.'>';
160 $aNewAddressList[] = $s;
163 return explode($aProps['seperator'],$aNewAddressList);
168 * Do after address parsing handling. This is used by compose.php and should
169 * be moved to compose.php.
170 * The AddressStructure objetc is now obsolete and dependent parts of that will
171 * be adapted so that it can make use of this function
172 * After that we can remove the parseAddress method from the Rfc822Header class completely
173 * so we achieved 1 single instance of parseAddress instead of two like we have now.
175 * @param array $aAddressList list with email address arrays
176 * @param array $aProps associative array with properties
179 * @see parseRFC822Address
181 * @author Marc Groot Koerkamp
184 function processAddressArray($aAddresses,$aProps) {
185 $aPropsDefault = array (
188 'abooklookup' => false);
190 $aProps = is_array($aProps) ?
array_merge($aPropsDefault,$aProps) : $aPropsDefault;
191 $aProcessedAddress = array();
193 foreach ($aAddresses as $aEntry) {
195 * if the emailaddress does not contain the domainpart it can concern
196 * an alias or local (in the same domain as the user is) email
197 * address. In that case we try to look it up in the addressbook or add
198 * the local domain part
200 if (!$aEntry[SQM_ADDR_HOST
]) {
202 $aAddr = call_user_func_array($cbLookup,array($aEntry[SQM_ADDR_MAILBOX
]));
203 if (isset($aAddr['email'])) {
205 * if the returned email address concerns multiple email
206 * addresses we have to process those as well
208 if (strpos($aAddr['email'],',')) { /* multiple addresses */
209 /* add the parsed addresses to the processed address array */
210 $aProcessedAddress = array_merge($aProcessedAddress,parseAddress($aAddr['email']));
211 /* skip to next address, all processing is done */
213 } else { /* single address */
214 $iPosAt = strpos($aAddr['email'], '@');
215 $aEntry[SQM_ADDR_MAILBOX
] = substr($aAddr['email'], 0, $iPosAt);
216 $aEntry[SQM_ADDR_HOST
] = substr($aAddr['email'], $iPosAt+
1);
217 if (isset($aAddr['name'])) {
218 $aEntry[SQM_ADDR_PERSONAL
] = $aAddr['name'];
220 $aEntry[SQM_ADDR_PERSONAL
] = encodeHeader($sPersonal);
229 if (!$aEntry[SQM_ADDR_MAILBOX
]) {
230 $aEntry[SQM_ADDR_MAILBOX
] = trim($sEmail);
232 if ($sDomain && !$aEntry[SQM_ADDR_HOST
]) {
233 $aEntry[SQM_ADDR_HOST
] = $sDomain;
236 if ($aEntry[SQM_ADDR_MAILBOX
]) {
237 $aProcessedAddress[] = $aEntry;
240 return $aProcessedAddress;
244 * Internal function for creating an address array
246 * @param array $aStack
247 * @param array $aComment
248 * @param string $sEmail
249 * @return array $aAddr array with personal (0), adl(1), mailbox(2) and host(3) info
251 * @author Marc Groot Koerkamp
255 function _createAddressElement(&$aStack,&$aComment,&$sEmail) {
257 while (count($aStack) && !$sEmail) {
258 $sEmail = trim(array_pop($aStack));
261 if (count($aStack)) {
262 $sPersonal = trim(implode('',$aStack));
266 if (!$sPersonal && count($aComment)) {
267 $sComment = trim(implode(' ',$aComment));
268 $sPersonal .= $sComment;
271 // if ($sPersonal && substr($sPersonal,0,2) == '=?') {
272 // $aAddr[SQM_ADDR_PERSONAL] = encodeHeader($sPersonal);
274 $aAddr[SQM_ADDR_PERSONAL
] = $sPersonal;
277 $iPosAt = strpos($sEmail,'@');
279 $aAddr[SQM_ADDR_MAILBOX
] = substr($sEmail, 0, $iPosAt);
280 $aAddr[SQM_ADDR_HOST
] = substr($sEmail, $iPosAt+
1);
282 $aAddr[SQM_ADDR_MAILBOX
] = $sEmail;
283 $aAddr[SQM_ADDR_HOST
] = false;
286 $aStack = $aComment = array();
291 * Tokenizer function for parsing the RFC822 email address string
293 * @param string $address The email address string to parse
294 * @return array $aTokens
296 * @author Marc Groot Koerkamp
300 function _getAddressTokens($address) {
303 $aSpecials = array('(' ,'<' ,',' ,';' ,':');
304 $aReplace = array(' (',' <',' ,',' ;',' :');
305 $address = str_replace($aSpecials,$aReplace,$address);
306 $iCnt = strlen($address);
309 $cChar = $address{$i};
313 $iEnd = strpos($address,'>',$i+
1);
315 $sToken = substr($address,$i);
318 $sToken = substr($address,$i,$iEnd - $i +
1);
321 $sToken = str_replace($aReplace, $aSpecials,$sToken);
322 if ($sToken) $aTokens[] = $sToken;
325 $iEnd = strpos($address,$cChar,$i+
1);
327 // skip escaped quotes
328 $prev_char = $address{$iEnd-1};
329 while ($prev_char === '\\' && substr($address,$iEnd-2,2) !== '\\\\') {
330 $iEnd = strpos($address,$cChar,$iEnd+
1);
332 $prev_char = $address{$iEnd-1};
339 $sToken = substr($address,$i);
342 // also remove the surrounding quotes
343 $sToken = substr($address,$i+
1,$iEnd - $i -1);
346 $sToken = str_replace($aReplace, $aSpecials,$sToken);
347 if ($sToken) $aTokens[] = $sToken;
350 array_pop($aTokens); //remove inserted space
351 $iEnd = strpos($address,')',$i);
353 $sToken = substr($address,$i);
358 while (($iDepth > 0) && (++
$iComment < $iCnt)) {
359 $cCharComment = $address{$iComment};
360 switch($cCharComment) {
375 $sToken = substr($address,$i,$iComment - $i +
1);
378 $sToken = substr($address,$i,$iEnd - $i +
1);
382 // check the next token in case comments appear in the middle of email addresses
383 $prevToken = end($aTokens);
384 if (!in_array($prevToken,$aSpecials,true)) {
385 if ($i+
1<strlen($address) && !in_array($address{$i+
1},$aSpecials,true)) {
386 $iEnd = strpos($address,' ',$i+
1);
388 $sNextToken = trim(substr($address,$i+
1,$iEnd - $i -1));
391 $sNextToken = trim(substr($address,$i+
1));
396 // create token and add it again
397 $sNewToken = $prevToken . $sNextToken;
398 if($sNewToken) $aTokens[] = $sNewToken;
401 $sToken = str_replace($aReplace, $aSpecials,$sToken);
402 if ($sToken) $aTokens[] = $sToken;
411 $iEnd = strpos($address,' ',$i+
1);
413 $sToken = trim(substr($address,$i,$iEnd - $i));
416 $sToken = trim(substr($address,$i));
419 if ($sToken) $aTokens[] = $sToken;