SCR/AL1 - TOME III. Les librairies utilitaires


Présentation	Documentation				L'équipe	Sérialisation
	Programmes	Objets	Libs Utilitaires	Libs Internes
	Editeur	Syntaxes	Windows	Versions

22. Le groupe s_ipc

22.5 Accès POP3

Ce groupe comprend une série de fonctions de lecture de mail. Elles permettent de détacher et de décoder les pièces jointes encodées base64 et quoted-printable. Les autres encodages (7bit, ...) sont reproduits tels quels.

Pop3Connect(server, user, pass, port) : connexion au serveur de mail
Pop3Close(sock) : fin de la connexion
Pop3Nb(sock) : nombre de messages dans la boîte mail
POP3MSG *Pop3GetHeader(int sock, int msgnb) : lit le headers du message msgnb
POP3MSG **Pop3GetHeaders(int sock) : lit les headers des messages
POP3MSG *Pop3GetMsg(server, user, passwd, msgnb) lit le message msgnb
POP3MSG **Pop3GetMsgs(sock) lit tous les messages
Pop3DeleteMsg(int sock, int msgnb) : détruit le message msgnb
Pop3Detach(POP3MSG *msg, int attachnb, char *filename) : détache une pièce jointe
Pop3FreeMsgs(POP3MSG **msgs) : libère les messages lus
Pop3FreeMsg(POP3MSG *msg) : libère un message
POP3MSG **Pop3Session(server, user, passwd, port) : effectue toute la session et lit tous les messages

Les messages sont stockés dans des structures POP3MSG.

Le message d'erreur éventuel se trouve dans la variable char *POP3_ERROR.

22.5.1 Pop3Connect (file s_pop3.c:239)

Syntax

Pop3Connect(server, user, pass, port)
char    *server, *user, *pass;
int     port;

Description

Connecte au POP3 serveur sur la porte port (par défaut 110) sous le login user avec le mot de passe pass.

char *server : nom du serveur (ex. "pop3.plan.be")
char *user : nom de login (ex. "jmp")
char *pass : mot de passe (ex. "123456")
int port : porte POP3. Si <= 0, fixée à 110.

Valeur retournée

si > 0 : entier indiquant le numéro de socket ouvert
-1 : connexion au serveur impossible
-2 : erreur de transmission
-3 : erreur retournée par le serveur

La variable POP3_ERROR contient le message d'erreur éventuel.

Voir également

Pop3Connect(), Pop3Close(), Pop3Nb(), Pop3GetHeaders(), Pop3GetMsgs(), Pop3GetHeader(), Pop3GetMsg(), Pop3FreeMsg(), Pop3Session(), Pop3Detach()

File s_pop3.c

Pop3Close(sock)
Pop3Connect(server, user, pass, port)
Pop3DeleteMsg(int sock, int msgnb)
Pop3Detach(POP3MSG *msg, int attachnb, char *filename)
Pop3DetachBody(POP3MSG *attach, char *filename)
Pop3FreeMsg(POP3MSG *msg)
Pop3FreeMsgs(POP3MSG **msgs)
POP3MSG *Pop3GetHeader(int sock, int msgnb)
POP3MSG **Pop3GetHeaders(int sock)
POP3MSG *Pop3GetMsg(int sock, int msgnb)
POP3MSG **Pop3GetMsgs(int sock)
Pop3Nb(sock)
Pop3SaveMsg(POP3MSG *msg, char *filename)
POP3MSG **Pop3Session(server, user, passwd, port)

Pop3DetachBody (file s_pop3.c:809)

Syntax

Pop3DetachBody(POP3MSG *attach, char *filename)

Description

Détache le body d'un message et le sauve dans un fichier.

attach : POP3MSG * lu par Pop3ReadMsg() ou sous message (attach)
char *filename : nom du fichier résultat ou 0 ou string vide. Si 0 ou string vide, la pièce est sauvée sous le nom qu'elle avait à l'envoi du message mais dans le répertoire courant. Si elle n'avait pas de nom, elle n'est pas sauvée.

