Ações de E-mail
Ações de e-mail são usadas para interagir com servidores de e-mail enviando e recebendo mensagens.
Para enviar e-mails é necessário ter uma credencial SMTP para o Mail Server, e para receber e-mails é necessário ter uma credencial IMAP ou POP3 para o Mail Server.
Importante: recomendamos o uso de conexões IMAP para recebimento de e-mails, pois este é um protocolo muito mais recente e oferece mais funcionalidades e melhor controle.
Ações
email.close
Fecha a conexão ativa com o Mail Server.
Parâmetros:
email_client - conexão do cliente com o Mail Server. As conexões são criadas usando email.create_imap_client ou email.create_pop_client
quit (opcional) - ao usar o cliente POP3, para persistir todos os e-mails lidos e exclusões, o parâmetro quit deve ser definido como True.
Retorna:
Esta ação não dá retorno.
Exceções:
Esta ação não oferece exceções.
email.create_imap_client
Crie uma nova conexão com o Mail Server, usando o protocolo IMAP.
Parâmetros:
user - usuário para autenticar com o Mail Server
password - senha para autenticar com o Mail Server
host - IP ou nome para conectar com o Mail Server
port (opcional) - porta no Mail Server usada para conexão IMAP (padrão=995).
default_folder (opcional) - nome da caixa de correio para iniciar a leitura (deafult='inbox').
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.
email.create_pop_client
Crie uma nova conexão com o Mail Server, usando o protocolo POP3.
Parâmetros:
user - usuário para autenticar com o Mail Server
password - senha para autenticar com o Mail Server
host - IP ou nome para conectar com o Mail Server
port (opcional) - porta no Mail Server usada para conexão IMAP (padrão=995).
Retorna:
email_client - email_client para ser usado em outras ações de e-mail.
email_count - retorna o número total de e-mails em default_folder.
Exceções:
Esta ação não oferece exceções.
email.delete
Exclui a mensagem atual.
Parâmetros:
email_client - conexão do cliente com o Mail Server. As conexões são criadas usando email.create_imap_client ou email.create_pop_client
Retorna:
Esta ação não dá retorno.
Exceções:
Esta ação não oferece exceções.
email.find_attachments
Permite retornar todos os anexos do e-mail atual ou pesquisar um anexo específico por nome e/ou tipo MIME.
Parâmetros:
email_client - conexão do cliente com o Mail Server. As conexões são criadas usando email.create_imap_client ou email.create_pop_client
attach_name (opcional) - nome ou nome parcial do anexo a ser procurado (padrão=não filtrar por nome)
mime_type (opcional) - tipo mime para filtrar anexos (padrão=não filtrar por tipo mime)
only_attachments (opcional) - Definido como True incluirá arquivos definidos como anexos. Definido como False incluirá todos os arquivos, anexos e embutidos (padrão=True)
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.
email.get_current_email
Retorna a mensagem de e-mail na posição atual no cliente de e-mail.
Parâmetros:
email_client - conexão do cliente com o Mail Server. As conexões são criadas usando email.create_imap_client ou email.create_pop_client
Retorna:
from - texto com nome (se definido) e endereço de e-mail do remetente da mensagem.
from_address - retorna apenas o endereço de e-mail do remetente da mensagem.
to - texto com nome (se definido) e endereço de e-mail dos destinatários.
subject - assunto da mensagem de e-mail.
date - dados e hora em que a mensagem foi enviada.
body - conteúdo da mensagem de e-mail como texto simples.
html_body - conteúdo da mensagem de e-mail como conteúdo HTML.
attachments_count - número de anexos na mensagem.
has_attachments - configuração de variável booleana se a mensagem de e-mail tem anexos ou não.
Exceções:
Esta ação não oferece exceções.
email.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 o Mail Server. As conexões são criadas usando email.create_imap_client ou email.create_pop_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.
email.move_to
Mova o e-mail atual para outra pasta existente da conta de e-mail.
Esta ação está disponível apenas para clientes IMAP.
Parâmetros:
email_client - conexão do cliente com o Mail Server. As conexões são criadas usando email.create_imap_client ou email.create_pop_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.
email.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 o Mail Server. As conexões são criadas usando email.create_imap_client ou email.create_pop_client
Retorna:
from - texto com nome (se definido) e endereço de e-mail do remetente da mensagem.
from_address - retorna apenas o endereço de e-mail do remetente da mensagem.
to - texto com nome (se definido) e endereço de e-mail dos destinatários.
subject - assunto da mensagem de e-mail.
date - dados e hora em que a mensagem foi enviada.
body - conteúdo da mensagem de e-mail como texto simples.
html_body - conteúdo da mensagem de e-mail como conteúdo HTML.
attachments_count - número de anexos na mensagem.
has_attachments - configuração de variável booleana se a mensagem de e-mail tem anexos ou não.
Exceções:
Esta ação não oferece exceções.
email.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 o Mail Server. As conexões são criadas usando email.create_imap_client ou email.create_pop_client
Retorna:
from - texto com nome (se definido) e endereço de e-mail do remetente da mensagem.
from_address - retorna apenas o endereço de e-mail do remetente da mensagem.
to - texto com nome (se definido) e endereço de e-mail dos destinatários.
subject - assunto da mensagem de e-mail.
date - dados e hora em que a mensagem foi enviada.
body - conteúdo da mensagem de e-mail como texto simples.
html_body - conteúdo da mensagem de e-mail como conteúdo HTML.
attachments_count - número de anexos na mensagem.
has_attachments - configuração de variável booleana se a mensagem de e-mail tem anexos ou não.
Exceções:
Esta ação não oferece exceções.
email.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 o Mail Server. As conexões são criadas usando email.create_imap_client ou email.create_pop_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=não filtrar por nome)
mime_type (opcional) - tipo mime para filtrar anexos (padrão=não filtrar por tipo mime)
only_attachments (opcional) - Definido como True incluirá arquivos definidos como anexos. Definido como False incluirá todos os arquivos, anexos e embutidos (padrão=True)
Retorna:
saved_files - lista com caminho de arquivo completo, para arquivos salvos
Exceções:
FileNotFoundException - quando nenhum anexo é encontrado para os filtros fornecidos
email.search
Salve os anexos em uma pasta, mantendo o mesmo nome do anexo do e-mail.
Esta ação está disponível apenas para clientes IMAP.
Parâmetros:
email_client - conexão do cliente com o Mail Server. As conexões são criadas usando email.create_imap_client ou email.create_pop_client
search_filter - filtro de pesquisa a ser aplicado na pasta atual, conforme definido na especificação de pesquisa IMAP. Para mais informações, acesse https://tools.ietf.org/html/rfc3501#page-49
Retorna:
emails_count - retorna o número total de e-mails em default_folder.
Exceções:
Esta ação não oferece exceções.
email.select_folder
Altere a pasta atual para o nome da pasta fornecida
Esta ação está disponível apenas para clientes IMAP.
Parâmetros:
email_client - conexão do cliente com o Mail Server. As conexões são criadas usando email.create_imap_client ou email.create_pop_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.
email.send_email
Envie uma mensagem de e-mail usando o protocolo SMTP. Para usar esta ação, você deve ter um usuário e senha com permissão para enviar mensagens ao seu Servidor de Correio.
Parâmetros:
sender - e-mail a inserir no campo DE da mensagem.
to - e-mails para inserir no campo TO da mensagem.
subject - assunto da mensagem.
smtp_user - nome de usuário para autenticação no servidor SMTP.
smtp_password - senha para autenticação no servidor SMTP.
smtp_server - IP ou nome de host do servidor SMTP.
smtp_port - porta para conectar no servidor SMTP (padrão=25).
tls - define se o TLS deve ser usado na comunicação com o servidor (default=False).
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).
attach_path - caminho para a pasta a ser anexada na mensagem (padrão=sem anexo).
Retorna:
saved_files - lista com caminho de arquivo completo, para arquivos salvos
Exceções:
AuthorizationException - quando ocorre um problema com a autenticação do servidor
MarvinRuntimeException - quando ocorre um problema com a comunicação do servidor de correio
email.store
Execute o comando IMAP store, para outras ações específicas do servidor. Isso permite trabalhar com sinalizadores específicos do servidor ou provedor de correio.
Esta ação está disponível apenas para clientes IMAP.
Parâmetros:
email_client - conexão do cliente com o Mail Server. As conexões são criadas usando email.create_imap_client ou email.create_pop_client
message - armazena a mensagem a ser enviada ao servidor.
value - valor a ser definido como mensagem.
Retorna:
emails_count - retorna o número total de e-mails em default_folder.
Exceções:
Esta ação não oferece exceções.
email.update_mailbox
Atualize as informações de contagem de e-mails e lista de e-mails dentro da pasta atual.
Parâmetros:
email_client - conexão do cliente com o Mail Server. As conexões são criadas usando email.create_imap_client ou email.create_pop_client
Retorna:
emails_count - retorna o número total de e-mails em default_folder.
Exceções:
Esta ação não oferece exceções.