IMP_Compose_Attachment
in package
implements
Serializable
Attachment data for an outgoing compose message.
Tags
Table of Contents
Interfaces
- Serializable
Properties
- $forceLinked : bool
- Force this attachment to be linked?
- $id : int
- Attachment ID.
- $link_url : Horde_Url
- $linked : bool
- $related : bool
- Is this part associated with multipart/related data?
- $storage : IMP_Compose_Attachment_Storage
- $tmpfile : string
- $_composeCache : string
- Compose object cache ID.
- $_isBuilt : bool
- Does the part contain the attachment contents?
- $_linked : bool
- Should this attachment be linked?
- $_part : Horde_Mime_Part
- MIME part object.
- $_uuid : string
- The unique identifier for the file.
Methods
- __construct() : mixed
- Constructor.
- __get() : mixed
- __serialize() : array<string|int, mixed>
- __unserialize() : void
- delete() : mixed
- Delete the attachment data.
- getPart() : Horde_Mime_Part
- Return the MIME part object.
- serialize() : mixed
- unserialize() : mixed
- viewUrl() : Horde_Url
- Get a URL of the data.
Properties
$forceLinked
Force this attachment to be linked?
public
bool
$forceLinked
= \false
$id
Attachment ID.
public
int
$id
$link_url read-only
public
Horde_Url
$link_url
The URL, if the attachment is linked.
$linked read-only
public
bool
$linked
Should this attachment be linked?
$related
Is this part associated with multipart/related data?
public
bool
$related
= \false
$storage read-only
public
IMP_Compose_Attachment_Storage
$storage
The storage object.
$tmpfile read-only
public
string
$tmpfile
The temporary file location on the local filesystem.
$_composeCache
Compose object cache ID.
protected
string
$_composeCache
$_isBuilt
Does the part contain the attachment contents?
protected
bool
$_isBuilt
= \false
$_linked
Should this attachment be linked?
protected
bool
$_linked
= \null
$_part
MIME part object.
protected
Horde_Mime_Part
$_part
$_uuid
The unique identifier for the file.
protected
string
$_uuid
= \null
Methods
__construct()
Constructor.
public
__construct(IMP_Compose $ob, Horde_Mime_Part $part, string $tmp_file) : mixed
Parameters
- $ob : IMP_Compose
-
Compose object.
- $part : Horde_Mime_Part
-
MIME part object.
- $tmp_file : string
-
Temporary filename containing the data.
__get()
public
__get(mixed $name) : mixed
Parameters
- $name : mixed
__serialize()
public
__serialize() : array<string|int, mixed>
Return values
array<string|int, mixed>__unserialize()
public
__unserialize(array<string|int, mixed> $data) : void
Parameters
- $data : array<string|int, mixed>
delete()
Delete the attachment data.
public
delete() : mixed
getPart()
Return the MIME part object.
public
getPart([bool $build = false ]) : Horde_Mime_Part
Parameters
- $build : bool = false
-
If true, ensures the part contains the data.
Tags
Return values
Horde_Mime_Part —MIME part object.
serialize()
public
serialize() : mixed
unserialize()
public
unserialize(mixed $data) : mixed
Parameters
- $data : mixed
viewUrl()
Get a URL of the data.
public
viewUrl() : Horde_Url
Return values
Horde_Url —URL to display the attachment data.