Le type de décodage est basé sur le contenu de l'attachment. Sont gérés :

base64, mais pose problème avec Outlook et les fichiers .doc et autres qui contiennent de l'information "cachée" et pas seulement le fichier .doc attaché
quoted-printable
7bit (pas de décodage)
8bit (pas de décodage)

Valeur retournée

0 si Ok
-1 si message non défini
-2 si filename est nul et pas de nom de fichier dans le message
-3 si l'attachment est vide
-4 si le fichier cible ne peut être ouvert

Voir également

Pop3Connect(), Pop3Close(), Pop3Nb(), Pop3GetHeaders(), Pop3GetMsgs(), Pop3GetHeader(), Pop3GetMsg(), Pop3FreeMsg(), Pop3Session(), Pop3Detach()

Pop3SaveMsg (file s_pop3.c:1078)

Syntax

Pop3SaveMsg(POP3MSG *msg, char *filename)

22.5.2 Pop3Close (file s_pop3.c:292)

Syntax

Pop3Close(sock)
int     sock;

Description

Termine un session POP3.

int sock : socket retourné par Pop3Connect()

Valeur retournée

0 : Ok
-1 : erreur à la fermeture ou socket non ouvert.

La variable POP3_ERROR contient le message d'erreur éventuel.

Voir également

Pop3Connect(), Pop3Close(), Pop3Nb(), Pop3GetHeaders(), Pop3GetMsgs(), Pop3GetHeader(), Pop3GetMsg(), Pop3FreeMsg(), Pop3Session(), Pop3Detach()

22.5.3 Pop3Nb (file s_pop3.c:320)

Syntax

Pop3Nb(sock)
int     sock;

Description

Retourne le nombre de message en attente sur le socket sock.

int sock : socket retourné par Pop3Connect()

Valeur retournée

entier >= 0 : nbre de messages sur le serveur pour l'utilisateur donné
-1 : erreur retournée par le serveur

La variable POP3_ERROR contient le message d'erreur éventuel.

Voir également

Pop3Connect(), Pop3Close(), Pop3Nb(), Pop3GetHeaders(), Pop3GetMsgs(), Pop3GetHeader(), Pop3GetMsg(), Pop3FreeMsg(), Pop3Session(), Pop3Detach()

22.5.4 Structure POP3MSG

Cette structure est retournée par les fonctions d'accès au serveur de mail.

typedef struct _pop3msg_ {
    int     size;           /* Taille du message */
    char    *from;          /* Origine du message */
    char    *to;            /* Destinataire du message */
    char    *reply;         /* Adresse de retour du message */
    char    *date;          /* Date d'envoi du message */
    char    *subject;       /* Champ sujet du message */
    char    *type;          /* Content-type */
    char    *encoding;      /* Transfer-Encoding */
    char    *disposition;   /* Disposition (attachment) */
    char    *filename;      /* Nom de l'attachment */
    char    *boundary;      /* Boundary */
    char    **txt;          /* Texte du message */
    char    **body;         /* Corps du message */
    char    **headers;      /* Header du Message */
    int     nbattachs;      /* Nbre d'attach */
    struct _pop3msg_ **attachs;   /* Attachments */
} POP3MSG;

22.5.5 Pop3GetHeader (file s_pop3.c:638)

Syntax

POP3MSG *Pop3GetHeader(int sock, int msgnb)

Description

Lit le header du message msgnb sur le socket sock ouvert via Pop3Connect().

int msgnb : numéro d'ordre du message. Le premier message est le numéro 1 (et pas 0!).
int sock : socket retourné par Pop3Connect()

Valeur retournée

0 : Erreur (voir POP3_ERROR)
structure POP3MSG allouée

La variable POP3_ERROR contient le message d'erreur éventuel.

Voir également

Pop3Connect(), Pop3Close(), Pop3Nb(), Pop3GetHeaders(), Pop3GetMsgs(), Pop3GetHeader(), Pop3GetMsg(), Pop3FreeMsg(), Pop3Session(), Pop3Detach()

