NeoMutt  2024-03-23-23-gec7045
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 935 of file smtp.c.

936{
937 for (size_t i = 0; i < mutt_array_size(SmtpAuthenticators); i++)
938 {
939 const struct SmtpAuth *auth = &SmtpAuthenticators[i];
940 if (auth->method && mutt_istr_equal(auth->method, authenticator))
941 return true;
942 }
943
944 return false;
945}
#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:721
static const struct SmtpAuth SmtpAuthenticators[]
Accepted authentication methods.
Definition: smtp.c:912
SMTP authentication multiplexor.
Definition: smtp.c:111
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 1108 of file smtp.c.

1111{
1112 struct SmtpAccountData adata = { 0 };
1113 struct ConnAccount cac = { { 0 } };
1114 const char *envfrom = NULL;
1115 char buf[1024] = { 0 };
1116 int rc = -1;
1117
1118 adata.sub = sub;
1119 adata.fqdn = mutt_fqdn(false, adata.sub);
1120 if (!adata.fqdn)
1121 adata.fqdn = NONULL(ShortHostname);
1122
1123 const struct Address *c_envelope_from_address = cs_subset_address(adata.sub, "envelope_from_address");
1124
1125 /* it might be better to synthesize an envelope from from user and host
1126 * but this condition is most likely arrived at accidentally */
1127 if (c_envelope_from_address)
1128 {
1129 envfrom = buf_string(c_envelope_from_address->mailbox);
1130 }
1131 else if (from && !TAILQ_EMPTY(from))
1132 {
1133 envfrom = buf_string(TAILQ_FIRST(from)->mailbox);
1134 }
1135 else
1136 {
1137 mutt_error(_("No from address given"));
1138 return -1;
1139 }
1140
1141 if (smtp_fill_account(&adata, &cac) < 0)
1142 return rc;
1143
1144 adata.conn = mutt_conn_find(&cac);
1145 if (!adata.conn)
1146 return -1;
1147
1148 const char *const c_dsn_return = cs_subset_string(adata.sub, "dsn_return");
1149
1150 do
1151 {
1152 /* send our greeting */
1153 rc = smtp_open(&adata, eightbit);
1154 if (rc != 0)
1155 break;
1156 FREE(&adata.auth_mechs);
1157
1158 /* send the sender's address */
1159 int len = snprintf(buf, sizeof(buf), "MAIL FROM:<%s>", envfrom);
1160 if (eightbit && (adata.capabilities & SMTP_CAP_EIGHTBITMIME))
1161 {
1162 mutt_strn_cat(buf, sizeof(buf), " BODY=8BITMIME", 15);
1163 len += 14;
1164 }
1165 if (c_dsn_return && (adata.capabilities & SMTP_CAP_DSN))
1166 len += snprintf(buf + len, sizeof(buf) - len, " RET=%s", c_dsn_return);
1167 if ((adata.capabilities & SMTP_CAP_SMTPUTF8) &&
1170 {
1171 snprintf(buf + len, sizeof(buf) - len, " SMTPUTF8");
1172 }
1173 mutt_strn_cat(buf, sizeof(buf), "\r\n", 3);
1174 if (mutt_socket_send(adata.conn, buf) == -1)
1175 {
1176 rc = SMTP_ERR_WRITE;
1177 break;
1178 }
1179 rc = smtp_get_resp(&adata);
1180 if (rc != 0)
1181 break;
1182
1183 /* send the recipient list */
1184 if ((rc = smtp_rcpt_to(&adata, to)) || (rc = smtp_rcpt_to(&adata, cc)) ||
1185 (rc = smtp_rcpt_to(&adata, bcc)))
1186 {
1187 break;
1188 }
1189
1190 /* send the message data */
1191 rc = smtp_data(&adata, msgfile);
1192 if (rc != 0)
1193 break;
1194
1195 mutt_socket_send(adata.conn, "QUIT\r\n");
1196
1197 rc = 0;
1198 } while (false);
1199
1200 mutt_socket_close(adata.conn);
1201 FREE(&adata.conn);
1202
1203 if (rc == SMTP_ERR_READ)
1204 mutt_error(_("SMTP session failed: read error"));
1205 else if (rc == SMTP_ERR_WRITE)
1206 mutt_error(_("SMTP session failed: write error"));
1207 else if (rc == SMTP_ERR_CODE)
1208 mutt_error(_("Invalid server response"));
1209
1210 return rc;
1211}
bool mutt_addrlist_uses_unicode(const struct AddressList *al)
Do any of a list of addresses use Unicode characters.
Definition: address.c:1526
bool mutt_addr_uses_unicode(const char *str)
Does this address use Unicode character.
Definition: address.c:1506
const struct Address * cs_subset_address(const struct ConfigSubset *sub, const char *name)
Get an Address config item by name.
Definition: config_type.c:273
static const char * buf_string(const struct Buffer *buf)
Convert a buffer to a const char * "string".
Definition: buffer.h:97
const char * cs_subset_string(const struct ConfigSubset *sub, const char *name)
Get a string config item by name.
Definition: helpers.c:292
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
char * mutt_strn_cat(char *d, size_t l, const char *s, size_t sl)
Concatenate two strings.
Definition: string.c:297
struct Connection * mutt_conn_find(const struct ConnAccount *cac)
Find a connection from a list.
Definition: mutt_socket.c:90
#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:706
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:70
#define SMTP_ERR_CODE
Definition: smtp.c:72
#define SMTP_CAP_EIGHTBITMIME
Server supports 8-bit MIME content.
Definition: smtp.c:90
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:71
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:91
#define SMTP_CAP_DSN
Server supports Delivery Status Notification.
Definition: smtp.c:89
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:1026
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
Login details for a remote server.
Definition: connaccount.h:53
Server connection data.
Definition: smtp.c:99
const char * fqdn
Fully-qualified domain name.
Definition: smtp.c:104
struct ConfigSubset * sub
Config scope.
Definition: smtp.c:103
struct Connection * conn
Server Connection.
Definition: smtp.c:102
const char * auth_mechs
Allowed authorisation mechanisms.
Definition: smtp.c:100
SmtpCapFlags capabilities
Server capabilities.
Definition: smtp.c:101
+ Here is the call graph for this function:
+ Here is the caller graph for this function: