1. class
  2. Illuminate
  3. \
  4. Mail
  5. \
  6. Attachment

Attachment

class Attachment (View source)

Traits

Macroable

Properties

static protected array $macros

The registered string macros.

 from  Macroable
string|null $as

The attached file's filename.
string|null $mime

The attached file's mime type.
protected Closure $resolver

A callback that attaches the attachment to the mail message.

Methods

static void
macro(string $name, object|callable $macro)

Register a custom macro.

from  Macroable
static void
mixin(object $mixin, bool $replace = true)

Mix another object into the class.

from  Macroable
static bool
hasMacro(string $name)

Checks if macro is registered.

from  Macroable
static void
flushMacros()

Flush the existing macros.

from  Macroable
static mixed
__callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

from  Macroable
mixed
__call(string $method, array $parameters)

Dynamically handle calls to the class.

from  Macroable
static Attachment
fromPath(string $path)

Create a mail attachment from a path.

static Attachment
fromUrl(string $url)

Create a mail attachment from a URL.

static Attachment
fromData(Closure $data, string|null $name = null)

Create a mail attachment from in-memory data.

static Attachment
fromStorage(string $path)

Create a mail attachment from a file in the default storage disk.

static Attachment
fromStorageDisk(string|null $disk, string $path)

Create a mail attachment from a file in the specified storage disk.

$this
as(string|null $name)

Set the attached file's filename.

$this
withMime(string $mime)

Set the attached file's mime type.

mixed
attachWith(Closure $pathStrategy, Closure $dataStrategy)

Attach the attachment with the given strategies.

mixed
attachTo(Mailable|Message|MailMessage $mail, array $options = [])

Attach the attachment to a built-in mail type.

bool
isEquivalent(Attachment $attachment, array $options = [])

Determine if the given attachment is equivalent to this attachment.

Details

in Macroable at line 29
static void macro(string $name, object|callable $macro)

Register a custom macro.

Parameters

string $name
object|callable $macro

Return Value

void

in Macroable at line 43
static void mixin(object $mixin, bool $replace = true)

Mix another object into the class.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

in Macroable at line 62
static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

in Macroable at line 72
static void flushMacros()

Flush the existing macros.

Return Value

void

in Macroable at line 86
static mixed __callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

in Macroable at line 112
mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

at line 52
static Attachment fromPath(string $path)

Create a mail attachment from a path.

Parameters

string $path

Return Value

Attachment

at line 63
static Attachment fromUrl(string $url)

Create a mail attachment from a URL.

Parameters

string $url

Return Value

Attachment

at line 75
static Attachment fromData(Closure $data, string|null $name = null)

Create a mail attachment from in-memory data.

Parameters

Closure $data
string|null $name

Return Value

Attachment

at line 88
static Attachment fromStorage(string $path)

Create a mail attachment from a file in the default storage disk.

Parameters

string $path

Return Value

Attachment

at line 100
static Attachment fromStorageDisk(string|null $disk, string $path)

Create a mail attachment from a file in the specified storage disk.

Parameters

string|null $disk
string $path

Return Value

Attachment

at line 121
$this as(string|null $name)

Set the attached file's filename.

Parameters

string|null $name

Return Value

$this

at line 134
$this withMime(string $mime)

Set the attached file's mime type.

Parameters

string $mime

Return Value

$this

at line 148
mixed attachWith(Closure $pathStrategy, Closure $dataStrategy)

Attach the attachment with the given strategies.

Parameters

Closure $pathStrategy
Closure $dataStrategy

Return Value

mixed

at line 160
mixed attachTo(Mailable|Message|MailMessage $mail, array $options = [])

Attach the attachment to a built-in mail type.

Parameters

Mailable|Message|MailMessage $mail
array $options

Return Value

mixed

at line 189
bool isEquivalent(Attachment $attachment, array $options = [])

Determine if the given attachment is equivalent to this attachment.

Parameters

Attachment $attachment
array $options

Return Value

bool