Back

sendFile()

Name	Type	Required	Default	Description
file	string	Yes		The file to send to the user.
name	string	No		The file name to show in the browser download dialog box.
type	string	No		The HTTP content type to deliver the file as.
disposition	string	No	attachment	Set to `inline` to have the browser handle the opening of the file (possibly inline in the browser) or set to `attachment` to force a download dialog box.
directory	string	No		Directory outside of the web root where the file exists. Must be a full path.
deleteFile	boolean	No	false	Pass in `true` to delete the file on the server after sending it.
deliver	boolean	No	true

1. Send a file for download from the files folder
sendFile(file="wheels_tutorial_20081028_J657D6HX.pdf");

2. Rename the file for the client
sendFile(
    file="wheels_tutorial_20081028_J657D6HX.pdf",
    name="Tutorial.pdf"
);

3. Send a file located outside the web root
sendFile(
    file="../../tutorials/wheels_tutorial_20081028_J657D6HX.pdf"
);

4. Inline display instead of download
sendFile(
    file="brochure.pdf",
    disposition="inline",
    type="application/pdf"
);

5. Delete file after sending
sendFile(
    file="temporary_report.xlsx",
    deleteFile=true
);