iPdfWriter.Mail
1.0.1
dotnet add package iPdfWriter.Mail --version 1.0.1
NuGet\Install-Package iPdfWriter.Mail -Version 1.0.1
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="iPdfWriter.Mail" Version="1.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add iPdfWriter.Mail --version 1.0.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: iPdfWriter.Mail, 1.0.1"
#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 iPdfWriter.Mail as a Cake Addin #addin nuget:?package=iPdfWriter.Mail&version=1.0.1 // Install iPdfWriter.Mail as a Cake Tool #tool nuget:?package=iPdfWriter.Mail&version=1.0.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
What is iPdfWriter.Mail?
iPdfWriter.Mail, extends iPdfWriter, contains extension methods to send by mail PdfInput instances as well as OutputResult.
I hope it helps someone. 😏
Usage
Samples
Sample 1 - Shows the use of synchronous mail by SendMail action
var doc = new PdfInput
{
AutoUpdateChanges = true,
Input = "~/Resources/Sample-01/file-sample.pdf"
};
// report title
doc.Replace(new ReplaceText(
new WithTextObject
{
Text = "#TITLE#",
NewText = "Lorem ipsum",
Offset = PointF.Empty,
Style = StylesHelper.Sample01.TextStylesTable["ReportTitle"],
ReplaceOptions = ReplaceTextOptions.AccordingToMargins
}))
// bar-chart image
.Replace(new ReplaceText(
new WithImageObject
{
Text = "#BAR-CHART#",
Offset = PointF.Empty,
Style = StylesHelper.Sample01.ImagesStylesTable["Default"],
ReplaceOptions = ReplaceTextOptions.Default,
Image = PdfImage.FromFile("~Resources/Sample-01/Images/bar-chart.png")
}))
// image
.Replace(new ReplaceText(
new WithImageObject
{
Text = "#IMAGE1#",
Offset = PointF.Empty,
Style = StylesHelper.Sample01.ImagesStylesTable["Center"],
ReplaceOptions = ReplaceTextOptions.AccordingToMargins,
Image = PdfImage.FromFile("~/Resources/Sample-01/Images/image-1.jpg")
}));
var pdfCreationResult = doc.CreateResult();
if (!pdfCreationResult.Success)
{
return;
}
var sendResult = pdfCreationResult.Result.Action(new SendMail
{
FromAddress = " >> WRITE HERE EMAIL ADDRESS OF THE SENDER << ",
FromDisplayName = " >> WRITE HERE THE NAME TO DISPLAY << ",
AttachedFilename = "Sample-01", // OutputResult file name
Settings = new SmtpMailSettings
{
Credential = new SmtpCredential
{
Port = 465,
UseSsl = true,
Host = SmtpMail.GmailSmtpHost, // YOU CAN ALSO USE: SmtpMail.MailtrapSmtpHost OR SmtpMail.EtherealSmtpHost, for more information, please see Sample02 and Sample03
Email = " >> WRITE HERE YOUR EMAIL << ",
UserName = " >> WRITE HERE YOUR USERNAME << ",
Password = " >> WRITE HERE YOUR PASSWORD << "
},
Templates = new TemplateSettings
{
IsBodyHtml = true,
BodyTemplate = "Hey!!!",
SubjectTemplate = "test pdf file"
},
Recipients = new RecipientsSettings
{
ToAddresses = new[] { " >> WRITE HERE EMAIL ADDRESS OF THE RECIPIENT << " }
},
Attachments = new[]
{
"~/Resources/Sample-01/Images/bar-chart.png",
"~/Resources/Sample-01/Images/image-1.jpg"
}
}
});
if (!sendResult.Success)
{
// Handle error(s)
}
Sample 2 - Shows the use of asynchronous mail by SendMailAsync action
var doc = new PdfInput
{
AutoUpdateChanges = true,
Input = "~/Resources/Sample-01/file-sample.pdf"
};
// report title
doc.Replace(new ReplaceText(
new WithTextObject
{
Text = "#TITLE#",
NewText = "Lorem ipsum",
Offset = PointF.Empty,
Style = StylesHelper.Sample01.TextStylesTable["ReportTitle"],
ReplaceOptions = ReplaceTextOptions.AccordingToMargins
}))
// bar-chart image
.Replace(new ReplaceText(
new WithImageObject
{
Text = "#BAR-CHART#",
Offset = PointF.Empty,
Style = StylesHelper.Sample01.ImagesStylesTable["Default"],
ReplaceOptions = ReplaceTextOptions.Default,
Image = PdfImage.FromFile("~Resources/Sample-01/Images/bar-chart.png")
}))
// image
.Replace(new ReplaceText(
new WithImageObject
{
Text = "#IMAGE1#",
Offset = PointF.Empty,
Style = StylesHelper.Sample01.ImagesStylesTable["Center"],
ReplaceOptions = ReplaceTextOptions.AccordingToMargins,
Image = PdfImage.FromFile("~/Resources/Sample-01/Images/image-1.jpg")
}));
var pdfCreationResult = await doc.CreateResultAsync();
if (!pdfCreationResult.Success)
{
return;
}
var sendResult = await pdfCreationResult.Result.Action(new SendMailAsync
{
FromAddress = " >> WRITE HERE EMAIL ADDRESS OF THE SENDER << ",
FromDisplayName = " >> WRITE HERE THE NAME TO DISPLAY << ",
AttachedFilename = "Sample-01", // OutputResult file name
Settings = new SmtpMailSettings
{
Credential = new SmtpCredential
{
Port = 465,
UseSsl = true,
Host = SmtpMail.GmailSmtpHost, // YOU CAN ALSO USE: SmtpMail.MailtrapSmtpHost OR SmtpMail.EtherealSmtpHost, for more information, please see Sample02 and Sample03
Email = " >> WRITE HERE YOUR EMAIL << ",
UserName = " >> WRITE HERE YOUR USERNAME << ",
Password = " >> WRITE HERE YOUR PASSWORD << "
},
Templates = new TemplateSettings
{
IsBodyHtml = true,
BodyTemplate = "Hey!!!",
SubjectTemplate = "test pdf file"
},
Recipients = new RecipientsSettings
{
ToAddresses = new[] { " >> WRITE HERE EMAIL ADDRESS OF THE RECIPIENT << " }
},
Attachments = new[]
{
"~/Resources/Sample-01/Images/bar-chart.png",
"~/Resources/Sample-01/Images/image-1.jpg"
}
}
});
if (!sendResult.Success)
{
// Handle error(s)
}
Documentation
- Please see next link documentation.
Changes
For more information, please visit the next link CHANGELOG
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. 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 was computed. 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.
-
.NETStandard 2.0
- iPdfWriter.Abstractions (>= 1.0.1)
- MailKit (>= 3.4.3)
-
.NETStandard 2.1
- iPdfWriter.Abstractions (>= 1.0.1)
- MailKit (>= 3.4.3)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
1.0.1 | 185 | 12/15/2022 |