Get Mail

UiPath.MicrosoftOffice365.Activities.Mail.GetMail

Description

Usa as APIs Get message e List messages 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 dos objetos Office365Message correspondentes (Results) que você pode usar 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 email com o qual interagir. Isso pode incluir qualquer caixa de correio compartilhada à qual o usuário atual tenha direito de acesso. Se deixado em branco, a conta atual do usuário será utilizada. Essa propriedade é compatível com variáveis String e valores formatados de string.

  Observação:

  Account field is mandatory for ApplicationIdAndSecret and ApplicationIdAndCertificate authentication types.

• Pasta de email - A pasta de email da qual as mensagens são recuperadas. Insira sua pasta como ela aparece no seu aplicativo Outlook (por exemplo, "Caixa de entrada", "Itens Enviados", "Itens Excluídos", etc.). As subpastas usam o formato "ParentFolder/SubFolder/AnotherSubfolder". Essa propriedade é compatível com variáveis String e valores formatados de string.

Diversos

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

Opções

• ID do Email - O ID do email para procurar. Quando especificado, os parâmetros Account, Get As HTML e Mark As Read são levados em consideração, enquanto os parâmetros Only Unread Messages, Order By Date, Query e Top são ignorados. Se o email com o ID especificado for encontrado, a matriz de saída conterá exatamente uma elemento. Se não for encontrado, a atividade lançará uma exceção. Essa propriedade é compatível com variáveis String e valores formatados de string.

• Obter como HTML – Se selecionado, o corpo da mensagem é retornado no formato HTML. Esse campo aceita valores Booleanos.

• Marcar como lida - Se estiver selecionado, as mensagens retornadas são marcadas como lidas. Esse campo aceita valores Booleanos.

• Apenas mensagens não lidas — se selecionado, apenas mensagens não lidas são retornadas. Esse campo aceita valores Booleanos. O valor padrão é True.

• Order By Date - The returned messages are ordered by date. The available options are NewestFirst and OldestFirst.

• Consulta — consulta usada para filtrar os emails retornados. Se a consulta não for concluída, todos os emails serão retornados. Insira seu String usando o parâmetro de consulta $filter do OData. Abaixo estão alguns exemplos de entradas:

  • "from/emailAddress eq 'algué[e-mail] '"
  • "subject eq 'Office365 Quickstart'"
  • "subject eq 'Office365 Quickstart' and from/emailAddress/address eq algué[e-mail] '"
  • "categories/any(a:a eq 'Red category')"

• Top - The maximum number of emails to retrieve. This field supports only integer and Int32 variables. The default value is 50 (not shown).

Saída

• Result - Returns all emails from the user's inbox. This field supports only Office365Message[] variables. Required if you plan to use the output data in subsequent activities.

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 de Mensagem ). Ao usar essa variável como um valor da propriedade de entrada, especifique o item na matriz que você deseja usar (por exemplo, FindMessages(0)).

A Office365Messageobject inclui várias propriedades que você pode usar em outras atividades.

A propriedade Body.Content é retornada apenas no formato HTML.

Importante:

Há uma limitação conhecida em que a atividade não é compatível com a obtenção de anexos de e-mails assinados digitalmente e, portanto, não pode salvá-los.

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. Add the Get Mail activity inside the Microsoft Office 365 Scope activity.
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.