SMTP · Doc

Recurso de envio de e-mail por SMTP.

attachment

_smtp.attachment(nome: string, tipo: string, ficheiro: File) : SMTP

Descrição

Adiciona ficheiro de anexo ao e-mail.

Atributos

NOME	TIPO	DESCRIÇÃO
nome	string	O nome do anexo.
tipo	string	O tipo de conteúdo do anexo, por exemplo image/png, text/html, application/zip, e muitos outros...
ficheiro	File	O ficheiro.

Retorno

( SMTP )

Objeto SMTP atual.

_smtp.attachment(nome: string, tipo: string, ficheiro: File, idConteudo: string) : SMTP

Descrição

Adiciona ficheiro de anexo ao e-mail.

Atributos

NOME	TIPO	DESCRIÇÃO
nome	string	O nome do anexo.
tipo	string	O tipo de conteúdo do anexo, por exemplo image/png, text/html, application/zip, e muitos outros...
ficheiro	File	O ficheiro.
idConteudo	string	O ID do anexo para ser utilizado no conteúdo HTML como `<img src="cid:anexo"/>`.

Retorno

( SMTP )

Objeto SMTP atual.

_smtp.attachment(nome: string, tipo: string, ficheiro: File, idConteudo: string, emLinha: boolean) : SMTP

Descrição

Adiciona ficheiro de anexo ao e-mail.

Atributos

NOME	TIPO	DESCRIÇÃO
nome	string	O nome do anexo.
tipo	string	O tipo de conteúdo do anexo, por exemplo image/png, text/html, application/zip, e muitos outros...
ficheiro	File	O ficheiro.
idConteudo	string	O ID do anexo para ser utilizado no conteúdo HTML como `<img src="cid:anexo"/>`.
emLinha	boolean	Se é ou não para ser injetado no conteúdo.

Retorno

( SMTP )

Objeto SMTP atual.

_smtp.attachment(nome: string, tipo: string, ficheiro: Storage) : SMTP

Descrição

Adiciona ficheiro de anexo ao e-mail.

Atributos

NOME	TIPO	DESCRIÇÃO
nome	string	O nome do anexo.
tipo	string	O tipo de conteúdo do anexo, por exemplo image/png, text/html, application/zip, e muitos outros...
ficheiro	Storage	O ficheiro.

Retorno

( SMTP )

Objeto SMTP atual.

_smtp.attachment(nome: string, tipo: string, ficheiro: Storage, idConteudo: string) : SMTP

Descrição

Adiciona ficheiro de anexo ao e-mail.

Atributos

NOME	TIPO	DESCRIÇÃO
nome	string	O nome do anexo.
tipo	string	O tipo de conteúdo do anexo, por exemplo image/png, text/html, application/zip, e muitos outros...
ficheiro	Storage	O ficheiro.
idConteudo	string	O ID do anexo para ser utilizado no conteúdo HTML como `<img src="cid:anexo"/>`.

Retorno

( SMTP )

Objeto SMTP atual.

_smtp.attachment(nome: string, tipo: string, ficheiro: Storage, idConteudo: string, emLinha: boolean) : SMTP

Descrição

Adiciona ficheiro de anexo ao e-mail.

Atributos

NOME	TIPO	DESCRIÇÃO
nome	string	O nome do anexo.
tipo	string	O tipo de conteúdo do anexo, por exemplo image/png, text/html, application/zip, e muitos outros...
ficheiro	Storage	O ficheiro.
idConteudo	string	O ID do anexo para ser utilizado no conteúdo HTML como `<img src="cid:anexo"/>`.
emLinha	boolean	Se é ou não para ser injetado no conteúdo.

Retorno

( SMTP )

Objeto SMTP atual.

bcc

_smtp.bcc() : string

Descrição

Obtém quem recebe uma cópia escondida do e-mail.

Retorno

( string )

O e-mail de quem vai receber o e-mail como cópia oculta.

_smtp.bcc(bcc: string) : SMTP

Descrição

Define quem recebe uma cópia escondida do e-mail.

Atributos

