html_email/html_email_udt.tps at main · lee-lindley/html_email · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
BEGIN -- cause need compile directives
EXECUTE IMMEDIATE 'CREATE OR REPLACE TYPE html_email_udt'
$if $$use_invoker_rights $then
||' AUTHID CURRENT_USER'
$end
||q'[ AS OBJECT (
    /*
        An object for creating and sending an email message with an HTML
        body and optional attachments.
        A utility static function can return an HTML table from a query string
        or cursor for general use in addition to adding it to an email body.
    */
-- See note in deployment file if you get ORA-24247 upon execution.
/*
MIT License

Copyright (c) 2021 Lee Lindley

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

*/
--
--
--    Note that you do not put in the <header></header><body></body> tags as the
--    send procedure will do that.
--    The Subject will become the HTML title in the header.
--
--    Here is an example that puts the results of a query both into the body of
--    the email as an HTML table as well as attaching it as an XLSX file.
--
--    DECLARE
--        v_email         html_email_udt;
--        v_src           SYS_REFCURSOR;
--        v_query         VARCHAR2(32767) := q'!SELECT --+ no_parallel
--                v.view_name AS "View Name"
--                ,c.comments AS "Comments"
--            FROM dictionary d
--            INNER JOIN all_views v
--                ON v.view_name = d.table_name
--            LEFT OUTER JOIN all_tab_comments c
--                ON c.table_name = v.view_name
--            WHERE d.table_name LIKE 'ALL%'
--            ORDER BY v.view_name
--            FETCH FIRST 40 ROWS ONLY!';
--        --
--        -- Because you cannot CLOSE/ReOPEN a dynamic sys_refcursor variable directly,
--        -- you must regenerate it and assign it. Weird restriction, but do not
--        -- try to fight it by opening it in the main code twice. Get a fresh copy from a function.
--        FUNCTION l_getcurs RETURN SYS_REFCURSOR IS
--            l_src       SYS_REFCURSOR;
--        BEGIN
--            OPEN l_src FOR v_query;
--            RETURN l_src;
--        END;
--    BEGIN
--        v_email := html_email_udt(
--            p_to_list   => 'myname@google.com, yourname@yahoo.com'
--            ,p_from_email_addr  => 'myname@mycompany.com'
--            ,p_reply_to         => 'donotreply@nohost'
--            ,p_smtp_server      => 'smtp.mycompany.com'
--            ,p_subject          => 'A sample email from html_email_udt'
--        );
--        v_email.add_paragraph('We constructed and sent this email with html_email_udt.');
--        v_src := l_getcurs;
--        --v_email.add_to_body(html_email_udt.cursor_to_table(p_refcursor => v_src, p_caption => 'DBA Views'));
--        v_email.add_table_to_body(p_refcursor => v_src, p_caption => 'DBA Views');
--        -- we need to close it because we are going to open again.
--        -- The called package may have closed it, but must be sure or nasty
--        -- bugs/caching can happen.
--        BEGIN
--            CLOSE v_src;
--        EXCEPTION WHEN invalid_cursor THEN NULL;
--        END;
--
--        -- https://github.com/mbleron/ExcelGen
--        DECLARE
--            l_xlsx_blob     BLOB;
--            l_ctxId         ExcelGen.ctxHandle;
--            l_sheet_handle  BINARY_INTEGER;
--        BEGIN
--            v_src := l_getcurs;
--            l_ctxId := ExcelGen.createContext();
--            l_sheet_handle := ExcelGen.addSheetFromCursor(l_ctxId, 'DBA Views', v_src, p_tabColor => 'green');
--            BEGIN
--                CLOSE v_src;
--            EXCEPTION WHEN invalid_cursor THEN NULL;
--            END;
--            ExcelGen.setHeader(l_ctxId, l_sheet_handle, p_frozen => TRUE);
--
--            v_email.add_attachment(p_file_name => 'dba_views.xlsx', p_blob_content => ExcelGen.getFileContent(l_ctxId));
--
--            excelGen.closeContext(l_ctxId);
--        END;
--
--        v_email.add_paragraph('The attached spreadsheet should match what is in the html table above');
--        v_email.send;
--    END;
--
-- You have no need to muck with these object attributes directly. Use the methods.
    attachments         arr_email_attachment_udt
    ,arr_to             &&d_arr_varchar2_udt.
    ,arr_cc             &&d_arr_varchar2_udt.
    ,arr_bcc            &&d_arr_varchar2_udt.
    ,from_email_addr    VARCHAR2(4000)
    ,reply_to           VARCHAR2(4000)
    ,smtp_server        VARCHAR2(4000)
    ,subject            VARCHAR2(4000)
    ,body               CLOB]'
