imap_savebody

Save a specific body section to a file

&reftitle.description; `bool` `imap_savebody` `IMAP\Connection` `imap` ``resource``string``int```file` `int` `message_num` `string` `section`"" `int` `flags` 0

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

&reftitle.parameters;

&imap.imap-parameter.imap;

`file`

- The path to the saved file as a string, or a valid file descriptor returned by `fopen`.

`message_num`

- The message number

`section`

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

`flags`

- A bitmask with one or more of the following:

  - `FT_UID` - The `message_num` is a UID

  - `FT_PEEK` - Do not set the \Seen flag if not already set

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

&reftitle.returnvalues;

&return.success;

&reftitle.changelog;

&Version; | &Description;
&imap.changelog.imap-param;

&reftitle.seealso;

- `imap_fetchbody`