NOME	TIPO	DESCRIÇÃO
bcc	string	O e-mail de quem vai receber o e-mail como cópia oculta.

Retorno

( SMTP )

Objeto SMTP atual.

cc

_smtp.cc() : string

Descrição

Obtém quem recebe uma cópia do e-mail.

Retorno

( string )

O e-mail de quem vai receber o e-mail como cópia.

_smtp.cc(cc: string) : SMTP

Descrição

Define quem recebe uma cópia do e-mail.

Atributos

NOME	TIPO	DESCRIÇÃO
cc	string	O e-mail de quem vai receber o e-mail como cópia.

Retorno

( SMTP )

Objeto SMTP atual.

config

_smtp.config() : SMTPConfig

Descrição

Inicia uma nova configuração própria.

Retorno

( SMTPConfig )

Objeto de configuração carregada a partir dos dados recebidos.

_smtp.config(config: Values) : SMTPConfig

Descrição

Inicia uma nova configuração própria.

Atributos

NOME	TIPO	DESCRIÇÃO
config	Values	Estrutura de dados da definição da configuração.

Retorno

( SMTPConfig )

Objeto de configuração carregada a partir dos dados recebidos.

_smtp.config(config: SMTPConfig) : SMTP

Descrição

Define outra configuração que deve ser utilizada.

Atributos

NOME	TIPO	DESCRIÇÃO
config	SMTPConfig	Definição da nova configuração.

Retorno

( SMTP )

Objeto SMTP atual.

emptyMail

_smtp.emptyMail() : org.netuno.psamata.mail.Mail

Retorno

( org.netuno.psamata.mail.Mail )

enabled

_smtp.enabled() : boolean

Retorno

( boolean )

_smtp.enabled(ativo: boolean) : SMTP

Descrição

Define se está habilitado.

Atributos

NOME	TIPO	DESCRIÇÃO
ativo	boolean	Se fica ativo ou inactivo.

Retorno

( SMTP )

Objeto SMTP atual.

from

_smtp.from() : string

Descrição

Obtém o endereço do remetente do e-mail.

Retorno

( string )

O endereço de e-mail de quem envia.

_smtp.from(de: string) : SMTP

Descrição

Define o endereço do remetente do e-mail.

Atributos

NOME	TIPO	DESCRIÇÃO
de	string	O endereço de e-mail de quem envia.

Retorno

( SMTP )

Objeto SMTP atual.

getBcc

_smtp.getBcc() : string

Descrição

Obtém quem recebe uma cópia escondida do e-mail.

Retorno

( string )

O e-mail de quem vai receber o e-mail como cópia oculta.

getCc

_smtp.getCc() : string

Descrição

Obtém quem recebe uma cópia do e-mail.

Retorno

( string )

O e-mail de quem vai receber o e-mail como cópia.

getConfig

_smtp.getConfig() : SMTPConfig

Descrição

Obtém a configuração que está a ser utilizada.

Retorno

( SMTPConfig )

Objeto da configuração ativa.

getFrom

_smtp.getFrom() : string

Descrição

Obtém o endereço do remetente do e-mail.

Retorno

( string )

O endereço de e-mail de quem envia.

getHTML

_smtp.getHTML() : string

Descrição

Obtém o HTML do corpo do e-mail.

Retorno

( string )

O HTML que vai ir no e-mail.

getMultipartSubtype

_smtp.getMultipartSubtype() : string

Descrição

Obtém o subtipo do multipart como por exemplo mixed, alternative, digest e parallel.

Retorno

( string )

O subtipo do multipart.

getReplyTo

_smtp.getReplyTo() : string

Descrição

Obtém quem deve receber a resposta ao e-mail.

Retorno

( string )

O e-mail de quem vai receber o e-mail como resposta.

getSubject

_smtp.getSubject() : string

Descrição

Obtém o título do e-mail.

Retorno

( string )

O título que vai ir no e-mail.

getSubjectPrefix

_smtp.getSubjectPrefix() : string

Descrição

Obtém o prefixo do título do e-mail.

Retorno

( string )

