Elgg\Email\Attachment Class Reference

Email attachment. More...

Inheritance diagram for Elgg\Email\Attachment:

Static Public Member Functions
static	factory (mixed $options)
	Create an attachment. More...
static	fromElggFile (\ElggFile $file)
	Create an attachment from an ElggFile. More...

Detailed Description

Email attachment.

Definition at line 11 of file Attachment.php.

Member Function Documentation

factory()

static Elgg\Email\Attachment::factory ( mixed  $options )

static

Create an attachment.

Parameters

mixed

$options

an array or an ElggFile, supported array keys are: content: (string) the file contents of the attachment

• filepath: (string) if content isn't provided, a filepath can be given to fetch the content from
• filename: (string) the name of the attachment
• type: (string) the mimetype
• encoding: (string) the content encoding
• disposition: (string) the attachment disposition (default: attachment)
• charset: (string) the charset

See also

\Symfony\Component\Mime\Part\DataPart

Returns

Attachment return the attachment

Exceptions

InvalidArgumentException

Definition at line 30 of file Attachment.php.

fromElggFile()

static Elgg\Email\Attachment::fromElggFile ( \ElggFile  $file )

static

Create an attachment from an ElggFile.

Parameters

\ElggFile

$file

the file

Returns

Attachment

Exceptions

InvalidArgumentException

Definition at line 88 of file Attachment.php.

---

The documentation for this class was generated from the following file:

• engine/classes/Elgg/Email/Attachment.php