Wrong stubs for imap_delete and imap_undelete

[ppdeblieck]

Wrong stubs for imap_delete and imap_undelete

https://www.php.net/imap_delete and https://www.php.net/imap_undelete shows the following function signatures:

imap_delete(IMAP\Connection $imap, string $message_nums, int $flags = 0): bool
imap_undelete(IMAP\Connection $imap, string $message_nums, int $flags = 0): bool

It seems that the definititions in Callmap.php are incorrect.

Now:

'imap_delete' => ['bool', 'imap'=>'IMAP\Connection', 'message_num'=>'int', 'flags='=>'int'],
'imap_undelete' => ['bool', 'imap'=>'IMAP\Connection', 'message_num'=>'int', 'flags='=>'int'],

Should be:

'imap_delete' => ['bool', 'imap'=>'IMAP\Connection', 'message_nums'=>'string', 'flags='=>'int'],
'imap_undelete' => ['bool', 'imap'=>'IMAP\Connection', 'message_nums'=>'string', 'flags='=>'int'],

[psalm-github-bot]

Hey @ppdeblieck, can you reproduce the issue on https://psalm.dev ?

[ppdeblieck]

Sure. See https://psalm.dev/r/8afa9e030c

[psalm-github-bot]

I found these snippets:

https://psalm.dev/r/8afa9e030c

<?php

declare(strict_types=1);

function psalmTest(IMAP\Connection $imapConnection): void 
{
    /**
     * According to https://www.php.net/imap_delete the second parameter should be a string
     */
    if(imap_delete($imapConnection, 'abcd', FT_UID)) {
        //success
    }
    
    /**
     * According to https://www.php.net/imap_undelete the second parameter should be a string
     */
    if(imap_undelete($imapConnection, 'abcd', FT_UID)) {
        //success
    }
    
    /**
     * According to https://www.php.net/imap_delete providing an int for $message_nums should be incorrect
     */
    if(imap_delete($imapConnection, 123, FT_UID)) {
        //success
    }
    
    /**
     * According to https://www.php.net/imap_undelete providing an int for $message_nums should be incorrect
     */
    if(imap_undelete($imapConnection, 123, FT_UID)) {
        //success
    }
}

Psalm output (using commit 028ac7f):

ERROR: InvalidArgument - 10:37 - Argument 2 of imap_delete expects int, 'abcd' provided

ERROR: InvalidArgument - 17:39 - Argument 2 of imap_undelete expects int, 'abcd' provided

[orklah]

Thanks for the report!

Care to create the PR? 🙂

[ppdeblieck]

Done; see #8537