summaryrefslogtreecommitdiff
path: root/manager/library/imap/imapConnection.php
blob: 1528a764381f74128c66e96578972ff9241925d4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
<?php
/**
 * @author markus
 * $Id: $
 */

/**
 * required files
 * @ignore
 */
require_once('exception.IMAPException.php');

define('IMAP_RETRIES', 5);

/**
 * Wraps PHP built in imap commands within a class, features open, hold, close connection and
 * issue imap commands.
 *
 * @author markus
 */
class imapConnection {

	/**
	 * Array mit den bereits vorhandenen Instanzen
	 * @var array
	 */
	private static $instances = array();

	/**
	 * Instanzname, die unterschiedlichen Entitäten werden über den Namen
	 * auseinandergehalten.
	 * @var string
	 */
	private $instanceName = '';

	/**
	 * Configsection
	 * @var Config
	 */
	private $config = null;

	/**
	 * IMAP Resource
	 * @var imap_stream
	 */
	private $imap = null;

	/**
	 * Servername, Port, Flags
	 * @var string
	 */
	private $server = '';

    /**
     * Name der zuletzt geöffneten Mailbox
     * @var string
     */
    private $mbox = '';

	/**
	 * wird auf true gesetzt, wenn imapPing die Connection neu aufbaut
	 * @var boolean
	 */
	private $reopenedConnection = false;

	/**
	 * liefert eine Liste der verfügbaren Folder
	 * @param string $pattern
	 * @return array
	 */
	public function imapList($pattern = '*') {
		if ($this->imap === null) {
			throw new IMAPException(__METHOD__ . ' not connected');
		}
        $this->imapPing(true);

		return imap_list($this->imap, $this->server, $pattern);
	}


	/**
	 * Checkt die Anzahl Messages in einer Mailbox
	 * return array
	 */
	public function imapCheck() {
		if ($this->imap === null) {
			throw new IMAPException(__METHOD__ . ' not connected');
		}
        $this->imapPing(true);

		return imap_check($this->imap);
	}


	/**
	 * per imap_reopen die aktuelle Connection auf eine andere mbox umstellen
	 * @param string $mbox
	 * @return boolean
	 */
	public function imapSwitchMbox($mbox) {
		if ($this->imap === null) {
			throw new IMAPException(__METHOD__ . ' not connected');
		}
        $this->imapPing(true);

		if (imap_reopen($this->imap, $this->server.$mbox) === false) {
			throw new IMAPException(__METHOD__ . ' reopen failed');
		}

        $this->mbox = $mbox;

		return true;
	}


	/**
	 * setzt ein Flag bei allen in $sequence aufgeführten Messages
	 * @param string $sequence
	 * @param string $flag
	 * @param integer $options
	 * @return boolean
	 */
	public function imapSetflagFull($sequence, $flag, $options = 0) {
		if ($this->imap === null) {
			throw new IMAPException(__METHOD__ . ' not connected');
		}
        $this->imapPing(true);

		return imap_setflag_full($this->imap, $sequence, $flag, $options);
	}


	/**
	 * liefert die Mailheader
	 * @return array
	 */
	public function imapHeaders() {
		if ($this->imap === null) {
			throw new IMAPException(__METHOD__ . ' not connected');
		}
        $this->imapPing(true);

		return imap_headers($this->imap);
	}

	/**
	 * liefert die Header zu genau einer Mail mit der gegebenen ID
	 * @param integer $number
	 * @return array
	 */
	public function imapHeader($number) {
		if ($this->imap === null) {
			throw new IMAPException(__METHOD__ . ' not connected');
		}
        $this->imapPing(true);

		return imap_headerinfo($this->imap, $number);
	}

	/**
	 * liefert die Header zu genau einer Mail mit der gegebenen UID
	 * @param integer $uid
	 * @return array
	 */
	public function imapFetchHeader($uid) {
		if ($this->imap === null) {
			throw new IMAPException(__METHOD__ . ' not connected');
		}

		$ret = imap_fetchheader($this->imap, $uid, FT_UID);

        return $ret;
	}

	/**
	 * liefert die Header zu genau einer Mail mit der gegebenen UID
	 * @param integer $uid
	 * @return array
	 */
	public function imapFetchOverview($uid) {
		if ($this->imap === null) {
			throw new IMAPException(__METHOD__ . ' not connected');
		}

		$ret = imap_fetch_overview($this->imap, $uid, FT_UID);

        return $ret[0];
	}

	/**
	 * liefert den Body zu genau einer Mail mit der gegebenen ID
	 * @param integer $number
	 * @return string
	 */
	public function imapBody($number) {
		if ($this->imap === null) {
			throw new IMAPException(__METHOD__ . ' not connected');
		}
        $this->imapPing(true);

		return imap_body($this->imap, $number);
	}

	/**
	 * liefert den Body zu genau einer Mail mit der gegebenen UID
	 * @param integer $uid
	 * @return string
	 */
	public function imapBodyByUID($uid) {
		if ($this->imap === null) {
			throw new IMAPException(__METHOD__ . ' not connected');
		}
        $this->imapPing(true);

		return imap_body($this->imap, $uid, FT_UID );
	}

