imap_getacl

(PHP 5, PHP 7, PHP 8)

imap_getaclGets the ACL for a given mailbox

Description

imap_getacl(IMAP\Connection $imap, string $mailbox): array|false

Gets the ACL for a given mailbox.

Parameters

imap

An IMAP\Connection instance.

mailbox

The mailbox name, see imap_open() for more information

Warning

Passing untrusted data to this parameter is insecure, unless imap.enable_insecure_rsh is disabled.

Return Values

Returns an associative array of "folder" => "acl" pairs, or false on failure.

Changelog

Version Description
8.1.0 The imap parameter expects an IMAP\Connection instance now; previously, a valid imap resource was expected.

Examples

Example #1 imap_getacl() example

<?php

print_r
(imap_getacl($imap, 'user.joecool'));

?>

The above example will output something similar to:

Array
(
    [asubfolder] => lrswipcda
    [anothersubfolder] => lrswipcda
)

Notes

This function is currently only available to users of the c-client2000 or greater library.

See Also

add a note

User Contributed Notes 2 notes

up
0
hartmut dot woehrle at hwds dot ch
8 years ago
Maybe the functionality changed over the years but the examples are wrong.
It does NOT return [subfolder] => ACL

At the moment (PHP5) the usage and answer of imap_getacl is the following:
You ask for the folder and get the ACLs for exactly this folder (no Wildcards)

Example:
When you have the folder Business in your mailbox

print_r(imap_getacl($connection , "user/john.doe/Business"));

returns the following:

Array
(
[john.doe@example.com] => lrswipkxtecda
[cyrus@example.com] => lrswipkxtecd
[secretary@example.com] => lrsp
[department@example.com] => lrs
)

Which means you have to loop over your directories (imap_list) and list the ACL for ever folder seperately.
up
0
info at obengelb dot de
17 years ago
stream_id is the stream returned from imap_open

mailbox is a mailbox name (without server name)

Example:
print_r(imap_getacl ($strea_id, 'user.joecool'));

Array
(
[asubfolder] => lrswipcda
[anothersubfolder] => lrswipcda
)
To Top