smtp_client_auth.h File Reference

SMTP authentication mechanism. More...

#include "core/net.h"
#include "smtp/smtp_client.h"

Go to the source code of this file.

Functions

error_t smtpClientLoginAuth (SmtpClientContext *context, const char_t *username, const char_t *password)
 Perform LOGIN authentication. More...
 
error_t smtpClientPlainAuth (SmtpClientContext *context, const char_t *username, const char_t *password)
 Perform PLAIN authentication. More...
 
error_t smtpClientCramMd5Auth (SmtpClientContext *context, const char_t *username, const char_t *password)
 Perform CRAM-MD5 authentication. More...
 

Detailed Description

SMTP authentication mechanism.

License

SPDX-License-Identifier: GPL-2.0-or-later

Copyright (C) 2010-2019 Oryx Embedded SARL. All rights reserved.

This file is part of CycloneTCP Open.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Author
Oryx Embedded SARL (www.oryx-embedded.com)
Version
1.9.4

Definition in file smtp_client_auth.h.

Function Documentation

◆ smtpClientCramMd5Auth()

error_t smtpClientCramMd5Auth ( SmtpClientContext context,
const char_t username,
const char_t password 
)

Perform CRAM-MD5 authentication.

Parameters
[in]contextPointer to the SMTP client context
[in]usernameNULL-terminated string containing the user name
[in]passwordNULL-terminated string containing the user's password
Returns
Error code

Definition at line 321 of file smtp_client_auth.c.

◆ smtpClientLoginAuth()

error_t smtpClientLoginAuth ( SmtpClientContext context,
const char_t username,
const char_t password 
)

Perform LOGIN authentication.

Parameters
[in]contextPointer to the SMTP client context
[in]usernameNULL-terminated string containing the user name
[in]passwordNULL-terminated string containing the user's password
Returns
Error code

Definition at line 52 of file smtp_client_auth.c.

◆ smtpClientPlainAuth()

error_t smtpClientPlainAuth ( SmtpClientContext context,
const char_t username,
const char_t password 
)

Perform PLAIN authentication.

Parameters
[in]contextPointer to the SMTP client context
[in]usernameNULL-terminated string containing the user name
[in]passwordNULL-terminated string containing the user's password
Returns
Error code

Definition at line 216 of file smtp_client_auth.c.