O prefixo do título que vai ir no e-mail.

getText

_smtp.getText() : string

Descrição

Obtém o texto do corpo do e-mail.

Retorno

( string )

O texto que vai ir no e-mail.

getTo

_smtp.getTo() : string

Descrição

Obtém o endereço de destinatário do e-mail.

Retorno

( string )

O endereço de e-mail de quem recebe.

html

_smtp.html() : string

Retorno

( string )

_smtp.html(html: string) : SMTP

Atributos

NOME	TIPO	DESCRIÇÃO
html	string

Retorno

( SMTP )

init

_smtp.init() : SMTP

Descrição

Inicia uma nova instância do SMTP utilizando a configuração do STMP da chave default.

Retorno

( SMTP )

A nova instância do recurso SMTP com base na configuração do STMP default.

_smtp.init(configKey: string) : SMTP

Descrição

Inicia uma nova instância do SMTP a partir de uma configuração específica.

Atributos

NOME	TIPO	DESCRIÇÃO
configKey	string	Chave da configuração SMTP que será utilizada.

Retorno

( SMTP )

A nova instância do recurso SMTP com base na configuração do SMTP especificada.

_smtp.init(config: SMTPConfig) : SMTP

Descrição

Inicia uma nova instância do SMTP a partir de uma configuração que é definida em um objeto de configuração própria.

Atributos

NOME	TIPO	DESCRIÇÃO
config	SMTPConfig	Configuração que será utilizada.

Retorno

( SMTP )

A nova instância do recurso SMTP com base na configuração definida.

isEnabled

_smtp.isEnabled() : boolean

Descrição

Verifica se está habilitado.

Retorno

( boolean )

Resultado se está ou não ativado.

mail

_smtp.mail() : org.netuno.psamata.mail.Mail

Retorno

( org.netuno.psamata.mail.Mail )

multipartSubtype

_smtp.multipartSubtype() : string

Retorno

( string )

_smtp.multipartSubtype(html: string) : SMTP

Atributos

NOME	TIPO	DESCRIÇÃO
html	string

Retorno

( SMTP )

replyTo

_smtp.replyTo() : string

Retorno

( string )

_smtp.replyTo(replyTo: string) : SMTP

Atributos

NOME	TIPO	DESCRIÇÃO
replyTo	string

Retorno

( SMTP )

send

_smtp.send() : void

Descrição

Realiza o envio do e-mail.

Retorno

( void )

_smtp.send(mail: org.netuno.psamata.mail.Mail) : void

Atributos

NOME	TIPO	DESCRIÇÃO
mail	org.netuno.psamata.mail.Mail

Retorno

( void )

setBcc

_smtp.setBcc(bcc: string) : SMTP

Descrição

Define quem recebe uma cópia escondida do e-mail.

Atributos

NOME	TIPO	DESCRIÇÃO
bcc	string	O e-mail de quem vai receber o e-mail como cópia oculta.

Retorno

( SMTP )

Objeto SMTP atual.

setCc

_smtp.setCc(cc: string) : SMTP

Descrição

Define quem recebe uma cópia do e-mail.

Atributos

NOME	TIPO	DESCRIÇÃO
cc	string	O e-mail de quem vai receber o e-mail como cópia.

Retorno

( SMTP )

Objeto SMTP atual.

setConfig

_smtp.setConfig(config: SMTPConfig) : SMTP

Descrição

Define outra configuração que deve ser utilizada.

Atributos

NOME	TIPO	DESCRIÇÃO
config	SMTPConfig	Definição da nova configuração.

Retorno

( SMTP )

Objeto SMTP atual.

setEnabled

_smtp.setEnabled(ativo: boolean) : SMTP

Descrição

Define se está habilitado.

Atributos

NOME	TIPO	DESCRIÇÃO
ativo	boolean	Se fica ativo ou inactivo.

Retorno

( SMTP )

Objeto SMTP atual.

setFrom

_smtp.setFrom(de: string) : SMTP

Descrição

Define o endereço do remetente do e-mail.

Atributos

