Skip to content

Commit a31b72c

Browse files
nikicnikic
committed
Update ext/imap parameter names
1 parent c4a25da commit a31b72c

File tree

2 files changed

+196
-207
lines changed

2 files changed

+196
-207
lines changed

‎ext/imap/php_imap.stub.php

Lines changed: 119 additions & 120 deletions
Original file line numberDiff line numberDiff line change
@@ -5,251 +5,250 @@
55
/**
66
* @return resource|false
77
*/
8-
function imap_open(string $mailbox, string $user, string $password, int $options = 0, int $n_retries = 0, array $params = []) {}
8+
function imap_open(string $mailbox, string $user, string $password, int $flags = 0, int $retries = 0, array $options = []) {}
99

1010
/**
11-
* @param resource $stream_id
11+
* @param resource $imap
1212
*/
13-
function imap_reopen($stream_id, string $mailbox, int $options = 0, int $n_retries = 0): bool {}
13+
function imap_reopen($imap, string $mailbox, int $flags = 0, int $retries = 0): bool {}
1414

1515
/**
16-
* @param resource $stream_id
16+
* @param resource $imap
1717
*/
18-
function imap_close($stream_id, int $options = 0): bool {}
18+
function imap_close($imap, int $flags = 0): bool {}
1919

20-
/** @param resource $stream_id */
21-
function imap_num_msg($stream_id): int|false {}
20+
/** @param resource $imap */
21+
function imap_num_msg($imap): int|false {}
2222

23-
/** @param resource $stream_id */
24-
function imap_num_recent($stream_id): int|false {}
23+
/** @param resource $imap */
24+
function imap_num_recent($imap): int|false {}
2525

26-
/** @param resource $stream_id */
27-
function imap_headers($stream_id): array|false {}
26+
/** @param resource $imap */
27+
function imap_headers($imap): array|false {}
2828

29-
/** @param resource $stream_id */
30-
function imap_headerinfo($stream_id, int $msg_no, int $from_length = 0, int $subject_length = 0): stdClass|false {}
29+
/** @param resource $imap */
30+
function imap_headerinfo($imap, int $message_num, int $from_length = 0, int $subject_length = 0): stdClass|false {}
3131

3232
function imap_rfc822_parse_headers(string $headers, string $default_host = "UNKNOWN"): stdClass {}
3333

3434
function imap_rfc822_write_address(string $mailbox, string $host, string $personal): string|false {}
3535

36-
function imap_rfc822_parse_adrlist(string $address_string, string $default_host): array {}
36+
function imap_rfc822_parse_adrlist(string $string, string $default_host): array {}
3737

38-
/** @param resource $stream_id */
39-
function imap_body($stream_id, int $msg_no, int $options = 0): string|false {}
38+
/** @param resource $imap */
39+
function imap_body($imap, int $message_num, int $flags = 0): string|false {}
4040

4141
/**
42-
* @param resource $stream_id
42+
* @param resource $imap
4343
* @alias imap_body
4444
*/
45-
function imap_fetchtext($stream_id, int $msg_no, int $options = 0): string|false {}
45+
function imap_fetchtext($imap, int $message_num, int $flags = 0): string|false {}
4646

4747
/**
48-
* @param resource $stream_id
48+
* @param resource $imap
4949
* @return stdClass|false
5050
*/
51-
function imap_bodystruct($stream_id, int $msg_no, string $section) {}
51+
function imap_bodystruct($imap, int $message_num, string $section) {}
5252

53-
/** @param resource $stream_id */
54-
function imap_fetchbody($stream_id, int $msg_no, string $section, int $options = 0): string|false {}
53+
/** @param resource $imap */
54+
function imap_fetchbody($imap, int $message_num, string $section, int $flags = 0): string|false {}
5555

56-
/** @param resource $stream_id */
57-
function imap_fetchmime($stream_id, int $msg_no, string $section, int $options = 0): string|false {}
56+
/** @param resource $imap */
57+
function imap_fetchmime($imap, int $message_num, string $section, int $flags = 0): string|false {}
5858

5959
/**
60-
* @param resource $stream_id
60+
* @param resource $imap
6161
* @param resource|string|int $file
6262
*/
63-
function imap_savebody($stream_id, $file, int $msg_no, string $section = "", int $options = 0): bool {}
63+
function imap_savebody($imap, $file, int $message_num, string $section = "", int $flags = 0): bool {}
6464

