Smiling Souls

Steeped in the delicious tea like leaves of anthroposophy for the evolving soul.

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.

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 Error: The constant is not defined. The constant supplied in the $constant argument does not exist, check spelling.
access public

Comments

There are no comments posted at this time.

Leave a Comment

Simple HTML is allowed: <code>, <b>, <i>, <u>, <var>, <strong>, <em>, <blockquote>, <ul>, <ol>, <li>, <p> (no attributes). All spacing and line breaks in your comment will be preserved.

* All comments are moderated and are subject to approval.
Your comment will appear once it has been approved.
Posting multiple times will not expedite the approval process.

Comments are closed at this time.

© Copyright 2014 Hot Toddy, All Rights Reserved.