22.5.6 Pop3GetHeaders (file s_pop3.c:668)

Syntax

POP3MSG **Pop3GetHeaders(int sock)

Description

Lit les headers de tous les messages sur le socket ouvert via Pop3Connect().

int sock : socket retourné par Pop3Connect()

Valeur retournée

0 : Erreur (voir POP3_ERROR)
Tableau pointeurs vers des structures POP3MSG terminée par un NULL

La variable POP3_ERROR contient le message d'erreur éventuel.

Voir également

Pop3Connect(), Pop3Close(), Pop3Nb(), Pop3GetHeaders(), Pop3GetMsgs(), Pop3GetHeader(), Pop3GetMsg(), Pop3FreeMsg(), Pop3Session(), Pop3Detach()

22.5.7 Pop3GetMsg (file s_pop3.c:700)

Syntax

POP3MSG *Pop3GetMsg(int sock, int msgnb)

Description

Lit le message msgnb sur la session pop3 sock ouverte par Pop3Connect().

int sock : socket retourné par Pop3Connect()
int msgnb : numéro du message (commençant à 1)

Valeur retournée

0 : Erreur (voir POP3_ERROR)
structure POP3MSG allouée

La variable POP3_ERROR contient le message d'erreur éventuel.

Voir également

Pop3Connect(), Pop3Close(), Pop3Nb(), Pop3GetHeaders(), Pop3GetMsgs(), Pop3GetHeader(), Pop3GetMsg(), Pop3FreeMsg(), Pop3Session(), Pop3Detach()

22.5.8 Pop3GetMsgs (file s_pop3.c:729)

Syntax

POP3MSG **Pop3GetMsgs(int sock)

Description

Lit les messages sur le socket ouvert via Pop3Connect().

int sock : socket retourné par Pop3Connect()

Valeur retournée

0 : Erreur (voir POP3_ERROR)
Tableau de pointeurs vers des structures POP3MSG terminé par un NULL

La variable POP3_ERROR contient le message d'erreur éventuel.

Voir également

Pop3Connect(), Pop3Close(), Pop3Nb(), Pop3GetHeaders(), Pop3GetMsgs(), Pop3GetHeader(), Pop3GetMsg(), Pop3FreeMsg(), Pop3Session(), Pop3Detach()

22.5.9 Pop3DeleteMsg (file s_pop3.c:761)

Syntax

Pop3DeleteMsg(int sock, int msgnb)

Description

Detruit le message msgnb sur le serveur. Il ne sera réellement détruit que lors de la fin normale de la session.

int sock : socket retourné par Pop3Connect()
int msgnb : numéro du message (commençant à 1)

Valeur retournée

-1 : Erreur (voir POP3_ERROR)
0 : Ok

La variable POP3_ERROR contient le message d'erreur éventuel.

Voir également

Pop3Connect(), Pop3Close(), Pop3Nb(), Pop3GetHeaders(), Pop3GetMsgs(), Pop3GetHeader(), Pop3GetMsg(), Pop3FreeMsg(), Pop3Session(), Pop3Detach()

22.5.10 Pop3Detach (file s_pop3.c:899)

Syntax

Pop3Detach(POP3MSG *msg, int attachnb, char *filename)

Description

Détache une pièce jointe et la sauve dans un fichier.

msg : POP3MSG * lu par Pop3ReadMsg();
int attachnb : numéro de l'attachment ou -1 s'il faut détacher le body du message
char *filename : nom du fichier résultat ou 0 ou string vide. Si 0 ou string vide, la pièce est sauvée sous le nom qu'elle avait à l'envoi du message mais dans le répertoire courant. Si elle n'avait pas de nom, elle n'est pas sauvée.

Le type de décodage est basé sur le contenu de l'attachment. Sont gérés :

base64, mais pose problème avec Outlook et les fichiers .doc et autres qui contiennent de l'information "cachée" et pas seulement le fichier .doc attaché
quoted-printable
7bit (pas de décodage)
8bit (pas de décodage)

