(SQL Server) Explaining the Email FromName, FromAddress, and From Properties

This example explains the email object's FromName, FromAddress, and From properties.

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- The email's FROM name and address can be set in several ways.
    -- It can include an optional friendly name (which is just a description),
    -- and it must include an address.

    -- For example:
    DECLARE @email1 int
    -- Use "Chilkat_9_5_0.Email" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Email', @email1 OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    EXEC sp_OASetProperty @email1, 'Subject', 'test'
    EXEC sp_OASetProperty @email1, 'Body', 'test'

    EXEC sp_OASetProperty @email1, 'FromName', 'Joe Sample'
    EXEC sp_OASetProperty @email1, 'FromAddress', 'joe.sample@example.com'

    -- the From property contains both the FromName and FromAddress
    -- This produces the following output:
    -- From: "Joe Sample" <joe.sample@example.com>

    EXEC sp_OAGetProperty @email1, 'From', @sTmp0 OUT
    PRINT 'From: ' + @sTmp0

    PRINT '--------------------------------------------------'

    -- Examine the MIME of the email:
    EXEC sp_OAMethod @email1, 'GetMime', @sTmp0 OUT
    PRINT @sTmp0

    PRINT '--------------------------------------------------'

    -- Output is:

    -- 	MIME-Version: 1.0
    -- 	Date: Wed, 16 Nov 2016 12:32:13 -0600
    -- 	Message-ID: <02B461C6D12FA6686C3151A649ED8D5BBFBE0721@CHILKAT13>
    -- 	Content-Type: text/plain
    -- 	Content-Transfer-Encoding: 7bit
    -- 	X-Priority: 3 (Normal)
    -- 	Subject: test
    -- 	From: "Joe Sample" <joe.sample@example.com>
    -- 	CKX-Bounce-Address: joe.sample@example.com
    -- 
    -- 	test

    -- --------------------------------------------
    -- Alternatively, the From property can be set, and this 
    -- implicitly sets the FromName and FromAddress properties.

    DECLARE @email2 int
    -- Use "Chilkat_9_5_0.Email" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Email', @email2 OUT

    EXEC sp_OASetProperty @email2, 'From', 'Joe Sample <joe.sample@example.com>'


    EXEC sp_OAGetProperty @email2, 'FromName', @sTmp0 OUT
    PRINT 'FromName: ' + @sTmp0

    EXEC sp_OAGetProperty @email2, 'FromAddress', @sTmp0 OUT
    PRINT 'FromAddress: ' + @sTmp0

    PRINT '--------------------------------------------------'

    EXEC sp_OAMethod @email2, 'GetMime', @sTmp0 OUT
    PRINT @sTmp0

    EXEC @hr = sp_OADestroy @email1
    EXEC @hr = sp_OADestroy @email2


END
GO