View source code
Display the source code in std/net/curl.d from which this page was generated on github.
Report a bug
If you spot a problem with this page, click here to create a Bugzilla issue.
Improve this page
Quickly fork, edit online, and submit a pull request for this page. Requires a signed-in GitHub account. This works well for small changes. If you'd like to make larger changes you may want to consider using local clone.

Struct std.net.curl.SMTP

Basic SMTP protocol support.

struct SMTP ;

Properties

NameTypeDescription
connectTimeout[set] DurationSet timeout for connecting.
connectTimeout[set] DurationSet timeout for connecting.
dataTimeout[set] DurationSet timeout for activity on connection.
dataTimeout[set] DurationSet timeout for activity on connection.
dnsTimeout[set] DurationDNS lookup timeout.
dnsTimeout[set] DurationDNS lookup timeout.
isStopped[get] boolTrue if the instance is stopped. A stopped instance is not usable.
isStopped[get] boolTrue if the instance is stopped. A stopped instance is not usable.
localPort[set] ushortSet the local outgoing port to use.
localPort[set] ushortSet the local outgoing port to use.
localPortRange[set] ushortSet the local outgoing port range to use. This can be used together with the localPort property.
localPortRange[set] ushortSet the local outgoing port range to use. This can be used together with the localPort property.
mailFrom[set] const(char)[]Setter for the sender's email address.
message[set] stringSets the message body text.
netInterface[set] const(char)[]The network interface to use in form of the the IP of the interface.
netInterface[set] const(char)[]The network interface to use in form of the the IP of the interface.
onProgress[set] int delegate(ulong, ulong, ulong, ulong)The event handler that gets called to inform of upload/download progress.
onProgress[set] int delegate(ulong, ulong, ulong, ulong)The event handler that gets called to inform of upload/download progress.
onReceive[set] ulong delegate(ubyte[])The event handler that receives incoming data. Be sure to copy the incoming ubyte[] since it is not guaranteed to be valid after the callback returns.
onReceive[set] ulong delegate(ubyte[])The event handler that receives incoming data. Be sure to copy the incoming ubyte[] since it is not guaranteed to be valid after the callback returns.
onSend[set] ulong delegate(void[])The event handler that gets called when data is needed for sending. The length of the void[] specifies the maximum number of bytes that can be sent.
onSend[set] ulong delegate(void[])The event handler that gets called when data is needed for sending. The length of the void[] specifies the maximum number of bytes that can be sent.
operationTimeout[set] DurationSet maximum time an operation is allowed to take. This includes dns resolution, connecting, data transfer, etc.
operationTimeout[set] DurationSet maximum time an operation is allowed to take. This includes dns resolution, connecting, data transfer, etc.
proxy[set] const(char)[]Proxy
proxy[set] const(char)[]Proxy
proxyPort[set] ushortProxy port
proxyPort[set] ushortProxy port
proxyType[set] CurlProxyProxy type
proxyType[set] CurlProxyProxy type
tcpNoDelay[set] boolSet the tcp no-delay socket option on or off.
tcpNoDelay[set] boolSet the tcp no-delay socket option on or off.
url[set] const(char)[]The URL to specify the location of the resource.
verbose[set] boolSet verbose. This will print request information to stderr.
verbose[set] boolSet verbose. This will print request information to stderr.

Methods

NameDescription
mailTo Setter for the recipient email addresses.
opCall Sets to the URL of the SMTP server.
opCall
perform Performs the request as configured.
setAuthentication Set the user name, password and optionally domain for authentication purposes.
setAuthentication Set the user name, password and optionally domain for authentication purposes.
setProxyAuthentication Set the user name and password for proxy authentication.
setProxyAuthentication Set the user name and password for proxy authentication.
shutdown Stop and invalidate this instance.
shutdown Stop and invalidate this instance.

Aliases

NameDescription
CurlProxy Type of proxy
CurlProxy Type of proxy
requestAbort Value to return from onSend delegate in order to abort a request
requestAbort Value to return from onSend delegate in order to abort a request
requestPause Value to return from onSend/onReceive delegates in order to pause a request
requestPause Value to return from onSend/onReceive delegates in order to pause a request

Example

import std.net.curl;

// Send an email with SMTPS
auto smtp = SMTP("smtps://smtp.gmail.com");
smtp.setAuthentication("from.addr@gmail.com", "password");
smtp.mailTo = ["<to.addr@gmail.com>"];
smtp.mailFrom = "<from.addr@gmail.com>";
smtp.message = "Example Message";
smtp.perform();

See Also

RFC2821

Authors

Jonas Drewsen. Some of the SMTP code contributed by Jimmy Cao.

License

Boost License 1.0.