NeoMutt  2024-04-25-100-gcb3684
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
smtp.h File Reference

Send email to an SMTP server. More...

#include "config.h"
#include <stdbool.h>
+ Include dependency graph for smtp.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

bool smtp_auth_is_valid (const char *authenticator)
 Check if string is a valid smtp authentication method.
 
int mutt_smtp_send (const struct AddressList *from, const struct AddressList *to, const struct AddressList *cc, const struct AddressList *bcc, const char *msgfile, bool eightbit, struct ConfigSubset *sub)
 Send a message using SMTP.
 

Detailed Description

Send email to an SMTP server.

Authors
  • Pietro Cerutti
  • Richard Russon

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, see http://www.gnu.org/licenses/.

Definition in file smtp.h.

Function Documentation

◆ smtp_auth_is_valid()

bool smtp_auth_is_valid ( const char *  authenticator)

Check if string is a valid smtp authentication method.

Parameters
authenticatorAuthenticator string to check
Return values
trueArgument is a valid auth method

Validate whether an input string is an accepted smtp authentication method as defined by SmtpAuthenticators.

Definition at line 927 of file smtp.c.

928{
929 for (size_t i = 0; i < mutt_array_size(SmtpAuthenticators); i++)
930 {
931 const struct SmtpAuth *auth = &SmtpAuthenticators[i];
932 if (auth->method && mutt_istr_equal(auth->method, authenticator))
933 return true;
934 }
935
936 return false;
937}
#define mutt_array_size(x)
Definition: memory.h:38
bool mutt_istr_equal(const char *a, const char *b)
Compare two strings, ignoring case.
Definition: string.c:672
static const struct SmtpAuth SmtpAuthenticators[]
Accepted authentication methods.
Definition: smtp.c:904
SMTP authentication multiplexor.
Definition: smtp.c:109
const char * method
Name of authentication method supported, NULL means variable.
Definition: smtp.c:120
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_smtp_send()

int mutt_smtp_send ( const struct AddressList *  from,
const struct AddressList *  to,
const struct AddressList *  cc,
const struct AddressList *  bcc,
const char *  msgfile,
bool  eightbit,
struct ConfigSubset sub 
)

Send a message using SMTP.

Parameters
fromFrom Address
toTo Address
ccCc Address
bccBcc Address
msgfileMessage to send to the server
eightbitIf true, try for an 8-bit friendly connection
subConfig Subset
Return values
0Success
-1Error

Definition at line 1100 of file smtp.c.

