@evokegroup/mailgun

@evokegroup/mailgun

Class: Mailgun

constructor({ args })

Parameter	Type	Default	Description
apiKey	string		The Mailgun API key
domain	string		The sending domain
version	string	v3	The API version

Properties

Name	Type	Default	Description
apiKey	string		The Mailgun API key
domain	string		The sending domain
version	string	v3	The API version

Methods

sendAPI({ args }) => Promise

Sends mail via the Mailgun API method. See the Mailgun API documentation

Parameter	Type	Default	Description
from	Mailgun.MailAddress, string
to	Array<Mailgun.MailAddress>, Mailgun.MailAddress, string
cc	Array<Mailgun.MailAddress>, Mailgun.MailAddress, string
bcc	Array<Mailgun.MailAddress>, Mailgun.MailAddress, string
subject	string
html	string
text	string
mailgunArgs	object		Additional API parameters.

sendMIME({ args }) => Promise

Sends mail via the Mailgun API MIME method.

Parameter	Type	Default	Description
from	Mailgun.MailAddress, string
to	Array<Mailgun.MailAddress>, Mailgun.MailAddress, string
cc	Array<Mailgun.MailAddress>, Mailgun.MailAddress, string
bcc	Array<Mailgun.MailAddress>, Mailgun.MailAddress, string
replyTo	Mailgun.MailAddress, string
sender	Mailgun.MailAddress, string
subject	string
html	Mailgun.Alternative, object, string
text	Mailgun.Alternative, object, string
charset	string	Mailgun.Charset.UTF8
contentTransferEncoding	string	Mailgun.ContentTransferEncoding.base64
forceMultipartAlternative	boolean	false

Static Methods

getIncomingMessageBasicData(message) => object

Get basic data like to, from, subject, and body from a received message

Parameter	Type	Default	Description
message	string		The received message

parseIncomingMessage(message) => object

Parse a received message

Parameter	Type	Default	Description
message	string		The received message

Static Properties

Charset

Supported character sets. See @evokegroup/mime

ContentTransferEncoding

Supported content transfer encodings. See @evokegroup/mime

Class: Mailgun.MailAddress extends MIME.MailAddress (@evokegroup/mime)

Class: Mailgun.Alternative extends MIME.Alternative (@evokegroup/mime)