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

SCR/AL1 - TOME III. Les librairies utilitaires

22. Le groupe s_ipc

22.4 Accès SMTP

Ce groupe de fonction permet d'envoyer des messages via un serveur SMTP.

Connexion

• SendMailConnect : connecte au serveur

Destinataires

• SendMailTo : ajoute un destinataire

Envoi de données

• SendMailStartData : prépare l'envoi de données
• SendMailWriteData : envoie une ligne de données
• SendMailEndData : termine l'envoi de données
• SendMailData : envoie les données en une fonction
• SendMailFile : envoie un fichier dans la partie data (pas en attachment)

Mails avec attach

• SendMailInit: démarre un mail avec attachments
• SendMailEnd: termine un mail avec attachments
• SendMailAttach : envoie un fichier en attachment
• SendMailStartAttachTxt : démarre un attachment de type texte
• SendMailAddAttachTxtLine : ajoute une ligne à l'attach courant

Déconnexion

• SendMailClose : termine la connexion

Fonctions de base

• SendMailWrite : envoie une ligne au serveur
• SendMailRead : lit la réponse du serveur

Variables

• SENDMAIL_BUF : buffer de réception des réponses du serveur SMTP.
• SENDMAIL_ERROR : dernier message d'erreur
• SENDMAIL_SOCKET : numéro du socket ouvert

22.4.1 SendMailConnect (file s_smtp.c:110)

Syntaxe

SendMailConnect(server, port, host, user)
char    *server, *host, *user;
int     port;

Description

Connecte au serveur SMTP server via le port port. Les paramètres host et user sont seulement indicatifs et ne sont en général pas traités par le serveur.

• char *server : nom du serveur (ex. "smtp.xon.be")
• int port : numéro du port (ex. : 25)
• char *host : nom du host source (ex. "heaven.be")
• char *user : user source (ex. "god@heaven.be")

Valeur retournée

• 0 : connexion opérée sans problème
• -1 : connexion au serveur impossible
• -2 : code retour du serveur SMTP incorrect
• -3 : erreur retournée par le serveur SMTP (HELO)
• -4 : erreur retournée par le serveur SMTP (MAIL FROM)

Le message d'erreur se trouve dans la variable globale SENDMAIL_ERROR.

Exemple

    U_ch    **data;
 
    if(SendMailConnect("smtp.whitehouse.org", 25, "heaven.ru", "kgb")) return(-1);
    if(SendMailTo("bill@whitehouse.be")) goto err;
    data = SCR_vtom("To: <bill@whitehouse.org>,Subject:La vie est belle,Coucou,c'est moi,..", ',');
    if(SendMailData(data)) goto err;
    SCR_free_tbl(data);
    SendMailClose();
    return(0);
  err:
    printf("Error : %s\n", SENDMAIL_ERROR);
    SendMailClose();
    return(-1);

Voir également

SendMailClose()

22.4.1.1 File s_smtp.c

SendMailAddAttachTxtLine(char *txt, int convertansi)
SendMailAttach(char *filename, char *contenttype, int base64, int convertansi)
SendMailClose()
SendMailConnect(server, port, host, user)
SendMailData(data)
SendMailEnd()
SendMailEndData()
SendMailFile(filename)
SendMailInit(char *smtpsrv, char *fromaddr, char *fromname, char *toaddr, char *subject)
SendMailRead()
SendMailStartAttachTxt()
SendMailStartData()
SendMailTo(dest)
SendMailWrite(rec)
SendMailWriteData(data)

22.4.2 SendMailTo (file s_smtp.c:184)

Syntaxe

SendMailTo(dest)
char    *dest;

Description

Ajoute des destinataires pour le message.

• char *dest = liste des destinataires séparés par des virgules, points-virgules ou blancs.

Valeur retournée

• 0 : déconnexion opérée sans problème
• -1 : erreur (connexion effectuée)

Le message d'erreur se trouve dans la variable globale SENDMAIL_ERROR.

Voir également

SendMailConnect(), SendMailData()

22.4.3 SendMailStartData (file s_smtp.c:221)

Syntaxe

SendMailStartData()

Description

Prépare l'envoi d'un message.

Valeur retournée

• 0 : Ok
• -1 : erreur