65-
/** @param resource $stream_id */
66-
function imap_fetchheader($stream_id, int $msg_no, int $options = 0): string|false {}
65+
/** @param resource $imap */
66+
function imap_fetchheader($imap, int $message_num, int $flags = 0): string|false {}
6767

68-
/** @param resource $stream_id */
69-
function imap_fetchstructure($stream_id, int $msg_no, int $options = 0): stdClass|false {}
68+
/** @param resource $imap */
69+
function imap_fetchstructure($imap, int $message_num, int $flags = 0): stdClass|false {}
7070

7171
/**
72-
* @param resource $stream_id
72+
* @param resource $imap
7373
*/
74-
function imap_gc($stream_id, int $flags): bool {}
74+
function imap_gc($imap, int $flags): bool {}
7575

7676
/**
77-
* @param resource $stream_id
77+
* @param resource $imap
7878
*/
79-
function imap_expunge($stream_id): bool {}
79+
function imap_expunge($imap): bool {}
8080

8181
/**
82-
* @param resource $stream_id
82+
* @param resource $imap
8383
*/
84-
function imap_delete($stream_id, string $msg_no, int $options = 0): bool {}
84+
function imap_delete($imap, string $message_num, int $flags = 0): bool {}
8585

8686
/**
87-
* @param resource $stream_id
87+
* @param resource $imap
8888
*/
89-
function imap_undelete($stream_id, string $msg_no, int $options = 0): bool {}
89+
function imap_undelete($imap, string $message_num, int $flags = 0): bool {}
9090

91-
/** @param resource $stream_id */
92-
function imap_check($stream_id): stdClass|false {}
91+
/** @param resource $imap */
92+
function imap_check($imap): stdClass|false {}
9393

94-
/** @param resource $stream_id */
95-
function imap_listscan($stream_id, string $ref, string $pattern, string $content): array|false {}
94+
/** @param resource $imap */
95+
function imap_listscan($imap, string $reference, string $pattern, string $content): array|false {}
9696

9797
/**
98-
* @param resource $stream_id
98+
* @param resource $imap
9999
* @alias imap_listscan
100100
*/
101-
function imap_scan($stream_id, string $ref, string $pattern, string $content): array|false {}
101+
function imap_scan($imap, string $reference, string $pattern, string $content): array|false {}
102102

103103
/**
104-
* @param resource $stream_id
104+
* @param resource $imap
105105
* @alias imap_listscan
106106
*/
107-
function imap_scanmailbox($stream_id, string $ref, string $pattern, string $content): array|false {}
107+
function imap_scanmailbox($imap, string $reference, string $pattern, string $content): array|false {}
108108

109-
/** @param resource $stream_id */
110-
function imap_mail_copy($stream_id, string $msglist, string $mailbox, int $options = 0): bool {}
109+
/** @param resource $imap */
110+
function imap_mail_copy($imap, string $message_nums, string $mailbox, int $flags = 0): bool {}
111111

112-
/** @param resource $stream_id */
113-
function imap_mail_move($stream_id, string $sequence, string $mailbox, int $options = 0): bool {}
112+
/** @param resource $imap */
113+
function imap_mail_move($imap, string $message_nums, string $mailbox, int $flags = 0): bool {}
114114

115115
function imap_mail_compose(array $envelope, array $body): string|false {}
116116

117-
/** @param resource $stream_id */
118-
function imap_createmailbox($stream_id, string $mailbox): bool {}
117+
/** @param resource $imap */
118+
function imap_createmailbox($imap, string $mailbox): bool {}
119119

120120
/**
121-
* @param resource $stream_id
121+
* @param resource $imap
122122
* @alias imap_createmailbox
123123
*/
124-
function imap_create($stream_id, string $mailbox): bool {}
124+
function imap_create($imap, string $mailbox): bool {}
125125

126-
/** @param resource $stream_id */
127-
function imap_renamemailbox($stream_id, string $old_name, string $new_name): bool {}
126+
/** @param resource $imap */
127+
function imap_renamemailbox($imap, string $from, string $to): bool {}
128128

129129
/**
130-
* @param resource $stream_id
130+
* @param resource $imap
131131
* @alias imap_renamemailbox
132132
*/
133-
function imap_rename($stream_id, string $old_name, string $new_name): bool {}
133+
function imap_rename($imap, string $from, string $to): bool {}
134134

