PureBasic
PureBasic
Create MDN (Message Disposition Notification) Email
Demonstrates how to create a MDN (Message Disposition Notification) Email having the format as defined in RFC 3798.Chilkat PureBasic Downloads
IncludeFile "CkEmail.pb"
IncludeFile "CkXml.pb"
Procedure ChilkatExample()
success.i = 0
email.i = CkEmail::ckCreate()
If email.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
; An MDN can be used to notify the
; sender of a message of any of several conditions that may occur after
; successful delivery, such as display of the message contents,
; printing of the message, deletion (without display) of the message,
; or the recipient's refusal to provide MDNs.
; (for more information, see RFC 3798)
; IMPORTANT:
; Note: Please be careful in sending automated MDN's.
; It is important to be aware of an issue called "backscatter".
; See the Wikipedia article here: http://en.wikipedia.org/wiki/Backscatter_%28e-mail%29
; The ToMdn method is called to create a new
; MDN email based upon the email object calling ToMdn.
; The email object instance used to call ToMdn would
; typically be an email received from a POP3 or IMAP server.
; In this case, to simplify the example, we'll load the email
; from a .eml file.
; This example will be creating a MDN for "someEmail.eml"
success = CkEmail::ckLoadEml(email,"someEmail.eml")
If success = 0
Debug CkEmail::ckLastErrorText(email)
CkEmail::ckDispose(email)
ProcedureReturn
EndIf
; The MDN created by ToMdn will contain a
; "message/disposition-notification" MIME sub-part that will
; be composed of a number of name-value pairs.
; See RFC 3798 ( http://tools.ietf.org/html/rfc3798 )
; The name-value content for this part is passed
; as XML to ToMdn. This part of the example
; prepares the XML:
xml.i = CkXml::ckCreate()
If xml.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
; For this example, we're just adding a few name-value pairs.
; These should not be considered to be correct, required or
; even sensible -- they are simply for the example.
CkXml::setCkTag(xml, "DispositionFields")
CkXml::ckNewChild2(xml,"Disposition","manual-action/MDN-sent-manually; displayed")
CkXml::ckNewChild2(xml,"Original-Message-ID",CkEmail::ckGetHeaderField(email,"Message-ID"))
CkXml::ckNewChild2(xml,"Final-Recipient",CkEmail::ckGetToAddr(email,0))
xmlStr.s = CkXml::ckGetXml(xml)
; The last argument to be passed to ToMdn will be a boolean
; indicating whether to include the entire MIME of the calling
; email object in the MDN, or only the header.
; It may make sense to include the entire email for small emails,
; but for large emails (with large attachments) it's probably
; best to make the MDN header-only.
bHeaderOnly.i = 1
; The first argument to be passed to ToMdn will
; be a human-readable explanation that will be placed
; into the 1st MIME part of the MDN (see RFC 3798).
humanReadableExplanation.s = "Blah blah blah. Your message has been received and displayed. Blah blah blah"
; OK, we're ready to create MDN...
mdnEmail.i = CkEmail::ckCreate()
If mdnEmail.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkEmail::ckToMdn(email,humanReadableExplanation,xmlStr,bHeaderOnly,mdnEmail)
If success = 0
Debug CkEmail::ckLastErrorText(email)
CkEmail::ckDispose(email)
CkXml::ckDispose(xml)
CkEmail::ckDispose(mdnEmail)
ProcedureReturn
EndIf
; Show the MIME of the source (original) email:
Debug CkEmail::ckGetMime(email)
Debug "**************************************"
; Show the MIME of the MDN email:
Debug CkEmail::ckGetMime(mdnEmail)
; Sample output showing the MIME of the original email,
; and the MDN email created based upon it:
; X-Account-Key: account2
; X-UIDL: 0D154945439D42BD80F180F6D9DE4D82
; Received: with MailEnable Postoffice Connector;
; Tue, 21 Jun 2011 09:21:23 -0400
; Received: from qmta14.emeryville.ca.mail.comcast.net ([76.96.227.212]) by chilkatsoft.com with MailEnable ESMTP;
; Tue, 21 Jun 2011 09:21:22 -0400
; Received: from omta03.emeryville.ca.mail.comcast.net ([76.196.30.27]) by qmta14.emeryville.ca.mail.comcast.net with comcast id yd4k1g0050b6N64AEdLW9x;
; Tue, 21 Jun 2011 13:20:30 +0000
; Received: from [127.0.0.1] ([67.175.202.103]) by omta03.emeryville.ca.mail.comcast.net with comcast id ydLV1g00n2EMkZ78PdLWxi;
; Tue, 21 Jun 2011 13:20:31 +0000
; Message-ID: <4E009AA4.3090205@chilkatsoft.com>
; Date: Tue, 21 Jun 2011 08:20:36 -0500
; From: Chilkat Software <admin@chilkatsoft.com>
; User-Agent: Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.9.2.17) Gecko/20110414 Thunderbird/3.1.10
; MIME-Version: 1.0
; To: Chilkat Support <support@chilkatsoft.com>
; Subject: test 123
; Content-Type: text/plain; charset=ISO-8859-1; format=flowed
; Content-Transfer-Encoding: 7bit
; Return-Path: <>
; X-Antivirus: avast! (VPS 110621-0, 06/21/2011), Inbound message
; X-Antivirus-Status: Clean
;
; This is a test 123
;
;
;
; **************************************
; Content-Type: multipart/report;
; report-type=disposition-notification;
; boundary="------------000802010206080606030808"
;
; --------------000802010206080606030808
; Content-Type: text/plain
; Content-Transfer-Encoding: 7bit
;
; Blah blah blah. Your message has been received and displayed. Blah blah blah
; --------------000802010206080606030808
; Content-Type: message/disposition-notification
;
; Disposition: manual-action/MDN-sent-manually; displayed
; Original-Message-ID: <4E009AA4.3090205@chilkatsoft.com>
; Final-Recipient: support@chilkatsoft.com
;
; --------------000802010206080606030808
; Content-Type: text/rfc822-headers
;
; X-Account-Key: account2
; X-UIDL: 0D154945439D42BD80F180F6D9DE4D82
; Received: with MailEnable Postoffice Connector;
; Tue, 21 Jun 2011 09:21:23 -0400
; Received: from qmta14.emeryville.ca.mail.comcast.net ([76.96.227.212]) by chilkatsoft.com with MailEnable ESMTP;
; Tue, 21 Jun 2011 09:21:22 -0400
; Received: from omta03.emeryville.ca.mail.comcast.net ([76.196.30.27]) by qmta14.emeryville.ca.mail.comcast.net with comcast id yd4k1g0050b6N64AEdLW9x;
; Tue, 21 Jun 2011 13:20:30 +0000
; Received: from [127.0.0.1] ([67.175.202.103]) by omta03.emeryville.ca.mail.comcast.net with comcast id ydLV1g00n2EMkZ78PdLWxi;
; Tue, 21 Jun 2011 13:20:31 +0000
; Message-ID: <4E009AA4.3090205@chilkatsoft.com>
; Date: Tue, 21 Jun 2011 08:20:36 -0500
; From: Chilkat Software <admin@chilkatsoft.com>
; User-Agent: Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.9.2.17) Gecko/20110414 Thunderbird/3.1.10
; MIME-Version: 1.0
; To: Chilkat Support <support@chilkatsoft.com>
; Subject: test 123
; Content-Type: text/plain; charset=ISO-8859-1; format=flowed
; Content-Transfer-Encoding: 7bit
; Return-Path: <>
; X-Antivirus: avast! (VPS 110621-0, 06/21/2011), Inbound message
; X-Antivirus-Status: Clean
; --------------000802010206080606030808--
;
;
CkEmail::ckDispose(email)
CkXml::ckDispose(xml)
CkEmail::ckDispose(mdnEmail)
ProcedureReturn
EndProcedure