nginstack

Class: Email

@nginstack/engine/lib/email/Email~ Email

new Email()

Classe responsável pelo envio de e-mails por meio do sistema.

É possível definir uma configuração de padrão de servidor SMTP no Manage. A configuração padrão de servidor SMTP do Manage só vale para o Engine configurado e não para toda base.

A configuração padrão de servidor SMTP do Manage é feita em Configuration/General, preenchendo os campos: Administrator Full Name, Administrator Email Address, Configuration Port, SMTP Server, SMTP Username, SMTP Secure Connection, SMTP Password e Confirm SMTP Password.

Examples
var email = new Email()
email.smtpServer = "smtp.gmail.com:465"
email.fullSsl = true
email.userName = "usuario@company.com.br"
email.password = "senha"
email.addRecipient( "Destino", "destino@company.com" )
email.subject = "Teste2"
email.content = "Teste"
email.sendLocally()
// Exemplo do uso da classe Email usando a configuração do Manage:
//Note que no exemplo abaixo não há informação de configuração do servidor de SMTP.
//Toda configuração é obtida automaticamente dos valores dos campos informados no
//Manage
var email = new Email()
email.addRecipient( "Nome destinatário", "usuario@company.com.br" )
email.subject = "Teste"
email.content = "Teste"
email.sendLocally()

Members

autoTls :boolean

Se o valor for true, será realizado automaticamente o upgrade para um canal seguro SSL/TLS desde que o servidor SMTP suporte.

Type:
  • boolean

content :string

Conteúdo do e-mail

Type:
  • string

fullSsl :boolean

Se o valor for true, estabelece um canal seguro SSL/TLS assim que estabelece a conexão.

Type:
  • boolean

htmlContent :string

Conteúdo do e-mail no formato HTML

Type:
  • string

log :string

Variável que armazena o log da 'conversa' do objeto Email com o servidor de SMTP. O armazenamento do log só ocorre quando a propriedade enableLog for true.

Type:
  • string

logEnabled :boolean

Habilita logs adicionais relacionados ao envio do e-mail que são gravados no log do sistema e na propriedade log.

Importante: os logs são gerados no Engine que envia o e-mail. Quando utilizado o método Database.prototype.sendEmail, os logs são gravados no Engine servidor associado à conexão e a propriedade log não é atualizada.

Type:
  • boolean

password :string

Senha do remetente no servidor de SMTP.

Type:
  • string

senderEmailAddress :string

Endereço de e-mail do remetente

Type:
  • string

senderName :string

Nome do remetente

Type:
  • string

smtpServer :string

Endereço ou IP do servidor de SMTP e porta no formato "HostName:Port".

Type:
  • string

subject :string

Assunto do e-mail.

Type:
  • string

userName :string

Nome de usuário do remetente no servidor de SMTP.

Type:
  • string

Methods

<static> hasDefaultSMTPSettings()

Verifica se o Engine corrente possui uma conta de SMTP configurada no Manage.

Returns:

True se o Engine tiver uma conta SMTP padrão.

Type
boolean

addAttachment(name, content)

Adiciona um arquivo anexo ao e-mail.

Parameters:
Name Type Description
name string

Nome do arquivo anexo(Não precisa ser o nome original).
content string | ArrayBuffer

Conteúdo do arquivo anexo.

addRecipient(nameOrEmail [, email])

Adiciona um destinatário com apenas o email, ou nome e email.

Parameters:
Name Type Argument Description
nameOrEmail string

Nome ou email do destinatário.
email string <optional>

Endereço de email do destinatário, necessário somente se o mesmo não foi informado como o primeiro parâmetro.
Example
email.addRecipient('example@example.com.br'); //ou
email.addRecipient('maria','maria@example.com.br');

addRecipientBcc(nameOrEmail [, email])

Adiciona um destinatário que receberá uma cópia oculta da mensagem (CCO).

Parameters:
Name Type Argument Description
nameOrEmail string

Nome ou Email do destinatário.
email string <optional>

Endereço de email do destinatário, necessário somente se o mesmo não foi informado como o primeiro parâmetro.
Example
email.addRecipientBcc('example@example.com.br'); //ou
email.addRecipientBcc('maria','maria@example.com.br');

addRelatedContent(name, content)

Adiciona um arquivo no e-mail. Este recurso deve ser usado para adicionar imagens ao e-mail. Ao adicionar uma imagem o desenvolvedor deve atentar para o uso o prefixo cid:. Vide o exemplo: <img src="cid:dfs9898jskFs"&gt
cid é uma abreviação para content-id. O content id é retornado por este método.

Parameters:
Name Type Description
name string

Nome do conteúdo. O nome poderá ser referenciado dentro do próprio e-mail.
content string | ArrayBuffer

Conteúdo do arquivo adicionado, codificado em Base64.
Returns:

Identificador do conteúdo(content-id) gerado para o conteúdo adicionado.

Type
string

clear()

Limpa os dados do e-mail.

sendLocally()

Envia o e-mail.

toString()

Representação deste objeto em formato String.

Returns:

Retorna sempre '[object Email]'

Type
string

write()

Escreve dados no conteúdo do e-mail e adiciona uma quebra de linha no final.