php man page for imap_savebody

IMAP_SAVEBODY(3)							 1							  IMAP_SAVEBODY(3)

imap_savebody - Save a specific body section to a file

SYNOPSIS
       bool imap_savebody (resource  $imap_stream, mixed  $file, int  $msg_number, [string  $part_number = ""], [int  $options])

DESCRIPTION
	Saves a part or the whole body of the specified message.

PARAMETERS
	      o $
		imap_stream -An IMAP stream returned by imap_open(3).

	      o $file
		- The path to the saved file as a string, or a valid file descriptor returned by fopen(3).

	      o $msg_number
		- The message number

	      o $part_number
		- The part number. It is a string of integers delimited by period which index into a body part list as per the IMAP4 specification

	      o $options
		- A bitmask with one or more of the following:

		     o FT_UID - The $msg_number is a UID

		     o FT_PEEK - Do not set the Seen flag if not already set

		     o FT_INTERNAL - The return string is in internal format, will not canonicalize to CRLF.

RETURN VALUES
	Returns TRUE on success or FALSE on failure.

SEE ALSO
       imap_fetchbody(3).

PHP Documentation Group 													  IMAP_SAVEBODY(3)