Ir para o conteúdo principal
Documentação
Documentação
Administrator Guide
Última atualização: 2023-06-23
Referência: propriedades de transporte de email-out

Referência: propriedades de transporte de email-out

Guia Common

Propriedade
Nome do atributo XML
Descrição
ID
id
A ID exclusiva do componente
de envio por e-mail
 na conjunto.
Encaminha resposta para
routes-response-to
O destino da mensagem de resposta para o transporte
de envio por e-mail
 .
Executar quando
execute-when
Uma condição que determina se o transporte é executado.
Até
to
O endereço de e-mail principal do destinatário. Segue o formato
mailto:[emailaddress]
.
Se você quer usar apenas endereços Cco, especifique um campo vazio:
mailto:
 Valor
Assunto
subject
A linha de assunto do e-mail.
De
from
O endereço de e-mail que deve ser exibido no campo
De
 do e-mail entregue.
Ssl
ssl
Especifica se a conexão é SSL.
Inícios
starttls
Especifica se uma negociação SSL imediata deve ser ativada com o servidor SMTP remoto, emitindo um comando StartTLS antes de iniciar a sessão SMTP. O servidor SMTP responde com um destes códigos de resposta:
  • 220 Ready to start.
  • TLS 501 Syntax error (no parameters allowed).
  • 454 TLS not available due to a temporary reason.
As propriedades
Ssl
 e
starttls
 são mutuamente exclusivas.
Host
host
O nome ou endereço IP do servidor de e-mail SMTP que o transporte usa para entregar a mensagem.
Se você está usando o OAuth, defina este valor como
localhost
.
Port
port
O número da porta na qual o servidor de e-mail está sendo executado. O valor por padrão é 25, a porta SMTP padrão. Exceções:
  • Se a propriedade
    ssl
     está definida como
    true
     e nenhuma porta é especificada, o valor por padrão é 465.
  • Se a propriedade
    Starttls
     está definida como
    true
     e nenhuma porta é especificada, o valor por padrão é 587.
Usuário
O nome de usuário para acessar o servidor de e-mail.
Senha
password
A senha para o nome de usuário especificado na propriedade
User
 .

Guia Advanced

Propriedade
Nome do atributo XML
Descrição
Mensagem da loja
store-message
Não especifique
nenhum,
 a menos que seja orientado de outra forma pelo Suporte da Workday.
Para armazenar mensagens, use a etapa
store
 do Studio.
Classe de transporte
transport-class
Especifica uma classe de implementação alternativa com base em cada conjunto, se necessário.
Você pode alterar globalmente as classes de implementação editando o arquivo WEB-INF/classes/spring/assembly-bean.xml.
Ignorar pontos de extremidade dinâmicos
ignore-dynamic-endpoints
Especifica se o valor dinâmico WS-Addressing (WSA) deve ser ignorado no cabeçalho da mensagem de entrada ou usado para substituir o valor na propriedade
Endpoint
 do transporte.
Use a etapa
set-dynamic-endpoint
 para especificar os detalhes de WS-Addressing.
Bcc
bcc
Especifica os destinatários de e-mail em cópia oculta, usando um separador de ponto e vírgula. Exemplo:
logan.mcneil@workday.com; jake.lee@workday.com
.
Cc
cc
Especifica os destinatários de e-mail em cópia eletrônica usando um separador de ponto e vírgula. Exemplo:
logan.mcneil@workday.com; jake.lee@workday.com
.
Responder para
reply-to
O endereço de e-mail que é inserido automaticamente no
campo
 Para quando um usuário responde a uma mensagem de e-mail. Para a maioria das mensagens de e-mail, o endereço no campo
From
 é suficiente. Portanto, não há necessidade de definir a propriedade
Reply To
. Especifique vários endereços de e-mail usando um separador de ponto e vírgula. Exemplo:
logan.mcneil@workday.com; jake.lee@workday.com
.
Tempo limite
timeout
Especifica, em milissegundos, um período de tempo limite para sessões de FTP entre os clientes e o servidor FTP no qual o transporte está aguardando. Se você não especifica um valor, o tempo limite da sessão é atingido depois de 300.000 ms (5 minutos).
Exceções transitórias
transient-exceptions
Exceções transitórias são exceções que podem ter êxito sem nenhuma modificação em uma nova tentativa. Exceções não transitórias são aquelas que continuam falhando na nova tentativa até que a causa subjacente do problema seja corrigida.
Por padrão, o Workday trata apenas
java.net.ConnectException
 e
