WireMail::attachment() method

Add a file to be attached to the email

  • Multiple calls will append attachments.
  • To remove the supplied attachments, specify NULL as the value.
  • Attachments may or may not be supported by 3rd party WireMail modules.

Example

$m = wireMail();
$m->to('user@domain.com')->from('hello@world.com');
$m->subject('Test attachment');
$m->body('This is just a test of a file attachment');
$m->attachment('/path/to/file.jpg');
$m->send();

Usage

// basic usage
$m->attachment(string $value);

// usage with all arguments
$m->attachment(string $value, string $filename = '');

Arguments

NameType(s)Description
valuestring

Full path and filename of file attachment

filename (optional)string

Optional different basename for file as it appears in the mail

Return value

$this

Object instance it was called from (method supports fluent interface).


$m methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #544
    In the 150th issue of ProcessWire Weekly we'll check out brand-new third party module called Inputfield Dependency Helper, share some recent highlights from the support forum, and more. Read on!
    Weekly.pw / 12 October 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • Subscribe to weekly ProcessWire news

I just love the easy and intuitive ProcessWire API. ProcessWire rocks!” —Jens Martsch, Web developer