Ações de E-mail (Office 365)

Ações de e-mail com a utilização via API do Office 365.

Para ler ou enviar e-mails é necessário ter as credenciais de Tenant ID, Client ID, Client Secret e User ID. Para seguir um passo a passo de criação do app: Tutorial de Criação do App na Azure

Ações

office365.create_office365_client

Crie uma nova conexão com a API do Office 365.

Parâmetros:

tenant_id - Dado de Tenant ID do app criado na Azure.

client_id - Dado de Client ID do usuário na Azure.

client_secret - Dado da secret do app criado na Azure.

user_id - Informação de ID do usuário na Azure.

pagination_limit (opcional) - Tamanho da paginação (quantidade de e-mails por busca). O valor padrão é 50.

folder_name (opcional) - Nome da pasta que será feita a busca dos e-mails. Por padrão é realizado na 'Caixa de Entrada'.

Retorna:

email_client - email_client para ser usado em outras ações de e-mail.

emails_count - retorna o número total de e-mails em default_folder.

current_folder - nome da pasta atual.

Exceções:

Esta ação não oferece exceções.

office365.delete

Exclui a mensagem atual.

Parâmetros:

email_client - conexão do cliente com a API do Office 365. As conexões são criadas usando office365.create_office365_client

Retorna:

Esta ação não dá retorno.

Exceções:

Esta ação não oferece exceções.

office365.find_attachments

Permite retornar todos os anexos do e-mail atual ou pesquisar um anexo específico por nome.

Parâmetros:

email_client - conexão do cliente com a API do Office 365. As conexões são criadas usando office365.create_office365_client

attach_name (opcional) - nome ou nome parcial do anexo a ser procurado (padrão=filtrar por nome)

Retorna:

attachments - lista com todos os anexos que satisfazem a pesquisa.

attachments_count - número de anexos que satisfazem a pesquisa.

Exceções:

Esta ação não oferece exceções.

office365.get_current_email

Retorna a mensagem de e-mail na posição atual no cliente de e-mail do Office 365.

Parâmetros:

email_client - conexão do cliente com o Mail Server. As conexões são criadas usando office365.create_office365_client

Retorna:

id - id do e-mail na API do Office 365.

from - nome do usuário que enviou a mensagem de e-mail.

from_address - retorna apenas o endereço de e-mail do remetente da mensagem.

subject - assunto da mensagem de e-mail.

date - dados e hora em que a mensagem foi enviada.

html_body - conteúdo da mensagem de e-mail como conteúdo HTML.

has_attachments - configuração de variável booleana se a mensagem de e-mail tem anexos ou não.

check_read - configuração de variável booleana se a mensagem de e-mail foi lida ou não.

Exceções:

Esta ação não oferece exceções.

office365.list_folders

Retorna uma lista de todas as pastas disponíveis na conta de e-mail conectada.

Parâmetros:

email_client - conexão do cliente com a API do Office 365. As conexões são criadas usando office365.create_office365_client

Retorna:

folders - lista com o nome de todas as pastas da conta de e-mail conectada.

Exceções:

Esta ação não oferece exceções.

office365.move_to

Mova o e-mail atual para outra pasta existente da conta de e-mail.

Parâmetros:

email_client - conexão do cliente com a API do Office 365. As conexões são criadas usando office365.create_office365_client

to_folder - nome da pasta para onde a mensagem atual deve ser movida.

Retorna:

Esta ação não tem retorno.

Exceções:

Esta ação não oferece exceções.

office365.next_email

Mover a posição atual para o próximo e-mail (próxima mensagem mais recente).

Parâmetros:

email_client - conexão do cliente com a API do Office 365. As conexões são criadas usando office365.create_office365_client

Retorna:

id - id do e-mail na API do Office 365.

from - nome do usuário que enviou a mensagem de e-mail.

from_address - retorna apenas o endereço de e-mail do remetente da mensagem.

subject - assunto da mensagem de e-mail.

date - dados e hora em que a mensagem foi enviada.

html_body - conteúdo da mensagem de e-mail como conteúdo HTML.

has_attachments - configuração de variável booleana se a mensagem de e-mail tem anexos ou não.

check_read - configuração de variável booleana se a mensagem de e-mail foi lida ou não.

Exceções:

Esta ação não oferece exceções.

office365.previous_email

Mover a posição atual para o e-mail anterior (próxima mensagem mais antiga).

Parâmetros:

email_client - conexão do cliente com a API do Office 365. As conexões são criadas usando office365.create_office365_client

Retorna:

id - id do e-mail na API do Office 365.

from - nome do usuário que enviou a mensagem de e-mail.

from_address - retorna apenas o endereço de e-mail do remetente da mensagem.

subject - assunto da mensagem de e-mail.

date - dados e hora em que a mensagem foi enviada.

html_body - conteúdo da mensagem de e-mail como conteúdo HTML.

has_attachments - configuração de variável booleana se a mensagem de e-mail tem anexos ou não.

check_read - configuração de variável booleana se a mensagem de e-mail foi lida ou não.

Exceções:

Esta ação não oferece exceções.

office365.save_attachment

Salve os anexos em uma pasta, mantendo o mesmo nome do anexo do e-mail.

Parâmetros:

email_client - conexão do cliente com a API do Office 365. As conexões são criadas usando office365.create_office365_client

file_path - caminho para pasta onde os anexos devem ser salvos.

attach_name (opcional) - nome ou nome parcial do anexo a ser procurado (padrão=filtrar por nome)

Retorna:

saved_files - lista com caminho de arquivo completo, para arquivos salvos

Exceções:

Esta ação não oferece exceções.

office365.select_folder

Altere a pasta atual para o nome da pasta fornecida

Parâmetros:

email_client - conexão do cliente com a API do Office 365. As conexões são criadas usando office365.create_office365_client

pasta - nome da nova pasta para a qual apontar a caixa de correio

Retorna:

current_folder - nome da pasta atual, após a alteração da pasta emails_count - retorna o número total de e-mails na nova pasta.

Exceções:

Esta ação não oferece exceções.

office365.send_email

Parâmetros:

email_client - conexão do cliente com a API do Office 365. As conexões são criadas usando office365.create_office365_client

to - e-mails para inserir no campo TO da mensagem.

subject - assunto da mensagem.

text - conteúdo da mensagem como texto simples (padrão=sem mensagem de texto).

html - conteúdo da mensagem como texto HTML (padrão=sem mensagem html).

attachments - caminho para a pasta a ser anexada na mensagem (padrão=sem anexo).

to_cc - envio para e-mails com cópia oculta (padrão=sem envio com cópia oculta) - Opcional

to_bcc - envio para e-mails com cópia oculta sem visualização de outros destinatários (padrão=sem envio com cópia oculta)

Retorna:

email_sent - status do envio booleano.

status_code - código de status recebido da API do Office 365.

message_status - mensagem de status recebido da API do Office 365.