	/**
	 * markiert die Nachricht mit der unique ID zum löschen
	 * @param integer $uid
	 * return boolean
	 */
	public function imapDelete($uid) {
		if ($this->imap === null) {
			throw new IMAPException(__METHOD__ . ' not connected');
		}
        $this->imapPing(true);

		$ret = imap_delete($this->imap, $uid, FT_UID);

		if ($ret !== true) {
			print "imap delete returned false for ".$uid."\n";
		}

		return $ret;
	}

	/**
	 * löscht alle zum löschen markierten Nachrichten
	 * @return boolean
	 */
	public function imapExpunge() {
		if ($this->imap === null) {
			throw new IMAPException(__METHOD__ . ' not connected');
		}
        $this->imapPing(true);

		return imap_expunge($this->imap);
	}

	/**
	 * kopiert die Nachricht mit der gegebenen uid in die gegebene Mailbox *auf dem selben Server*
	 * @param integer $uid
	 * @param string $dest_mbox
	 * @return boolean
	 */
	public function imapMailCopy($uid, $dest_mbox) {
		if ($this->imap === null) {
			throw new IMAPException(__METHOD__ . ' not connected');
		}
        $this->imapPing(true);

		return imap_mail_copy($this->imap, $uid, $dest_mbox, CP_UID);
	}

	/**
	 * verschiebt die Nachricht mit der gegebenen uid in die gegebene Mailbox *auf dem selben Server*
	 * @param integer $uid
	 * @param string $dest_mbox
	 * @return boolean
	 */
	public function imapMailMove($uid, $dest_mbox) {
		if ($this->imap === null) {
			throw new IMAPException(__METHOD__ . ' not connected');
		}
        $this->imapPing(true);
        /*
         * dont't add the server part,
         * only the mailbox name works fine
         *
         * $dest_mbox = $this->server.$dest_mbox;
         */
		return imap_mail_move( $this->imap, $uid, $dest_mbox, CP_UID);
	}

	/**
	 * legt eine neue Mailbox *auf dem selben Server* an
	 * @param string $mbox
	 * @return boolean
	 */
	public function imapCreateMailbox($mbox) {
		if ($this->imap === null) {
			throw new IMAPException(__METHOD__ . ' not connected');
		}
        $this->imapPing(true);

		return imap_createmailbox($this->imap, $this->server.$mbox);
	}

	/**
	 * fragt ab, ob eine mbox unterhalb von mbox_root existiert und liefert true zurück, falls ja
	 * Funktion existiert nicht direkt als IMAP Kommando, aus einzelnen Kommando's zusammengebaut
	 *
	 * @param string $mbox_root
	 * @param string $mbox
	 * @return boolean
	 */
	public function imapMailboxExists($mbox_root, $mbox) {
		if ($this->imap === null) {
			throw new IMAPException(__METHOD__ . ' not connected');
		}
        $this->imapPing(true);

		$folderlist = $this->imapList($mbox_root);
		$foundFolder = false;
		foreach ($folderlist as $folder) {
			if (strpos($folder, $mbox) !== false) {
				return true;
			}
		}

		return false;
	}

	const AR_YYYY = 'Y';
	const AR_YYYYMM = 'Ym';
	const AR_YYYYMMDD = 'Ymd';

	/**
	 * erzeugt eine Archivmailbox zur Mailbox $mbox, dabei wird das Archiv unterhalb von $mbox
	 * auf dem selben Server angelegt, der Name der Mailbox enthält je nach $mode noch einen Datumsstamp
	 * Wenn der Input ($mbox) bereits mehrere Ebenen enthält (NOC3.domain.incoming z.B.), dann
	 * wird automatisch nur der am weitesten rechts stehende Teil extrahiert und benutzt.
	 * NOC3.domain.incoming => NOC3.domain.incoming.incoming-200705
	 * @param string $mbox
	 * @param string $mode
	 * @param integer $timestamp
	 * @param string $delimiter
	 * @return string
	 */
	public static function imapMakeArchiveName($mbox, $mode, $timestamp = null, $delimiter = '-') {
		if ($timestamp === null)
			$timestamp = time();

		$ar = explode('.', $mbox);

		$sub_mbox = $ar[count($ar) - 1];

		return $mbox.'.'.$sub_mbox.$delimiter.date($mode,$timestamp);
	}

	public static function imapMakePrefixedArchiveName($mbox, $mode, $prefix = '', $timestamp = null, $delimiter = '-') {
		if ($timestamp === null)
			$timestamp = time();

		$ar = explode('.', $mbox);

		$sub_mbox = $ar[count($ar) - 1];

		return $mbox.'.'.$prefix.$delimiter.$sub_mbox.$delimiter.date($mode,$timestamp);
	}