Le message d'erreur se trouve dans la variable globale SENDMAIL_ERROR.

Voir également

SendMailConnect(), SendMailData(), SendMailEndData(), SendMailWriteData()

22.4.4 SendMailWriteData (file s_smtp.c:259)

Syntaxe

SendMailWriteData(data)
U_ch    *data;

Description

Envoie une ligne d'un message.

Valeur retournée

• 0 : Ok
• -1 : erreur

Le message d'erreur se trouve dans la variable globale SENDMAIL_ERROR.

Voir également

SendMailConnect(), SendMailData(), SendMailEndData(), SendMailWriteData()

22.4.5 SendMailEndData (file s_smtp.c:240)

Syntaxe

SendMailEndData()

Description

Termine l'envoi d'un message.

Valeur retournée

• 0 : Ok
• -1 : erreur

Le message d'erreur se trouve dans la variable globale SENDMAIL_ERROR.

Voir également

SendMailConnect(), SendMailData(), SendMailStartData(), SendMailWriteData()

22.4.6 SendMailData (file s_smtp.c:290)

Syntaxe

SendMailData(data)
U_ch    **data;

Description

Envoie le message. Ce message contiendra les éventuels Subject, To ... qui seront traités par l'Agent Pop. Cette fonction appelle SendMailStartData(), SendMailWriteData() et SendMailEndData().

• U_ch **data : tableau de strings terminé par un NULL contenant les lignes du message.

Valeur retournée

• 0 : Ok
• -1 : erreur

Le message d'erreur se trouve dans la variable globale SENDMAIL_ERROR.

Voir également

SendMailConnect(), SendMailStartData(), SendMailEndData(), SendMailWriteData()

22.4.7 SendMailFile (file s_smtp.c:319)

Syntaxe

SendMailFile(filename)
char    *filename;

Description

Envoie un fichier dans la zone DATA du message. La zone DATA est ouverte et fermée par cette fonction (un seul fichier peut donc être envoyé).

• char *filename;

Valeur retournée

• 0 : Ok
• -1 : erreur

Le message d'erreur se trouve dans la variable globale SENDMAIL_ERROR.

Voir également

SendMailConnect(), SendMailStartData(), SendMailEndData(), SendMailWriteData() SendMailAttach64()

22.4.8 SendMailInit (file s_smtp.c:410)

Syntaxe

SendMailInit(char *smtpsrv, char *fromaddr,
             char *fromname, char *toaddr, char *subject)

Description

Démarre une session SMTP. Crée le socket et envoie les premières informations jusqu'au début de la section DATA.

• char *smtpsrv : serveur SMTP ("mail.xon.be")
• char *fromadr : adresse de l'expéditeur
• char *fromname : nom de l'expéditeur
• char *toadr : adresse(s) destination séparées par des virgules
• char *subject : titre du message

La porte du serveur SMTP est définie par la variable globale int SENDMAIL_PORT. Par défaut, celle-ci est fixée à 25.

Valeur retournée

• 0 : Ok
• -1 : erreur

Le message d'erreur se trouve dans la variable globale SENDMAIL_ERROR.

Exemple

    if(SendMailInit("mail.xon.be",
              "jmp.be", "jmp@xon.be", "Jean-Marc",
              "jmp@xon.be", "Essai d'attachment")) goto err;
 
    if(SendMailAttach("subject.txt", "text/plain", 0)) goto err;
    if(SendMailAttach("lastnode12.gif", "image/gif", 1)) goto err;
    if(SendMailAttach("budget.xls", "application/octet-stream", 1)) goto err;
 
    if(SendMailEnd()) goto err;
 
    printf("Ok\n");
    return(0);
 
err:
    printf("Error : %s\n", SENDMAIL_ERROR);
    SendMailClose();
    return(-1);
}
 

Voir également

SendMailClose(), SendMailAttach()

22.4.9 SendMailEnd (file s_smtp.c:452)

Syntaxe

SendMailEnd()

Description

Termine une session SMTP démarrée par SendMailInit().

Valeur retournée

• 0 : Ok
• -1 : erreur

Le message d'erreur se trouve dans la variable globale SENDMAIL_ERROR.

Exemple

    voir SendMailInit()

Voir également

SendMailEnd(), SendMailAttach()

