| Where allowed to run: All environments (*ALL) Threadsafe: No |
Parameters Examples Error messages |
The Change SMTP Attributes (CHGSMTPA) command is used to change common SMTP attributes such as retries, name delimiters, mail router, and the automatic registration of remote users into the system directory.
Changes for the following parameters take effect immediately the next time SMTP processes an email:
ADDRESS, ALLMAILMSF, ALWAUTH, ALWBARELF, ALWRLY, AUTOADD, CCSID, ETRNCLT, ETRNSVR, FIREWALL, FWDHUBSVR, FTRACN, IFCDMN, JOURNAL, MAILROUTER, MIME8BIT, NFYDLVRY, OVRRJTCNNL, PCTRTGCHR, POPWDW, RBLSVR, RTYDAY, RTYHOUR, RTYMIN, RTYRMTSVR, SBSD, SYSNAME, TBLSMTPIN, TBLSMTPOUT, TBLTYPE, USRIDPFX, VFYFROMUSR, VFYID, and VFYMSFMSG.
Changes for the following parameters take effect the next time SMTP is started:
AUTOSTART, DIALSCD, and USRIDDELIM.
Restrictions:
| Top |
| Keyword | Description | Choices | Notes |
|---|---|---|---|
| AUTOSTART | Autostart server | *SAME, *YES, *NO | Optional, Positional 1 |
| RTYMIN | Retries by minute | Element list | Optional |
| Element 1: Number of retries | 0-99, *SAME, *DFT | ||
| Element 2: Time interval | 0-99, *SAME, *DFT | ||
| RTYDAY | Retries by day | Element list | Optional |
| Element 1: Number of retries | 0-9, *SAME, *DFT | ||
| Element 2: Time interval | 0-9, *SAME, *DFT | ||
| RTYHOUR | Retries by hour | Element list | Optional |
| Element 1: Number of retries | 0-99, *SAME, *DFT | ||
| Element 2: Time interval | 0-99, *SAME, *DFT | ||
| RTYRMTSVR | Retry remote name server | *SAME, *YES, *NO | Optional |
| AUTOADD | Automatic registration | *SAME, *NO, *YES | Optional |
| USRIDPFX | User ID prefix | Communications name, *SAME, *DFT | Optional |
| ADDRESS | Address | Communications name, *SAME, *DFT | Optional |
| SYSNAME | System name | Character value, *SAME, *DFT | Optional |
| TBLTYPE | Alias table type | *SAME, *SYSTEM, *PERSONAL | Optional |
| USRIDDELIM | User ID delimiter | *SAME, *DFT, '?', '=', '.', '&', $, #, '/', '+', '_', '-', *, '"' | Optional |
| MAILROUTER | Mail router | Character value, *SAME, *NONE | Optional |
| CCSID | Coded character set identifier | 1-65533, *SAME, *DFT | Optional |
| TBLSMTPOUT | Outgoing EBCDIC/ASCII table | Single values: *SAME, *CCSID, *DFT Other values: Element list |
Optional |
| Element 1: Outgoing EBCDIC/ASCII table | Qualified object name | ||
| Qualifier 1: Outgoing EBCDIC/ASCII table | Name | ||
| Qualifier 2: Library | Name, *LIBL, *CURLIB | ||
| TBLSMTPIN | Incoming ASCII/EBCDIC table | Single values: *SAME, *CCSID, *DFT Other values: Element list |
Optional |
| Element 1: Incoming ASCII/EBCDIC table | Qualified object name | ||
| Qualifier 1: Incoming ASCII/EBCDIC table | Name | ||
| Qualifier 2: Library | Name, *LIBL, *CURLIB | ||
| FIREWALL | Firewall | *SAME, *YES, *NO | Optional |
| JOURNAL | Journal | *SAME, *YES, *NO | Optional |
| ALLMAILMSF | Process all mail through MSF | *SAME, *YES, *NO | Optional |
| PCTRTGCHR | Percent routing character | *SAME, *YES, *NO | Optional |
| DIALSCD | Dial-up scheduler | Single values: *NO Other values: Element list |
Optional |
| Element 1: Start with SMTP server | *SAME, *YES | ||
| Element 2: Configuration profile | Name, *SAME | ||
| Element 3: Connection time interval | 1-1440, *SAME, *NONE | ||
| ETRNSVR | Support ETRN for server | *SAME, *NO, *YES | Optional |
| ETRNCLT | Support ETRN for client | Single values: *NO Other values: Element list |
Optional |
| Element 1: Enable client ETRN | *SAME, *YES | ||
| Element 2: Incoming mail server address | Character value, *SAME | ||
| Element 3: Mail domain name | Character value, *SAME | ||
| MIME8BIT | Support 8-bit MIME | *SAME, *NO, *YES | Optional |
| NFYDLVRY | Delivery status notification | Element list | Optional |
| Element 1: Responsible person | Character value, *SAME, *NONE | ||
| SBSD | Subsystem description | Single values: *SAME, *DFT Other values: Qualified object name |
Optional |
| Qualifier 1: Subsystem description | Name | ||
| Qualifier 2: Library | Name | ||
| RBLSVR | Realtime Blackhole List | Character value, *SAME, *NONE | Optional |
| ALWRLY | Allow relayed mail | Single values: *SAME, *NONE, *ALL, *BOTH Other values (up to 3 repetitions): *LIST, *NEAR, *POPWDW |
Optional |
| POPWDW | POP send mail window | 15-65535, *SAME, *NONE | Optional |
| IFCDMN | Interface/domain association | *SAME, *NONE, *LIST | Optional |
| FTRACN | Filter mail for virus | *SAME, *NONE, *KEEP, *DISCARD | Optional |
| OVRRJTCNNL | Override reject connect list | *SAME, *NO, *YES | Optional |
| ALWBARELF | Allow bare line feed | *SAME, *NO, *YES | Optional |
| VFYID | Verify identification | *SAME, *NO, *YES | Optional |
| ALWAUTH | Allow authentication | *SAME, *RELAY, *LCLRLY, *NONE | Optional |
| VFYMSFMSG | Verify MSF messages | *SAME, *YES, *NO | Optional |
| VFYFROMUSR | Verify from user | *SAME, *ALL, *LIST, *NONE | Optional |
| FWDHUBSVR | Forwarding mailhub server | Character value, *SAME, *NONE | Optional |
| Top |
Specifies whether to start the SMTP server automatically when TCP/IP is started by running the Start TCP/IP (STRTCP) command, or the Start TCP/IP Server (STRTCPSVR) command with SERVER(*AUTOSTART) specified. When SMTP is started by running the STRTCPSVR command, this parameter is ignored; the SMTP server is started regardless of the value of this parameter.
| Top |
Specifies the number of attempts and the number of minutes between attempts for SMTP to distribute mail and to retry the remote name server. If the number specified is used and is not successful, the daily retries that are specified by the RTYHOUR parameter are attempted.
Element 1: Number of retries
Element 2: Time interval
| Top |
Specifies the number of attempts and the number of days between attempts for SMTP to distribute mail and to retry the remote name server. The RTYDAY parameter is used when the RTYMIN parameter was not successful. If the number of RTYDAY attempts is used and is not successful in distributing mail, a status distribution note is returned to the sender. Because the default on the RTYDAY parameter is set to 0 for the number of retries, this level of retry is not used unless intentionally set by the customer. Either, the RTYDAY or RTYHOUR parameter may be chosen for Second Level retry, but not both.
Element 1: Number of retries
Element 2: Time interval
| Top |
Specifies the number of attempts and the number of hours between attempts for SMTP to distribute mail and to retry the remote name server. The RTYHOUR parameter is used when the RTYMIN parameter was not successful. If the number of retries is greater than zero, and the time interval is greater than zero for RTYHOUR parameter, the RTYDAY parameter values are not used. If the number of RTYHOUR attempts is used and is not successful in distributing mail, a status distribution note is returned to the sender. Because the default on the RTYHOUR parameter is set to 0 for the number of retries, this level of retry is not used unless intentionally set by the customer.
Element 1: Number of retries
Element 2: Time interval
| Top |
Specifies whether SMTP should retry contacting the remote name server when attempts to contact it are unsuccessful. The RTYMIN and RTYHOUR/RTYDAY parameters are used to determine the frequency of retries.
| Top |
Specifies, for incoming mail, whether the remote user ID and address are automatically added to the system directory and, if necessary, to an alias table. This enables the local user to respond to the mail without first entering the necessary data into the directory and the alias table.
| Top |
Specifies the 3-character prefix that is to be used with the generated 5-digit number that together make up the SNADS user ID. The SNADS user ID is automatically added to the system directory and the alias table. This parameter takes effect only if the AUTOADD parameter is set to *YES.
| Top |
Specifies the SNADS address to be generated when remote users are to be automatically added to the system directory and the alias table. This parameter takes effect only if the AUTOADD parameter is set to *YES.
| Top |
Specifies the name that SNADS uses to route mail to SMTP. This name should match the distribution routing specified when SMTP was configured. This parameter takes effect only if the AUTOADD parameter is set to *YES.
| Top |
Specifies the type of SMTP alias table to be updated with the remote users information if remote users are to be automatically added to the system directory. This parameter takes effect only if the AUTOADD parameter is set to *YES.
| Top |
Specifies the single character delimiter to be used to separate parts of the SMTP user ID. All subsequent entries in the system and personal alias tables use this new character. The special characters must be enclosed in apostrophes.
| Top |
Specifies that a mail router should be used when SMTP cannot find the name and address of the recipient in the system or personal alias tables or when SMTP is not able to resolve the address of the recipient. If you do not want mail routing, you must specify *NONE.
Note: When MAILROUTER(*NONE) is defined, then the FIREWALL parameter will be ignored by the SMTP server.
| Top |
Specifies the ASCII coded character set identifier (CCSID) that is used to map all single-byte character set (SBCS) data on outgoing mail. This value is also assumed to be the ASCII CCSID for mapping all SBCS data for incoming mail. Mapping is determined by the specified ASCII CCSID and the EBCDIC CCSID of the job.
The CCSID value chosen is the default used by SMTP for ASCII-to-EBCDIC and EBCDIC-to-ASCII mapping. Outgoing and incoming mapping can be done optionally with mapping tables defined in the TBLSMTPOUT and TBLSMTPIN parameters. Normally the TBLSMTPOUT and TBLSMTPIN parameters are set to the default of *CCSID or *DFT. Both values indicate that the value used in the CCSID parameter is used for mapping.
If a mapping table is used for outgoing mapping, a table object can be specified in the TBLSMTPOUT parameter. The table object specified in the TBLSMTPOUT parameter is used instead of the CCSID value.
Incoming mapping can be changed to use a mapping table by specifying a table object in the TBLSMTPIN parameter. This mapping table overrides the specified CCSID value and is used for incoming mapping.
Double-byte character set (DBCS) CCSID values are not permitted for this parameter. DBCS data is self-identifying in SMTP mail.
| Top |
Specifies the outgoing mapping table used by the SMTP client to map outgoing mail from EBCDIC to ASCII.
If a table object is specified for TBLSMTPOUT, the table object is used for outgoing mapping. Otherwise, the CCSID parameter is used to determine outgoing mapping.
Single values
Qualifier 1: Outgoing EBCDIC/ASCII table
Qualifier 2: Library
| Top |
Specifies the incoming mapping table used by the SMTP server to map incoming data from ASCII to EBCDIC.
If a table object is specified for the TBLSMTPIN parameter, the table object is used for incoming mapping. Otherwise, the CCSID parameter is used to determine incoming mapping.
Qualifier 1: Outgoing EBCDIC/ASCII table
Qualifier 2: Library
| Top |
Specifies whether outbound mail, destined for a host in a remote domain, should be forwarded to the configured mail router to get through the network's firewall.
Note: When MAILROUTER(*NONE) is defined, then the FIREWALL parameter will be ignored by the SMTP server.
| Top |
Specifies whether SMTP should write additional journal entries which show mail message transitions, events, and informational data to the Mail Server Framework journal (QUSRSYS/QZMF) as each mail item passes thru SMTP.
| Top |
Specifies whether the SMTP server should process all mail that it receives, even mail that is not addressed to the IBM i that the server is running on, and pass it into the Mail Server Framework.
| Top |
Specifies whether the SMTP Server should interpret the '%' character as an SMTP routing character, or allow the character to just pass through. Lotus Notes uses the '%' character as a default separator character for fully qualifying a Lotus Note domain name, ie. John_Smith%NotesDomain1%NotesDomain2@host.domain.
Note: You should select *NO, if you use Lotus Notes, or you exchange mail with a Lotus Notes domain.
| Top |
Determines if the SMTP scheduler should be started to handle dial-up connections. The scheduler is started as a separate SMTP job. An initial connection is first made using the communications profile to establish a Point-to-Point Protocol (PPP) link. The waiting mail is sent, then the job sleeps for the time interval specified. When the time interval expires, the Scheduler reestablishes the communication link and sends any waiting mail accumulated during the interval.
Note: Delivery attempts resulting from the scheduler are not counted as retries (see RTYMIN and RTYHOUR parameters).
Single values
Element 1: Start with SMTP server
Element 2: Configuration profile
Element 3: Connection time interval
| Top |
Specifies whether the SMTP server will support the Service Extension for Remote Message Queue Starting (ETRN) command from a remote host's client. ETRN is described in RFC 1985 SMTP Service Extension for Remote Message Queue Starting.
| Top |
Specifies whether the Service Extension for Remote Message Queue Starting (ETRN) command will be issued to an internet service provider's (ISP's) incoming mail server when a dial-out connection is made. The connection's profile is the one defined in the DIALSCD parameter. ETRN is described in RFC 1985 SMTP Service Extension for Remote Message Queue Starting.
Single values
Element 1: Enable client ETRN
Element 2: Incoming mail server address
Element 3: Mail domain name
| Top |
Specifies whether the 8BITMIME extension is honored by the SMTP server. The SMTP client will try to send the 8BITMIME message (for relayed mail cases), but will send a non-delivery notice to the originator if the destination's mail server does not support 8BITMIME. No conversion will be done.
| Top |
Specifies whether Delivery Status Notification (DSN) is supported and, if supported, the address to use in the "from" field in the delivery status notification.
The server will honor a request for Delivery Status Notification from an SMTP client. Status notes, indicating delivery, delay, relay or failure of a note to a recipient, will be generated as requested.
| Top |
Specifies the subsystem description of the subsystem where SMTP server jobs are to run. If the specified subsystem description does not exist, it is created. If the library does not exist where the description is to be created, the command will fail.
If a subsystem description other than an IBM-supplied *SBSD QSYSWRK is specified, a job queue is also created with the same name and in the same library as the specified subsystem description. This job queue is used for submitting SMTP server jobs.
*READ, *ADD, and *EXECUTE authorities are required to the library where the subsystem description and/or job queue are created. If the subsystem description already exists, *READ, *EXECUTE, *OBJMGT and *OBJOPR authorities to the object are required otherwise this command will fail. If the job queue already exists, *READ, *EXECUTE, *OBJMGT, and *OBJOPR authorities are required to that object; otherwise the command will fail. For an existing subsystem description and job queue, the QTCP user profile will be granted *USE authority to these objects.
Single values
Qualifier 1: Subsystem description
Qualifier 2: Library
| Top |
Specify the fully-qualified domain names of the servers to query that are running a Realtime Blackhole List (RBL). If no entry is found for the mail originator's address in the reject connections list, a query will be sent to each RBL server specified in this parameter before mail is accepted for delivery or relay. The reject connections list can be set by using IBM i Navigator SMTP properties pages or by using the ADDSMTPLE command with *REJECT specified for the TYPE parameter.
| Top |
Specifies whether to allow relay mail through this server. The value specified for this parameter is ignored if *RELAY or *LCLRLY is specified or in effect for the Allow authentication (ALWAUTH) parameter.
Single values
Other values (up to 3 repetitions)
Note: IBM i POP users on this system should be added to this list if this system is to act as their outbound SMTP server. Any message from POP users must be relayed.
| Top |
Specifies the number of minutes to allow a client to send mail, using the SMTP server, to addresses other than a local address. The time starts for each client when the client logs on to the POP server to receive mail.
| Top |
Specifies whether SMTP should associate domains with specific interfaces.
| Top |
Allows mail to be scanned and either discarded or quarantined if a set of conditions are met. These conditions are:
The Subject comparison records are defined by using IBM i Navigator SMTP properties pages or by using the Add SMTP List Entry (ADDSMTPLE) command with a value of *FTRSUBJECT.
The Filename/Extension records are defined by using IBM i Navigator SMTP properties pages or by using the ADDSMTPLE command with a value of *FTRFILNAME.
The Type/Subtype records are defined by using IBM i Navigator SMTP properties pages or by using the ADDSMTPLE command with a value of *FTRTYPE.
The Originator records are defined by using IBM i Navigator SMTP properties pages or by using the ADDSMTPLE command with a value of *FTRORIGIN.
| Top |
Specifies whether the SMTP server will support a POP-before-mail authorization to override the reject connection list.
| Top |
Specifies whether the SMTP server will support bare linefeed (LF) instead of carriage return and linefeed (CRLF).
| Top |
Specifies whether the SMTP server will verify whether the user is on the authorized list for email.
| Top |
Specifies whether the SMTP server will support transport layer security (TLS) and secure socket layer (SSL), and when authentication of the user will occur. If *RELAY or *LCLRLY is specified or in effect, the value specified for the Allow relayed mail (ALWRLY) parameter is ignored.
| Top |
Specifies whether the SMTP server will allow the SMTP mail server framework (MSF) snap-ins functions to reject an email that is not verified. For backwards compatibility this will only be valid when the ALWAUTH parameter is set to *LCLRLY. If the email doesn't come from an authenticated source then the user that issued the QzmfCrtMailMsg() function must match the originator of the MSF message.
| Top |
Specifies whether the SMTP server will verify the Mail From: address to see if the user is in the System Distribution Directory (SDD) and if the email address matches. If there isn't a match, and *ALL or *LIST is specified or in effect for this parameter, the user will be rejected. For backwards compatibility this will only be valid when the ALWAUTH parameter is set to *LCLRLY.
| Top |
Specifies domain name of the SMTP server that this SMTP server should forward all non-local emails. This makes this SMTP server behave like a mailhub. If you do not want the mail forwarded, you must specify *NONE.
| Top |
Example 1: Changing the POP Send Time to two Hours
CHGSMTPA ALWRLY(*POPWDW) POPWDW(120)
This command changes the SMTP attributes to allow a POP client to send mail using the local SMTP server to any remote address for 2 hours (120 minutes) after logging on to the POP server to check mail.
Example 2: Allow Relay for Addresses on List
CHGSMTPA ALWRLY(*LIST)
This command changes the SMTP attributes to allow clients using IP address on a list to send relay mail.
Example 3: Require authentication for Relay
CHGSMTPA ALWAUTH(*RELAY)
This command changes the SMTP attributes to authenticate the SMTP relay prior to accepting email forwarded from that relay.
Example 4: Require Users Not on List be Verified
CHGSMTPA VFYFROMUSR(*LIST)
This command changes the SMTP attributes to require all emails not in the list defined in the ADDSMTPLE *ACCEPT CL command to have the username verified.
| Top |
*ESCAPE Messages
| Top |