Função: SendEmail

Descrição

Esta API disponibiliza recursos para envio de email através de um script LUA. Sua operação necessita que o módulo EmailSender esteja integrado ao ambiente. Uma vez criado um projeto no módulo e configurado um ou mais grupos de email, esta função pode ser chamada de dentro de um script qualquer para enviar um email para um dos grupos definidos. A sintaxe da função LUA é a seguinte:

Sintaxe da função :

int result SendEmail(group, subject, body_text, attach_file, transaction_id, timeout)

Parâmetros de entrada

Entrada
group	Nome do grupo de email a ser notificado (o texto deve ser especificado entre parenteses).
subject	Texto a ser inserido no email como assunto (o texto deve ser especificado entre parenteses).
body_text	Texto a ser inserido no email como corpo do email (o texto deve ser especificado entre parenteses). Este parâmetro é opcional, quando não utilizado deve-se passar este parâmetro como string nula (“”).
attach_file	Nome (caminho completo) de um arquivo a ser anexado ao email. Este parâmetro é opcional, quando não utilizado deve-se passar este parâmetro como string nula (“”).
transaction_id	identificador numerico do email. Este parâmetro é utilizado pelo módulo de gerencia de email para identificar o email enviado. Finallizado o processo de envio, o resultado (sucesso ou falha) é salvo em um arquivo de log mantido pelo módulo (ems.log)
timeout	Tempo de em que a aplicação irá aguardar ate o envio do email se não retornará timeout.

Parâmetros de saida

String resultante com o caminho completo do arquivo selecionado pelo usuário. Se o usuário cancelar a seleção do arquivo, a função retorna uma string nula.

Saída
result	Código de retorno da função. Se zero indica execução do comando com sucesso. Se diferente de zero indica falha no envio. Possíveis códigos de retorno: 15202: Módulo de gerência de email não encontrado. 15359: Falha no processo de ativação do módulo de gerência de email.

O processo de envio de email é realizado de forma assíncrona. Por este motivo, o código retornado pela função LUA indica apenas que o email foi encaminhado com sucesso para o gerenciador de email. O resultado final do processo de envio é salvo no arquivo de log do módulo de gerência de email (ems.log)

Exemplo de utilização

-- Envia email para o grupo G1 com arquivo anexado
 local result = SendEmail(
                                   "G1",                                      -- nome do grupo de email
                                   "Notificação de evento do HIscada Pro",    -- assunto
                                   "Variável Tp102 atingiu limite de alerta", -- corpo do email
                                   "c:\alm01.txt",                            -- arquivo a ser anexado ao email
                                   1010,                                      -- identificador do email (para log)
                                   5)                                         -- Timeout (segundos)

 if (result ~= 0) then
   msg = "Falha no processo de encaminhamento do email"
 else
   msg = "Email encaminhado com sucesso"
 end
 print (msg)