22.4.10 SendMailAttach (file s_smtp.c:552)

Syntaxe

SendMailAttach(char *filename, char *contenttype, int base64, int convertansi)

Description

Attache un fichier au mail démarré par SendMailInit(). Un nombre quelconque de fichiers peuvent être attachés.

Attention, cette fonction ne peut être utilisée qu'après SendMailInit().

• char *filename = nom du fichier à attacher
• char *contenttype = type de fichier (ex. "text/plain" ou "image/gif", "application/octet-stream")
• int base64 = codage de l'attachment en base 64 ou non (0 = non)
• int convertansi = convertit automatiquement d'Ascii en Ansi

Valeur retournée

• 0 : Ok
• -1 : erreur

Le message d'erreur se trouve dans la variable globale SENDMAIL_ERROR.

Exemple

    voir SendMailInit()

Voir également

SendMailInit(), SendMailEnd(), SendMailAttach()

22.4.11 SendMailStartAttachTxt (file s_smtp.c:484)

Syntaxe

SendMailStartAttachTxt()

Description

Démarre un nouvel attachment de type texte. Le contenu de cet attachment doit être alimenté par la fonction SendMailAddAttachTxtLine(). Il s'agit en général du premier attachment d'un mail qui constituera le corps du message.

Attention, cette fonction ne peut être utilisée qu'après SendMailInit().

• 0 : Ok
• -1 : erreur

Le message d'erreur se trouve dans la variable globale SENDMAIL_ERROR.

Exemple

    voir SendMailInit()

Voir également

SendMailInit(), SendMailEnd(), SendMailAttach(), SendMailAttachTxtLine()

22.4.12 SendMailAddAttachTxtLine (file s_smtp.c:516)

Syntaxe

SendMailAddAttachTxtLine(char *txt, int convertansi)

Description

Ajoute un ligne à l'attachment courant commencé par l'appel à SendMailStartAttachTxt().

• char *txt : texte à envoyer
• int convertansi : 1 pour convertir d'Oem à Ansi, 0 sans conversion
• 0 : Ok
• -1 : erreur

Le message d'erreur se trouve dans la variable globale SENDMAIL_ERROR.

Exemple

    voir SendMailInit()

Voir également

SendMailInit(), SendMailEnd(), SendMailAttach(), SendMailStartAttachTxt()

22.4.13 SendMailClose (file s_smtp.c:156)

Syntaxe

SendMailClose()

Description

Déconnecte du serveur SMTP ouvert par SendMailConnect().

Valeur retournée

• 0 : déconnexion opérée sans problème
• -1 : erreur (connexion effectuée)

Le message d'erreur se trouve dans la variable globale SENDMAIL_ERROR.

Voir également

SendMailConnect()

22.4.14 SendMailWrite (file s_smtp.c:23)

Syntaxe

SendMailWrite(rec)
char    *rec;

Description

Envoie des données (ou une commande) sur le socket ouvert par SendMailConnect().

• char *rec : record à envoyer

Valeur retournée

• 0 : Ok
• -1 : erreur

Le message d'erreur se trouve dans la variable globale SENDMAIL_ERROR.

Voir également

SendMailConnect(), SendMailData(), SendMailStartData(), SendMailWriteData()

22.4.15 SendMailRead (file s_smtp.c:51)

Syntaxe

SendMailRead()

Description

Lit la réponse du serveur SMTP sur le socket ouvert par SendMailConnect().

Valeur retournée

• code de retour du serveur
• -1 : erreur de transmission

En cas d'erreur de transmission, le message d'erreur se trouve dans la variable globale SENDMAIL_ERROR.

La variable globale char *SENDMAIL_BUF contient le texte retourné par le serveur.

Voir également

SendMailConnect(), SendMailData(), SendMailStartData(), SendMailWriteData()

22.4.16 SENDMAIL_BUF

    char    SENDMAIL_BUF[128];

Buffer de réception des réponses du serveur SMTP.

22.4.17 SENDMAIL_ERROR

    char    SENDMAIL_ERROR[81];

Dernier message d'erreur.

22.4.18 SENDMAIL_SOCKET

    int     SENDMAIL_SOCKET;

Indique le numéro du socket ouvert.

[X-ON] [SCR4/AL1]