135-
/** @param resource $stream_id */
136-
function imap_deletemailbox($stream_id, string $mailbox): bool {}
135+
/** @param resource $imap */
136+
function imap_deletemailbox($imap, string $mailbox): bool {}
137137

138-
/** @param resource $stream_id */
139-
function imap_subscribe($stream_id, string $mailbox): bool {}
138+
/** @param resource $imap */
139+
function imap_subscribe($imap, string $mailbox): bool {}
140140

141-
/** @param resource $stream_id */
142-
function imap_unsubscribe($stream_id, string $mailbox): bool {}
141+
/** @param resource $imap */
142+
function imap_unsubscribe($imap, string $mailbox): bool {}
143143

144-
/** @param resource $stream_id */
145-
function imap_append($stream_id, string $folder, string $message, ?string $options = null, ?string $internal_date = null): bool {}
144+
/** @param resource $imap */
145+
function imap_append($imap, string $folder, string $message, ?string $options = null, ?string $internal_date = null): bool {}
146146

147-
/** @param resource $stream_id */
148-
function imap_ping($stream_id): bool {}
147+
/** @param resource $imap */
148+
function imap_ping($imap): bool {}
149149

150-
function imap_base64(string $text): string|false {}
150+
function imap_base64(string $string): string|false {}
151151

152-
function imap_qprint(string $text): string|false {}
152+
function imap_qprint(string $string): string|false {}
153153

154-
function imap_8bit(string $text): string|false {}
155-
156-
function imap_binary(string $text): string|false {}
154+
function imap_8bit(string $string): string|false {}
157155

156+
function imap_binary(string $string): string|false {}
158157

159158
function imap_utf8(string $mime_encoded_text): string {}
160159

161160
/**
162-
* @param resource $stream_id
161+
* @param resource $imap
163162
* @return stdClass|false
164163
*/
165-
function imap_status($stream_id, string $mailbox, int $options) {}
164+
function imap_status($imap, string $mailbox, int $flags) {}
166165

167-
/** @param resource $stream_id */
168-
function imap_mailboxmsginfo($stream_id): stdClass {}
166+
/** @param resource $imap */
167+
function imap_mailboxmsginfo($imap): stdClass {}
169168

170-
/** @param resource $stream_id */
171-
function imap_setflag_full($stream_id, string $sequence, string $flag, int $options = 0): bool {}
169+
/** @param resource $imap */
170+
function imap_setflag_full($imap, string $sequence, string $flag, int $options = 0): bool {}
172171

173-
/** @param resource $stream_id */
174-
function imap_clearflag_full($stream_id, string $sequence, string $flag, int $options = 0): bool {}
172+
/** @param resource $imap */
173+
function imap_clearflag_full($imap, string $sequence, string $flag, int $options = 0): bool {}
175174

176-
/** @param resource $stream_id */
177-
function imap_sort($stream_id, int $criteria, int $reverse, int $options = 0, ?string $search_criteria = null, ?string $charset = null): array|false {}
175+
/** @param resource $imap */
176+
function imap_sort($imap, int $criteria, int $reverse, int $flags = 0, ?string $search_criteria = null, ?string $charset = null): array|false {}
178177

179-
/** @param resource $stream_id */
180-
function imap_uid($stream_id, int $msg_no): int|false {}
178+
/** @param resource $imap */
179+
function imap_uid($imap, int $message_num): int|false {}
181180

182-
/** @param resource $stream_id */
183-
function imap_msgno($stream_id, int $unique_msg_id): int|false {}
181+
/** @param resource $imap */
182+
function imap_msgno($imap, int $message_uid): int|false {}
184183

185-
/** @param resource $stream_id */
186-
function imap_list($stream_id, string $ref, string $pattern): array|false {}
184+
/** @param resource $imap */
185+
function imap_list($imap, string $reference, string $pattern): array|false {}
187186

188187
/**
189-
* @param resource $stream_id
188+
* @param resource $imap
190189
* @alias imap_list
191190
*/
192-
function imap_listmailbox($stream_id, string $ref, string $pattern): array|false {}
191+
function imap_listmailbox($imap, string $reference, string $pattern): array|false {}
193192