java.net.SocketException
 erros como exceções transitórias.
Especifique exceções temporárias adicionais como vírgula, espaço ou enumeração de nomes de classe separada por vírgula e espaço. Exemplos:
  • java.net.UknownHostException java.net.ConnectException java.net.SocketException
  • java.net.UknownHostException,java.net.ConnectException,java.net.SocketException
  • java.net.UknownHostException, java.net.ConnectException, java.net.SocketException
  • @{new java.net.UnknownHostException().getClass().getName()}
Se você especifica exceções temporárias adicionais, deve incluir também as exceções por padrão
java.net.ConnectException
 e
java.net.SocketException
 na lista. Caso contrário, o Workday as substitui.

Guia SMTP Headers

Propriedade
Nome do atributo XML
Descrição
Name
name
O nome de um cabeçalho SMTP personalizado.
Para adicionar um novo cabeçalho personalizado abaixo de qualquer linha existente, clique em
Add
. Em seguida, forneça um nome em
Name
 e um valor em
Value
.
Para adicionar um novo cabeçalho acima de uma linha existente, posicione o cursor nessa linha e clique em
Insert
 no menu suspenso
Add
.
Use os botões à direita da guia
SMTP Headers
 para excluir ou reordenar as linhas.
Valor
value
O valor de um cabeçalho SMTP personalizado.

Guia OAuth

Para usar a autenticação OAuth do Microsoft Outlook com o componente de saída de e-mail do Studio, registre o Studio como um aplicativo no Microsoft Azure, forneça a delegação em todo o domínio, conceda consentimento de administrador para o
Mail.Send
 Permissões e obter vários valores. Para obter detalhes, consulte https://learn.microsoft.com/en-gb/azure/active-directory/develop/v2-oauth2-client-creds-grant-flow.
Para usar a autenticação OAuth do Google Gmail com o componente email-out do Studio, registre uma conta de serviço no Google Cloud, forneça a delegação em todo o domínio e obtenha uma descrição JSON de vários valores. Para obter detalhes, consulte https://support.google.com/cloud/answer/6158849?hl=en.
Propriedade
Nome do atributo XML
Descrição
Provedor
provider
O nome do provedor de e-mail,
MICROSOFT_OUTLOOK
 ou
GOOGLE_GMAIL
.
Name
name
Os nomes obrigatórios do Workday que você associa a vários valores obtidos no portal do Microsoft Azure ou no console do Google Cloud.
Para o Microsoft Outlook, digite estes nomes:
  • outlook.client.id
  • outlook.client.secret
  • outlook.tenant.id
  • outlook.user.id
Para o Google Gmail, digite:
  • gmail.service.account.key.json
  • gmail.delegated.user
Valor
value
Os valores obtidos da Microsoft ou do Google que você associou aos nomes acima.
Para o Microsoft Outlook, crie estes pares de nome/valor:
Name
Valor
outlook.client.id
Na página
Overview
 de um aplicativo registrado no Portal do Microsoft Azure:
ID (de cliente) do aplicativo.
outlook.client.secret
Na página
Certificates & secrets
 de um aplicativo registrado no Portal do Microsoft Azure:
ID da chave secreta cliente.
outlook.tenant.id
Na página
Overview
 de um aplicativo registrado no Portal do Microsoft Azure:
ID (de locatário) do diretório.
outlook.user.id
O endereço do Outlook da conta da qual o e-mail será enviado. Também inserido no campo
From
 na guia
Common
.
Para o Google Gmail, crie estes pares de nome/valor:
Name
Valor
gmail.service.account.key.json
O texto JSON do arquivo baixado da seção
KEYS
 da página
Service accounts
 no Console do Google Cloud.
