SQL Server

Add a Custom Header Field to an Email

Demonstrates the Chilkat Email.AddHeaderField method, which adds a standard or custom header field. If the field already exists, this method replaces it (use AddHeaderField2 to allow duplicates). Header fields whose names begin with CKX- are not transmitted when the email is sent, but are preserved across XML save/load, making them handy for persistent metadata. This example adds a custom X- header and reads it back.

Background: Beyond the well-known headers (From, Subject, etc.), MIME lets you add arbitrary fields. By convention custom, non-standard fields are prefixed with X-, so mail systems know not to expect them in the standards. Applications use these to carry tracking IDs, campaign tags, or routing hints. Chilkat's CKX- convention goes a step further — those fields live with the object but are stripped before the message is actually sent.

Chilkat SQL Server Downloads

Download Chilkat for SQL Server

SQL Server

--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @sTmp0 nvarchar(4000)
    --  Demonstrates the AddHeaderField method, which adds a standard or custom header field.
    --  If the header field already exists, this method REPLACES it.  (To allow duplicates,
    --  use AddHeaderField2 instead.)  Header fields whose names begin with "CKX-" are not
    --  transmitted when the email is sent, but are preserved when saved to/loaded from XML.

    DECLARE @email int
    EXEC @hr = sp_OACreate 'Chilkat.Email', @email OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    EXEC sp_OASetProperty @email, 'Subject', 'Custom header example'
    EXEC sp_OASetProperty @email, 'From', 'alice@example.com'

    --  Add a custom header field.
    EXEC sp_OAMethod @email, 'AddHeaderField', NULL, 'X-Custom-Header', 'custom value'


    EXEC sp_OAMethod @email, 'GetHeaderField', @sTmp0 OUT, 'X-Custom-Header'
    PRINT 'X-Custom-Header = ' + @sTmp0

    EXEC @hr = sp_OADestroy @email


END
GO