Get Mail

UiPath.MicrosoftOffice365.Activities.Mail.GetMail

Description

Usa as APIs Obter mensagem e Listar mensagens do Microsoft Graph para recuperar as mensagens correspondentes de uma caixa de correio especificada (Mailbox).

Após realizar a pesquisa, a atividade retorna uma matriz de objetos Office365Message correspondentes (Resultados) que podem ser usados como variáveis de entrada em atividades subsequentes (por exemplo, Forward Mail e Move Mail).

Escopos

Essa atividade requer os seguintes escopos:

• Mail.Read AND User.Read

OU

• Mail.ReadWrite AND User.Read

OU

• Mail.Read.Shared AND User.Read

OU

• Mail.ReadWrite.Shared AND User.Read

OU

• Mail.Read AND User.ReadWrite

OU

• Mail.ReadWrite AND User.ReadWrite

OU

• Mail.Read.Shared AND User.ReadWrite

OU

• Mail.ReadWrite.Shared AND User.ReadWrite

Compatibilidade do projeto

Windows - Legado | Windows

Configuração

Propriedades

Comum

• NomeDeExibição — o nome de exibição da atividade. Essa propriedade é compatível com variáveis String e valores formatados de string.

Entrada

• Conta - (Opcional) O endereço de e-mail com o qual interagir. Isso pode incluir qualquer caixa de correio compartilhada à qual o usuário atual tenha direitos de acesso. Se deixado em branco, a conta do usuário atual será assumida. Esta propriedade oferece suporte a variáveis String e valores formatados em string.
  Observação: O campoConta é obrigatório para os tipos de autenticação ApplicationIdAndSecret e ApplicationIdAndCertificate .
• Pasta de correio - A pasta de correio da qual as mensagens são recuperadas. Insira sua pasta conforme ela aparece no aplicativo Outlook (por exemplo, "Caixa de entrada", "Itens enviados", "Itens excluídos"etc.). As subpastas usam o formato "ParentFolder/SubFolder/AnotherSubfolder". Esta propriedade oferece suporte a variáveis String e valores formatados em string.

Diversos

• Particular — se selecionada, os valores de variáveis e argumentos não são mais registrados no nível Verbose. Este campo aceita valores booleanos.

Opções

• ID do e-mail - O ID do e-mail a ser procurado. Quando especificados, os parâmetros Account, Get As HTMLe Mark As Read são levados em consideração, enquanto os parâmetros Only Unread Messages, Order By Date, Querye Top são ignorados. Se o e-mail com o ID especificado for encontrado, a matriz de saída conterá exatamente um elemento. Se não for encontrado, a atividade lançará uma exceção. Esta propriedade oferece suporte a String variáveis e valores formatados em string.
• Obter como HTML - Se selecionado, o corpo da mensagem é retornado no formato HTML. Este campo oferece suporte a valores booleanos.
• Marcar como lida - Se selecionado, as mensagens retornadas são marcadas como lidas. Este campo oferece suporte a valores booleanos.
• Somente mensagens não lidas - Se selecionado, somente as mensagens não lidas são retornadas. Este campo oferece suporte a valores booleanos. O valor padrão é True.
• Ordenar por data - As mensagens retornadas são ordenadas por data. As opções disponíveis são NewestFirst e OldestFirst.
• Consulta - Consulta utilizada para filtrar os e-mails retornados. Se a consulta não for concluída, todos os e-mails serão retornados. Insira seu String usando o parâmetro de consulta OData $filter . Abaixo estão alguns exemplos de entradas:
  • "from/emailAddress/address eq '[e-mail]'"
  • "subject eq 'Office365 Quickstart'"
  • "subject eq 'Office365 Quickstart' and from/emailAddress/address eq '[e-mail]'"
  • "categories/any(a:a eq 'Red category')"
• Superior - O número máximo de e-mails a serem recuperados. Este campo suporta apenas variáveis inteiras e Int32 . O valor padrão é 50 (não mostrado).

Saída

• Resultado - Retorna todos os e-mails da caixa de entrada do usuário. Este campo suporta apenas Office365Message[] variáveis. Obrigatório se você planeja usar os dados de saída em atividades subseqüentes.

  A variável que você cria para essa propriedade também é usada nas atividades Forward Mail e Move Mail (como o valor da propriedade de entrada Message ). Ao usar essa variável como um valor da propriedade de entrada, especifique o item na matriz que você deseja usar (por exemplo, foundMessages(0)).

  O Office365Messageobject inclui várias propriedades que você pode usar em outras atividades.
  A propriedade Body.Content é retornada apenas no formato HTML.

Como funciona

As etapas a seguir e o diagrama de sequência de mensagens são um exemplo de como a atividade funciona desde o tempo de design (ou seja, as dependências da atividade e as propriedades de entrada/saída) até o tempo de execução.

1. Conclua as etapas.
2. Adicione a atividade Microsoft Office 365 Scope ao seu projeto.
3. Adicione a atividade Get Mail dentro da atividade Microsoft Office 365 Scope.
4. Insira valores para as propriedades de entrada.
5. Crie e insira uma variável Office365Message[] para sua propriedade de saída.

6. Execute a atividade.

   • Seus valores de propriedade de entrada são enviados para as APIs GetMessage e ListMessages .
   • A API retorna o valor Office365Message[] para sua variável de propriedade de saída.