IMAPTransporter
A classe IMAPTransporter
permite-lhe recuperar mensagens a partir de um servidor de correio electrónico IMAP.
Objecto do IMAP Transporter
Os objetos do IMAP Transporter são instanciados com o comando IMAP New transporter. Eles oferecem as propriedades abaixo e funções:
.acceptUnsecureConnection : Boolean True if 4D is allowed to establish an unencrypted connection |
.addFlags( msgIDs : Collection ; keywords : Object ) : Object .addFlags( msgIDs : Text ; keywords : Object ) : Object .addFlags( msgIDs : Longint ; keywords : Object ) : Object adiciona sinalizadores aos msgIDs para as keywords especificadas |
.append( mailObj : Object ; destinationBox : Text ; options : Object ) : Object anexa um mailObj à destinationBox |
.authenticationMode : Text the authentication mode used to open the session on the mail server |
.checkConnection() : Object checks the connection using information stored in the transporter object |
.checkConnectionDelay : Integer o tempo máximo (em segundos) permitido antes de verificar a conexão com o servidor |
.connectionTimeOut : Integer the maximum wait time (in seconds) allowed to establish a connection to the server |
.copy( msgsIDs : Collection ; destinationBox : Text ) : Object .copy( allMsgs : Integer ; destinationBox : Text ) : Object copia as mensagens definidas por msgsIDs ou allMsgs para destinationBox no servidor IMAP |
.createBox( name : Text ) : Object cria uma caixa de correio com o name fornecido |
.delete( msgsIDs : Collection ) : Object .delete( allMsgs : Integer ) : Object define o sinalizador "deleted" para as mensagens definidas em msgsIDs ou allMsgs |
.deleteBox( name : Text ) : Object remove permanentemente a caixa de correio com o name fornecido do servidor IMAP |
.expunge() : Object remove todas as mensagens com o sinalizador "deleted" do servidor de e-mail IMAP. |
.getBoxInfo( { name : Text }) : Object retorna um objeto boxInfo correspondente à maibox atual ou à caixa de correio name |
.getBoxList( { parameters : Object } ) : Collection retorna uma coleção de caixas de correio que descreve todas as caixas de correio disponíveis |
.getDelimiter() : Text retorna o caractere usado para delimitar os níveis de hierarquia no nome da caixa de correio |
.getMail( msgNumber: Integer { ; options : Object } ) : Object .getMail( msgID: Text { ; options : Object } ) : Object retorna o objeto Email correspondente ao msgNumber ou msgID na caixa de correio designada pelo IMAP_transporter |
.getMails( ids : Collection { ; options : Object } ) : Object .getMails( startMsg : Integer ; endMsg : Integer { ; options : Object } ) : Object retorna um objeto que contém uma coleção de objetos Email |
.getMIMEAsBlob( msgNumber : Integer { ; updateSeen : Boolean } ) : Blob .getMIMEAsBlob( msgID : Text { ; updateSeen : Boolean } ) : Blob retorna um BLOB contendo o conteúdo MIME da mensagem correspondente ao msgNumber ou msgID na caixa de correio designada pelo IMAP_transporter |
.host : Text the name or the IP address of the host server |
.logFile : Text the path of the extended log file defined (if any) for the mail connection |
.move( msgsIDs : Collection ; destinationBox : Text ) : Object .move( allMsgs : Integer ; destinationBox : Text ) : Object move as mensagens definidas por msgsIDs ou allMsgs para destinationBox no servidor IMAP |
.numToID( startMsg : Integer ; endMsg : Integer ) : Collection converte os números de sequência em IDs exclusivos do IMAP para as mensagens no intervalo sequencial designado por startMsg e endMsg |
.removeFlags( msgIDs : Collection ; keywords : Object ) : Object .removeFlags( msgIDs : Text ; keywords : Object ) : Object .removeFlags( msgIDs : Longint ; keywords : Object ) : Object remove os sinalizadores dos msgIDs para as keywords especificadas |
.renameBox( currentName : Text ; newName : Text ) : Object altera o nome de uma caixa de correio no servidor IMAP |
.port : Integer the port number used for mail transactions |
.searchMails( searchCriteria : Text ) : Collection procura por mensagens que correspondam aos searchCriteria fornecidos na caixa de correio atual |
.selectBox( name : Text { ; state : Integer } ) : Object seleciona a caixa de correio name como a caixa de correio atual |
.subscribe( name : Text ) : Object permite adicionar ou remover a caixa de correio especificada do conjunto de caixas de correio "inscritas" do servidor IMAP |
.unsubscribe( name : Text ) : Object remove uma caixa de correio de um conjunto de caixas de correio inscritas |
.port : Integer the port number used for mail transactions |
IMAP New transporter
História
Release | Mudanças |
---|---|
18 R4 | Adicionado |
IMAP New transporter( server : Object ) : 4D.IMAPTransporter
Parâmetro | Tipo | Descrição | |
---|---|---|---|
server | Object | -> | Informação de servidor de correio |
Resultados | 4D.IMAPTransporter | <- | Objeto do transportador IMAP |
Descrição
O comando IMAP New transporter
configura uma nova conexão IMAP de acordo com o parâmetro server e retorna um novo objeto transporter. O objeto transporter retornado vai geralmente ser usado para receber emails.
No parâmetro server, passe um objeto contendo as propriedades abaixo:
server | Valor padrão (se omitido) |
---|---|
.acceptUnsecureConnection : Boolean True if 4D is allowed to establish an unencrypted connection | False |
.accessTokenOAuth2: Text .accessTokenOAuth2: Objeto Cadeia ou objeto token que representa as credenciais de autorização OAuth2. Usado somente com OAUTH2 authenticationMode . Se accessTokenOAuth2 for usado, mas authenticationMode for omitido, o protocolo OAuth 2 será usado (se permitido pelo servidor). Não retornado no objeto IMAP transporter. | nenhum |
.authenticationMode : Text the authentication mode used to open the session on the mail server | o modo de autenticação mais seguro disponível no servidor é usado |
.checkConnectionDelay : Integer o tempo máximo (em segundos) permitido antes de verificar a conexão com o servidor | 300 |
.connectionTimeOut : Integer the maximum wait time (in seconds) allowed to establish a connection to the server | 30 |
.host : Text the name or the IP address of the host server | mandatory |
.logFile : Text the path of the extended log file defined (if any) for the mail connection | nenhum |
senha : Texto Senha do usuário para autenticação no servidor. Não retornado no objeto IMAP transporter. | nenhum |
.port : Integer the port number used for mail transactions | 993 |
.port : Integer the port number used for mail transactions | nenhum |
Aviso: Certifique-se de que o tempo limite definido seja menor do que o tempo limite do servidor, caso contrário, o tempo limite do cliente será inútil.
Resultados
A função retorna um objeto transportador IMAP. Todas as propriedades retornadas são apenas leitura.
A ligação IMAP é automaticamente fechada quando o objecto transportador é destruído.