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
|
<?php
// Change these to make tests run successfully
$server = '{127.0.0.1:143/norsh}';
$default_mailbox = $server . "INBOX";
$domain = "something.com";
$admin_user = "webmaster"; // a user with admin access
$username = "$admin_user@$domain";
$password = 'p4ssw0rd';
$users = array("webmaster", "info", "admin", "foo"); // tests require 4 valid userids
$mailbox_prefix = "phpttest"; // name used for test mailbox
// record test start time (used by displayOverviewFields())
$start_time = time();
// list of fields to expect
$mandatory_overview_fields = array(
'size',
'uid',
'msgno',
'recent',
'flagged',
'answered',
'deleted',
'seen',
'draft',
'udate',
);
/**
* Display all fields in an element from an imap_fetch_overview() response
*
* Special handling for 'udate', which will vary run-to-run; assumes an IMAP
* server with its clock synced to the current system, which is consistent with
* setup instructions in ext/imap/tests/README.md
*
* @param array resp element from the return value of imap_fetch_overview()
*/
function displayOverviewFields($resp, $fields=null) {
global $mandatory_overview_fields;
global $start_time;
foreach ($fields ? $fields : $mandatory_overview_fields as $mf)
{
$z = $resp->$mf;
if ($mf == 'udate') {
if (($z >= $start_time) && ($z <= time())) {
echo "$mf is OK\n";
} else {
echo "$mf is BAD ($z)\n";
}
} else {
echo "$mf is $z\n";
}
}
}
/**
* Create a test mailbox and populate with msgs
*
* @param string mailbox_suffix Suffix used to uniquely identify mailboxes
* @param int message_count number of test msgs to be written to new mailbox
*
* @return IMAP stream to new mailbox on success; FALSE on failure
*/
function setup_test_mailbox($mailbox_suffix, $message_count, &$new_mailbox = null, $msg_type = "simple"){
global $server, $default_mailbox, $username, $password;
// open a stream to default mailbox
$imap_stream = imap_open($default_mailbox, $username, $password);
if ($imap_stream === false) {
echo "Cannot connect to IMAP server $server: " . imap_last_error() . "\n";
return false;
}
echo "Create a temporary mailbox and add " . $message_count . " msgs\n";
$new_mailbox = create_mailbox($imap_stream, $mailbox_suffix, $message_count, $msg_type);
if ($new_mailbox === false) {
echo "Can't create a temporary mailbox: " . imap_last_error(). "\n";
return false;
}
echo ".. mailbox '$new_mailbox' created\n";
// reopen stream to new mailbox
if (imap_reopen($imap_stream, $new_mailbox) === false) {
echo "can't re-open '$new_mailbox' mailbox: " . imap_last_error() . "\n";
return false;
}
return $imap_stream;
}
/**
* Create mailbox and fill with generic emails
*
* @param resource $imap_stream
* @param string $mailbox
*/
function create_mailbox($imap_stream, $mailbox_suffix, $message_count, $msg_type= "simple"){
global $default_mailbox, $mailbox_prefix;
$mailbox = $default_mailbox . "." . $mailbox_prefix . $mailbox_suffix;
$mailboxes = imap_getmailboxes($imap_stream, $mailbox, '*');
// check mailbox does not already exist
if ($mailboxes) {
foreach($mailboxes as $value) {
if ($value->name == $mailbox) {
exit ("TEST FAILED : Mailbox '$mailbox' already exists\n");
}
}
}
if (imap_createmailbox($imap_stream, $mailbox) === false) {
return false;
}
// Add number of test msgs requested
if ($message_count > 0) {
populate_mailbox($imap_stream, $mailbox, $message_count, $msg_type);
}
return $mailbox;
}
/**
* Populate a mailbox with generic emails
*
* @param resource $imap_stream
* @param string $mailbox
*/
function populate_mailbox($imap_stream, $mailbox, $message_count, $msg_type = "simple"){
global $users, $domain;
for($i = 1; $i <= $message_count; $i++) {
if ($msg_type == "simple") {
$msg = "From: foo@anywhere.com\r\n"
. "To: $users[0]@$domain\r\n"
. "Subject: test$i\r\n"
. "\r\n"
. "$i: this is a test message, please ignore\r\n";
} else {
$envelope["from"]= "foo@anywhere.com";
$envelope["to"] = "$users[0]@$domain";
$envelope["subject"] = "Test msg $i";
$part1["type"] = TYPEMULTIPART;
$part1["subtype"] = "mixed";
$part2["type"] = TYPETEXT;
$part2["subtype"] = "plain";
$part2["description"] = "imap_mail_compose() function";
$part2["contents.data"] = "message 1:xxxxxxxxxxxxxxxxxxxxxxxxxx";
$part3["type"] = TYPETEXT;
$part3["subtype"] = "plain";
$part3["description"] = "Example";
$part3["contents.data"] = "message 2:yyyyyyyyyyyyyyyyyyyyyyyyyy";
$part4["type"] = TYPETEXT;
$part4["subtype"] = "plain";
$part4["description"] = "Return Values";
$part4["contents.data"] = "message 3:zzzzzzzzzzzzzzzzzzzzzzzzzz";
$body[1] = $part1;
$body[2] = $part2;
$body[3] = $part3;
$body[4] = $part4;
$msg = imap_mail_compose($envelope, $body);
}
imap_append($imap_stream, $mailbox, $msg);
}
}
/**
* Get the mailbox name from a mailbox description, i.e strip off server details.
*
* @param string mailbox complete mailbox name
* @return mailbox name
*/
function get_mailbox_name($mailbox){
if (preg_match('/\{.*?\}(.*)/', $mailbox, $match) != 1) {
echo "Unrecpognized mailbox name\n";
return false;
}
return $match[1];
}
?>
|
