IMAP_Login

4D v20

IMAP_Login


IMAP_Login ( nomeServidor ; nomeUsuario ; senha ; imap_ID {; paramSessao} ) -> Resultado

Parâmetro	Tipo	Descrição
nomeServidor	String	Nome ou direção IP do servidor de correio IMAP
nomeUsuario	String	Nome do usuário
senha	String	Senha
imap_ID	Inteiro longo	Referencia a esta conexão IMAP
paramSessao	Inteiro longo	1 = Use SSL, 0 se omitido = Não utilizar SSL
Resultado	Inteiro	Código de erro

Descrição

O comando IMAP_Login conecta ao usuário ao servidor de correio IMAP com o nome de usuário e senha dados.

IMAP_Login devolve um número de identificação específico para a conexão (imap_ID) ao qual os comandos IMAP posteriores podem se referir.

A conexão é fechada com o comando IMAP_Logout ou quando o contador de inatividade do servidor IMAP supera o timeout.

nomeServidor é o nome ou a direção IP do servidor de correio IMAP. Se recomenda utilizar o nome do servidor, caso seja necessário, pode utilizar uma direção IP.

nomeUsuario é o nome do usuário do servidor de correio IMAP. O parâmetro nomeUsuario não deve conter o domínio. Por exemplo, para a direção "jack@4d.com", o nomeUsuario é “jack”.

senha é a senha correspondente a nomeUsuario no servidor de correio IMAP.

imap_ID é uma variável de tipo inteiro longo na qual é devolvida uma referencia à conexão que se acaba de estabelecer. Este parâmetro deve passar a uma variável 4D para aceitar os resultados devolvidos. A variável se utiliza em todos os comandos posteriores que realizam ações relacionadas com esta sessão. Se IMAP_Login, imap_ID toma o valor zero.

O parâmetro opcional paramSessao permite ativar o protocolo SSL para a conexão:

Se passa 1, a conexão ao servidor IMAP é realizada em SSL (modo síncrono),
Se passa 0 ou omite este parâmetro, a conexão é realizada em modo estandarte, não seguro.

Exemplo

Esta é uma sequência típica de conexão:

 $ErrorNum:=IMAP_Login(vHost;vUserName;vUserPassword;vImap_ID;1)

 If($ErrorNum =0)

    C_TEXT(vCapability)

    $ErrorNum:=IMAP_Capability(vImap_ID;vCapability))

  ` Os comandos IMAP utilizam o parâmetro vImap_ID

 End if

 $ErrorNum:=IMAP_Logout(vImap_ID)

Ver também

IMAP_Logout
IMAP_VerifyID