gmail.delegated.user
O endereço do Gmail do qual o e-mail será enviado. Deve ser um endereço Principal associado à conta de serviço do Google. Também inserido no campo
From
 na guia
Common
.

Gmail via SSL ou com STARTTLS

Quando configurar o transporte de
email-out
 para usar o Gmail via SSL ou STARTTLS, certifique-se de que:
  • O usuário
     e
    a senha do
     têm credenciais válidas do Outlook.
  • o ponto de extremidade
     é
    mailto:[name]@gmail.com
    .
  • anfitrião
     é
    smtp.gmail.com
    .
  • ssl
     ou
    starttls
     está definido como
    true
    .
  • A porta
     é:
    • 465, se
      ssl
       estiver definido como
      true
      .
    • 587, se
      starttls
       estiver definido como
      true
      .
  • o tempo limite
     é
    30000
     (30 segundos).

Microsoft Office 365 sobre SSL ou com StartTLS

Quando configurar o transporte de
email-out
 para usar o Microsoft Office 365 via SSL ou STARTTLS, certifique-se de que:
  • O usuário do
     e
    a senha
     contêm credenciais de usuário válidas do Office 365.
  • o ponto de extremidade
     é
    mailto:[name]@[domain-name.top-level-domain]
    .
  • anfitrião
     é
    smtp.office365.com
    .
  • ssl
     ou
    starttls
     está definido como
    true
    .
  • porta
     :
    • 465, se
      ssl
       estiver definido como
      true
      .
    • 587, se
      starttls
       está definido como
      true
      .
  • o tempo limite
     é
    30000
     (30 segundos).

Como configurar o corpo da mensagem e o anexo para formatos não binários

Quando recebem mensagens, muitos aplicativos de e-mail fazem a correspondência da primeira parte da mensagem MIME e a usam como texto da mensagem. Para definir o tipo MIME da parte da mensagem-raiz como
text/plain
, defina as propriedades
de entrada
 e
saída
 da mensagem como
message
e, em seguida, defina o Tipo MIME
de saída
 como
text/plany
.
Use o
construtor de mensagens
 para definir o conteúdo do corpo da mensagem de e-mail usando um elemento
de texto
 .
Para o anexo, defina a propriedade
Saída
 como
anexo
e o índice de anexos
de saída
 como .
0
e o Tipo de MIME
de saída
 para
text/planilhas
.
Mais uma vez, use o
construtor de mensagens
 para definir o conteúdo da mensagem do anexo usando um elemento
de texto
 .
Para evitar que alguns aplicativos de e-mail exibam anexos de texto no corpo da mensagem, defina o tipo MIME do anexo como
application/octet-stream
, mesmo que na verdade seja um texto. Para fazer isso, use uma expressão Mvel em uma etapa
de avaliação
 . Exemplo:
parts[1].setMimeType('application/octet-stream')
Para definir o nome do arquivo anexo, use uma expressão Mvel para definir a
Content-Disposition
 cabeçalho. Exemplo:
parts[1].setHeader('Content-Disposition', 'attachment; filename=payload.txt')
.
Por fim, configure a etapa
de envio por e-mail
 .

Configurar o corpo de mensagem e o anexo para formatos binários

Para inserir um arquivo binário em
MediationContext
, defina um serviço de recuperação para
workday-in
 que recupere o arquivo de um transporte FTP ou SFTP.
Crie o corpo da mensagem. Em seguida, use uma etapa
eval
 para copiar o arquivo recuperado para uma variável. Você pode usar a variável acessada do documento
da
 e o método
toVar
 para fazer isso. Exemplo:
da.toVar(Rising_2011_Logo.jpg', 'wd.retrieve.variable')
.
Use uma etapa
de cópia
 para copiar o arquivo da
wd.retrieve.variable
 em um anexo. Para fazer isso, defina a propriedade
Input
 como
variável
 e especifique
wd.retrieve.variable
 como a variável de entrada. Defina a propriedade
Saída
 como
anexo
, especifique um índice de anexo de
Saída
 de
0
e um Tipo de MIME
de saída
 de
imagem/jpeg
.
Por fim, configure a etapa
de envio por e-mail
 .