Attachment
extends AbstractPart
in package
Attachment message part class
Tags
Table of Contents
- _7BIT = '_7BIT'
- _8BIT = '_8BIT'
- BASE64 = 'BASE64'
- Encoding constants
- BINARY = 'BINARY'
- QUOTED_PRINTABLE = 'QUOTED_PRINTABLE'
- $basename : string
- File attachment basename
- $charSet : string
- Character set
- $content : string
- Message part content
- $contentType : string
- Content type
- $contentTypes : array<string|int, mixed>
- Common content types for auto-detection
- $encoding : string
- Message part encoding
- $headers : array<string|int, mixed>
- Headers
- $id : string
- Message or part ID
- $idHeader : string
- Message or part ID header name
- $stream : string
- File attachment original stream content
- __construct() : mixed
- Constructor
- __toString() : string
- Render message to string
- addHeader() : AbstractMessage
- Add message part header
- addHeaders() : AbstractMessage
- Add message part headers
- createFromFile() : self
- Create attachment from file
- createFromStream() : self
- Create attachment from stream
- generateId() : string
- Generate a new ID
- getBasename() : string
- Get attachment basename
- getBody() : string
- Get body
- getCharSet() : string
- Get message part character set
- getContent() : string
- Get message part content
- getContentType() : string
- Get message part content type
- getEncoding() : string
- Get message part encoding
- getHeader() : string
- Get message part header
- getHeaderAsString() : string
- Get header as string
- getHeaders() : array<string|int, mixed>
- Get all message part headers
- getHeadersAsString() : string
- Get all message headers as string
- getId() : string
- Get the ID
- getIdHeader() : string
- Get the ID
- getStream() : string
- Get attachment original stream content
- hasHeader() : bool
- Determine if message part has header
- isBase64() : string
- Check if encoding in base-64
- render() : string
- Render
- renderAsLines() : array<string|int, mixed>
- Render as an array of lines
- setCharSet() : AbstractMessage
- Set message part character set
- setContent() : AbstractPart
- Set message part content
- setContentType() : AbstractMessage
- Set message part content type
- setEncoding() : AbstractPart
- Set message part encoding
- setId() : AbstractMessage
- Set the ID
- setIdHeader() : AbstractMessage
- Set the ID header name
- getRandomId() : string
- Returns a random ID
Constants
_7BIT
public
mixed
_7BIT
= '_7BIT'
_8BIT
public
mixed
_8BIT
= '_8BIT'
BASE64
Encoding constants
public
string
BASE64
= 'BASE64'
BINARY
public
mixed
BINARY
= 'BINARY'
QUOTED_PRINTABLE
public
mixed
QUOTED_PRINTABLE
= 'QUOTED_PRINTABLE'
Properties
$basename
File attachment basename
protected
string
$basename
= null
$charSet
Character set
protected
string
$charSet
= 'utf-8'
$content
Message part content
protected
string
$content
= null
$contentType
Content type
protected
string
$contentType
= null
$contentTypes
Common content types for auto-detection
protected
array<string|int, mixed>
$contentTypes
= ['csv' => 'text/csv', 'doc' => 'application/msword', 'docx' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.document', 'gif' => 'image/gif', 'html' => 'text/html', 'htm' => 'text/html', 'jpe' => 'image/jpeg', 'jpg' => 'image/jpeg', 'jpeg' => 'image/jpeg', 'log' => 'text/plain', 'md' => 'text/plain', 'pdf' => 'application/pdf', 'png' => 'image/png', 'ppt' => 'application/vnd.ms-powerpoint', 'pptx' => 'application/vnd.openxmlformats-officedocument.presentationml.presentation', 'svg' => 'image/svg+xml', 'tif' => 'image/tiff', 'tiff' => 'image/tiff', 'tsv' => 'text/tsv', 'txt' => 'text/plain', 'xls' => 'application/vnd.ms-excel', 'xlsx' => 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', 'zip' => 'application/x-zip']
$encoding
Message part encoding
protected
string
$encoding
= null
$headers
Headers
protected
array<string|int, mixed>
$headers
= []
$id
Message or part ID
protected
string
$id
= null
$idHeader
Message or part ID header name
protected
string
$idHeader
= null
$stream
File attachment original stream content
protected
string
$stream
= null
Methods
__construct()
Constructor
public
__construct([string $file = null ][, string $stream = null ][, array<string|int, mixed> $options = [] ]) : mixed
Instantiate the mail attachment object
Parameters
- $file : string = null
- $stream : string = null
- $options : array<string|int, mixed> = []
-
['contentType', 'basename', 'encoding', 'chunk']
Tags
Return values
mixed —__toString()
Render message to string
public
__toString() : string
Return values
string —addHeader()
Add message part header
public
addHeader(string $header, string $value) : AbstractMessage
Parameters
- $header : string
- $value : string
Return values
AbstractMessage —addHeaders()
Add message part headers
public
addHeaders(array<string|int, mixed> $headers) : AbstractMessage
Parameters
- $headers : array<string|int, mixed>
Return values
AbstractMessage —createFromFile()
Create attachment from file
public
static createFromFile(string $file[, array<string|int, mixed> $options = [] ]) : self
Parameters
- $file : string
- $options : array<string|int, mixed> = []
-
['contentType', 'basename', 'encoding', 'chunk']
Return values
self —createFromStream()
Create attachment from stream
public
static createFromStream(string $stream[, array<string|int, mixed> $options = [] ]) : self
Parameters
- $stream : string
- $options : array<string|int, mixed> = []
-
['contentType', 'basename', 'encoding', 'chunk']
Return values
self —generateId()
Generate a new ID
public
generateId() : string
Return values
string —getBasename()
Get attachment basename
public
getBasename() : string
Return values
string —getBody()
Get body
public
abstract getBody() : string
Return values
string —getCharSet()
Get message part character set
public
getCharSet() : string
Return values
string —getContent()
Get message part content
public
getContent() : string
Return values
string —getContentType()
Get message part content type
public
getContentType() : string
Return values
string —getEncoding()
Get message part encoding
public
getEncoding() : string
Return values
string —getHeader()
Get message part header
public
getHeader(string $header) : string
Parameters
- $header : string
Return values
string —getHeaderAsString()
Get header as string
public
getHeaderAsString(string $header) : string
Parameters
- $header : string
Return values
string —getHeaders()
Get all message part headers
public
getHeaders() : array<string|int, mixed>
Return values
array<string|int, mixed> —getHeadersAsString()
Get all message headers as string
public
getHeadersAsString([array<string|int, mixed> $omitHeaders = [] ]) : string
Parameters
- $omitHeaders : array<string|int, mixed> = []
Return values
string —getId()
Get the ID
public
getId() : string
Return values
string —getIdHeader()
Get the ID
public
getIdHeader() : string
Return values
string —getStream()
Get attachment original stream content
public
getStream() : string
Return values
string —hasHeader()
Determine if message part has header
public
hasHeader(string $header) : bool
Parameters
- $header : string
Return values
bool —isBase64()
Check if encoding in base-64
public
isBase64() : string
Return values
string —render()
Render
public
abstract render() : string
Return values
string —renderAsLines()
Render as an array of lines
public
abstract renderAsLines() : array<string|int, mixed>
Return values
array<string|int, mixed> —setCharSet()
Set message part character set
public
setCharSet([string $charSet = null ]) : AbstractMessage
Parameters
- $charSet : string = null
Return values
AbstractMessage —setContent()
Set message part content
public
setContent(string $content) : AbstractPart
Parameters
- $content : string
Return values
AbstractPart —setContentType()
Set message part content type
public
setContentType(string $contentType) : AbstractMessage
Parameters
- $contentType : string
Return values
AbstractMessage —setEncoding()
Set message part encoding
public
setEncoding(string $encoding) : AbstractPart
Parameters
- $encoding : string
Return values
AbstractPart —setId()
Set the ID
public
setId(string $id) : AbstractMessage
Parameters
- $id : string
Return values
AbstractMessage —setIdHeader()
Set the ID header name
public
setIdHeader(string $header) : AbstractMessage
Parameters
- $header : string
Return values
AbstractMessage —getRandomId()
Returns a random ID
protected
getRandomId() : string