DBA Data[Home] [Help]
Skip to content

PACKAGE: SYS.UTL_MAIL

Source


1 PACKAGE utl_mail AUTHID CURRENT_USER AS
2 
3   -------------
4   --  CONSTANTS
5   --
6   invalid_argument EXCEPTION;
7   invalid_priority EXCEPTION;
8   invalid_argument_errcode CONSTANT PLS_INTEGER:= -29261;
9   PRAGMA EXCEPTION_INIT(invalid_argument, -29261);
10   PRAGMA EXCEPTION_INIT(INVALID_PRIORITY, -44101);
11   /*----------------------------------------------------------------
12   **
13   ** SEND - send an email message
14   **
15   ** This procedure packages and delivers an email message to the
16   ** SMTP server specified by the following configuration parameters:
17   **
18   **   SMTP_SERVER=my_server.my_company.com
19   **   SMTP_DOMAIN=my_company.com
20   **
21   ** SEND PROCEDURE
22   ** IN
23   **   sender       - sender address
24   **   recipients   - address(es) of 1 or more recipients, comma delimited
25   **   cc           - CC (carbon copy) recipient(s)), 1 or more addresses,
26   **                    comma delimited, default=NULL
27   **   bcc          - BCC (blind carbon copy) recipient(s), 1 or more
28   **                    addresses, comma delimited, default=NULL
29   **   subject      - subject string, default=NULL
30   **   message      - message text, default=NULL
31   **   mime_type    - mime type, default='text/plain'
32   **   priority     - message priority, default=3, valid values are [1..5]
33   **
34   ** SEND_ATTACH_VARCHAR2 PROCEDURE
35   ** IN
36   **   sender       - sender address
37   **   recipients   - address(es) of 1 or more recipients, comma delimited
38   **   cc           - CC (carbon copy) recipient(s)), 1 or more addresses,
39   **                    comma delimited, default=NULL
40   **   bcc          - BCC (blind carbon copy) recipient(s), 1 or more
41   **                    addresses, comma delimited, default=NULL
42   **   subject      - subject string, default=NULL
43   **   message      - message text, default=NULL
44   **   mime_type    - mime type, default='text/plain'
45   **   priority     - message priority, default=3, valid values are [1..5]
46   **   att_txt_inline - boolean specifying whether the attachment is viewable
47   **                    inline with the message body text, default=TRUE
48   **   attachment   - attachment text data
49   **   att_mime_type- attachment mime_type, default='text/plain'
50   **   att_filename - filename to be offered as a default upon saving the
51   **                    attachment to disk
52   **
53   ** SEND_ATTACH_RAW PROCEDURE
54   ** IN
55   **   sender       - sender address
56   **   recipients   - address(es) of 1 or more recipients, comma delimited
57   **   cc           - CC (carbon copy) recipient(s)), 1 or more addresses,
58   **                    comma delimited, default=NULL
59   **   bcc          - BCC (blind carbon copy) recipient(s), 1 or more
60   **                    addresses, comma delimited, default=NULL
61   **   subject      - subject string, default=NULL
62   **   message      - message text, default=NULL
63   **   mime_type    - mime type, default='text/plain'
64   **   priority     - message priority, default=3, valid values are [1..5]
65   **   att_raw_inline - boolean specifying whether the attachment is viewable
66   **                    inline with the message body text, default=TRUE
67   **   attachment   - attachment RAW data
68   **   att_mime_type- attachment mime_type, default='application/octet'
69   **   att_filename - filename to be offered as a default upon saving the
70   **                    attachment to disk
71   **
72   */
73 
74   PROCEDURE send(sender         IN VARCHAR2 CHARACTER SET ANY_CS,
75                  recipients     IN VARCHAR2 CHARACTER SET ANY_CS,
76                  cc             IN VARCHAR2 CHARACTER SET ANY_CS DEFAULT NULL,
77                  bcc            IN VARCHAR2 CHARACTER SET ANY_CS DEFAULT NULL,
78                  subject        IN VARCHAR2 CHARACTER SET ANY_CS DEFAULT NULL,
79                  message        IN VARCHAR2 CHARACTER SET ANY_CS DEFAULT NULL,
80                  mime_type      IN VARCHAR2 CHARACTER SET ANY_CS
81                                    DEFAULT 'text/plain; charset=us-ascii',
82                  priority       IN PLS_INTEGER DEFAULT 3,
83                  replyto        IN VARCHAR2 CHARACTER SET ANY_CS DEFAULT NULL);
84 
85   PROCEDURE send_attach_varchar2(
86                  sender         IN VARCHAR2 CHARACTER SET ANY_CS,
87                  recipients     IN VARCHAR2 CHARACTER SET ANY_CS,
88                  cc             IN VARCHAR2 CHARACTER SET ANY_CS DEFAULT NULL,
89                  bcc            IN VARCHAR2 CHARACTER SET ANY_CS DEFAULT NULL,
90                  subject        IN VARCHAR2 CHARACTER SET ANY_CS DEFAULT NULL,
91                  message        IN VARCHAR2 CHARACTER SET ANY_CS DEFAULT NULL,
92                  mime_type      IN VARCHAR2 CHARACTER SET ANY_CS
93                                    DEFAULT 'text/plain; charset=us-ascii',
94                  priority       IN PLS_INTEGER DEFAULT 3,
95                  attachment     IN VARCHAR2 CHARACTER SET ANY_CS,
96                  att_inline     IN BOOLEAN  DEFAULT TRUE,
97                  att_mime_type  IN VARCHAR2 CHARACTER SET ANY_CS
98                                    DEFAULT 'text/plain; charset=us-ascii',
99                  att_filename   IN VARCHAR2 CHARACTER SET ANY_CS DEFAULT NULL,
100                  replyto        IN VARCHAR2 CHARACTER SET ANY_CS DEFAULT NULL);
101 
102   PROCEDURE send_attach_raw(
103                  sender         IN VARCHAR2 CHARACTER SET ANY_CS,
104                  recipients     IN VARCHAR2 CHARACTER SET ANY_CS,
105                  cc             IN VARCHAR2 CHARACTER SET ANY_CS DEFAULT NULL,
106                  bcc            IN VARCHAR2 CHARACTER SET ANY_CS DEFAULT NULL,
107                  subject        IN VARCHAR2 CHARACTER SET ANY_CS DEFAULT NULL,
108                  message        IN VARCHAR2 CHARACTER SET ANY_CS DEFAULT NULL,
109                  mime_type      IN VARCHAR2 CHARACTER SET ANY_CS
110                                    DEFAULT 'text/plain; charset=us-ascii',
111                  priority       IN PLS_INTEGER DEFAULT 3,
112                  attachment     IN RAW,
113                  att_inline     IN BOOLEAN  DEFAULT TRUE,
114                  att_mime_type  IN VARCHAR2 CHARACTER SET ANY_CS
115                                    DEFAULT 'application/octet',
116                  att_filename   IN VARCHAR2 CHARACTER SET ANY_CS DEFAULT NULL,
117                  replyto        IN VARCHAR2 CHARACTER SET ANY_CS DEFAULT NULL);
118 
119 END;