smtp_client_misc.h
Go to the documentation of this file.
1 /**
2  * @file smtp_client_misc.h
3  * @brief Helper functions for SMTP client
4  *
5  * @section License
6  *
7  * SPDX-License-Identifier: GPL-2.0-or-later
8  *
9  * Copyright (C) 2010-2019 Oryx Embedded SARL. All rights reserved.
10  *
11  * This file is part of CycloneTCP Open.
12  *
13  * This program is free software; you can redistribute it and/or
14  * modify it under the terms of the GNU General Public License
15  * as published by the Free Software Foundation; either version 2
16  * of the License, or (at your option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software Foundation,
25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
26  *
27  * @author Oryx Embedded SARL (www.oryx-embedded.com)
28  * @version 1.9.4
29  **/
30 
31 #ifndef _SMTP_CLIENT_MISC_H
32 #define _SMTP_CLIENT_MISC_H
33 
34 //Dependencies
35 #include "core/net.h"
36 #include "smtp/smtp_client.h"
37 
38 //C++ guard
39 #ifdef __cplusplus
40  extern "C" {
41 #endif
42 
43 //SMTP client related functions
45  SmtpClientState newState);
46 
48  SmtpClientReplyCallback callback);
49 
51  const char_t *command, const char_t *argument);
52 
54  char_t *replyLine);
55 
57  const SmtpMailAddr *from, const SmtpMailAddr *recipients,
58  uint_t numRecipients, const char_t *subject);
59 
61  const char_t *filename, const char_t *contentType,
62  const char_t *contentTransferEncoding, bool_t last);
63 
65 
66 //C++ guard
67 #ifdef __cplusplus
68  }
69 #endif
70 
71 #endif
error_t smtpClientFormatCommand(SmtpClientContext *context, const char_t *command, const char_t *argument)
Format SMTP command.
SmtpClientState
SMTP client states.
Definition: smtp_client.h:193
char_t filename[]
Definition: tftp_common.h:91
char char_t
Definition: compiler_port.h:43
TCP/IP stack core.
error_t smtpClientSendCommand(SmtpClientContext *context, SmtpClientReplyCallback callback)
Send SMTP command and wait for a reply.
error_t smtpClientFormatMailHeader(SmtpClientContext *context, const SmtpMailAddr *from, const SmtpMailAddr *recipients, uint_t numRecipients, const char_t *subject)
Format email header.
error_t smtpClientCheckTimeout(SmtpClientContext *context)
Determine whether a timeout error has occurred.
error_t(* SmtpClientReplyCallback)(SmtpClientContext *context, char_t *replyLine)
Multiline reply parsing callback function.
Definition: smtp_client.h:214
uint16_t last
Definition: ipv4_frag.h:96
SMTP client (Simple Mail Transfer Protocol)
Email address.
Definition: smtp_client.h:235
#define SmtpClientContext
Definition: smtp_client.h:156
error_t
Error codes.
Definition: error.h:42
error_t smtpClientFormatMultipartHeader(SmtpClientContext *context, const char_t *filename, const char_t *contentType, const char_t *contentTransferEncoding, bool_t last)
Format multipart header.
unsigned int uint_t
Definition: compiler_port.h:45
void smtpClientChangeState(SmtpClientContext *context, SmtpClientState newState)
Update SMTP client state.
error_t smtpClientParseEhloReply(SmtpClientContext *context, char_t *replyLine)
Parse EHLO response.
int bool_t
Definition: compiler_port.h:49