YGMailLib 1.0.10
.NET 6.0
This package targets .NET 6.0. The package is compatible with this framework or higher.
.NET Standard 2.0
This package targets .NET Standard 2.0. The package is compatible with this framework or higher.
.NET Framework 4.8
This package targets .NET Framework 4.8. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details.
See the version list below for details.
dotnet add package YGMailLib --version 1.0.10
NuGet\Install-Package YGMailLib -Version 1.0.10
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="YGMailLib" Version="1.0.10" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add YGMailLib --version 1.0.10
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: YGMailLib, 1.0.10"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install YGMailLib as a Cake Addin #addin nuget:?package=YGMailLib&version=1.0.10 // Install YGMailLib as a Cake Tool #tool nuget:?package=YGMailLib&version=1.0.10
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
YGMailLib
YGMailLib is a library for sending email.
Features
- HTML Mail
- SMTP Authentication(CLAM MD5/PLAIN/LOGIN)
- S/MIME signature and encryption
- SSL/TLS Support
- DKIM Support
- ZIP File Support
Basic Usage
using YGZipLib;
public void MailSend()
{
// Instances should be Disposed.
using (YGMailLib.SmtpClient mail = new SmtpClient()) {
// SMTP Server
mail.SmtpServer = "smtp.example.com";
// From Address
mail.SetAddress(SmtpClient.ADDRESS_TYPE.FROM, "from@example.com");
// To Address
mail.SetAddress(SmtpClient.ADDRESS_TYPE.TO, "to@example.com");
// Subject
mail.Subject = "Test Mail";
// Body Text(Line feed code must be CR+LF)
mail.BodyText = "This is test mail.";
// Execution of mail transmission
mail.Send();
}
}
- HTML mail, Attached File
using YGZipLib;
public void MailSend(string subject,string body, string html)
{
// Instances should be Disposed.
using (YGMailLib.SmtpClient mail = new SmtpClient())
{
// SMTP Server
mail.SmtpServer = "smtp.example.com";
// From Address
mail.SetAddress(SmtpClient.ADDRESS_TYPE.FROM, "from@example.com");
// To Address
mail.SetAddress(SmtpClient.ADDRESS_TYPE.TO, "to@example.com");
// Subject
mail.Subject = "Test Mail";
// Body Text(Line feed code must be CR+LF)
mail.BodyText = "This is test mail.";
// HTML Text(Line feed code must be CR+LF)
mail.BodyHTML = "<html><body>This is test mail.</body></html>";
// Attached File
mail.SetAttachedFile("AttachedFile.zip", @"D:\AttachedFile.zip");
// Execution of mail transmission
mail.Send();
}
}
Advanced Usage
- TCP Settings
// SMTP Port
mail.SmtpPort = 587;
// IP address family to use
mail.IpAddressFamily = SmtpClient.IP_ADDRESS_FAMILY.IPV4_PREFER;
// Timeout when connecting to SMTP server (milliseconds)
mail.ConnectionTimeout = 30000;
// Timeout after sending SMTP command (milliseconds)
mail.SmtpTimeout = 30000;
- Encoding
Default,
Header
B Encode
BodyText
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: 8bit
HtmlText
Content-Type: text/html; charset="utf-8"
Content-Transfer-Encoding: base64
// Headers are B-encoded by default, but can be changed to Q-encoding.
mail.HeaderEncoding = SmtpClient.HEADER_ENCODING.Q_ENCODE;
// Example of changing Encoding
// Transfer-Encoding for 8-bit and 7-bit is automatically line-breaking if a line exceeds approximately 1000 Bytes. If you do not want automatic line feed, specify base64 or quoted-printable.
mail.TextEncoding = YGMailLib.Common.TextEncodings.ISO2022JP;
mail.TransferEncoding = SmtpClient.TRANSFER_ENCODING.ENCODING_BASE64;
mail.HtmlTransferEncoding = SmtpClient.HTML_TRANSFER_ENCODING.ENCODING_QUOTED_PRINTABLE;
// Non-.net Framework environments may require the encoding provider to be registered at the beginning of the program.
System.Text.Encoding.RegisterProvider(CodePagesEncodingProvider.Instance);
- SMTP Auth
mail.SmtpAuth.UseSmtpAuth = SmtpClient.USE_SMTP_AUTH.USE;
mail.SmtpAuth.User = "userid";
mail.SmtpAuth.Password = "password";
// The LOGIN and PLAIN methods are by default only available for TLS connections.
// To use them for non-TLS connections, set the following properties.
mail.SmtpAuth.PlainEnabled = SmtpClient.USE_SMTPAUTH_METHOD.USE;
mail.SmtpAuth.LoginEnabled = SmtpClient.USE_SMTPAUTH_METHOD.USE;
- S/MIME
The preparation of the certificate will not be explained. Please refer to other resources.
For more information on X509Certificate2, please refer to the documentation.
// Signing
mail.Smime.Signing = true;
// Set the certificate containing the private key to a FROM address.
mail.SetAddress(SmtpClient.ADDRESS_TYPE.FROM, "from@example.com", new System.Security.Cryptography.X509Certificates.X509Certificate2(@"D:\cert.pfx", "password"));
// Encryption
mail.Smime.Encryption = true;
// Set certificates to all destination addresses. No private key required.
mail.SetAddress(SmtpClient.ADDRESS_TYPE.TO, "to1@example.com", new System.Security.Cryptography.X509Certificates.X509Certificate2(@"D:\to1.pfx"));
mail.SetAddress(SmtpClient.ADDRESS_TYPE.TO, "to2@example.com", new System.Security.Cryptography.X509Certificates.X509Certificate2(@"D:\to2.pfx"));
// Additional settings
// Do not check certificates. If a self-signed certificate is used for verification, it is necessary to specify it.
mail.Smime.CertificateValidation = false;
// Certificate revocation check. Not checked by default.
mail.Smime.CertValidRevocationMode = X509RevocationMode.Online;
- DKIM
DNS configuration and RSAk key creation are not described. Please refer to other documentation.
mail.Dkim.UseDkim = true;
mail.Dkim.Domain = "example.com";
mail.Dkim.Selector = "selector0001";
// RSA private keys should not be password protected.
mail.Dkim.SetRsaParamFile(@"D:\selector0001.pem");
// Additional settings
// Auid
mail.Dkim.Auid = "@example.com";
// Headers to sign. Default: from:from:reply-to:subject:date:to:cc:content-type:content-transfer-encoding
// If the same header is specified twice, the actual number of signatures plus one is output to the signature header list of the DKIM-Signature header. Even if the header does not exist, it is output to the signature header list.
mail.Dkim.SigHeaderFields = "to:from:date";
- ZIP File
Attachments can be sent in a ZIP archive.
// Add Attachment
mail.SetAttachedFile("Test.xlsx", @"D:\Text.xlsx");
mail.SetAttachedFile("Test.pptx", @"D:\Text.pptx");
mail.SetAttachedFile("Test.txt", @"D:\Text.txt");
// Specify a ZIP archive file name.
mail.Zip.FileName = "attached.zip";
// To create an encrypted ZIP archive, specify a password.
mail.Zip.Password = "password";
// To encrypt with AES, change the Encryption Algorithm.
mail.Zip.EncryptionAlgorithm = SmtpClient.ZIP_ENCRYPTION_ALGORITHM.AES256;
// The encoding of the file name is obtained by "System.Text.Encoding.Default.CodePage".
// In environments other than .net Framework, Default is utf8, so specify Encoding as necessary.
mail.Zip.FileNameEncoding = System.Text.Encoding.GetEncoding("shift-jis");
// Maximum number of processes for creating ZIPs archives
// If 0, the smaller of the number of processors or 4
mail.Zip.SemaphoreCount = 4;
- Output eml file
// Output to a file
mail.WriteEml(@"D:\mail.eml");
// Output to Stream
mail.WriteEml(st);
// Output to Byte array
byte[] emlData = mail.WriteEml();
- Asynchronous Process
// Some statement
// Execution of mail transmission
await mail.SendAsync();
// Some statement
- Other Settings
// Client host name, used for Message-Id.
mail.MachineName = "client.example.com";
// Specifies the action to be taken when an error occurs in RCPT TO (specify destination address).
// If IGNORE is selected, when there are multiple destinations, even if an error occurs, the command is sent if there is an accepted address.
mail.IfRcptToCommandFails = SmtpClient.IF_RCPT_TO_FAILS.IGNORE;
// The Message-Id header is not added.
mail.MessageIdRequired = false;
// Specifies the size of mail with large attachments to be separated (byte)
mail.SeparatedSize = 1000000;
// Delivery Status Notification
mail.DSN = SmtpClient.DELIVERY_STATUS_NOTIFICATION.SUCCESS;
// Specify the X-Mail-Agent header; if null, the library name "YGMailLib" is used. h header is not added if empty.
mail.XMailAgent = null;
// Change Temporary Directory from System.IO.Path.GetTempPath()
// Temporary Directory is used for ZIP files and DKIM.
mail.TempDir = @"D:\temp";
- Debug
// Transaction log can be obtained for debugging.
System.Diagnostics.Debug.WriteLine(mail.SmtpTranLog);
Note
License
"YGMailLib" is under MIT license
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 is compatible. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 is compatible. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
.NETFramework 4.8
- System.Security.Cryptography.Pkcs (>= 6.0.2)
-
.NETStandard 2.0
- System.Security.Cryptography.Pkcs (>= 6.0.2)
-
.NETStandard 2.1
- System.Security.Cryptography.Pkcs (>= 6.0.2)
-
net6.0
- System.Security.Cryptography.Pkcs (>= 6.0.2)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.