Mail_IMAP::setOptions()
bool setOptions(array $options, string $constant)
This method is used to specify arguments of functions in the c-client extension marked flags or options.
The $options argument is set by providing an array of function names without the "imap_" prefix, then the constant is supplied as a string.
<?php
$msg->setOptions(array('fetchbody', 'body'), 'FT_PEEK');
?>
In the above example, the FT_PEEK argument is passed to the imap_fetchbody and imap_body functions where ever they are called on by Mail_IMAP.
This method transfers these options to the $option property, therefore the $option property may be set directly with these arguments as well.
Method summary:
| param | array | $options |
| param | string | $constant |
| return | bool | |
| throws | ErrorStack: The constant is not defined. | The constant supplied in the $constant argument does not exist, check spelling. |
| throws | ErrorStack: Argument requires array. | The $options argument must be an array. |
| access | public | |