194-
/** @param resource $stream_id */
195-
function imap_lsub($stream_id, string $ref, string $pattern): array|false {}
193+
/** @param resource $imap */
194+
function imap_lsub($imap, string $reference, string $pattern): array|false {}
196195

197196
/**
198-
* @param resource $stream_id
197+
* @param resource $imap
199198
* @alias imap_lsub
200199
*/
201-
function imap_listsubscribed($stream_id, string $ref, string $pattern): array|false {}
200+
function imap_listsubscribed($imap, string $reference, string $pattern): array|false {}
202201

203-
/** @param resource $stream_id */
204-
function imap_getsubscribed($stream_id, string $ref, string $pattern): array|false {}
202+
/** @param resource $imap */
203+
function imap_getsubscribed($imap, string $reference, string $pattern): array|false {}
205204

206-
/** @param resource $stream_id */
207-
function imap_getmailboxes($stream_id, string $ref, string $pattern): array|false {}
205+
/** @param resource $imap */
206+
function imap_getmailboxes($imap, string $reference, string $pattern): array|false {}
208207

209-
/** @param resource $stream_id */
210-
function imap_fetch_overview($stream_id, string $sequence, int $options = 0): array|false {}
208+
/** @param resource $imap */
209+
function imap_fetch_overview($imap, string $sequence, int $flags = 0): array|false {}
211210

212211
function imap_alerts(): array|false {}
213212

214213
function imap_errors(): array|false {}
215214

216215
function imap_last_error(): string|false {}
217216

218-
/** @param resource $stream_id */
219-
function imap_search($stream_id, string $criteria, int $options = SE_FREE, string $charset = ""): array|false {}
217+
/** @param resource $imap */
218+
function imap_search($imap, string $criteria, int $flags = SE_FREE, string $charset = ""): array|false {}
220219

221-
function imap_utf7_decode(string $buf): string|false {}
220+
function imap_utf7_decode(string $string): string|false {}
222221

223-
function imap_utf7_encode(string $buf): string {}
222+
function imap_utf7_encode(string $string): string {}
224223

225224
#ifdef HAVE_IMAP_MUTF7
226-
function imap_utf8_to_mutf7(string $in): string|false {}
225+
function imap_utf8_to_mutf7(string $string): string|false {}
227226

228-
function imap_mutf7_to_utf8(string $in): string|false {}
227+
function imap_mutf7_to_utf8(string $string): string|false {}
229228
#endif
230229

231-
function imap_mime_header_decode(string $str): array|false {}
230+
function imap_mime_header_decode(string $string): array|false {}
232231

233-
/** @param resource $stream_id */
234-
function imap_thread($stream_id, int $options = SE_FREE): array|false {}
232+
/** @param resource $imap */
233+
function imap_thread($imap, int $flags = SE_FREE): array|false {}
235234

236235
function imap_timeout(int $timeout_type, int $timeout = -1): int|bool {}
237236

238237
#if defined(HAVE_IMAP2000) || defined(HAVE_IMAP2001)
239-
/** @param resource $stream_id */
240-
function imap_get_quota($stream_id, string $qroot): array|false {}
238+
/** @param resource $imap */
239+
function imap_get_quota($imap, string $quota_root): array|false {}
241240

242-
/** @param resource $stream_id */
243-
function imap_get_quotaroot($stream_id, string $mbox): array|false {}
241+
/** @param resource $imap */
242+
function imap_get_quotaroot($imap, string $mailbox): array|false {}
244243

245-
/** @param resource $stream_id */
246-
function imap_set_quota($stream_id, string $qroot, int $mailbox_size): bool {}
244+
/** @param resource $imap */
245+
function imap_set_quota($imap, string $quota_root, int $mailbox_size): bool {}
247246

248-
/** @param resource $stream_id */
249-
function imap_setacl($stream_id, string $mailbox, string $id, string $rights): bool {}
247+
/** @param resource $imap */
248+
function imap_setacl($imap, string $mailbox, string $user_id, string $rights): bool {}
250249

251-
/** @param resource $stream_id */
252-
function imap_getacl($stream_id, string $mailbox): array|false {}
250+
/** @param resource $imap */
251+
function imap_getacl($imap, string $mailbox): array|false {}
253252
#endif
254253

255254
function imap_mail(string $to, string $subject, string $message, ?string $additional_headers = null, ?string $cc = null, ?string $bcc = null, ?string $rpath = null): bool {}

0 commit comments

Comments
 (0)