	/**
	 * liefert die unique ID der Nachricht mit der laufenden msg_number
	 * @param integer $msg_number
	 * @return integer
	 */
	public function imapUID($msg_number) {
		if ($this->imap === null) {
			throw new IMAPException(__METHOD__ . ' not connected');
		}
        $this->imapPing(true);

		return imap_uid($this->imap, $msg_number);
	}


	/**
	 * liefert die laufende msg_number der Nachricht, die die unique ID uid hat
	 * @param integer $uid
	 * @return integer
	 */
	public function imapMsgNo($uid) {
		if ($this->imap === null) {
			throw new IMAPException(__METHOD__ . ' not connected');
		}
        $this->imapPing(true);

		return imap_msgno($this->imap, $uid);
	}


	/**
	 * prüft, ob die Connection noch aktiv ist, Exception falls keine Connection definiert ist,
     * oder die Connection geschlossen wurde
     * wenn reconnect = true, dann wird bei einer geschlossenen Connection die Connection neu aufgebaut
     * @param boolean $reconnect
	 * @return boolean
	 */
	public function imapPing($reconnect = false) {
		if ($this->imap === null) {
			throw new IMAPException(__METHOD__ . ' not connected');
		}

		$ret = imap_ping($this->imap);

        if ($ret === false) {
            if ($reconnect === true) {
				$this->imap = $this->imapOpen($this->server.$this->mbox,
					$this->config->username,
					$this->config->password,
					OP_HALFOPEN);

                $ret = imap_ping($this->imap);

                if ($ret === false) {
                    throw new IMAPException(__METHOD__ . ' reconnect failed');
                }

                $this->reopenedConnection = true;
            }
            else {
                throw new IMAPException(__METHOD__ . ' not connected');
            }
        }

		return true;
	}


	public function __destruct() {
		if ($this->imap !== null) {
			imap_close($this->imap);
			$this->imap = null;
		}
	}


	/**
	 * true, wenn imapPing die Connection neu aufgemacht hat
	 * Variable wird auf false gesetzt wenn $flush true ist
	 * @param boolean $flush
	 * @return boolean
	 */
	public function connectionReopened($flush = true) {
		$ret = $this->reopenedConnection;
		if ($flush === true) {
			$this->reopenedConnection = false;
		}
		return $ret;
	}


	/**
	 * interne IMAP Open Methode
	 *
	 * @param string $servername
     * @param string $username
     * @param string password
     * @param integer $flags
	 * @return resource
	 */
    protected function imapOpen($server, $username, $password, $flags) {
	    return imap_open($server, $username, $password, $flags);
    }


	/**
	 * privater Konstruktor, wird exklusiv von getInstance aufgerufen
	 *
	 * @param $instanceName
	 * @param $config
	 */
	protected function __construct($instanceName, $config) {
		$this->instanceName = $instanceName;
		$this->config = $config;

		if (!isset($this->config->mailhost)) {
			throw new IMAPException(__METHOD__ . ' config attribute missing: "mailhost"');
		}
		if (!isset($this->config->username)) {
			throw new IMAPException(__METHOD__ . ' config attribute missing: "username"');
		}
		if (!isset($this->config->password)) {
			throw new IMAPException(__METHOD__ . ' config attribute missing: "password"');
		}
		if (!isset($this->config->port)) {
			throw new IMAPException(__METHOD__ . ' config attribute missing: "port"');
		}

		$this->server = '{'.$this->config->mailhost.':'.$this->config->port.'/imap';
		if( isset($this->config->use_tls) &&
			$this->config->use_tls != 0 ) {
			$this->server .= '/tls';
		}
		$this->server .= '/novalidate-cert}';

		$mbox = '';

        $this->mbox = $mbox;

		$this->imap = null;

		$this->imap = $this->imapOpen($this->server.$mbox,
			$this->config->username,
			$this->config->password,
			OP_HALFOPEN);

		if ($this->imap === false) {
			$this->imap = null;
			throw new IMAPException(__METHOD__ . ' not connected');
		}

		$this->reopenedConnection = false;
	}


	/**
	 * sucht nach einer bereits vorhandenen Instanz, wird keine gefunden,
	 * dann wird eine neue Instanz angelegt.
	 * Man kann die Config-Variable weglassen, wenn man sicher ist, dass
	 * bereits eine Instanz mit dem gewünschten instanceName existiert,
	 * existiert aber keiner, dann liefert getInstance eine Exception.
	 *
	 * @param $instance
	 * @param $config
	 * @return imapConnection
	 */
	public static function getInstance($instanceName,$config = null) {
		if (!self::$instances)
			self::$instances = array();

		foreach (self::$instances as $instance) {
			if ($instance->getInstanceName() == $instanceName)
				return $instance;
		}

		/*
		if (!$config instanceof Config) {
			throw new IMAPException(__METHOD__ . ' no config');
		}
		*/

		$object = new imapConnection($instanceName, $config);

		self::$instances[] = $object;

		return $object;
	}


	/**
	 * Liefert den Namen der aktuellen Instanz
	 * @return string
	 */
	public function getInstanceName() {
		return $this->instanceName;
	}


}