$if $$use_app_log $then
||q'[
    ,log                app_log_udt]'
$end
||q'[
    ,CONSTRUCTOR FUNCTION html_email_udt(
        p_to_list           VARCHAR2 DEFAULT NULL
        ,p_cc_list          VARCHAR2 DEFAULT NULL
        ,p_bcc_list         VARCHAR2 DEFAULT NULL
        ,p_from_email_addr  VARCHAR2 DEFAULT '&&from_email_addr'
        ,p_reply_to         VARCHAR2 DEFAULT '&&reply_to'
        ,p_smtp_server      VARCHAR2 DEFAULT '&&smtp_server'
        ,p_subject          VARCHAR2 DEFAULT NULL
        ,p_body             CLOB DEFAULT NULL]'
$if $$use_app_log $then
        ||q'[
        ,p_log              app_log_udt DEFAULT NULL]'
$end
||q'[
    )
        RETURN SELF AS RESULT
    ,FINAL MEMBER PROCEDURE html_email_constructor(
        SELF IN OUT NOCOPY html_email_udt
        ,p_to_list          VARCHAR2 DEFAULT NULL
        ,p_cc_list          VARCHAR2 DEFAULT NULL
        ,p_bcc_list         VARCHAR2 DEFAULT NULL
        ,p_from_email_addr  VARCHAR2 DEFAULT '&&from_email_addr'
        ,p_reply_to         VARCHAR2 DEFAULT '&&reply_to'
        ,p_smtp_server      VARCHAR2 DEFAULT '&&smtp_server'
        ,p_subject          VARCHAR2 DEFAULT NULL
        ,p_body             CLOB DEFAULT NULL]'
$if $$use_app_log $then
        ||q'[
        ,p_log              app_log_udt DEFAULT NULL]'
$end
||q'[
    )
    --
    -- best explanation of method chaining rules I found is
    -- https://stevenfeuersteinonplsql.blogspot.com/2019/09/object-type-methods-part-3.html
    --
    ,--FINAL
