Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MailTarget

A 'mail' target.

Hierarchy

Index

Properties

__cache

__cache: CacheProvider

[INTERNAL] DO NOT DEFINE OR OVERWRITE THIS PROPERTY BY YOUR OWN!

The cache for that item.

__id

__id: any

[INTERNAL] DO NOT DEFINE OR OVERWRITE THIS PROPERTY BY YOUR OWN!

Gets the ID of that item.

__index

__index: number

[INTERNAL] DO NOT DEFINE OR OVERWRITE THIS PROPERTY BY YOUR OWN!

Gets the zero-based of that item.

__searchValue

__searchValue: any

[INTERNAL] DO NOT DEFINE OR OVERWRITE THIS PROPERTY BY YOUR OWN!

A value for comparison.

__workspace

__workspace: Workspace

[INTERNAL] DO NOT DEFINE OR OVERWRITE THIS PROPERTY BY YOUR OWN!

Gets the underlying workspace.

Optional applyValuesTo

applyValuesTo: object

A list of property names and their values that should be applied to that object.

Type declaration

  • [prop: string]: any

Optional beforeDelete

One or more target operations that should be invoked BEFORE a deletion in that target starts.

Optional beforeDeploy

One or more target operations that should be invoked BEFORE a deployment to that target starts.

Optional beforePull

One or more target operations that should be invoked BEFORE a pullment from that target starts.

Optional checkBeforeDeploy

checkBeforeDeploy: boolean

Check for newer files before a deploy operation starts or not.

Optional checkBeforePull

checkBeforePull: boolean

Check for older files before a pull operation starts or not.

Optional deleted

One or more target operations that should be invoked AFTER a deletion in that target has been done.

Optional deployed

One or more target operations that should be invoked AFTER a deployment to that target has been done.

Optional description

description: string

A description.

Optional encryptBy

encryptBy: string

The custom password algorithm to use.

Optional encryptWith

encryptWith: string

The password.

from

from: string

The address that sends the mail.

Optional hideIf

hideIf: string | string[]

A list of one or more package names that indicates if that target is hidden from GUI if one of the package(s) has been selected.

Optional host

host: string

The address of the SMTP host.

Optional if

if: string | string[]

One or more (JavaScript) conditions that check if that item is available or not.

Optional ignoreTLS

ignoreTLS: boolean

Ignore TLS or not.

Optional isHidden

isHidden: boolean

Is hidden or not.

Optional mappings

mappings: deploy_mappings.FolderMappings

Defines folder mappings.

Optional name

name: string

The name.

Optional password

password: string

The password for the authentication.

Optional platforms

platforms: string | string[]

One or more platform names, the object is available for.

Optional port

port: number

The custom TCP port of the SMTP host.

Optional prepare

Operations which are executed even before the operations of 'beforeDeploy' and even if no file is going to be handled.

Optional pulled

One or more target operations that should be invoked AFTER a pullment from that target has been done.

Optional rejectUnauthorized

rejectUnauthorized: boolean

Reject unauthorized TLS or not.

Optional requireTLS

requireTLS: boolean

SMTP requires TLS or not.

Optional secure

secure: boolean

Use secure connection or not.

Optional showIf

showIf: string | string[]

A list of one or more package names that indicates if that target is only shown in GUI if one of the package(s) has been selected.

to

to: string | string[]

The list of email addresses to send the file(s) to.

Optional transformer

transformer: string

The path (or URI) to the transformer script.

Optional transformerOptions

transformerOptions: any

The options for the transformer script.

Optional type

type: string

The type.

Optional useFastGlob

useFastGlob: boolean

Use 'fast-glob' instead of 'node-glob' or not.

Optional user

user: string

The user for the authentication.

Generated using TypeDoc