1103{
1104 struct SmtpAccountData adata = { 0 };
1105 struct ConnAccount cac = { { 0 } };
1106 const char *envfrom = NULL;
1107 int rc = -1;
1108
1109 adata.sub = sub;
1110 adata.fqdn = mutt_fqdn(false, adata.sub);
1111 if (!adata.fqdn)
1112 adata.fqdn = NONULL(ShortHostname);
1113
1114 const struct Address *c_envelope_from_address = cs_subset_address(adata.sub, "envelope_from_address");
1115
1116 if (smtp_fill_account(&adata, &cac) < 0)
1117 return rc;
1118
1119 adata.conn = mutt_conn_find(&cac);
1120 if (!adata.conn)
1121 return -1;
1122
1123 /* it might be better to synthesize an envelope from from user and host
1124 * but this condition is most likely arrived at accidentally */
1125 if (c_envelope_from_address)
1126 {
1127 envfrom = buf_string(c_envelope_from_address->mailbox);
1128 }
1129 else if (from && !TAILQ_EMPTY(from))
1130 {
1131 envfrom = buf_string(TAILQ_FIRST(from)->mailbox);
1132 }
1133 else
1134 {
1135 mutt_error(_("No from address given"));
1136 mutt_socket_close(adata.conn);
1137 return -1;
1138 }
1139
1140 const char *const c_dsn_return = cs_subset_string(adata.sub, "dsn_return");
1141
1142 struct Buffer *buf = buf_pool_get();
1143 do
1144 {
1145 /* send our greeting */
1146 rc = smtp_open(&adata, eightbit);
1147 if (rc != 0)
1148 break;
1149 FREE(&adata.auth_mechs);
1150
1151 /* send the sender's address */
1152 buf_printf(buf, "MAIL FROM:<%s>", envfrom);
1153 if (eightbit && (adata.capabilities & SMTP_CAP_EIGHTBITMIME))
1154 buf_addstr(buf, " BODY=8BITMIME");
1155
1156 if (c_dsn_return && (adata.capabilities & SMTP_CAP_DSN))
1157 buf_add_printf(buf, " RET=%s", c_dsn_return);
1158
1159 if ((adata.capabilities & SMTP_CAP_SMTPUTF8) &&
1162 {
1163 buf_addstr(buf, " SMTPUTF8");
1164 }
1165 buf_addstr(buf, "\r\n");
1166 if (mutt_socket_send(adata.conn, buf_string(buf)) == -1)
1167 {
1168 rc = SMTP_ERR_WRITE;
1169 break;
1170 }
1171 rc = smtp_get_resp(&adata);
1172 if (rc != 0)
1173 break;
1174
1175 /* send the recipient list */
1176 if ((rc = smtp_rcpt_to(&adata, to)) || (rc = smtp_rcpt_to(&adata, cc)) ||
1177 (rc = smtp_rcpt_to(&adata, bcc)))
1178 {
1179 break;
1180 }
1181
1182 /* send the message data */
1183 rc = smtp_data(&adata, msgfile);
1184 if (rc != 0)
1185 break;
1186
1187 mutt_socket_send(adata.conn, "QUIT\r\n");
1188
1189 rc = 0;
1190 } while (false);
1191
1192 mutt_socket_close(adata.conn);
1193 FREE(&adata.conn);
1194
1195 if (rc == SMTP_ERR_READ)
1196 mutt_error(_("SMTP session failed: read error"));
1197 else if (rc == SMTP_ERR_WRITE)
1198 mutt_error(_("SMTP session failed: write error"));
1199 else if (rc == SMTP_ERR_CODE)
1200 mutt_error(_("Invalid server response"));
1201
1202 buf_pool_release(&buf);
1203 return rc;
1204}
bool mutt_addrlist_uses_unicode(const struct AddressList *al)
Do any of a list of addresses use Unicode characters.
Definition: address.c:1522
bool mutt_addr_uses_unicode(const char *str)
Does this address use Unicode character.
Definition: address.c:1502
const struct Address * cs_subset_address(const struct ConfigSubset *sub, const char *name)
Get an Address config item by name.
Definition: config_type.c:272
int buf_printf(struct Buffer *buf, const char *fmt,...)
Format a string overwriting a Buffer.
Definition: buffer.c:161
int buf_add_printf(struct Buffer *buf, const char *fmt,...)
Format a string appending a Buffer.
Definition: buffer.c:204
size_t buf_addstr(struct Buffer *buf, const char *s)
Add a string to a Buffer.
Definition: buffer.c:226
static const char * buf_string(const struct Buffer *buf)
Convert a buffer to a const char * "string".
Definition: buffer.h:96
const char * cs_subset_string(const struct ConfigSubset *sub, const char *name)
Get a string config item by name.
Definition: helpers.c:291
char * ShortHostname
Short version of the hostname.
Definition: globals.c:39
#define mutt_error(...)
Definition: logging2.h:92
#define FREE(x)
Definition: memory.h:45
#define _(a)
Definition: message.h:28
struct Connection * mutt_conn_find(const struct ConnAccount *cac)
Find a connection from a list.
Definition: mutt_socket.c:90
struct Buffer * buf_pool_get(void)
Get a Buffer from the pool.
Definition: pool.c:81
void buf_pool_release(struct Buffer **ptr)
Return a Buffer to the pool.
Definition: pool.c:94
#define TAILQ_FIRST(head)
Definition: queue.h:723
#define TAILQ_EMPTY(head)
Definition: queue.h:721
const char * mutt_fqdn(bool may_hide_host, const struct ConfigSubset *sub)
Get the Fully-Qualified Domain Name.
Definition: sendlib.c:707
static int smtp_get_resp(struct SmtpAccountData *adata)
Read a command response from the SMTP server.
Definition: smtp.c:141
#define SMTP_ERR_READ
Definition: smtp.c:68
#define SMTP_ERR_CODE
Definition: smtp.c:70
#define SMTP_CAP_EIGHTBITMIME
Server supports 8-bit MIME content.
Definition: smtp.c:88
static int smtp_data(struct SmtpAccountData *adata, const char *msgfile)
Send data to an SMTP server.
Definition: smtp.c:241
#define SMTP_ERR_WRITE
Definition: smtp.c:69
static int smtp_fill_account(struct SmtpAccountData *adata, struct ConnAccount *cac)
Create ConnAccount object from SMTP Url.
Definition: smtp.c:359
#define SMTP_CAP_SMTPUTF8
Server accepts UTF-8 strings.
Definition: smtp.c:89
#define SMTP_CAP_DSN
Server supports Delivery Status Notification.
Definition: smtp.c:87
static int smtp_rcpt_to(struct SmtpAccountData *adata, const struct AddressList *al)
Set the recipient to an Address.
Definition: smtp.c:199
static int smtp_open(struct SmtpAccountData *adata, bool esmtp)
Open an SMTP Connection.
Definition: smtp.c:1018
int mutt_socket_close(struct Connection *conn)
Close a socket.
Definition: socket.c:100
#define mutt_socket_send(conn, buf)
Definition: socket.h:57
#define NONULL(x)
Definition: string2.h:37
An email address.
Definition: address.h:36
struct Buffer * mailbox
Mailbox and host address.
Definition: address.h:38
String manipulation buffer.
Definition: buffer.h:36
Login details for a remote server.
Definition: connaccount.h:53
Server connection data.
Definition: smtp.c:97
const char * fqdn
Fully-qualified domain name.
Definition: smtp.c:102
struct ConfigSubset * sub
Config scope.
Definition: smtp.c:101
struct Connection * conn
Server Connection.
Definition: smtp.c:100
const char * auth_mechs
Allowed authorisation mechanisms.
Definition: smtp.c:98
SmtpCapFlags capabilities
Server capabilities.
Definition: smtp.c:99
+ Here is the call graph for this function:
+ Here is the caller graph for this function: