Function EmailIntegration->_imap_get_part
Definitions
sources/mail_integration.php
- Find a message part of an e-mail that matches a mime-type.Also collects a list of *all* attachments along the way, for APPLICATION/OCTET-STREAM.Taken from http://php.net/manual/en/function.imap-fetchbody.php.
- Visibility: protected
- Is abstract?: No
- Is static?: No
- Is final?: No
- Return: string
Parameters
| Name | Type | Default | Set | Range | Description |
|---|---|---|---|---|---|
| $stream | resource | required parameter | N/A | N/A | IMAP connection object |
| $msg_number | integer | required parameter | N/A | N/A | Message number |
| $needed_mime_type | string | required parameter | N/A | N/A | Mime type we need (in upper case) |
| $attachments | array | required parameter | N/A | N/A | Map of attachments (name to file data); only populated if $needed_mime_type is appropriate for an attachment |
| $attachment_size_total | integer | required parameter | N/A | N/A | Total size of attachments in bytes |
| $input_charset | string | required parameter | N/A | N/A | The character set of the e-mail |
| $structure | ?object | Null | N/A | N/A | IMAP message structure (null: look up) |
| $part_number | string | Blank (empty string) | N/A | N/A | Message part number (blank: root) |
Return
- The message part (null: could not find one)
- Type: ?string
- Set: N/A
- Range: N/A