Valeur retournée

0 si Ok
-1 si message non défini ou pas de pièces jointes
-2 si filename est nul et pas de nom de fichier dans le message
-3 si l'attachment est vide
-4 si le fichier cible ne peut être ouvert

Voir également

Pop3Connect(), Pop3Close(), Pop3Nb(), Pop3GetHeaders(), Pop3GetMsgs(), Pop3GetHeader(), Pop3GetMsg(), Pop3FreeMsg(), Pop3Session(), Pop3Detach()

22.5.11 Pop3FreeMsgs (file s_pop3.c:610)

Syntax

Pop3FreeMsgs(POP3MSG **msgs)

Description

Libère un tableau de structures POP3MSG.

msgs = tableau de pointeur retourné par une des fonctions de Pop3GetHeaders() ou Pop3GetMsgs().

Valeur retournée

Voir également

Pop3Connect(), Pop3Close(), Pop3Nb(), Pop3GetHeaders(), Pop3GetMsgs(), Pop3GetHeader(), Pop3GetMsg(), Pop3FreeMsg(), Pop3Session(), Pop3Detach()

22.5.12 Pop3FreeMsg (file s_pop3.c:574)

Syntax

Pop3FreeMsg(POP3MSG *msg)

Description

Libère une structure POP3MSG et toutes les sous-structures.

msg = un message alloué par Pop3GetMsg(), Pop3GetMsgs(), Pop3GetHeader() ou Pop3GetHeaders().

Valeur retournée

Voir également

Pop3Connect(), Pop3Close(), Pop3Nb(), Pop3GetHeaders(), Pop3GetMsgs(), Pop3GetHeader(), Pop3GetMsg(), Pop3FreeMsg(), Pop3Session(), Pop3Detach()

22.5.13 Pop3Session (file s_pop3.c:1028)

Syntax

POP3MSG **Pop3Session(server, user, passwd, port)
char    *server, *user, *passwd;
int     port;

Description

Session complète de lecture de message sur un serveur POP3. Ouvre la session, lit les messages et ferme la session.

char *server : nom du serveur (ex. "pop3.plan.be")
char *user : nom de login (ex. "jmp")
char *pass : mot de passe (ex. "123456")
int port : porte POP3. Si <= 0, fixée à 110.

Valeur retournée

0 : Erreur (voir POP3_ERROR)
Tableau de structures POP3MSG

La variable POP3_ERROR contient le message d'erreur éventuel.

Exemple

    main(argc, argv)
    int     argc;
    char    *argv[];
    {
        POP3MSG **msgs;
        int     i, j;
        char    filename[60];
 
        if(argc < 4) {
            printf("Syntax : Pop3 pop3host user passwd\n");
            exit(1);
            }
        msgs = Pop3Session(argv[1], argv[2], argv[3], 110);
        if(msgs == 0) {
            printf("%s\n", POP3_ERROR);
            exit(1);
            }
        for(i = 0 ; msgs[i] ; i++) {
            printf("%d. From '%s' Subject '%s'\n", i, msgs[i]->from, msgs[i]->subject);
            for(j = 0 ; j < msgs[i]->nbattachs ; j++) {
                sprintf(filename, "file%d_%d", i, j);
                if(Pop3Detach(msgs[i], j, filename) == 0)
                    printf(" Attach %d saved in %s\n", j + 1, filename);
                else
                    printf(" Attach %d not saved\n", j + 1);
                }
            }
 
        Pop3FreeMsgs(msgs);
        exit(0);
    }

Voir également

Pop3Connect(), Pop3Close(), Pop3Nb(), Pop3GetHeaders(), Pop3GetMsgs(), Pop3GetHeader(), Pop3GetMsg(), Pop3FreeMsg(), Pop3Session(), Pop3Detach()

22.5.14 Variable POP3_ERROR

Cette variable contient le dernier message d'erreur rencontré par une fonction de lecture de mail.

    char    POP3_ERROR[80];