nginstack

Module: @nginstack/engine/lib/email/ImapClient

Classes

ImapAttachment
ImapClient
ImapEmail

Type Definitions

AuthenticationType

Type:
  • 'plain' | 'xoauth2'

Mailbox

Objeto com as informações de uma caixa de entrada.

Type:
  • Object
Properties:
Name Type Description
name string

Nome da caixa de entrada.
delimiter string

Delimitador utilizado para hierarquia de caixas de entrada.
attributes Array.<string>

Lista de atributos da caixa de entrada.

PlainAuthentication

Objeto com as credenciais para autenticação quando o método authenticate é chamado com o tipo "plain".

Type:
  • Object
Properties:
Name Type Description
user string

Usuário. O email que será acessado.
password string

Senha. Alguns servidores necessitam que uma senha de aplicativo seja gerada para efetuar o acesso via IMAP.

SearchOptions

Objeto com opções de busca usado nos métodos search e uidSearch

Type:
  • Object
Properties:
Name Type Description
since Date

Filtra mensagens recebidas após uma data específica. A data local é usada, desconsiderando a hora.
before Date

Filtra mensagens recebidas antes de uma data específica. A data local é usada, desconsiderando a hora.
subject string

Filtra mensagens com um assunto específico. Apenas textos sem caracteres especiais são suportados.
from string

Filtra mensagens de um remetente específico.
to string

Filtra mensagens enviadas para um destinatário específico.
flags Array.<string>

Filtra mensagens com uma lista de flags específica.

XOAuth2Authentication

Objeto com as credenciais para autenticação quando o método authenticate é chamado com o tipo "xoauth2".

Type:
  • Object
Properties:
Name Type Description
user string

Usuário. O email que será acessado.
accessToken string

Token de acesso. Deve ser obtido previamente via fluxo OAuth 2.0.