EmailAttachmentInterface
in
Interface EmailAttachmentInterface
Tags
Table of Contents
- getConfiguration() : AttachmentConfigurationInterface
- Returns the configuration of an email attachment.
- getName() : AttachmentNameInterface
- Returns the name of an email attachment.
- getPath() : AttachmentPathInterface
- Returns the path of an email attachment.
- setConfiguration() : mixed
- Sets the configuration of an email attachment.
- setName() : mixed
- Sets the name of an email attachment.
- setPath() : mixed
- Sets the path of an email attachment.
Methods
getConfiguration()
Returns the configuration of an email attachment.
public
getConfiguration() : AttachmentConfigurationInterface
Return values
AttachmentConfigurationInterface —Attachment configuration.
getName()
Returns the name of an email attachment.
public
getName() : AttachmentNameInterface
Return values
AttachmentNameInterface —Attachment name.
getPath()
Returns the path of an email attachment.
public
getPath([bool $absolutePath = true ]) : AttachmentPathInterface
Parameters
- $absolutePath : bool = true
-
(optional) Whether to return the absolute path or the relative one.
Return values
AttachmentPathInterface —Attachment path.
setConfiguration()
Sets the configuration of an email attachment.
public
setConfiguration(AttachmentConfigurationInterface $configuration) : mixed
Parameters
- $configuration : AttachmentConfigurationInterface
-
Attachment configuration.
Return values
mixed —setName()
Sets the name of an email attachment.
public
setName(AttachmentNameInterface $name) : mixed
Parameters
- $name : AttachmentNameInterface
-
Attachment name.
Return values
mixed —setPath()
Sets the path of an email attachment.
public
setPath(AttachmentPathInterface $path) : mixed
Parameters
- $path : AttachmentPathInterface
-
Attachment path.