Configurar conta de e-mail de recebimento

Configura uma conta de e-mail de recebimento para a empresa informada.

Path Parameters

• empresa string required

  CNPJ da empresa

Header Parameters

• x-auth-token string required

  identificador de sessão

application/json;charset=UTF-8

Request Body required

Configuração da conta de email de recebimento

• apiRecebimento string

  Chave da API para recebimento de NFSe. Obrigatório se 'habilitarRecebimentoNfse = true' e não informado o campo 'emailRecebimento'.

• ativo boolean

  Ativa/Desativa configuração. Se 'ativo = false', os demais atributos não são persistidos

• diasParaManterEmailCaixaEntrada int32

  Quantidade de dias em que os e-mails devem ser armazenados após a conta começar a ser monitorada. Exemplo: Se for configurado 30 dias, a partir que o percentual máximo for atingido, as mensagens com mais de 30 dias serão apagadas automaticamente. Obrigatório se 'habilitarMonitoramentoEspacoConta = true'.

• emailNotificacao string

  E-mail a ser notificado caso percentual de uso seja atingido. Obrigatório se 'habilitarMonitoramentoEspacoConta = true'.

• emailRecebimento string

  E-mail para recebimento de NFSe. Obrigatório se 'habilitarRecebimentoNfse = true' e não informado o campo 'apiRecebimento'.

• habilitarMonitoramentoEspacoConta boolean

  Ativa/Desativa o monitoramento de espaço em conta. Caso ativo, deve-se informar os campos 'emailNotificacao', 'percentualMaximoUsoConta' e 'diasParaManterEmailCaixaEntrada'.

• habilitarRecebimentoNfse boolean

  Ativa/Desativa o recebimento de NFSe. Caso ativo, deve-se informar o e-mail de recebimento ou a API de recebimento.

• habilitarSegurancaCriptografada boolean

  Ativa/Desativa o protocolo de segurança criptografado. Caso ativo, deve-se ativar SSL ou TLS.

• mfa object

  Tokens para autenticação multifatores (MFA). Obrigatório se 'ativo = true' e não informado o campo 'senha'

  clientId string

  clientSecret string

  clientTenantId string
• monitorarOutraPasta boolean

  Ativa/Desativa o monitoramento de outra pasta diferente do padrão (caixa de entrada). Caso ativo, deve-se informar o campo 'outraPasta'.

• outraPasta string

  Caminho da pasta monitorada (Exemplo: INBOX\RECEBIMENTO). Obrigatório se 'monitorarOutraPasta = true'.

• percentualMaximoUsoConta int32

  Espaço máximo a ser utilizado para a conta ser monitorada. Obrigatório se 'habilitarMonitoramentoEspacoConta = true'.

• porta int32

  Porta para conexão. Obrigatório se 'ativo = true'

• senha string

  Senha do Email/Usuário de acesso ao Servidor de Email. Obrigatório se 'ativo = true'

• servidor string

  Endereço do Servidor de Email. Obrigatório se 'ativo = true'

• testarConexao boolean

  Ativa/Desativa o teste de conexão com a conta de e-mail.

• tipoConexao string

  Possible values: [IMAP, POP3]

  Tipo de conexão com o Email. Obrigatório se 'ativo = true'

• usarSsl boolean

  Ativa/Desativa de SSL para conexão. Obrigatório se 'ativo = true'

• usarTls boolean

  Ativa/Desativa SSL como protocolo de segurança criptografado. Obrigatório se 'habilitarSegurancaCriptografada = true' e não informado ou informado como false o campo 'usarTls'.

• usuario string

  Email/Usuário de acesso ao Servidor de Email. Obrigatório se 'ativo = true'

Responses

• 200
• 201
• 401
• 403
• 404

---

OK

*/*

• Schema

---

Schema

• string

Created

Unauthorized

Forbidden

Not Found

Loading...