NOME	TIPO	DESCRIÇÃO
de	string	O endereço de e-mail de quem envia.

Retorno

( SMTP )

Objeto SMTP atual.

setHTML

_smtp.setHTML(html: string) : SMTP

Descrição

Define o HTML do corpo do e-mail.

Atributos

NOME	TIPO	DESCRIÇÃO
html	string	O HTML que vai ir no e-mail.

Retorno

( SMTP )

Objeto SMTP atual.

setMultipartSubtype

_smtp.setMultipartSubtype(multipartSubtipo: string) : SMTP

Descrição

Define o subtipo do multipart como por exemplo mixed, alternative, digest e parallel.

Atributos

NOME	TIPO	DESCRIÇÃO
multipartSubtipo	string	O subtipo do multipart.

Retorno

( SMTP )

Objeto SMTP atual.

setReplyTo

_smtp.setReplyTo(replyTo: string) : SMTP

Descrição

Define quem deve ser respondido ao e-mail.

Atributos

NOME	TIPO	DESCRIÇÃO
replyTo	string	O e-mail de quem vai receber o e-mail como resposta.

Retorno

( SMTP )

Objeto SMTP atual.

setSubject

_smtp.setSubject(titulo: string) : SMTP

Descrição

Define o título do e-mail.

Atributos

NOME	TIPO	DESCRIÇÃO
titulo	string	O título que vai ir no e-mail.

Retorno

( SMTP )

Objeto SMTP atual.

setSubjectPrefix

_smtp.setSubjectPrefix(tituloPrefixo: string) : SMTP

Descrição

Define o prefixo do título do e-mail.

Atributos

NOME	TIPO	DESCRIÇÃO
tituloPrefixo	string	O prefixo do título que vai ir no e-mail.

Retorno

( SMTP )

Objeto SMTP atual.

setText

_smtp.setText(texto: string) : SMTP

Descrição

Define o texto do corpo do e-mail.

Atributos

NOME	TIPO	DESCRIÇÃO
texto	string	O texto que vai ir no e-mail.

Retorno

( SMTP )

Objeto SMTP atual.

setTo

_smtp.setTo(para: string) : SMTP

Descrição

Define o endereço do destinatário do e-mail.

Atributos

NOME	TIPO	DESCRIÇÃO
para	string	O endereço de e-mail de quem recebe.

Retorno

( SMTP )

Objeto SMTP atual.

subject

_smtp.subject() : string

Descrição

Obtém o título do e-mail.

Retorno

( string )

O título que vai ir no e-mail.

_smtp.subject(titulo: string) : SMTP

Descrição

Define o título do e-mail.

Atributos

NOME	TIPO	DESCRIÇÃO
titulo	string	O título que vai ir no e-mail.

Retorno

( SMTP )

Objeto SMTP atual.

subjectPrefix

_smtp.subjectPrefix() : string

Retorno

( string )

_smtp.subjectPrefix(subjectPrefix: string) : SMTP

Atributos

NOME	TIPO	DESCRIÇÃO
subjectPrefix	string

Retorno

( SMTP )

text

_smtp.text() : string

Descrição

Obtém o texto do corpo do e-mail.

Retorno

( string )

O texto que vai ir no e-mail.

_smtp.text(texto: string) : SMTP

Descrição

Define o texto do corpo do e-mail.

Atributos

NOME	TIPO	DESCRIÇÃO
texto	string	O texto que vai ir no e-mail.

Retorno

( SMTP )

Objeto SMTP atual.

to

_smtp.to() : string

Descrição

Obtém o endereço de destinatário do e-mail.

Retorno

( string )

O endereço de e-mail de quem recebe.

_smtp.to(para: string) : SMTP

Descrição

Define o endereço do destinatário do e-mail.

Atributos

NOME	TIPO	DESCRIÇÃO
para	string	O endereço de e-mail de quem recebe.

Retorno

( SMTP )

Objeto SMTP atual.

with

_smtp.with(imap: IMAP) : SMTP

Atributos

NOME	TIPO	DESCRIÇÃO
imap	IMAP

Retorno

( SMTP )