MEMBER PROCEDURE send(SELF IN html_email_udt) -- cannot be in/out if we allow chaining it.
    ,MEMBER PROCEDURE add_paragraph(SELF IN OUT NOCOPY html_email_udt , p_clob CLOB)
    ,MEMBER FUNCTION  add_paragraph(p_clob CLOB) RETURN html_email_udt
    ,MEMBER PROCEDURE add_code_block(SELF IN OUT NOCOPY html_email_udt , p_clob CLOB)
    ,MEMBER FUNCTION  add_code_block(p_clob CLOB) RETURN html_email_udt
    ,MEMBER PROCEDURE add_to_body(SELF IN OUT NOCOPY html_email_udt, p_clob CLOB)
    ,MEMBER FUNCTION  add_to_body(p_clob CLOB) RETURN html_email_udt
    ,MEMBER PROCEDURE add_table_to_body( -- see cursor_to_table
        SELF IN OUT NOCOPY html_email_udt
        ,p_sql_string   CLOB            := NULL
        ,p_refcursor    SYS_REFCURSOR  := NULL
        ,p_caption      VARCHAR2        := NULL
    )
    ,MEMBER FUNCTION  add_table_to_body( -- see cursor_to_table
        p_sql_string    CLOB            := NULL
        ,p_refcursor    SYS_REFCURSOR  := NULL
        ,p_caption      VARCHAR2        := NULL
    ) RETURN html_email_udt
    -- these take strings that can have multiple comma separated email addresses
    ,MEMBER PROCEDURE add_to(SELF IN OUT NOCOPY html_email_udt, p_to VARCHAR2)
    ,MEMBER FUNCTION  add_to(p_to VARCHAR2)  RETURN html_email_udt
    ,MEMBER PROCEDURE add_cc(SELF IN OUT NOCOPY html_email_udt, p_cc VARCHAR2)
    ,MEMBER FUNCTION  add_cc(p_cc VARCHAR2) RETURN html_email_udt
    ,MEMBER PROCEDURE add_bcc(SELF IN OUT NOCOPY html_email_udt, p_bcc VARCHAR2)
    ,MEMBER FUNCTION  add_bcc(p_bcc VARCHAR2) RETURN html_email_udt
    ,MEMBER PROCEDURE add_subject(SELF IN OUT NOCOPY html_email_udt, p_subject VARCHAR2)
    ,MEMBER FUNCTION  add_subject(p_subject VARCHAR2) RETURN html_email_udt
    ,MEMBER PROCEDURE add_attachment(
        SELF IN OUT NOCOPY html_email_udt
        ,p_file_name    VARCHAR2
        ,p_clob_content CLOB DEFAULT NULL
        ,p_blob_content BLOB DEFAULT NULL
        -- looks up the mime type from the file_name extension
    )
    ,MEMBER FUNCTION  add_attachment(
        p_file_name     VARCHAR2
        ,p_clob_content CLOB DEFAULT NULL
        ,p_blob_content BLOB DEFAULT NULL
        -- looks up the mime type from the file_name extension
    ) RETURN html_email_udt
    ,MEMBER PROCEDURE add_attachment( -- just in case you need fine control
        SELF IN OUT NOCOPY html_email_udt
        ,p_attachment   email_attachment_udt
    )
    ,MEMBER FUNCTION  add_attachment( -- just in case you need fine control
        p_attachment    email_attachment_udt
    ) RETURN html_email_udt
    --
    -- cursor_to_table() converts either an open sys_refcursor or a SQL query
    -- string (do not pass both) into an HTML table from the result set of the
    -- query as a CLOB. By HTML table I mean the partial HTML between
    -- <table>..</table> inclusive, not the header/body part.
    --
    -- Column value coversions are whatever the database decides, so if you want
    -- to format the results a certain way, do so in the query. Also give
    -- column aliases for the table column headers to look nice.
    -- Beware to not use spaces in the column name aliases as
    -- something munges them with _x0020_.
    --
    -- Example:
    --     l_clob := html_email_udt.cursor_to_table(
    --                     p_caption      => 'Payroll Report'
    --                    ,p_sql_string   => q'!
    --                        SELECT
    --                            TO_CHAR(pidm) AS "Employee_PIDM_ID"
    --                            ,TO_CHAR(sum_salary, 'S999,999.99') AS "Salary"
    --                            ,TO_CHAR(payroll_date, 'MM/DD/YYYY') AS "Payroll_Date"
    --                        FROM some_table
    --                    !'
    --              );
    --
    -- You can pass the result to add_to_body() member procedure here, or you
    -- can use it to construct html separate from this Object. The code is
    -- surprisingly short and sweet, and I pulled it off the interwebs mostly
    -- intact, so feel free to just steal that procedure and use it as you wish.
    --
    --Note: that if the cursor does not return any rows, we silently pass back
    -- a NULL clob
    ,STATIC FUNCTION cursor_to_table(
        -- pass in a string.
        -- Unfortunately any tables that are not in your schema
        -- will need to be fully qualified with the schema name. The cursor
        -- version does not share this issue.
        p_sql_string    CLOB            := NULL
        -- pass in an open cursor. This is better for my money.
        ,p_refcursor    SYS_REFCURSOR   := NULL
        -- if provided, will be the caption on the table, generally centered
        -- on the top of the table by most renderers.
        ,p_caption      VARCHAR2        := NULL]'
$if $$use_app_log $then
        ||q'[
        ,p_log          app_log_udt     := NULL]'
$end
||q'[
    ) RETURN CLOB
    ,STATIC FUNCTION s_split(
         p_s            VARCHAR2
        ,p_separator    VARCHAR2 := ','
    ) RETURN &&d_arr_varchar2_udt.
)
NOT FINAL
;
]'; -- end execute immediate
END; -- end anonymous block
/
show errors