MailMessage

new MailMessage()

A mail message

Extends

$k.NetEntity

Methods

(static) testConnection(throwExceptionsopt, testUserNameopt)

Tests the SMTP configuration of the volume

Parameters:

Name	Type	Attributes	Description
`throwExceptions`	boolean	<optional>	Control, whether a failing connection test throws its exception. Default: false.
`testUserName`	string	<optional>	The name of the user account. Required if the SMTP configuration requires authentication and more than one user is configured.

attach(attachment)

Attach a entity

Parameters:

Name	Type	Description
`attachment`	$k.NetEntity

Inherited From: $k.NetEntity#attach

Throws:

If the entity is not a valid attachment
Type $k.exception.TypeError

attachments() → {Array.<$k.NetEntity>}

Returns the attached entities

Inherited From: $k.NetEntity#attachments

Returns:

Type:: Array.<$k.NetEntity>

base64String() → {string}

Get the binay contents as base64-encoded string. Returns undefined if the contents is not binary

Inherited From: $k.NetEntity#base64String

Returns:

Type:: string

bcc() → {Array.<string>}

Get the blind carbon copy receivers ('bcc' field)

Returns:

Type:: Array.<string>

cc() → {Array.<string>}

Get the carbon copy receivers ('cc' field)

Returns:

Type:: Array.<string>

charset() → {string}

Returns the charset

Inherited From: $k.NetEntity#charset

Returns:

Type:: string

contentDisposition() → {string}

Returns the content disposition

Inherited From: $k.NetEntity#contentDisposition

Returns:

Type:: string

contentLength() → {number}

Returns the content length

Inherited From: $k.NetEntity#contentLength

Returns:

Type:: number

contentType() → {string}

Returns the content type (only the media type part)

Inherited From: $k.NetEntity#contentType

Returns:

Type:: string

dataUrl() → {string}

Returns the entity bytes as a data URL, or undefined if the entity is not binary

Inherited From: $k.NetEntity#dataUrl
See: https://en.wikipedia.org/wiki/Data_URI_scheme

Returns:

Type:: string

date() → {Array.<date>}

Get the date ('date' field)

Since: 5.4.2

Returns:

Type:: Array.<date>

debugString() → {string}

Prints the entity, except binary contents, for debugging purposes

Inherited From: $k.NetEntity#debugString

Returns:

Type:: string

filename() → {string}

Returns the filename part of the content disposition field

Inherited From: $k.NetEntity#filename

Returns:

Type:: string

formData() → {object}

Get all form fields (multipart/form-data or application/x-www-form-urlencoded). The property names correspond to the field names. The property values are either strings (if the form is of type application/x-www-form-urlencoded) or NetEntities (multipart/form-data)

Inherited From: $k.NetEntity#formData
See: $k.NetEntity

Returns:

Type:: object

headerCharset()

Get the charset of the headers

headerField(fieldName) → {string}

Get the value of the field of the request header. Returns undefined if the field does not exist

Parameters:

Name	Type	Description
`fieldName`	string

Inherited From: $k.NetEntity#headerField

Returns:

The field value

Type:: string

headerFields() → {object}

Get all fields of the request header. Field names are always lower case

Inherited From: $k.NetEntity#headerFields

Returns:

Type:: object

isBinary() → {boolean}

True if the entity has binary contents

Inherited From: $k.NetEntity#isBinary

Returns:

Type:: boolean

receiver() → {Array.<string>}

Get the receiver ('to' field)

Returns:

Type:: Array.<string>

removeHeaderField(fieldName)

Removes the field of the request heade

Parameters:

Name	Type	Description
`fieldName`	string

Since: 5.0.3
Inherited From: $k.NetEntity#removeHeaderField

send(asyncopt)

Send the mail, using the SMTP configuration of the volume

Parameters:

Name	Type	Attributes	Description
`async`	boolean	<optional>	True if the mail should be sent asynchronously, false if send() should block until the mail has been sent. Default is true.

sender() → {Array.<string>}

Get the sender

Returns:

Type:: Array.<string>

setBcc(receivers)

Set the blind carbon copy receivers ('bcc' field)

Parameters:

Name	Type	Description
`receivers`		String or Array of strings

setCc(receivers)

Set the carbon copy receivers ('cc' field)

Parameters:

Name	Type	Description
`receivers`		String or Array of strings

setCharset(charset)

Set the charset

Parameters:

Name	Type	Description
`charset`	string

Inherited From: $k.NetEntity#setCharset

Throws:

If the charset is unknown
Type $k.exception.InvalidValue

setContentDisposition(contentDisposition)

Set the content disposition

Parameters:

Name	Type	Description
`contentDisposition`	string

Inherited From: $k.NetEntity#setContentDisposition

setContentLength(length)

Set the content length

Parameters:

Name	Type	Description
`length`	number

Inherited From: $k.NetEntity#setContentLength

setContents(contents)

Set the contents of the entity. Also sets the content type and filename if known. The contents object can be a string, document ($k.TextDocument), a blob value ($k.Blob) or another NetEntity

Parameters:

Name	Type	Description
`contents`		Contents object

Inherited From: $k.NetEntity#setContents
See: $k.Blob
$k.TextDocument

setContentType(mediaType, charsetopt)

Set the content type

Parameters:

Name	Type	Attributes	Description
`mediaType`	string		Media type of the contents
`charset`	string	<optional>	Charset of the contents

Inherited From: $k.NetEntity#setContentType

setDate(date)

Set the date ('date' field)

Parameters:

Name	Type	Description
`date`		Date (either as a date or a string)

Since: 5.4.2

setFilename(filename)

Set the filename part of the content disposition field

Parameters:

Name	Type	Description
`filename`	string

Inherited From: $k.NetEntity#setFilename

setHeaderCharset(charset)

Set the charset of the headers

Parameters:

Name	Type	Description
`charset`	string	Charset (encoding) of the headers

Throws:

If the charset is unknown
Type $k.exception.InvalidValue

setHeaderField(fieldName, fieldValue)

Set the value of the field of the request header

Parameters:

Name	Type	Description
`fieldName`	string
`fieldValue`

Inherited From: $k.NetEntity#setHeaderField

Throws:

If the value does not match the type of the field
Type $k.exception.TypeError

setReceiver(receivers)

Set the receiver ('to' field)

Parameters:

Name	Type	Description
`receivers`		String or Array of strings

Throws:

If the value is not a valid receiver
Type $k.exception.InvalidValue

setSender(sender)

Set the sender ('from' field)

Parameters:

Name	Type	Description
`sender`	string

Throws:

If the value is not a valid sender
Type
$k.exception.InvalidValue
Sender value must be strings
Type
$k.exception.TypeError

setSubject(subject)

Set the subject

Parameters:

Name	Type	Description
`subject`	string

Throws:

If the value is not a valid subject
Type $k.exception.InvalidValue

setText(text)

Set the text as the body

Parameters:

Name	Type	Description
`text`	string

Inherited From: $k.NetEntity#setText

setUserName(username)

Set the name of the user account. Required if the SMTP configuration requires authentication and more than one user is configured

Parameters:

Name	Type	Description
`username`	string

subject() → {string}

Get the subject

Returns:

Type:: string

text(charsetopt) → {string}

Get the contents as string

Parameters:

Name	Type	Attributes	Description
`charset`	string	<optional>	Charset of the characters. Required for binary entities. Optional for text entities.

Inherited From: $k.NetEntity#text

Returns:

Type:: string

userName() → {string}

Get the name of the user account

Returns:

Type:: string