Class EmailAttachment

Email attachment will serve as the path to the file that needs to be attached (located on the server).

EmailAttachment implements EmailAttachmentInterface

Package: Email\Entities
Category: System
Located at Services/System/Email/Entities/EmailAttachment.inc.php

Methods summary

`public`	# `__construct( AttachmentPathInterface $path = null, AttachmentNameInterface $name = null )` Constructor Constructor Entity representing an email attachment. Parameters `$path` (optional) Attachment path. `$name` (optional) Attachment name.
`public`	# `setPath( AttachmentPathInterface $path )` Sets the path of an email attachment. Sets the path of an email attachment. Parameters `$path` Attachment path. Implementation of `EmailAttachmentInterface::setPath()`
`public AttachmentPathInterface`	# `getPath( boolean $absolutePath = true )` Returns the path of an email attachment. Returns the path of an email attachment. Parameters `$absolutePath` (optional) Whether to return the absolute path or the relative one. Returns `AttachmentPathInterface` Attachment path. Implementation of `EmailAttachmentInterface::getPath()`
`public`	# `setName( AttachmentNameInterface $name )` Sets the name of an email attachment. Sets the name of an email attachment. Parameters `$name` Attachment name. Implementation of `EmailAttachmentInterface::setName()`
`public AttachmentNameInterface`	# `getName( )` Returns the name of an email attachment. Returns the name of an email attachment. Returns `AttachmentNameInterface` Attachment name. Implementation of `EmailAttachmentInterface::getName()`
`protected string`	# `_convertToRelativePath( AttachmentPathInterface $path = null )` Convert a path to relative. Convert a path to relative. Due to different server setups this process can be tedious and hard to foresee. The following method contains the conversion logic and must be used in any setter of the class. Parameters `$path` Attachment path. Returns string Returns the converted path.

Properties summary

`protected string`	`$path` E-Mail attachment path. E-Mail attachment path.	#
`protected string`	`$name` E-Mail attachment name. E-Mail attachment name.	#

Packages

Classes

Class EmailAttachment

Methods summary

Parameters

Parameters

Implementation of

Parameters

Returns

Implementation of

Parameters

Implementation of

Returns

Implementation of

Parameters

Returns

Properties summary